@hubspot/cli 4.1.7 → 4.1.8-beta.1

package/commands/sandbox/sync.js

@@ -7,12 +7,8 @@ const {
 } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { logger } = require('@hubspot/cli-lib/logger');
-const Spinnies = require('spinnies');
-const { initiateSync } = require('@hubspot/cli-lib/sandboxes');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
-const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
-const { ENVIRONMENTS } = require('@hubspot/cli-lib/lib/constants');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const { getAccountConfig, getEnv } = require('@hubspot/cli-lib');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
@@ -20,13 +16,12 @@ const { promptUser } = require('../../lib/prompts/promptUtils');
 const { uiLine } = require('../../lib/ui');
 const {
   getAccountName,
-  getAvailableSyncTypes,
-  pollSyncTaskStatus,
+  sandboxTypeMap,
+  DEVELOPER_SANDBOX,
+  STANDARD_SANDBOX,
 } = require('../../lib/sandboxes');
-const {
-  isMissingScopeError,
-  isSpecifiedError,
-} = require('@hubspot/cli-lib/errorHandlers/apiErrors');
+const { syncSandbox } = require('../../lib/sandbox-sync');
+const { getValidEnv } = require('@hubspot/cli-lib/lib/environment');
 
 const i18nKey = 'cli.commands.sandbox.subcommands.sync';
 
@@ -39,9 +34,7 @@ exports.handler = async options => {
   const { force } = options; // For scripting purposes
   const accountId = getAccountId(options);
   const accountConfig = getAccountConfig(accountId);
-  const spinnies = new Spinnies({
-    succeedColor: 'white',
-  });
+  const env = getValidEnv(getEnv(accountId));
 
   trackCommandUsage('sandbox-sync', null, accountId);
 
@@ -51,10 +44,8 @@ exports.handler = async options => {
     accountConfig.sandboxAccountType === undefined ||
     accountConfig.sandboxAccountType === null
   ) {
-    trackCommandUsage('sandbox-sync', { successful: false }, accountId);
-
     logger.error(i18n(`${i18nKey}.failure.notSandbox`));
-
+    trackCommandUsage('sandbox-sync', { successful: false }, accountId);
     process.exit(EXIT_CODES.ERROR);
   }
 
@@ -67,12 +58,15 @@ exports.handler = async options => {
         sandboxName: getAccountName(accountConfig),
       })
     );
+    trackCommandUsage('sandbox-sync', { successful: false }, accountId);
     process.exit(EXIT_CODES.ERROR);
   }
 
   const parentAccountConfig = getAccountConfig(parentAccountId);
-  const isDevelopmentSandbox = accountConfig.sandboxAccountType === 'DEVELOPER';
-  const isStandardSandbox = accountConfig.sandboxAccountType === 'STANDARD';
+  const isDevelopmentSandbox =
+    sandboxTypeMap[accountConfig.sandboxAccountType] === DEVELOPER_SANDBOX;
+  const isStandardSandbox =
+    sandboxTypeMap[accountConfig.sandboxAccountType] === STANDARD_SANDBOX;
 
   if (isDevelopmentSandbox) {
     logger.log(i18n(`${i18nKey}.info.developmentSandbox`));
@@ -100,12 +94,13 @@ exports.handler = async options => {
         },
       ]);
       if (!confirmed) {
+        trackCommandUsage('sandbox-sync', { successful: false }, accountId);
         process.exit(EXIT_CODES.SUCCESS);
       }
     }
   } else if (isStandardSandbox) {
     const standardSyncUrl = `${getHubSpotWebsiteOrigin(
-      getEnv(accountId) === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
+      env
     )}/sandboxes-developer/${parentAccountId}/sync?step=select_sync_path&id=${parentAccountId}_${accountId}`;
 
     logger.log(
@@ -137,147 +132,26 @@ exports.handler = async options => {
         },
       ]);
       if (!confirmed) {
+        trackCommandUsage('sandbox-sync', { successful: false }, accountId);
         process.exit(EXIT_CODES.SUCCESS);
       }
     }
   } else {
     logger.error('Sync must be run in a sandbox account.');
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  let initiateSyncResponse;
-
-  const baseUrl = getHubSpotWebsiteOrigin(
-    getEnv(accountId) === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
-  );
-  const syncStatusUrl = `${baseUrl}/sandboxes-developer/${parentAccountId}/${
-    isDevelopmentSandbox ? 'development' : 'standard'
-  }`;
-
-  try {
-    logger.log('');
-    spinnies.add('sandboxSync', {
-      text: i18n(`${i18nKey}.loading.startSync`),
-    });
-
-    // Fetches sync types based on default account. Parent account required for fetch
-    const tasks = await getAvailableSyncTypes(
-      parentAccountConfig,
-      accountConfig
-    );
-
-    initiateSyncResponse = await initiateSync(
-      parentAccountId,
-      accountId,
-      tasks,
-      accountId
-    );
-
-    logger.log(i18n(`${i18nKey}.info.earlyExit`));
-    logger.log('');
-    spinnies.succeed('sandboxSync', {
-      text: i18n(`${i18nKey}.loading.succeed`),
-    });
-  } catch (err) {
     trackCommandUsage('sandbox-sync', { successful: false }, accountId);
-
-    spinnies.fail('sandboxSync', {
-      text: i18n(`${i18nKey}.loading.fail`),
-    });
-
-    logger.log('');
-    if (isMissingScopeError(err)) {
-      logger.error(
-        i18n(`${i18nKey}.failure.missingScopes`, {
-          accountName: getAccountName(parentAccountConfig),
-        })
-      );
-    } else if (
-      isSpecifiedError(
-        err,
-        429,
-        'RATE_LIMITS',
-        'sandboxes-sync-api.SYNC_IN_PROGRESS'
-      )
-    ) {
-      logger.error(
-        i18n(`${i18nKey}.failure.syncInProgress`, {
-          url: `${baseUrl}/sandboxes-developer/${parentAccountId}/syncactivitylog`,
-        })
-      );
-    } else if (
-      isSpecifiedError(
-        err,
-        403,
-        'BANNED',
-        'sandboxes-sync-api.SYNC_NOT_ALLOWED_INVALID_USERID'
-      )
-    ) {
-      // This will only trigger if a user is not a super admin of the target account.
-      logger.error(
-        i18n(`${i18nKey}.failure.notSuperAdmin`, {
-          account: getAccountName(accountConfig),
-        })
-      );
-    } else if (
-      isSpecifiedError(
-        err,
-        404,
-        'OBJECT_NOT_FOUND',
-        'SandboxErrors.SANDBOX_NOT_FOUND'
-      )
-    ) {
-      logger.error(
-        i18n(`${i18nKey}.failure.objectNotFound`, {
-          account: getAccountName(accountConfig),
-        })
-      );
-    } else {
-      logErrorInstance(err);
-    }
-    logger.log('');
-
     process.exit(EXIT_CODES.ERROR);
   }
 
   try {
-    logger.log('');
-    logger.log('Sync progress:');
-    // Poll sync task status to show progress bars
-    await pollSyncTaskStatus(
-      parentAccountId,
-      initiateSyncResponse.id,
-      syncStatusUrl
-    );
-
-    logger.log('');
-    spinnies.add('syncComplete', {
-      text: i18n(`${i18nKey}.polling.syncing`),
-    });
-    spinnies.succeed('syncComplete', {
-      text: i18n(`${i18nKey}.polling.succeed`),
+    await syncSandbox({
+      accountConfig,
+      parentAccountConfig,
+      env,
+      allowEarlyTermination: true,
     });
-    logger.log('');
-    logger.log(
-      i18n(`${i18nKey}.info.syncStatus`, {
-        url: syncStatusUrl,
-      })
-    );
-
     process.exit(EXIT_CODES.SUCCESS);
-  } catch (err) {
-    // If polling fails at this point, we do not track a failed sync since it is running in the background.
-    logErrorInstance(err);
-
-    spinnies.add('syncComplete', {
-      text: i18n(`${i18nKey}.polling.syncing`),
-    });
-    spinnies.fail('syncComplete', {
-      text: i18n(`${i18nKey}.polling.fail`, {
-        url: syncStatusUrl,
-      }),
-    });
-
+  } catch (error) {
+    trackCommandUsage('sandbox-sync', { successful: false }, accountId);
     process.exit(EXIT_CODES.ERROR);
   }
 };

package/lib/CliProgressMultibarManager.js

@@ -0,0 +1,66 @@
+// https://github.com/npkgz/cli-progress/blob/master/README.md
+const ProgressMultibarManager = require('cli-progress');
+
+class CliProgressMultibarManager {
+  constructor() {
+    this.multibar = null;
+    this.barInstances = {};
+  }
+
+  init(options) {
+    if (!this.multibar) {
+      this.multibar = new ProgressMultibarManager.MultiBar(
+        {
+          hideCursor: true,
+          format: '[{bar}] {percentage}% | {label}',
+          gracefulExit: true,
+          ...options,
+        },
+        ProgressMultibarManager.Presets.rect
+      );
+    }
+
+    return {
+      get: this.get.bind(this),
+      create: this.create.bind(this),
+      update: this.update.bind(this),
+      increment: this.increment.bind(this),
+      remove: this.multibar.remove.bind(this.multibar),
+      stop: this.multibar.stop.bind(this.multibar),
+      log: this.multibar.log.bind(this.multibar),
+    };
+  }
+
+  get(barName) {
+    return this.barInstances[barName];
+  }
+
+  create(barName, total = 100, startValue = 0, options = {}) {
+    if (!this.multibar) {
+      return;
+    }
+    if (!this.barInstances[barName]) {
+      this.barInstances[barName] = this.multibar.create(
+        total,
+        startValue,
+        options
+      );
+    }
+  }
+
+  update(barName, value, options = {}) {
+    const barInstance = this.barInstances[barName];
+    if (barInstance) {
+      barInstance.update(value, options);
+    }
+  }
+
+  increment(barName, value, options = {}) {
+    const barInstance = this.barInstances[barName];
+    if (barInstance) {
+      barInstance.increment(value, options);
+    }
+  }
+}
+
+module.exports = new CliProgressMultibarManager();

package/lib/prompts/accountsPrompt.js

@@ -1,12 +1,14 @@
 const { updateDefaultAccount } = require('@hubspot/cli-lib/lib/config');
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
-const { getSandboxType } = require('../sandboxes');
+const { getSandboxTypeAsString } = require('../sandboxes');
 
 const mapAccountChoices = portals =>
   portals.map(p => {
     const isSandbox = p.sandboxAccountType && p.sandboxAccountType !== null;
-    const sandboxName = `[${getSandboxType(p.sandboxAccountType)} sandbox] `;
+    const sandboxName = `[${getSandboxTypeAsString(
+      p.sandboxAccountType
+    )} sandbox] `;
     return {
       name: `${p.name} ${isSandbox ? sandboxName : ''}(${p.portalId})`,
       value: p.name || p.portalId,
@@ -15,14 +17,14 @@ const mapAccountChoices = portals =>
 
 const i18nKey = 'cli.commands.accounts.subcommands.use';
 
-const selectAccountFromConfig = async config => {
+const selectAccountFromConfig = async (config, prompt) => {
   const { default: selectedDefault } = await promptUser([
     {
       type: 'list',
       look: false,
       name: 'default',
       pageSize: 20,
-      message: i18n(`${i18nKey}.promptMessage`),
+      message: prompt || i18n(`${i18nKey}.promptMessage`),
       choices: mapAccountChoices(config.portals),
       default: config.defaultPortal,
     },

package/lib/prompts/projectsLogsPrompt.js

@@ -66,7 +66,7 @@ const projectLogsPrompt = (accountId, promptOptions = {}) => {
 
         if (deployedBuild && deployedBuild.subbuildStatuses) {
           return deployedBuild.subbuildStatuses
-            .filter(subbuild => subbuild.buildType === 'APP')
+            .filter(subbuild => subbuild.buildType === 'PRIVATE_APP')
             .map(subbuild => ({
               name: subbuild.buildName,
               value: subbuild.buildName,

package/lib/prompts/sandboxesPrompt.js

@@ -1,6 +1,7 @@
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
-const { getSandboxType } = require('../sandboxes');
+const { getSandboxTypeAsString } = require('../sandboxes');
+const { accountNameExistsInConfig } = require('@hubspot/cli-lib/lib/config');
 
 const i18nKey = 'cli.lib.prompts.sandboxesPrompt';
 
@@ -8,7 +9,9 @@ const mapSandboxAccountChoices = portals =>
   portals
     .filter(p => p.sandboxAccountType && p.sandboxAccountType !== null)
     .map(p => {
-      const sandboxName = `[${getSandboxType(p.sandboxAccountType)} sandbox] `;
+      const sandboxName = `[${getSandboxTypeAsString(
+        p.sandboxAccountType
+      )} sandbox] `;
       return {
         name: `${p.name} ${sandboxName}(${p.portalId})`,
         value: p.name || p.portalId,
@@ -27,22 +30,50 @@ const mapNonSandboxAccountChoices = portals =>
       };
     });
 
-const createSandboxPrompt = () => {
+const sandboxNamePrompt = () => {
   return promptUser([
     {
       name: 'name',
-      message: i18n(`${i18nKey}.enterName`),
+      message: i18n(`${i18nKey}.name.message`),
       validate(val) {
         if (typeof val !== 'string') {
-          return i18n(`${i18nKey}.errors.invalidName`);
+          return i18n(`${i18nKey}.name.errors.invalidName`);
+        } else if (!val.length) {
+          return i18n(`${i18nKey}.name.errors.nameRequired`);
         }
-        return true;
+        return accountNameExistsInConfig(val)
+          ? i18n(`${i18nKey}.name.errors.accountNameExists`, { name: val })
+          : true;
       },
       default: 'New sandbox',
     },
   ]);
 };
 
+const sandboxTypeChoices = [
+  {
+    name: i18n(`${i18nKey}.type.developer`),
+    value: 'DEVELOPER',
+  },
+  {
+    name: i18n(`${i18nKey}.type.standard`),
+    value: 'STANDARD',
+  },
+];
+
+const sandboxTypePrompt = () => {
+  return promptUser([
+    {
+      name: 'type',
+      message: i18n(`${i18nKey}.type.message`),
+      type: 'list',
+      look: false,
+      choices: sandboxTypeChoices,
+      default: 'DEVELOPER',
+    },
+  ]);
+};
+
 const deleteSandboxPrompt = (config, promptParentAccount = false) => {
   const choices = promptParentAccount
     ? mapNonSandboxAccountChoices(config.portals)
@@ -55,8 +86,8 @@ const deleteSandboxPrompt = (config, promptParentAccount = false) => {
       name: 'account',
       message: i18n(
         promptParentAccount
-          ? `${i18nKey}.selectParentAccountName`
-          : `${i18nKey}.selectAccountName`
+          ? `${i18nKey}.name.selectParentAccountName`
+          : `${i18nKey}.name.selectAccountName`
       ),
       type: 'list',
       look: false,
@@ -68,7 +99,7 @@ const deleteSandboxPrompt = (config, promptParentAccount = false) => {
 };
 
 module.exports = {
-  createSandboxPrompt,
+  sandboxNamePrompt,
+  sandboxTypePrompt,
   deleteSandboxPrompt,
-  getSandboxType,
 };