@hubspot/cli 4.1.8-beta.2 → 4.1.8-beta.4

package/lib/DevServerManager.js

@@ -0,0 +1,74 @@
+const express = require('express');
+const bodyParser = require('body-parser');
+const cors = require('cors');
+const { getProjectDetailUrl } = require('./projects');
+
+const DEFAULT_PORT = 8080;
+
+class DevServerManager {
+  constructor() {
+    this.server = null;
+    this.devServers = {};
+  }
+
+  async iterateDevServers(callback) {
+    const serverKeys = Object.keys(this.devServers);
+
+    for (let i = 0; i < serverKeys.length; i++) {
+      const serverKey = serverKeys[i];
+      const serverInterface = this.devServers[serverKey];
+      await callback(serverInterface, serverKey);
+    }
+  }
+
+  async start({ projectConfig, accountId, port }) {
+    const app = express();
+
+    // Install Middleware
+    app.use(bodyParser.json({ limit: '50mb' }));
+    app.use(bodyParser.urlencoded({ limit: '50mb', extended: true }));
+    app.use(cors());
+
+    // Configure
+    app.set('trust proxy', true);
+
+    // Initialize a base route
+    app.get('/', (req, res) => {
+      res.send('HubSpot local dev server');
+    });
+
+    // Initialize URL redirects
+    app.get('/hs/project', (req, res) => {
+      res.redirect(getProjectDetailUrl(projectConfig.name, accountId));
+    });
+
+    // Initialize component servers
+    await this.iterateDevServers(async (serverInterface, serverKey) => {
+      if (serverInterface.start) {
+        const serverApp = await serverInterface.start(serverKey);
+        app.use(`/${serverKey}`, serverApp);
+      }
+    });
+
+    // Start server
+    this.server = app.listen(port || DEFAULT_PORT);
+
+    return `http://localhost:${this.server.address().port}`;
+  }
+
+  async notify() {
+    return { uploadRequired: true };
+  }
+
+  async execute() {
+    return;
+  }
+
+  async cleanup() {
+    if (this.server) {
+      await this.server.close();
+    }
+  }
+}
+
+module.exports = new DevServerManager();

package/lib/LocalDevManager.js

@@ -1,7 +1,7 @@
 const chokidar = require('chokidar');
 const path = require('path');
 const { default: PQueue } = require('p-queue');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('./lang');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   isSpecifiedError,
@@ -22,11 +22,9 @@ const {
   queueBuild,
 } = require('@hubspot/cli-lib/api/dfs');
 const SpinniesManager = require('./SpinniesManager');
+const DevServerManager = require('./DevServerManager');
 const { EXIT_CODES } = require('./enums/exitCodes');
-const {
-  getProjectDetailUrl,
-  pollProjectBuildAndDeploy,
-} = require('./projects');
+const { pollProjectBuildAndDeploy } = require('./projects');
 const { uiAccountDescription, uiLink } = require('./ui');
 
 const i18nKey = 'cli.lib.LocalDevManager';
@@ -45,6 +43,7 @@ const UPLOAD_PERMISSIONS = {
   manual: 'manual',
   never: 'never',
 };
+
 class LocalDevManager {
   constructor(options) {
     this.targetAccountId = options.targetAccountId;
@@ -53,7 +52,6 @@ class LocalDevManager {
     this.uploadPermission =
       options.uploadPermission || UPLOAD_PERMISSIONS.always;
     this.debug = options.debug || false;
-    this.mockServers = options.mockServers || false;
     this.projectSourceDir = path.join(
       this.projectDir,
       this.projectConfig.srcDir
@@ -64,6 +62,8 @@ class LocalDevManager {
     this.standbyChanges = [];
     this.debouncedBuild = null;
     this.currentStagedBuildId = null;
+    this.port = options.port;
+    this.devServerPath = null;
 
     if (!this.targetAccountId || !this.projectConfig || !this.projectDir) {
       process.exit(EXIT_CODES.ERROR);
@@ -90,8 +90,9 @@ class LocalDevManager {
 
     this.uploadQueue.start();
 
-    this.logConsoleHeader();
     await this.startServers();
+
+    this.logConsoleHeader();
     await this.startWatching();
     this.updateKeypressListeners();
   }
@@ -146,24 +147,27 @@ class LocalDevManager {
   logConsoleHeader() {
     this.spinnies.removeAll();
     this.spinnies.add('devModeRunning', {
-      text: i18n(`${i18nKey}.running`),
+      text: i18n(`${i18nKey}.header.running`, {
+        accountIdentifier: uiAccountDescription(this.targetAccountId),
+        projectName: this.projectConfig.name,
+      }),
       isParent: true,
       category: 'header',
     });
     this.spinnies.add('devModeStatus', {
-      text: i18n(`${i18nKey}.status.clean`),
+      text: i18n(`${i18nKey}.header.status.clean`),
       status: 'non-spinnable',
       indent: 1,
       category: 'header',
     });
-    const projectDetailUrl = getProjectDetailUrl(
-      this.projectConfig.name,
-      this.targetAccountId
-    );
     this.spinnies.add('viewInHubSpotLink', {
-      text: uiLink(i18n(`${i18nKey}.viewInHubSpot`), projectDetailUrl, {
-        inSpinnies: true,
-      }),
+      text: uiLink(
+        i18n(`${i18nKey}.header.viewInHubSpotLink`),
+        this.generateLocalURL(`/hs/project`),
+        {
+          inSpinnies: true,
+        }
+      ),
       status: 'non-spinnable',
       indent: 1,
       category: 'header',
@@ -174,7 +178,7 @@ class LocalDevManager {
       category: 'header',
     });
     this.spinnies.add('keypressMessage', {
-      text: i18n(`${i18nKey}.quitHelper`),
+      text: i18n(`${i18nKey}.header.quitHelper`),
       status: 'non-spinnable',
       indent: 1,
       category: 'header',
@@ -223,9 +227,13 @@ class LocalDevManager {
     });
   }
 
+  generateLocalURL(path) {
+    return this.devServerPath ? `${this.devServerPath}${path}` : null;
+  }
+
   updateDevModeStatus(langKey) {
     this.spinnies.update('devModeStatus', {
-      text: i18n(`${i18nKey}.status.${langKey}`),
+      text: i18n(`${i18nKey}.header.status.${langKey}`),
       status: 'non-spinnable',
       noIndent: true,
     });
@@ -290,11 +298,13 @@ class LocalDevManager {
       remotePath: path.relative(this.projectSourceDir, filePath),
     };
 
-    const isSupportedChange = await this.notifyServers(changeInfo);
+    const notifyResponse = await this.notifyServers(changeInfo);
 
-    if (isSupportedChange) {
+    if (!notifyResponse.uploadRequired) {
       this.updateDevModeStatus('supportedChange');
       this.addChangeToStandbyQueue({ ...changeInfo, supported: true });
+
+      await this.executeServers(notifyResponse, changeInfo);
       return;
     }
 
@@ -503,23 +513,24 @@ class LocalDevManager {
   }
 
   async startServers() {
-    // TODO spin up local dev servers
-    return true;
+    this.devServerPath = await DevServerManager.start({
+      accountId: this.targetAccountId,
+      projectConfig: this.projectConfig,
+      port: this.port,
+    });
   }
 
   async notifyServers(changeInfo) {
-    const { remotePath } = changeInfo;
+    const notifyResponse = await DevServerManager.notify(changeInfo);
+    return notifyResponse;
+  }
 
-    // TODO notify servers of the change
-    if (this.mockServers) {
-      return !remotePath.endsWith('app.json');
-    }
-    return false;
+  async executeServers(notifyResponse, changeInfo) {
+    await DevServerManager.execute(notifyResponse, changeInfo);
   }
 
   async cleanupServers() {
-    // TODO tell servers to cleanup
-    return;
+    await DevServerManager.cleanup();
   }
 }
 

package/lib/commonOpts.js

@@ -6,7 +6,7 @@ const {
   DEFAULT_MODE,
   Mode,
 } = require('@hubspot/cli-lib');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('./lang');
 
 const i18nKey = 'cli.lib.commonOpts';
 const { LOG_LEVEL } = Logger;

package/lib/interpolation.js

@@ -0,0 +1,137 @@
+const helpers = require('./interpolationHelpers');
+const delimiters = {
+  interpolation: {
+    start: '{{',
+    end: '}}',
+  },
+  helpers: {
+    start: '#',
+    end: '/',
+  },
+};
+
+const isHelperIdentifier = identifier => {
+  return (
+    identifier.startsWith(delimiters.helpers.start) ||
+    identifier.startsWith(delimiters.helpers.end)
+  );
+};
+
+const generateReplaceFn = (matchedText, startIndex, replacementString) => {
+  return currentStringValue =>
+    `${currentStringValue.slice(0, startIndex)}${replacementString ||
+      ''}${currentStringValue.slice(startIndex + matchedText.length)}`;
+};
+
+/**
+ * Interpolate a string with data
+ * @param {string} stringValue - The string to interpolate
+ * @param {object} interpolationData - The data to interpolate with
+ * @returns {string} - The interpolated string
+ * @example
+ * interpolation('Hello {{name}}', { name: 'World' })
+ * // 'Hello World'
+ */
+const interpolation = (stringValue, interpolationData) => {
+  const interpolationIdentifierRegEx = new RegExp(
+    `${delimiters.interpolation.start}(.*?)${delimiters.interpolation.end}`,
+    'g'
+  );
+  const replaceQueue = [];
+  let match;
+
+  // while & reduce necessary because RegExp.exec is stateful and only runs
+  // from beginning to end of string
+  while ((match = interpolationIdentifierRegEx.exec(stringValue)) != null) {
+    const { 0: matchedText, 1: rawIdentifier, index } = match;
+    const identifier = rawIdentifier.trim();
+
+    if (identifier && !isHelperIdentifier(identifier)) {
+      replaceQueue.unshift(
+        generateReplaceFn(matchedText, index, interpolationData[identifier])
+      );
+    }
+  }
+
+  const compiledString = replaceQueue.reduce(
+    (currentValue, replaceFn) => replaceFn(currentValue),
+    stringValue
+  );
+
+  return compiledString;
+};
+
+/**
+ * Compile a string using a specified helper function
+ * @param {string} stringValue - The string to modify
+ * @param {object} helperIdentifier - Helper name
+ * @param {function} helperFn - Helper function to call on string
+ * @returns {string} - The modified string
+ * @example
+ * compileHelper('White {{#yellow}}yellow{{/yellow}}', 'yellow', (string) => { chalk.reset.yellow(string) }))))
+ * // 'White yellow' (with 'yellow' colored yellow)
+ */
+const compileHelper = (stringValue, helperIdentifier, helperFn) => {
+  const helperIdentifierRegEx = new RegExp(
+    `${delimiters.interpolation.start}(${delimiters.helpers.start}${helperIdentifier})${delimiters.interpolation.end}(.*?)${delimiters.interpolation.start}(${delimiters.helpers.end}${helperIdentifier})${delimiters.interpolation.end}`,
+    'g'
+  );
+  const replaceQueue = [];
+  let match;
+
+  // while & reduce necessary because RegExp.exec is stateful and only runs
+  // from beginning to end of string
+  while ((match = helperIdentifierRegEx.exec(stringValue)) != null) {
+    const {
+      0: matchedText,
+      1: rawHelperIdentifierStart,
+      2: innerText,
+      index,
+    } = match;
+    const identifier = rawHelperIdentifierStart
+      .replace(delimiters.helpers.start, '')
+      .trim();
+
+    if (identifier && helperFn) {
+      replaceQueue.unshift(
+        generateReplaceFn(matchedText, index, helperFn(innerText))
+      );
+    }
+  }
+
+  const compiledString = replaceQueue.reduce(
+    (currentValue, replaceFn) => replaceFn(currentValue),
+    stringValue
+  );
+
+  return compiledString;
+};
+
+const compileHelpers = stringValue => {
+  return Object.keys(helpers).reduce((currentStringValue, helperIdentifier) => {
+    return compileHelper(
+      currentStringValue,
+      helperIdentifier,
+      helpers[helperIdentifier]
+    );
+  }, stringValue);
+};
+
+/**
+ * Interpolate a string with data and compile helpers on the string
+ * @param {string} stringValue - The string to interpolate
+ * @param {object} interpolationData - The data to interpolate with
+ * @returns {string} - The interpolated and helper-compiled string
+ * @example
+ * interpolateAndCompile('Some {{#bold}}{{text}}{{/bold}} text', { text: 'awesomely bold' })
+ * // 'Some awsomely bold text' (with the words 'awesomely bold' in bold)
+ */
+const interpolate = (stringValue, interpolationData) => {
+  const interpolatedString = interpolation(stringValue, interpolationData);
+  const helperCompiledString = compileHelpers(interpolatedString);
+  return helperCompiledString;
+};
+
+module.exports = {
+  interpolate,
+};

package/lib/interpolationHelpers.js

@@ -0,0 +1,23 @@
+const chalk = require('chalk');
+
+/**
+ * These helper methods are used to modify text output within the CLI. They
+ * should all take in a string value and output a modified string value.
+ */
+module.exports = {
+  bold: function(stringValue) {
+    return chalk.bold(stringValue);
+  },
+  yellow: function(stringValue) {
+    return chalk.reset.yellow(stringValue);
+  },
+  green: function(stringValue) {
+    return chalk.reset.green(stringValue);
+  },
+  red: function(stringValue) {
+    return chalk.reset.red(stringValue);
+  },
+  cyan: function(stringValue) {
+    return chalk.cyan(stringValue);
+  },
+};

package/lib/lang.js

@@ -0,0 +1,95 @@
+const util = require('util');
+const path = require('path');
+const fs = require('fs-extra');
+const yaml = require('js-yaml');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { interpolate } = require('./interpolation');
+
+const MISSING_LANGUAGE_DATA_PREFIX = '[Missing language data]';
+
+let locale;
+let languageObj;
+
+const loadLanguageFromYaml = () => {
+  if (languageObj) return;
+
+  try {
+    const nodeLocale = Intl.DateTimeFormat()
+      .resolvedOptions()
+      .locale.split('-')[0];
+    const languageFilePath = path.join(
+      __dirname,
+      `../lang/${nodeLocale}.lyaml`
+    );
+    const languageFileExists = fs.existsSync(languageFilePath);
+
+    // Fall back to using the default language file
+    locale = languageFileExists ? nodeLocale : 'en';
+    languageObj = yaml.load(
+      fs.readFileSync(path.join(__dirname, `../lang/${locale}.lyaml`), 'utf8')
+    );
+
+    logger.debug(
+      'Loaded language data: ',
+      util.inspect(languageObj, true, 999, true)
+    );
+  } catch (e) {
+    logger.error('Error loading language data: ', e);
+  }
+};
+
+const getTextValue = lookupDotNotation => {
+  const lookupProps = [locale, ...lookupDotNotation.split('.')];
+  const missingTextData = `${MISSING_LANGUAGE_DATA_PREFIX}: ${lookupProps.join(
+    '.'
+  )}`;
+  let textValue = languageObj;
+  let previouslyCheckedProp = lookupProps[0];
+
+  try {
+    lookupProps.forEach(prop => {
+      textValue = textValue[prop];
+      previouslyCheckedProp = prop;
+    });
+  } catch (e) {
+    logger.error(
+      `Unable to access language property: ${lookupProps.join(
+        '.'
+      )}. Failed to access prop "${previouslyCheckedProp}".`
+    );
+    return missingTextData;
+  }
+
+  if (!textValue) {
+    return missingTextData;
+  }
+
+  return textValue;
+};
+
+const i18n = (lookupDotNotation, options = {}) => {
+  if (!languageObj) {
+    loadLanguageFromYaml();
+  }
+
+  if (typeof lookupDotNotation !== 'string') {
+    throw new Error(
+      `i18n must be passed a string value for lookupDotNotation, received ${typeof lookupDotNotation}`
+    );
+  }
+
+  const textValue = getTextValue(lookupDotNotation);
+  const shouldInterpolate = !textValue.startsWith(MISSING_LANGUAGE_DATA_PREFIX);
+
+  return shouldInterpolate ? interpolate(textValue, options) : textValue;
+};
+
+const setLangData = (newLocale, newLangObj) => {
+  locale = newLocale;
+  languageObj = newLangObj;
+};
+
+module.exports = {
+  i18n,
+  setLangData,
+};

package/lib/marketplace-validate.js

@@ -6,7 +6,7 @@ const {
   getValidationStatus,
   getValidationResults,
 } = require('@hubspot/cli-lib/api/marketplaceValidation');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('./lang');
 const { EXIT_CODES } = require('./enums/exitCodes');
 
 const SLEEP_TIME = 2000;

package/lib/projects.js

@@ -37,7 +37,7 @@ const { downloadGitHubRepoContents } = require('@hubspot/cli-lib/github');
 const { promptUser } = require('./prompts/promptUtils');
 const { EXIT_CODES } = require('./enums/exitCodes');
 const { uiLine, uiLink, uiAccountDescription } = require('../lib/ui');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('./lang');
 const SpinniesManager = require('./SpinniesManager');
 const {
   isSpecifiedError,

package/lib/prompts/accountsPrompt.js

@@ -1,6 +1,6 @@
 const { updateDefaultAccount } = require('@hubspot/cli-lib/lib/config');
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 const { getAccountName } = require('../sandboxes');
 
 const mapAccountChoices = portals =>

package/lib/prompts/buildIdPrompt.js

@@ -1,5 +1,5 @@
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 
 const i18nKey = 'cli.lib.prompts.buildIdPrompt';
 

package/lib/prompts/cmsFieldPrompt.js

@@ -1,7 +1,7 @@
 const path = require('path');
 const fs = require('fs');
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 const escapeRegExp = require('@hubspot/cli-lib/lib/escapeRegExp');
 const i18nKey = 'cli.lib.prompts.uploadPrompt';
 const FIELDS_FILES = ['fields.json', 'fields.js', 'fields.cjs', 'fields.mjs'];

package/lib/prompts/createApiSamplePrompt.js

@@ -1,5 +1,5 @@
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 
 const i18nKey = 'cli.lib.prompts.createApiSamplePrompt';
 

package/lib/prompts/createFunctionPrompt.js

@@ -1,5 +1,5 @@
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 
 const { STRING_WITH_NO_SPACES_REGEX } = require('../regex');
 

package/lib/prompts/createModulePrompt.js

@@ -1,5 +1,5 @@
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 
 const i18nKey = 'cli.lib.prompts.createModulePrompt';
 

package/lib/prompts/createProjectPrompt.js

@@ -6,7 +6,7 @@ const {
 } = require('@hubspot/cli-lib/lib/constants');
 const { promptUser } = require('./promptUtils');
 const { fetchJsonFromRepository } = require('@hubspot/cli-lib/github');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 

package/lib/prompts/createTemplatePrompt.js

@@ -1,5 +1,5 @@
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 
 const i18nKey = 'cli.lib.prompts.createTemplatePrompt';
 

package/lib/prompts/downloadProjectPrompt.js

@@ -1,7 +1,7 @@
 const { promptUser } = require('./promptUtils');
 const { getAccountId } = require('@hubspot/cli-lib/lib/config');
 const { fetchProjects } = require('@hubspot/cli-lib/api/dfs');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 
 const i18nKey = 'cli.lib.prompts.downloadProjectPrompt';
 

package/lib/prompts/enterAccountNamePrompt.js

@@ -1,7 +1,7 @@
 const { accountNameExistsInConfig } = require('@hubspot/cli-lib/lib/config');
 const { STRING_WITH_NO_SPACES_REGEX } = require('../regex');
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 
 const i18nKey = 'cli.lib.prompts.enterAccountNamePrompt';
 

package/lib/prompts/feedbackPrompt.js

@@ -1,5 +1,5 @@
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 const { FEEDBACK_OPTIONS } = require('@hubspot/cli-lib/lib/constants');
 
 const i18nKey = 'cli.lib.prompts.feedbackPrompt';

package/lib/prompts/folderOverwritePrompt.js

@@ -1,5 +1,5 @@
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 
 const i18nKey = 'cli.lib.prompts.folderOverwritePrompt';
 

package/lib/prompts/personalAccessKeyPrompt.js

@@ -8,7 +8,7 @@ const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { promptUser } = require('./promptUtils');
 const { accountNamePrompt } = require('./enterAccountNamePrompt');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 const { uiInfoSection } = require('../ui');
 const { EXIT_CODES } = require('../enums/exitCodes');
 

package/lib/prompts/projectAddPrompt.js

@@ -1,6 +1,6 @@
 const { promptUser } = require('./promptUtils');
 const { fetchJsonFromRepository } = require('@hubspot/cli-lib/github');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 const { PROJECT_COMPONENT_TYPES } = require('@hubspot/cli-lib/lib/constants');
 
 const i18nKey = 'cli.lib.prompts.projectAddPrompt';

package/lib/prompts/projectDevTargetAccountPrompt.js

@@ -1,5 +1,5 @@
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 const { uiAccountDescription } = require('../ui');
 const { isSandbox, getAccountName } = require('../sandboxes');
 const { getAccountId } = require('@hubspot/cli-lib');

package/lib/prompts/projectNamePrompt.js

@@ -1,5 +1,5 @@
 const { promptUser } = require('./promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { i18n } = require('../lang');
 const { ensureProjectExists } = require('../projects');
 
 const i18nKey = 'cli.lib.prompts.projectNamePrompt';