@hubspot/cli 4.1.7 → 4.1.8-beta.1

package/commands/accounts/list.js

@@ -12,7 +12,7 @@ const {
 } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
-const { getSandboxType } = require('../../lib/sandboxes');
+const { getSandboxTypeAsString } = require('../../lib/sandboxes');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
 const i18nKey = 'cli.commands.accounts.subcommands.list';
@@ -58,7 +58,7 @@ const getPortalData = mappedPortalData => {
         portalData.push([portal.name, portal.portalId, portal.authType]);
       } else {
         portalData.push([
-          `↳ ${portal.name} [${getSandboxType(
+          `↳ ${portal.name} [${getSandboxTypeAsString(
             portal.sandboxAccountType
           )} sandbox]`,
           portal.portalId,

package/commands/accounts/remove.js

@@ -0,0 +1,84 @@
+const { logger } = require('@hubspot/cli-lib/logger');
+const {
+  getConfig,
+  getConfigPath,
+  deleteAccount,
+  getConfigDefaultAccount,
+  getAccountId: getAccountIdFromConfig,
+  updateDefaultAccount,
+} = require('@hubspot/cli-lib/lib/config');
+
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { selectAccountFromConfig } = require('../../lib/prompts/accountsPrompt');
+const { loadAndValidateOptions } = require('../../lib/validation');
+
+const i18nKey = 'cli.commands.accounts.subcommands.remove';
+
+exports.command = 'remove [--account]';
+exports.describe = i18n(`${i18nKey}.describe`);
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options, false);
+
+  let config = getConfig();
+
+  let accountToRemove = options.account;
+
+  if (accountToRemove && !getAccountIdFromConfig(accountToRemove)) {
+    logger.error(
+      i18n(`${i18nKey}.errors.accountNotFound`, {
+        specifiedAccount: accountToRemove,
+        configPath: getConfigPath(),
+      })
+    );
+  }
+
+  if (!accountToRemove || !getAccountIdFromConfig(accountToRemove)) {
+    accountToRemove = await selectAccountFromConfig(
+      config,
+      i18n(`${i18nKey}.prompts.selectAccountToRemove`)
+    );
+  }
+
+  trackCommandUsage(
+    'accounts-remove',
+    null,
+    getAccountIdFromConfig(accountToRemove)
+  );
+
+  const currentDefaultAccount = getConfigDefaultAccount();
+
+  await deleteAccount(accountToRemove);
+  logger.success(
+    i18n(`${i18nKey}.success.accountRemoved`, {
+      accountName: accountToRemove,
+    })
+  );
+
+  // Get updated version of the config
+  config = getConfig();
+
+  if (accountToRemove === currentDefaultAccount) {
+    logger.log();
+    logger.log(i18n(`${i18nKey}.logs.replaceDefaultAccount`));
+    const newDefaultAccount = await selectAccountFromConfig(config);
+    updateDefaultAccount(newDefaultAccount);
+  }
+};
+
+exports.builder = yargs => {
+  yargs.option('account', {
+    describe: i18n(`${i18nKey}.options.account.describe`),
+    type: 'string',
+  });
+  yargs.example([
+    ['$0 accounts remove', i18n(`${i18nKey}.examples.default`)],
+    [
+      '$0 accounts remove --account=MyAccount',
+      i18n(`${i18nKey}.examples.byName`),
+    ],
+  ]);
+
+  return yargs;
+};

package/commands/accounts.js

@@ -4,6 +4,7 @@ const list = require('./accounts/list');
 const rename = require('./accounts/rename');
 const use = require('./accounts/use');
 const info = require('./accounts/info');
+const remove = require('./accounts/remove');
 
 const i18nKey = 'cli.commands.accounts';
 
@@ -22,6 +23,7 @@ exports.builder = yargs => {
     .command(rename)
     .command(use)
     .command(info)
+    .command(remove)
     .demandCommand(1, '');
 
   return yargs;

package/commands/functions/deploy.js

@@ -108,7 +108,6 @@ exports.handler = async options => {
       );
     } else {
       logApiErrorInstance(
-        accountId,
         e,
         new ApiErrorContext({ accountId, request: functionPath })
       );

package/commands/functions/list.js

@@ -36,7 +36,7 @@ exports.handler = async options => {
   logger.debug(i18n(`${i18nKey}.debug.gettingFunctions`));
 
   const routesResp = await getRoutes(accountId).catch(async e => {
-    await logApiErrorInstance(accountId, e, new ApiErrorContext({ accountId }));
+    await logApiErrorInstance(e, new ApiErrorContext({ accountId }));
     process.exit(EXIT_CODES.SUCCESS);
   });
 

package/commands/list.js

@@ -48,11 +48,7 @@ exports.handler = async options => {
   try {
     contentsResp = await getDirectoryContentsByPath(accountId, directoryPath);
   } catch (e) {
-    logApiErrorInstance(
-      accountId,
-      e,
-      new ApiErrorContext({ accountId, directoryPath })
-    );
+    logApiErrorInstance(e, new ApiErrorContext({ accountId, directoryPath }));
     process.exit(EXIT_CODES.SUCCESS);
   }
 

package/commands/sandbox/create.js

@@ -5,156 +5,70 @@ const {
   addUseEnvironmentOptions,
   addTestingOptions,
 } = require('../../lib/commonOpts');
-const { trackCommandUsage } = require('../../lib/usageTracking');
-const { logger } = require('@hubspot/cli-lib/logger');
-const Spinnies = require('spinnies');
-const { createSandbox } = require('@hubspot/cli-lib/sandboxes');
 const { loadAndValidateOptions } = require('../../lib/validation');
-const { createSandboxPrompt } = require('../../lib/prompts/sandboxesPrompt');
-const {
-  getSandboxType,
-  sandboxCreatePersonalAccessKeyFlow,
-} = require('../../lib/sandboxes');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
-const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
-const {
-  debugErrorAndContext,
-} = require('@hubspot/cli-lib/errorHandlers/standardErrors');
-const { ENVIRONMENTS } = require('@hubspot/cli-lib/lib/constants');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const { getAccountConfig } = require('@hubspot/cli-lib');
-const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
-const {
-  isMissingScopeError,
-  isSpecifiedError,
-} = require('@hubspot/cli-lib/errorHandlers/apiErrors');
+const { getAccountConfig, getEnv } = require('@hubspot/cli-lib');
+const { buildSandbox } = require('../../lib/sandbox-create');
+const { uiFeatureHighlight } = require('../../lib/ui');
+const { sandboxTypeMap, DEVELOPER_SANDBOX } = require('../../lib/sandboxes');
+const { getValidEnv } = require('@hubspot/cli-lib/lib/environment');
 
 const i18nKey = 'cli.commands.sandbox.subcommands.create';
 
-exports.command = 'create [--name]';
+exports.command = 'create [--name] [--type]';
 exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   await loadAndValidateOptions(options);
 
-  const { name } = options;
+  const { name, type, force } = options;
   const accountId = getAccountId(options);
   const accountConfig = getAccountConfig(accountId);
-  const env = options.qa ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD;
-  const spinnies = new Spinnies({
-    succeedColor: 'white',
-  });
-
-  trackCommandUsage('sandbox-create', null, accountId);
-
-  if (
-    accountConfig.sandboxAccountType &&
-    accountConfig.sandboxAccountType !== null
-  ) {
-    trackCommandUsage('sandbox-create', { successful: false }, accountId);
-
-    logger.error(
-      i18n(`${i18nKey}.failure.creatingWithinSandbox`, {
-        sandboxType: getSandboxType(accountConfig.sandboxAccountType),
-      })
-    );
-
-    process.exit(EXIT_CODES.ERROR);
-  }
-
-  let namePrompt;
-
-  logger.log(i18n(`${i18nKey}.sandboxLimitation`));
-  logger.log('');
-
-  if (!name) {
-    namePrompt = await createSandboxPrompt();
-  }
-
-  const sandboxName = name || namePrompt.name;
-
-  let result;
+  const env = getValidEnv(getEnv(accountId));
 
   try {
-    spinnies.add('sandboxCreate', {
-      text: i18n(`${i18nKey}.loading.add`, {
-        sandboxName,
-      }),
-    });
-
-    result = await createSandbox(accountId, sandboxName);
-
-    logger.log('');
-    spinnies.succeed('sandboxCreate', {
-      text: i18n(`${i18nKey}.loading.succeed`, {
-        name: result.name,
-        sandboxHubId: result.sandboxHubId,
-      }),
-    });
-  } catch (err) {
-    debugErrorAndContext(err);
-
-    trackCommandUsage('sandbox-create', { successful: false }, accountId);
-
-    spinnies.fail('sandboxCreate', {
-      text: i18n(`${i18nKey}.loading.fail`, {
-        sandboxName,
-      }),
+    const { result } = await buildSandbox({
+      name,
+      type,
+      accountConfig,
+      env,
+      force,
     });
 
-    if (isMissingScopeError(err)) {
-      logger.error(
-        i18n(`${i18nKey}.failure.scopes.message`, {
-          accountName: accountConfig.name || accountId,
-        })
-      );
-      const websiteOrigin = getHubSpotWebsiteOrigin(env);
-      const url = `${websiteOrigin}/personal-access-key/${accountId}`;
-      logger.info(
-        i18n(`${i18nKey}.failure.scopes.instructions`, {
-          accountName: accountConfig.name || accountId,
-          url,
-        })
-      );
-    } else if (
-      isSpecifiedError(
-        err,
-        400,
-        'VALIDATION_ERROR',
-        'SandboxErrors.NUM_DEVELOPMENT_SANDBOXES_LIMIT_EXCEEDED_ERROR'
-      ) &&
-      err.error &&
-      err.error.message
-    ) {
-      logger.log('');
-      logger.error(err.error.message);
-    } else {
-      logErrorInstance(err);
-    }
-    process.exit(EXIT_CODES.ERROR);
-  }
-  try {
-    await sandboxCreatePersonalAccessKeyFlow(
-      env,
-      result.sandboxHubId,
-      result.name
-    );
+    const sandboxType = sandboxTypeMap[result.sandbox.type];
+    uiFeatureHighlight([
+      // 'projectDevCommand',
+      'projectUploadCommand',
+      sandboxType === DEVELOPER_SANDBOX
+        ? 'sandboxSyncDevelopmentCommand'
+        : 'sandboxSyncStandardCommand',
+    ]);
     process.exit(EXIT_CODES.SUCCESS);
-  } catch (err) {
-    logErrorInstance(err);
+  } catch (error) {
+    // Errors are logged in buildSandbox
     process.exit(EXIT_CODES.ERROR);
   }
 };
 
 exports.builder = yargs => {
+  yargs.option('f', {
+    type: 'boolean',
+    alias: 'force',
+    describe: i18n(`${i18nKey}.examples.force`),
+  });
   yargs.option('name', {
     describe: i18n(`${i18nKey}.options.name.describe`),
     type: 'string',
   });
+  yargs.option('type', {
+    describe: i18n(`${i18nKey}.options.type.describe`),
+    type: 'string',
+  });
 
   yargs.example([
     [
-      '$0 sandbox create --name=MySandboxAccount',
+      '$0 sandbox create --name=MySandboxAccount --type=STANDARD',
       i18n(`${i18nKey}.examples.default`),
     ],
   ]);

package/commands/sandbox/delete.js

@@ -14,7 +14,7 @@ const {
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const { deleteSandbox } = require('@hubspot/cli-lib/sandboxes');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
-const { getConfig, getEnv } = require('@hubspot/cli-lib');
+const { getConfig, getEnv, getAccountConfig } = require('@hubspot/cli-lib');
 const { deleteSandboxPrompt } = require('../../lib/prompts/sandboxesPrompt');
 const {
   removeSandboxAccountFromConfig,
@@ -26,10 +26,12 @@ const {
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const { promptUser } = require('../../lib/prompts/promptUtils');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
-const { ENVIRONMENTS } = require('@hubspot/cli-lib/lib/constants');
 const {
   isSpecifiedError,
 } = require('@hubspot/cli-lib/errorHandlers/apiErrors');
+const { HubSpotAuthError } = require('@hubspot/cli-lib/lib/models/Errors');
+const { getAccountName } = require('../../lib/sandboxes');
+const { getValidEnv } = require('@hubspot/cli-lib/lib/environment');
 
 const i18nKey = 'cli.commands.sandbox.subcommands.delete';
 
@@ -62,14 +64,14 @@ exports.handler = async options => {
   const sandboxAccountId = getAccountId({
     account: account || accountPrompt.account,
   });
-
+  const accountConfig = getAccountConfig(sandboxAccountId);
   const isDefaultAccount =
     sandboxAccountId === getAccountId(config.defaultPortal);
 
   trackCommandUsage('sandbox-delete', null, sandboxAccountId);
 
   const baseUrl = getHubSpotWebsiteOrigin(
-    getEnv(sandboxAccountId) === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
+    getValidEnv(getEnv(sandboxAccountId))
   );
 
   let parentAccountId;
@@ -89,12 +91,13 @@ exports.handler = async options => {
     }
   }
 
+  const parentAccount = getAccountConfig(parentAccountId);
   const url = `${baseUrl}/sandboxes/${parentAccountId}`;
   const command = `hs auth ${
     getEnv(sandboxAccountId) === 'qa' ? '--qa' : ''
   } --account=${parentAccountId}`;
 
-  if (!getAccountId({ account: parentAccountId })) {
+  if (parentAccountId && !getAccountId({ account: parentAccountId })) {
     logger.log('');
     logger.error(
       i18n(`${i18nKey}.failure.noParentPortalAvailable`, {
@@ -109,16 +112,17 @@ exports.handler = async options => {
 
   logger.debug(
     i18n(`${i18nKey}.debug.deleting`, {
-      account: account || accountPrompt.account,
+      account: getAccountName(accountConfig),
     })
   );
 
   if (isDefaultAccount) {
-    logger.log(
+    logger.info(
       i18n(`${i18nKey}.defaultAccountWarning`, {
-        account: account || accountPrompt.account,
+        account: getAccountName(accountConfig),
       })
     );
+    logger.log('');
   }
 
   try {
@@ -128,7 +132,7 @@ exports.handler = async options => {
           name: 'confirmSandboxDeletePrompt',
           type: 'confirm',
           message: i18n(`${i18nKey}.confirm`, {
-            account: account || accountPrompt.account,
+            account: getAccountName(accountConfig),
           }),
         },
       ]);
@@ -170,7 +174,20 @@ exports.handler = async options => {
       sandboxAccountId
     );
 
-    if (
+    if (err instanceof HubSpotAuthError) {
+      // Intercept invalid key error
+      // This command uses the parent portal PAK to delete a sandbox, so we must specify which account needs a new key
+      const regex = /\bYour personal access key is invalid\b/;
+      const match = err.message.match(regex);
+      if (match && match[0]) {
+        logger.log('');
+        logger.error(
+          i18n(`${i18nKey}.failure.invalidKey`, {
+            account: getAccountName(parentAccount),
+          })
+        );
+      }
+    } else if (
       isSpecifiedError(
         err,
         404,
@@ -181,7 +198,7 @@ exports.handler = async options => {
       logger.log('');
       logger.warn(
         i18n(`${i18nKey}.failure.objectNotFound`, {
-          account: account || accountPrompt.account,
+          account: getAccountName(accountConfig),
         })
       );
       logger.log('');