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

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

@@ -14,6 +14,8 @@ const { createSandboxPrompt } = require('../../lib/prompts/sandboxesPrompt');
 const {
   getSandboxType,
   sandboxCreatePersonalAccessKeyFlow,
+  getHasDevelopmentSandboxes,
+  getDevSandboxLimit,
 } = require('../../lib/sandboxes');
 const { i18n } = require('@hubspot/cli-lib/lib/lang');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
@@ -22,7 +24,7 @@ const {
 } = 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 { getAccountConfig, getEnv } = require('@hubspot/cli-lib');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
 const {
   isMissingScopeError,
@@ -127,7 +129,32 @@ exports.handler = async options => {
       err.error.message
     ) {
       logger.log('');
-      logger.error(err.error.message);
+      const devSandboxLimit = getDevSandboxLimit(err.error);
+      const plural = devSandboxLimit !== 1;
+      const hasDevelopmentSandboxes = getHasDevelopmentSandboxes(accountConfig);
+      if (hasDevelopmentSandboxes) {
+        logger.error(
+          i18n(
+            `${i18nKey}.failure.alreadyInConfig.${plural ? 'other' : 'one'}`,
+            {
+              accountName: accountConfig.name || accountId,
+              limit: devSandboxLimit,
+            }
+          )
+        );
+      } else {
+        const baseUrl = getHubSpotWebsiteOrigin(
+          getEnv(accountId) === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
+        );
+        logger.error(
+          i18n(`${i18nKey}.failure.limit.${plural ? 'other' : 'one'}`, {
+            accountName: accountConfig.name || accountId,
+            limit: devSandboxLimit,
+            devSandboxesLink: `${baseUrl}/sandboxes-developer/${accountId}/development`,
+          })
+        );
+      }
+      logger.log('');
     } else {
       logErrorInstance(err);
     }

package/commands/sandbox/delete.js

@@ -14,10 +14,11 @@ 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,
+  updateDefaultAccount,
 } = require('@hubspot/cli-lib/lib/config');
 const {
   selectAndSetAsDefaultAccountPrompt,
@@ -29,6 +30,8 @@ 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 i18nKey = 'cli.commands.sandbox.subcommands.delete';
 
@@ -38,47 +41,66 @@ exports.describe = i18n(`${i18nKey}.describe`);
 exports.handler = async options => {
   await loadAndValidateOptions(options, false);
 
-  const { account } = options;
+  const { account, force } = options;
   const config = getConfig();
 
   let accountPrompt;
   if (!account) {
-    accountPrompt = await deleteSandboxPrompt(config);
+    if (!force) {
+      accountPrompt = await deleteSandboxPrompt(config);
+    } else {
+      // Account is required, throw error if force flag is present and no account is specified
+      logger.log('');
+      logger.error(i18n(`${i18nKey}.failure.noAccount`));
+      process.exit(EXIT_CODES.ERROR);
+    }
+    if (!accountPrompt) {
+      logger.log('');
+      logger.error(i18n(`${i18nKey}.failure.noSandboxAccounts`));
+      process.exit(EXIT_CODES.ERROR);
+    }
   }
+
   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
+  );
+
   let parentAccountId;
   for (const portal of config.portals) {
     if (portal.portalId === sandboxAccountId) {
       if (portal.parentAccountId) {
         parentAccountId = portal.parentAccountId;
-      } else {
+      } else if (!force) {
         const parentAccountPrompt = await deleteSandboxPrompt(config, true);
         parentAccountId = getAccountId({
           account: parentAccountPrompt.account,
         });
+      } else {
+        logger.error(i18n(`${i18nKey}.failure.noParentAccount`));
+        process.exit(EXIT_CODES.ERROR);
       }
     }
   }
 
-  if (!getAccountId({ account: parentAccountId })) {
-    const baseUrl = getHubSpotWebsiteOrigin(
-      getEnv(sandboxAccountId) === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
-    );
-    const url = `${baseUrl}/sandboxes/${parentAccountId}`;
-    const command = `hs auth ${
-      getEnv(sandboxAccountId) === 'qa' ? '--qa' : ''
-    } --account=${parentAccountId}`;
+  const parentAccount = getAccountConfig(parentAccountId);
+  const url = `${baseUrl}/sandboxes/${parentAccountId}`;
+  const command = `hs auth ${
+    getEnv(sandboxAccountId) === 'qa' ? '--qa' : ''
+  } --account=${parentAccountId}`;
+
+  if (parentAccountId && !getAccountId({ account: parentAccountId })) {
     logger.log('');
     logger.error(
-      i18n(`${i18nKey}.noParentPortalAvailable`, {
+      i18n(`${i18nKey}.failure.noParentPortalAvailable`, {
         parentAccountId,
         url,
         command,
@@ -90,30 +112,32 @@ exports.handler = async options => {
 
   logger.debug(
     i18n(`${i18nKey}.debug.deleting`, {
-      account: account || accountPrompt.account,
+      account: getAccountName(accountConfig),
     })
   );
 
   if (isDefaultAccount) {
     logger.log(
       i18n(`${i18nKey}.defaultAccountWarning`, {
-        account: account || accountPrompt.account,
+        account: getAccountName(accountConfig),
       })
     );
   }
 
   try {
-    const { confirmSandboxDeletePrompt: confirmed } = await promptUser([
-      {
-        name: 'confirmSandboxDeletePrompt',
-        type: 'confirm',
-        message: i18n(`${i18nKey}.confirm`, {
-          account: account || accountPrompt.account,
-        }),
-      },
-    ]);
-    if (!confirmed) {
-      process.exit(EXIT_CODES.SUCCESS);
+    if (!force) {
+      const { confirmSandboxDeletePrompt: confirmed } = await promptUser([
+        {
+          name: 'confirmSandboxDeletePrompt',
+          type: 'confirm',
+          message: i18n(`${i18nKey}.confirm`, {
+            account: getAccountName(accountConfig),
+          }),
+        },
+      ]);
+      if (!confirmed) {
+        process.exit(EXIT_CODES.SUCCESS);
+      }
     }
 
     await deleteSandbox(parentAccountId, sandboxAccountId);
@@ -133,8 +157,11 @@ exports.handler = async options => {
     const promptDefaultAccount = removeSandboxAccountFromConfig(
       sandboxAccountId
     );
-    if (promptDefaultAccount) {
+    if (promptDefaultAccount && !force) {
       await selectAndSetAsDefaultAccountPrompt(getConfig());
+    } else {
+      // If force is specified, skip prompt and set the parent account id as the default account
+      updateDefaultAccount(parentAccountId);
     }
     process.exit(EXIT_CODES.SUCCESS);
   } catch (err) {
@@ -146,7 +173,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,
@@ -156,8 +196,8 @@ exports.handler = async options => {
     ) {
       logger.log('');
       logger.warn(
-        i18n(`${i18nKey}.objectNotFound`, {
-          account: account || accountPrompt.account,
+        i18n(`${i18nKey}.failure.objectNotFound`, {
+          account: getAccountName(accountConfig),
         })
       );
       logger.log('');
@@ -165,8 +205,11 @@ exports.handler = async options => {
       const promptDefaultAccount = removeSandboxAccountFromConfig(
         sandboxAccountId
       );
-      if (promptDefaultAccount) {
+      if (promptDefaultAccount && !force) {
         await selectAndSetAsDefaultAccountPrompt(getConfig());
+      } else {
+        // If force is specified, skip prompt and set the parent account id as the default account
+        updateDefaultAccount(parentAccountId);
       }
       process.exit(EXIT_CODES.SUCCESS);
     } else {
@@ -181,6 +224,11 @@ exports.builder = yargs => {
     describe: i18n(`${i18nKey}.options.account.describe`),
     type: 'string',
   });
+  yargs.option('f', {
+    type: 'boolean',
+    alias: 'force',
+    describe: i18n(`${i18nKey}.examples.force`),
+  });
 
   yargs.example([
     [

package/lib/prompts/accountsPrompt.js

@@ -15,14 +15,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,
     },
@@ -49,4 +49,5 @@ const selectAndSetAsDefaultAccountPrompt = async config => {
 module.exports = {
   selectAndSetAsDefaultAccountPrompt,
   selectAccountFromConfig,
+  mapAccountChoices,
 };

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

@@ -15,6 +15,18 @@ const mapSandboxAccountChoices = portals =>
       };
     });
 
+const mapNonSandboxAccountChoices = portals =>
+  portals
+    .filter(
+      p => p.sandboxAccountType === null || p.sandboxAccountType === undefined
+    )
+    .map(p => {
+      return {
+        name: `${p.name} (${p.portalId})`,
+        value: p.name || p.portalId,
+      };
+    });
+
 const createSandboxPrompt = () => {
   return promptUser([
     {
@@ -32,6 +44,12 @@ const createSandboxPrompt = () => {
 };
 
 const deleteSandboxPrompt = (config, promptParentAccount = false) => {
+  const choices = promptParentAccount
+    ? mapNonSandboxAccountChoices(config.portals)
+    : mapSandboxAccountChoices(config.portals);
+  if (!choices.length) {
+    return undefined;
+  }
   return promptUser([
     {
       name: 'account',
@@ -43,7 +61,7 @@ const deleteSandboxPrompt = (config, promptParentAccount = false) => {
       type: 'list',
       look: false,
       pageSize: 20,
-      choices: mapSandboxAccountChoices(config.portals),
+      choices,
       default: config.defaultPortal,
     },
   ]);

package/lib/sandboxes.js

@@ -35,6 +35,29 @@ function getAccountName(config) {
   return `${config.name} ${isSandbox ? sandboxName : ''}(${config.portalId})`;
 }
 
+function getHasDevelopmentSandboxes(parentAccountConfig) {
+  const config = getConfig();
+  const parentPortalId = parentAccountConfig.portalId;
+  for (const portal of config.portals) {
+    if (
+      (portal.parentAccountId !== null ||
+        portal.parentAccountId !== undefined) &&
+      portal.parentAccountId === parentPortalId &&
+      portal.sandboxAccountType &&
+      portal.sandboxAccountType === 'DEVELOPER'
+    ) {
+      return true;
+    }
+  }
+  return false;
+}
+
+function getDevSandboxLimit(error) {
+  // Error context should contain a limit property with a list of one number. That number is the current limit
+  const limit = error.context && error.context.limit && error.context.limit[0];
+  return limit ? parseInt(limit, 10) : 1; // Default to 1
+}
+
 // Fetches available sync types for a given sandbox portal
 async function getAvailableSyncTypes(parentAccountConfig, config) {
   const parentPortalId = parentAccountConfig.portalId;
@@ -211,6 +234,8 @@ function pollSyncTaskStatus(accountId, taskId, syncStatusUrl) {
 module.exports = {
   getSandboxType,
   getAccountName,
+  getHasDevelopmentSandboxes,
+  getDevSandboxLimit,
   getAvailableSyncTypes,
   sandboxCreatePersonalAccessKeyFlow,
   pollSyncTaskStatus,

package/package.json

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