@hubspot/cli 4.1.7-beta.0 → 4.1.7-beta.2

package/commands/theme/marketplace-validate.js

@@ -1,7 +1,4 @@
 const Spinnies = require('spinnies');
-const chalk = require('chalk');
-
-const { logger } = require('@hubspot/cli-lib/logger');
 
 const {
   addConfigOptions,
@@ -12,16 +9,15 @@ const {
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const {
-  requestValidation,
-  getValidationStatus,
-  getValidationResults,
-} = require('@hubspot/cli-lib/api/marketplaceValidation');
-
+  kickOffValidation,
+  pollForValidationFinish,
+  fetchValidationResults,
+  processValidationErrors,
+  displayValidationResults,
+} = require('../../lib/marketplace-validate');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
 const i18nKey = 'cli.commands.theme.subcommands.marketplaceValidate';
-const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const SLEEP_TIME = 2000;
 
 exports.command = 'marketplace-validate <src>';
 exports.describe = i18n(`${i18nKey}.describe`);
@@ -36,130 +32,24 @@ exports.handler = async options => {
   trackCommandUsage('validate', null, accountId);
 
   const spinnies = new Spinnies();
-
   spinnies.add('marketplaceValidation', {
     text: i18n(`${i18nKey}.logs.validatingTheme`, {
       path: src,
     }),
   });
 
-  // Kick off validation
-  let requestResult;
   const assetType = 'THEME';
-  const requestGroup = 'EXTERNAL_DEVELOPER';
-  try {
-    requestResult = await requestValidation(accountId, {
-      path: src,
-      assetType,
-      requestGroup,
-    });
-  } catch (err) {
-    logger.debug(err);
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  // Poll till validation is finished
-  try {
-    const checkValidationStatus = async () => {
-      const validationStatus = await getValidationStatus(accountId, {
-        validationId: requestResult,
-      });
-
-      if (validationStatus === 'REQUESTED') {
-        await new Promise(resolve => setTimeout(resolve, SLEEP_TIME));
-        await checkValidationStatus();
-      }
-    };
-
-    await checkValidationStatus();
-
-    spinnies.remove('marketplaceValidation');
-  } catch (err) {
-    logger.debug(err);
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  // Fetch the validation results
-  let validationResults;
-  try {
-    validationResults = await getValidationResults(accountId, {
-      validationId: requestResult,
-    });
-  } catch (err) {
-    logger.debug(err);
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  if (validationResults.errors.length) {
-    const { errors } = validationResults;
-
-    errors.forEach(err => {
-      logger.error(`${err.context}`);
-    });
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  const displayResults = checks => {
-    const displayFileInfo = (file, line) => {
-      if (file) {
-        logger.log(
-          i18n(`${i18nKey}.results.warnings.file`, {
-            file,
-          })
-        );
-      }
-      if (line) {
-        logger.log(
-          i18n(`${i18nKey}.results.warnings.lineNumber`, {
-            line,
-          })
-        );
-      }
-      return null;
-    };
-
-    if (checks) {
-      const { status, results } = checks;
-
-      if (status === 'FAIL') {
-        const failedValidations = results.filter(
-          test => test.status === 'FAIL'
-        );
-        const warningValidations = results.filter(
-          test => test.status === 'WARN'
-        );
-
-        failedValidations.forEach(val => {
-          logger.error(`${val.message}`);
-          displayFileInfo(val.file, val.line);
-        });
-
-        warningValidations.forEach(val => {
-          logger.warn(`${val.message}`);
-          displayFileInfo(val.file, val.line);
-        });
-      }
-
-      if (status === 'PASS') {
-        logger.success(i18n(`${i18nKey}.results.noErrors`));
+  const validationId = await kickOffValidation(accountId, assetType, src);
+  await pollForValidationFinish(accountId, validationId);
 
-        results.forEach(test => {
-          if (test.status === 'WARN') {
-            logger.warn(`${test.message}`);
-            displayFileInfo(test.file, test.line);
-          }
-        });
-      }
-    }
-    return null;
-  };
+  spinnies.remove('marketplaceValidation');
 
-  logger.log(chalk.bold(i18n(`${i18nKey}.results.required`)));
-  displayResults(validationResults.results['REQUIRED']);
-  logger.log();
-  logger.log(chalk.bold(i18n(`${i18nKey}.results.recommended`)));
-  displayResults(validationResults.results['RECOMMENDED']);
-  logger.log();
+  const validationResults = await fetchValidationResults(
+    accountId,
+    validationId
+  );
+  processValidationErrors(validationResults);
+  displayValidationResults(i18nKey, validationResults);
 
   process.exit();
 };

package/lib/marketplace-validate.js

@@ -0,0 +1,137 @@
+const chalk = require('chalk');
+
+const { logger } = require('@hubspot/cli-lib/logger');
+const {
+  requestValidation,
+  getValidationStatus,
+  getValidationResults,
+} = require('@hubspot/cli-lib/api/marketplaceValidation');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { EXIT_CODES } = require('./enums/exitCodes');
+
+const SLEEP_TIME = 2000;
+
+const kickOffValidation = async (accountId, assetType, src) => {
+  const requestGroup = 'EXTERNAL_DEVELOPER';
+  try {
+    const requestResult = await requestValidation(accountId, {
+      path: src,
+      assetType,
+      requestGroup,
+    });
+    return requestResult;
+  } catch (err) {
+    logger.debug(err);
+    process.exit(EXIT_CODES.ERROR);
+  }
+};
+
+const pollForValidationFinish = async (accountId, validationId) => {
+  try {
+    const checkValidationStatus = async () => {
+      const validationStatus = await getValidationStatus(accountId, {
+        validationId,
+      });
+
+      if (validationStatus === 'REQUESTED') {
+        await new Promise(resolve => setTimeout(resolve, SLEEP_TIME));
+        await checkValidationStatus();
+      }
+    };
+    await checkValidationStatus();
+  } catch (err) {
+    logger.debug(err);
+    process.exit(EXIT_CODES.ERROR);
+  }
+};
+
+const fetchValidationResults = async (accountId, validationId) => {
+  try {
+    const validationResults = await getValidationResults(accountId, {
+      validationId,
+    });
+    return validationResults;
+  } catch (err) {
+    logger.debug(err);
+    process.exit(EXIT_CODES.ERROR);
+  }
+};
+
+const processValidationErrors = validationResults => {
+  if (validationResults.errors.length) {
+    const { errors } = validationResults;
+
+    errors.forEach(err => {
+      logger.error(`${err.context}`);
+    });
+    process.exit(EXIT_CODES.ERROR);
+  }
+};
+
+const displayValidationResults = (i18nKey, validationResults) => {
+  const displayResults = checks => {
+    const displayFileInfo = (file, line) => {
+      if (file) {
+        logger.log(
+          i18n(`${i18nKey}.results.warnings.file`, {
+            file,
+          })
+        );
+      }
+      if (line) {
+        logger.log(
+          i18n(`${i18nKey}.results.warnings.lineNumber`, {
+            line,
+          })
+        );
+      }
+      return null;
+    };
+
+    if (checks) {
+      const { status, results } = checks;
+
+      if (status === 'FAIL') {
+        const failedValidations = results.filter(
+          test => test.status === 'FAIL'
+        );
+        const warningValidations = results.filter(
+          test => test.status === 'WARN'
+        );
+        failedValidations.forEach(val => {
+          logger.error(`${val.message}`);
+          displayFileInfo(val.file, val.line);
+        });
+        warningValidations.forEach(val => {
+          logger.warn(`${val.message}`);
+          displayFileInfo(val.file, val.line);
+        });
+      }
+      if (status === 'PASS') {
+        logger.success(i18n(`${i18nKey}.results.noErrors`));
+
+        results.forEach(test => {
+          if (test.status === 'WARN') {
+            logger.warn(`${test.message}`);
+            displayFileInfo(test.file, test.line);
+          }
+        });
+      }
+    }
+    return null;
+  };
+
+  Object.keys(validationResults.results).forEach(type => {
+    logger.log(chalk.bold(i18n(`${i18nKey}.results.${type.toLowerCase()}`)));
+    displayResults(validationResults.results[type]);
+    logger.log();
+  });
+};
+
+module.exports = {
+  kickOffValidation,
+  pollForValidationFinish,
+  fetchValidationResults,
+  processValidationErrors,
+  displayValidationResults,
+};

package/lib/prompts/accountsPrompt.js

@@ -1,9 +1,7 @@
 const { updateDefaultAccount } = require('@hubspot/cli-lib/lib/config');
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
-
-const getSandboxType = type =>
-  type === 'DEVELOPER' ? 'development' : 'standard';
+const { getSandboxType } = require('../sandboxes');
 
 const mapAccountChoices = portals =>
   portals.map(p => {

package/lib/prompts/sandboxesPrompt.js

@@ -1,11 +1,9 @@
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { getSandboxType } = require('../sandboxes');
 
 const i18nKey = 'cli.lib.prompts.sandboxesPrompt';
 
-const getSandboxType = type =>
-  type === 'DEVELOPER' ? 'development' : 'standard';
-
 const mapSandboxAccountChoices = portals =>
   portals
     .filter(p => p.sandboxAccountType && p.sandboxAccountType !== null)

package/lib/sandboxes.js

@@ -0,0 +1,217 @@
+const cliProgress = require('cli-progress');
+const {
+  getConfig,
+  writeConfig,
+  updateAccountConfig,
+} = require('@hubspot/cli-lib');
+const {
+  DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
+  PERSONAL_ACCESS_KEY_AUTH_METHOD,
+} = require('@hubspot/cli-lib/lib/constants');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { logger } = require('@hubspot/cli-lib/logger');
+const {
+  updateConfigWithPersonalAccessKey,
+} = require('@hubspot/cli-lib/personalAccessKey');
+const { EXIT_CODES } = require('./enums/exitCodes');
+const { enterAccountNamePrompt } = require('./prompts/enterAccountNamePrompt');
+const {
+  personalAccessKeyPrompt,
+} = require('./prompts/personalAccessKeyPrompt');
+const {
+  setAsDefaultAccountPrompt,
+} = require('./prompts/setAsDefaultAccountPrompt');
+const { uiFeatureHighlight } = require('./ui');
+const { fetchTaskStatus, fetchTypes } = require('@hubspot/cli-lib/sandboxes');
+const { handleExit, handleKeypress } = require('@hubspot/cli-lib/lib/process');
+
+const getSandboxType = type =>
+  type === 'DEVELOPER' ? 'development' : 'standard';
+
+function getAccountName(config) {
+  const isSandbox =
+    config.sandboxAccountType && config.sandboxAccountType !== null;
+  const sandboxName = `[${getSandboxType(config.sandboxAccountType)} sandbox] `;
+  return `${config.name} ${isSandbox ? sandboxName : ''}(${config.portalId})`;
+}
+
+// Fetches available sync types for a given sandbox portal
+async function getAvailableSyncTypes(parentAccountConfig, config) {
+  const parentPortalId = parentAccountConfig.portalId;
+  const portalId = config.portalId;
+  const syncTypes = await fetchTypes(parentPortalId, portalId);
+  return syncTypes.map(t => ({ type: t.name }));
+}
+
+const sandboxCreatePersonalAccessKeyFlow = async (env, account, name) => {
+  const configData = await personalAccessKeyPrompt({ env, account });
+  const updatedConfig = await updateConfigWithPersonalAccessKey(configData);
+
+  if (!updatedConfig) {
+    process.exit(EXIT_CODES.SUCCESS);
+  }
+
+  let validName = updatedConfig.name;
+
+  if (!updatedConfig.name) {
+    const nameForConfig = name
+      .toLowerCase()
+      .split(' ')
+      .join('-');
+    const { name: promptName } = await enterAccountNamePrompt(nameForConfig);
+    validName = promptName;
+  }
+
+  updateAccountConfig({
+    ...updatedConfig,
+    environment: updatedConfig.env,
+    tokenInfo: updatedConfig.auth.tokenInfo,
+    name: validName,
+  });
+  writeConfig();
+
+  const setAsDefault = await setAsDefaultAccountPrompt(validName);
+
+  logger.log('');
+  if (setAsDefault) {
+    logger.success(
+      i18n(`cli.lib.prompts.setAsDefaultAccountPrompt.setAsDefaultAccount`, {
+        accountName: validName,
+      })
+    );
+  } else {
+    const config = getConfig();
+    logger.info(
+      i18n(`cli.lib.prompts.setAsDefaultAccountPrompt.keepingCurrentDefault`, {
+        accountName: config.defaultPortal,
+      })
+    );
+  }
+  logger.success(
+    i18n('cli.commands.sandbox.subcommands.create.success.configFileUpdated', {
+      configFilename: DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME,
+      authMethod: PERSONAL_ACCESS_KEY_AUTH_METHOD.name,
+      account: validName,
+    })
+  );
+  uiFeatureHighlight([
+    'accountsUseCommand',
+    'accountOption',
+    'accountsListCommand',
+  ]);
+};
+
+const ACTIVE_TASK_POLL_INTERVAL = 1000;
+
+const isTaskComplete = task => {
+  if (!task) {
+    return false;
+  }
+  return task.status === 'COMPLETE';
+};
+
+// Returns a promise to poll a sync task with taskId. Interval runs until sync task status is equal to 'COMPLETE'
+function pollSyncTaskStatus(accountId, taskId, syncStatusUrl) {
+  const i18nKey = 'cli.commands.sandbox.subcommands.sync.types';
+  const multibar = new cliProgress.MultiBar(
+    {
+      hideCursor: true,
+      format: '[{bar}] {percentage}% | {taskType}',
+      gracefulExit: true,
+    },
+    cliProgress.Presets.rect
+  );
+  const mergeTasks = {
+    'lead-flows': 'forms', // lead-flows are a subset of forms. We combine these in the UI as a single item, so we want to merge here for consistency.
+  };
+  const barInstances = {};
+  let pollInterval;
+  // Handle manual exit for return key and ctrl+c
+  const onTerminate = () => {
+    clearInterval(pollInterval);
+    multibar.stop();
+    logger.log('');
+    logger.log('Exiting, sync will continue in the background.');
+    logger.log('');
+    logger.log(
+      i18n('cli.commands.sandbox.subcommands.sync.info.syncStatus', {
+        url: syncStatusUrl,
+      })
+    );
+    process.exit(EXIT_CODES.SUCCESS);
+  };
+  handleExit(onTerminate);
+  handleKeypress(key => {
+    if (
+      (key && key.ctrl && key.name == 'c') ||
+      key.name === 'enter' ||
+      key.name === 'return'
+    ) {
+      onTerminate();
+    }
+  });
+  return new Promise((resolve, reject) => {
+    pollInterval = setInterval(async () => {
+      const taskResult = await fetchTaskStatus(accountId, taskId).catch(reject);
+      if (taskResult.tasks) {
+        // Array of sync tasks, eg: workflows, pipelines, object-schemas, etc. with each task containing a status of 'PENDING', 'IN_PROGRESS', 'COMPLETE', and 'FAILURE'
+        for (const task of taskResult.tasks) {
+          // For each sync task, show a progress bar and increment bar each time we run this interval until status is 'COMPLETE'
+          const taskType = task.type;
+          if (!barInstances[taskType] && !mergeTasks[taskType]) {
+            // skip creation of lead-flows bar because we're combining lead-flows into the forms bar
+            barInstances[taskType] = multibar.create(100, 0, {
+              taskType: i18n(`${i18nKey}.${taskType}.label`),
+            });
+          } else if (mergeTasks[taskType]) {
+            // If its a lead-flow, merge status into the forms progress bar
+            const formsTask = taskResult.tasks.filter(
+              t => t.type === mergeTasks[taskType]
+            )[0];
+            const formsTaskStatus = formsTask.status;
+            const leadFlowsTaskStatus = task.status;
+            if (
+              formsTaskStatus !== 'COMPLETE' ||
+              leadFlowsTaskStatus !== 'COMPLETE'
+            ) {
+              barInstances[mergeTasks[taskType]].increment(
+                Math.floor(Math.random() * 3),
+                {
+                  taskType: i18n(`${i18nKey}.${mergeTasks[taskType]}.label`),
+                }
+              );
+            }
+          }
+          if (barInstances[taskType] && task.status === 'COMPLETE') {
+            barInstances[taskType].update(100, {
+              taskType: i18n(`${i18nKey}.${taskType}.label`),
+            });
+          } else if (barInstances[taskType] && task.status === 'PROCESSING') {
+            // Do not increment for tasks still in PENDING state
+            barInstances[taskType].increment(Math.floor(Math.random() * 3), {
+              // Randomly increment bar by 0 - 2 while sync is in progress. Sandboxes currently does not have an accurate measurement for progress.
+              taskType: i18n(`${i18nKey}.${taskType}.label`),
+            });
+          }
+        }
+      } else {
+        clearInterval(pollInterval);
+        reject();
+        multibar.stop();
+      }
+      if (isTaskComplete(taskResult)) {
+        clearInterval(pollInterval);
+        resolve(taskResult);
+        multibar.stop();
+      }
+    }, ACTIVE_TASK_POLL_INTERVAL);
+  });
+}
+
+module.exports = {
+  getSandboxType,
+  getAccountName,
+  getAvailableSyncTypes,
+  sandboxCreatePersonalAccessKeyFlow,
+  pollSyncTaskStatus,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "4.1.7-beta.0",
+  "version": "4.1.7-beta.2",
   "description": "CLI for working with HubSpot",
   "license": "Apache-2.0",
   "repository": {
@@ -8,10 +8,11 @@
     "url": "https://github.com/HubSpot/hubspot-cms-tools"
   },
   "dependencies": {
-    "@hubspot/cli-lib": "4.1.7-beta.0",
-    "@hubspot/serverless-dev-runtime": "4.1.7-beta.0",
+    "@hubspot/cli-lib": "4.1.7-beta.2",
+    "@hubspot/serverless-dev-runtime": "4.1.7-beta.2",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
+    "cli-progress": "^3.11.2",
     "express": "^4.17.1",
     "findup-sync": "^4.0.0",
     "fs-extra": "^8.1.0",
@@ -37,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2f99be18415403ff6bbd48faba96cf5315f220ab"
+  "gitHead": "ce9f106f0da7a39fbf14ff0ead2d5d750adee428"
 }

package/lib/validators/__tests__/ModuleDependencyValidator.js

@@ -1,79 +0,0 @@
-const marketplace = require('@hubspot/cli-lib/api/marketplace');
-const path = require('path');
-
-const ModuleDependencyValidator = require('../marketplaceValidators/module/ModuleDependencyValidator');
-const { VALIDATION_RESULT } = require('../constants');
-const { MODULE_PATH } = require('./validatorTestUtils');
-
-jest.mock('@hubspot/cli-lib/api/marketplace');
-
-const getMockDependencyResult = (customPaths = []) => {
-  const result = {
-    dependencies: [...customPaths],
-  };
-  return Promise.resolve(result);
-};
-
-describe('validators/marketplaceValidators/module/ModuleDependencyValidator', () => {
-  beforeEach(() => {
-    ModuleDependencyValidator.setRelativePath(MODULE_PATH);
-  });
-
-  describe('isExternalDep', () => {
-    beforeEach(() => {
-      ModuleDependencyValidator.setRelativePath(MODULE_PATH);
-    });
-
-    it('returns true if dep is external to the provided absolute path', () => {
-      const isExternal = ModuleDependencyValidator.isExternalDep(
-        MODULE_PATH,
-        'SomeOtherFolder/In/The/DesignManager.css'
-      );
-      expect(isExternal).toBe(true);
-    });
-
-    it('returns false if dep is not external to the provided absolute path', () => {
-      const isExternal = ModuleDependencyValidator.isExternalDep(
-        MODULE_PATH,
-        `${path.parse(MODULE_PATH).dir}/Internal/Folder/style.css`
-      );
-      expect(isExternal).toBe(false);
-    });
-  });
-
-  describe('validate', () => {
-    it('returns error if any referenced path is absolute', async () => {
-      marketplace.fetchModuleDependencies.mockReturnValue(
-        getMockDependencyResult(['/absolute/path'])
-      );
-      const validationErrors = await ModuleDependencyValidator.validate(
-        MODULE_PATH
-      );
-
-      expect(validationErrors.length).toBe(1);
-      expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-    });
-
-    it('returns error if any referenced path is external to the theme', async () => {
-      marketplace.fetchModuleDependencies.mockReturnValue(
-        getMockDependencyResult(['../../external/file-3.js'])
-      );
-      const validationErrors = await ModuleDependencyValidator.validate(
-        MODULE_PATH
-      );
-
-      expect(validationErrors.length).toBe(1);
-      expect(validationErrors[0].result).toBe(VALIDATION_RESULT.FATAL);
-    });
-
-    it('returns no errors if paths are relative and internal', async () => {
-      marketplace.fetchModuleDependencies.mockReturnValue(
-        getMockDependencyResult(['module/style.css', 'module/another/test.js'])
-      );
-      const validationErrors = await ModuleDependencyValidator.validate(
-        MODULE_PATH
-      );
-      expect(validationErrors.length).toBe(0);
-    });
-  });
-});