@hubspot/cli 5.2.1-beta.1 → 5.2.1-beta.11

package/lib/prompts/projectDevTargetAccountPrompt.js

@@ -13,7 +13,7 @@ const {
   fetchDeveloperTestAccounts,
 } = require('@hubspot/local-dev-lib/developerTestAccounts');
 
-const i18nKey = 'cli.lib.prompts.projectDevTargetAccountPrompt';
+const i18nKey = 'lib.prompts.projectDevTargetAccountPrompt';
 
 const mapNestedAccount = accountConfig => ({
   name: uiAccountDescription(accountConfig.portalId, false),
@@ -24,6 +24,12 @@ const mapNestedAccount = accountConfig => ({
   },
 });
 
+const getNonConfigDeveloperTestAccountName = account => {
+  return `${account.accountName} [${
+    HUBSPOT_ACCOUNT_TYPE_STRINGS[HUBSPOT_ACCOUNT_TYPES.DEVELOPER_TEST]
+  }] (${account.id})`;
+};
+
 const selectSandboxTargetAccountPrompt = async (
   accounts,
   defaultAccountConfig
@@ -94,9 +100,11 @@ const selectDeveloperTestTargetAccountPrompt = async (
 ) => {
   const defaultAccountId = getAccountId(defaultAccountConfig.name);
   let choices = [];
-  let devTestAccountUsage = undefined;
+  let devTestAccountsResponse = undefined;
   try {
-    devTestAccountUsage = await fetchDeveloperTestAccounts(defaultAccountId);
+    devTestAccountsResponse = await fetchDeveloperTestAccounts(
+      defaultAccountId
+    );
   } catch (err) {
     logger.debug('Unable to fetch developer test account usage limits: ', err);
   }
@@ -110,17 +118,37 @@ const selectDeveloperTestTargetAccountPrompt = async (
     );
   let disabledMessage = false;
   if (
-    devTestAccountUsage &&
-    devTestAccountUsage.results.length >= devTestAccountUsage.maxTestPortals
+    devTestAccountsResponse &&
+    devTestAccountsResponse.results.length >=
+      devTestAccountsResponse.maxTestPortals
   ) {
     disabledMessage = i18n(`${i18nKey}.developerTestAccountLimit`, {
       authCommand: uiCommandReference('hs auth'),
-      limit: devTestAccountUsage.maxTestPortals,
+      limit: devTestAccountsResponse.maxTestPortals,
+    });
+  }
+
+  let devTestAccountsNotInConfig = [];
+  if (devTestAccountsResponse && devTestAccountsResponse.results) {
+    const inConfigIds = devTestAccounts.map(d => d.portalId);
+    devTestAccountsResponse.results.forEach(acct => {
+      if (inConfigIds.indexOf(acct.id) < 0) {
+        devTestAccountsNotInConfig.push({
+          name: getNonConfigDeveloperTestAccountName(acct),
+          value: {
+            targetAccountId: acct.id,
+            createdNestedAccount: false,
+            parentAccountId: defaultAccountId,
+            notInConfigAccount: acct,
+          },
+        });
+      }
     });
   }
 
   choices = [
     ...devTestAccounts.map(mapNestedAccount),
+    ...devTestAccountsNotInConfig,
     {
       name: i18n(`${i18nKey}.createNewDeveloperTestAccountOption`),
       value: {
@@ -172,8 +200,22 @@ const confirmDefaultAccountPrompt = async (accountName, accountType) => {
   return useDefaultAccount;
 };
 
+const confirmUseExistingDeveloperTestAccountPrompt = async account => {
+  const { confirmUseExistingDeveloperTestAccount } = await promptUser([
+    {
+      name: 'confirmUseExistingDeveloperTestAccount',
+      type: 'confirm',
+      message: i18n(`${i18nKey}.confirmUseExistingDeveloperTestAccount`, {
+        accountName: getNonConfigDeveloperTestAccountName(account),
+      }),
+    },
+  ]);
+  return confirmUseExistingDeveloperTestAccount;
+};
+
 module.exports = {
   selectSandboxTargetAccountPrompt,
   selectDeveloperTestTargetAccountPrompt,
   confirmDefaultAccountPrompt,
+  confirmUseExistingDeveloperTestAccountPrompt,
 };

package/lib/prompts/projectNamePrompt.js

@@ -3,7 +3,7 @@ const { i18n } = require('../lang');
 const { ensureProjectExists } = require('../projects');
 const { uiAccountDescription } = require('../ui');
 
-const i18nKey = 'cli.lib.prompts.projectNamePrompt';
+const i18nKey = 'lib.prompts.projectNamePrompt';
 
 const projectNamePrompt = (accountId, options = {}) => {
   return promptUser({
@@ -14,7 +14,7 @@ const projectNamePrompt = (accountId, options = {}) => {
       if (typeof val !== 'string' || !val) {
         return i18n(`${i18nKey}.errors.invalidName`);
       }
-      const projectExists = await ensureProjectExists(accountId, val, {
+      const { projectExists } = await ensureProjectExists(accountId, val, {
         allowCreate: false,
         noLogs: true,
       });

package/lib/prompts/projectsLogsPrompt.js

@@ -10,7 +10,7 @@ const {
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { EXIT_CODES } = require('../enums/exitCodes');
 
-const i18nKey = 'cli.lib.prompts.projectLogsPrompt';
+const i18nKey = 'lib.prompts.projectLogsPrompt';
 
 const SERVERLESS_FUNCTION_TYPES = {
   APP_FUNCTION: 'app-function',

package/lib/prompts/sandboxesPrompt.js

@@ -1,13 +1,12 @@
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
-const { accountNameExistsInConfig } = require('@hubspot/local-dev-lib/config');
 const { uiAccountDescription } = require('../ui');
 const {
   HUBSPOT_ACCOUNT_TYPES,
 } = require('@hubspot/local-dev-lib/constants/config');
 const { isSandbox } = require('../accountTypes');
 
-const i18nKey = 'cli.lib.prompts.sandboxesPrompt';
+const i18nKey = 'lib.prompts.sandboxesPrompt';
 
 const mapSandboxAccountChoices = portals =>
   portals
@@ -29,42 +28,6 @@ const mapNonSandboxAccountChoices = portals =>
       };
     });
 
-const sandboxNamePrompt = (type = HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX) => {
-  const isDevelopmentSandbox =
-    type === HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX;
-  const namePromptMessage = isDevelopmentSandbox
-    ? `${i18nKey}.name.developmentSandboxMessage`
-    : `${i18nKey}.name.message`;
-  return promptUser([
-    {
-      name: 'name',
-      message: i18n(namePromptMessage),
-      validate(val) {
-        if (typeof val !== 'string') {
-          return i18n(`${i18nKey}.name.errors.invalidName`);
-        } else if (!val.length) {
-          return i18n(`${i18nKey}.name.errors.nameRequired`);
-        }
-        return accountNameExistsInConfig(val)
-          ? i18n(`${i18nKey}.name.errors.accountNameExists`, { name: val })
-          : true;
-      },
-      default: `New ${isDevelopmentSandbox ? 'development ' : ''}sandbox`,
-    },
-  ]);
-};
-
-const sandboxTypeChoices = [
-  {
-    name: i18n(`${i18nKey}.type.developer`),
-    value: HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
-  },
-  {
-    name: i18n(`${i18nKey}.type.standard`),
-    value: HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX,
-  },
-];
-
 const sandboxTypePrompt = () => {
   return promptUser([
     {
@@ -72,7 +35,16 @@ const sandboxTypePrompt = () => {
       message: i18n(`${i18nKey}.type.message`),
       type: 'list',
       look: false,
-      choices: sandboxTypeChoices,
+      choices: [
+        {
+          name: i18n(`${i18nKey}.type.developer`),
+          value: HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
+        },
+        {
+          name: i18n(`${i18nKey}.type.standard`),
+          value: HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX,
+        },
+      ],
       default: HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX,
     },
   ]);
@@ -90,8 +62,8 @@ const deleteSandboxPrompt = (config, promptParentAccount = false) => {
       name: 'account',
       message: i18n(
         promptParentAccount
-          ? `${i18nKey}.name.selectParentAccountName`
-          : `${i18nKey}.name.selectAccountName`
+          ? `${i18nKey}.selectParentAccountName`
+          : `${i18nKey}.selectAccountName`
       ),
       type: 'list',
       look: false,
@@ -103,7 +75,6 @@ const deleteSandboxPrompt = (config, promptParentAccount = false) => {
 };
 
 module.exports = {
-  sandboxNamePrompt,
   sandboxTypePrompt,
   deleteSandboxPrompt,
 };

package/lib/prompts/secretPrompt.js

@@ -1,7 +1,7 @@
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
 
-const i18nKey = 'cli.lib.prompts.secretPrompt';
+const i18nKey = 'lib.prompts.secretPrompt';
 
 const SECRET_VALUE_PROMPT = {
   name: 'secretValue',

package/lib/prompts/selectPublicAppPrompt.js

@@ -0,0 +1,84 @@
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('../lang');
+const { uiLine } = require('../ui');
+const { logApiErrorInstance } = require('../errorHandlers/apiErrors');
+const { logger } = require('@hubspot/local-dev-lib/logger');
+const {
+  fetchPublicAppsForPortal,
+} = require('@hubspot/local-dev-lib/api/appsDev');
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+
+const i18nKey = 'lib.prompts.selectPublicAppPrompt';
+
+const fetchPublicAppOptions = async (accountId, accountName, migrateApp) => {
+  try {
+    const publicApps = await fetchPublicAppsForPortal(accountId);
+    const filteredPublicApps = publicApps.filter(
+      app => !app.projectId && !app.sourceId
+    );
+
+    if (
+      !filteredPublicApps.length ||
+      (migrateApp &&
+        !filteredPublicApps.find(app => !app.preventProjectMigrations))
+    ) {
+      const headerTranslationKey = migrateApp
+        ? 'noAppsMigration'
+        : 'noAppsClone';
+      const messageTranslationKey = migrateApp
+        ? 'noAppsMigrationMessage'
+        : 'noAppsCloneMessage';
+      uiLine();
+      logger.error(i18n(`${i18nKey}.errors.${headerTranslationKey}`));
+      logger.log(
+        i18n(`${i18nKey}.errors.${messageTranslationKey}`, { accountName })
+      );
+      uiLine();
+      process.exit(EXIT_CODES.SUCCESS);
+    }
+    return filteredPublicApps;
+  } catch (error) {
+    logApiErrorInstance(error, { accountId });
+    logger.error(i18n(`${i18nKey}.errors.errorFetchingApps`));
+    process.exit(EXIT_CODES.ERROR);
+  }
+};
+
+const selectPublicAppPrompt = async ({
+  accountId,
+  accountName,
+  migrateApp = false,
+}) => {
+  const publicApps = await fetchPublicAppOptions(
+    accountId,
+    accountName,
+    (migrateApp = false)
+  );
+  const translationKey = migrateApp ? 'selectAppIdMigrate' : 'selectAppIdClone';
+
+  return promptUser([
+    {
+      name: 'appId',
+      message: i18n(`${i18nKey}.${translationKey}`, {
+        accountName,
+      }),
+      type: 'list',
+      choices: publicApps.map(app => {
+        if (migrateApp && app.preventProjectMigrations) {
+          return {
+            name: `${app.name} (${app.id})`,
+            disabled: i18n(`${i18nKey}.errors.cannotBeMigrated`),
+          };
+        }
+        return {
+          name: `${app.name} (${app.id})`,
+          value: app.id,
+        };
+      }),
+    },
+  ]);
+};
+
+module.exports = {
+  selectPublicAppPrompt,
+};

package/lib/prompts/setAsDefaultAccountPrompt.js

@@ -5,7 +5,7 @@ const {
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
 
-const i18nKey = 'cli.lib.prompts.setAsDefaultAccountPrompt';
+const i18nKey = 'lib.prompts.setAsDefaultAccountPrompt';
 
 const setAsDefaultAccountPrompt = async accountName => {
   const config = getConfig();

package/lib/prompts/uploadPrompt.js

@@ -3,7 +3,7 @@ const { getCwd } = require('@hubspot/local-dev-lib/path');
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
 
-const i18nKey = 'cli.lib.prompts.uploadPrompt';
+const i18nKey = 'lib.prompts.uploadPrompt';
 
 const uploadPrompt = (promptOptions = {}) => {
   return promptUser([

package/lib/sandboxSync.js

@@ -21,7 +21,7 @@ const { getSandboxTypeAsString } = require('./sandboxes');
 const { getAccountId } = require('@hubspot/local-dev-lib/config');
 const { uiAccountDescription } = require('./ui');
 
-const i18nKey = 'cli.lib.sandbox.sync';
+const i18nKey = 'lib.sandbox.sync';
 
 /**
  * @param {Object} accountConfig - Account config of sandbox portal

package/lib/sandboxes.js

@@ -7,7 +7,11 @@ const {
   fetchTypes,
   getSandboxUsageLimits,
 } = require('@hubspot/local-dev-lib/sandboxes');
-const { getConfig, getAccountId } = require('@hubspot/local-dev-lib/config');
+const {
+  getConfig,
+  getAccountId,
+  getEnv,
+} = require('@hubspot/local-dev-lib/config');
 const CliProgressMultibarManager = require('./ui/CliProgressMultibarManager');
 const { promptUser } = require('./prompts/promptUtils');
 const { isDevelopmentSandbox } = require('./accountTypes');
@@ -15,6 +19,13 @@ const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
 const {
   HUBSPOT_ACCOUNT_TYPES,
 } = require('@hubspot/local-dev-lib/constants/config');
+const { uiAccountDescription } = require('./ui');
+const {
+  isMissingScopeError,
+  isSpecifiedError,
+} = require('@hubspot/local-dev-lib/errors/apiErrors');
+const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
+const { logErrorInstance } = require('./errorHandlers/standardErrors');
 
 const syncTypes = {
   OBJECT_RECORDS: 'object-records',
@@ -39,9 +50,6 @@ const getSandboxTypeAsString = accountType => {
   return 'standard';
 };
 
-const getSandboxName = config =>
-  `[${getSandboxTypeAsString(config.accountType)} sandbox] `;
-
 function getHasSandboxesByType(parentAccountConfig, type) {
   const config = getConfig();
   const parentPortalId = getAccountId(parentAccountConfig.portalId);
@@ -103,9 +111,7 @@ const getSyncTypesWithContactRecordsPrompt = async (
       {
         name: 'contactRecordsSyncPrompt',
         type: 'confirm',
-        message: i18n(
-          `cli.lib.sandbox.sync.confirm.syncContactRecords.${langKey}`
-        ),
+        message: i18n(`lib.sandbox.sync.confirm.syncContactRecords.${langKey}`),
       },
     ]);
     if (!contactRecordsSyncPrompt) {
@@ -138,7 +144,7 @@ const validateSandboxUsageLimits = async (accountConfig, sandboxType, env) => {
       if (hasDevelopmentSandboxes) {
         throw new Error(
           i18n(
-            `cli.lib.sandbox.create.failure.alreadyInConfig.developer.${
+            `lib.sandbox.create.failure.alreadyInConfig.developer.${
               plural ? 'other' : 'one'
             }`,
             {
@@ -151,7 +157,7 @@ const validateSandboxUsageLimits = async (accountConfig, sandboxType, env) => {
         const baseUrl = getHubSpotWebsiteOrigin(env);
         throw new Error(
           i18n(
-            `cli.lib.sandbox.create.failure.limit.developer.${
+            `lib.sandbox.create.failure.limit.developer.${
               plural ? 'other' : 'one'
             }`,
             {
@@ -175,7 +181,7 @@ const validateSandboxUsageLimits = async (accountConfig, sandboxType, env) => {
       if (hasStandardSandboxes) {
         throw new Error(
           i18n(
-            `cli.lib.sandbox.create.failure.alreadyInConfig.standard.${
+            `lib.sandbox.create.failure.alreadyInConfig.standard.${
               plural ? 'other' : 'one'
             }`,
             {
@@ -188,7 +194,7 @@ const validateSandboxUsageLimits = async (accountConfig, sandboxType, env) => {
         const baseUrl = getHubSpotWebsiteOrigin(env);
         throw new Error(
           i18n(
-            `cli.lib.sandbox.create.failure.limit.standard.${
+            `lib.sandbox.create.failure.limit.standard.${
               plural ? 'other' : 'one'
             }`,
             {
@@ -203,6 +209,153 @@ const validateSandboxUsageLimits = async (accountConfig, sandboxType, env) => {
   }
 };
 
+function handleSandboxCreateError({
+  err,
+  env,
+  accountId,
+  name,
+  accountConfig,
+}) {
+  if (isMissingScopeError(err)) {
+    logger.error(
+      i18n('lib.sandboxes.create.failure.scopes.message', {
+        accountName: uiAccountDescription(accountId),
+      })
+    );
+    const websiteOrigin = getHubSpotWebsiteOrigin(env);
+    const url = `${websiteOrigin}/personal-access-key/${accountId}`;
+    logger.info(
+      i18n('lib.sandboxes.create.failure.scopes.instructions', {
+        accountName: uiAccountDescription(accountId),
+        url,
+      })
+    );
+  } else if (
+    isSpecifiedError(err, {
+      statusCode: 403,
+      category: 'BANNED',
+      subCategory: 'SandboxErrors.USER_ACCESS_NOT_ALLOWED',
+    })
+  ) {
+    logger.log('');
+    logger.error(
+      i18n('lib.sandboxes.create.failure.invalidUser', {
+        accountName: name,
+        parentAccountName: uiAccountDescription(accountId),
+      })
+    );
+    logger.log('');
+  } else if (
+    isSpecifiedError(err, {
+      statusCode: 403,
+      category: 'BANNED',
+      subCategory: 'SandboxErrors.DEVELOPMENT_SANDBOX_ACCESS_NOT_ALLOWED',
+    })
+  ) {
+    logger.log('');
+    logger.error(
+      i18n('lib.sandboxes.create.failure.403Gating', {
+        accountName: name,
+        parentAccountName: uiAccountDescription(accountId),
+        accountId,
+      })
+    );
+    logger.log('');
+  } else if (
+    isSpecifiedError(err, {
+      statusCode: 400,
+      category: 'VALIDATION_ERROR',
+      subCategory:
+        'SandboxErrors.NUM_DEVELOPMENT_SANDBOXES_LIMIT_EXCEEDED_ERROR',
+    }) &&
+    err.error &&
+    err.error.message
+  ) {
+    logger.log('');
+    const devSandboxLimit = getSandboxLimit(err.error);
+    const plural = devSandboxLimit !== 1;
+    const hasDevelopmentSandboxes = getHasSandboxesByType(
+      accountConfig,
+      HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX
+    );
+    if (hasDevelopmentSandboxes) {
+      logger.error(
+        i18n(
+          `lib.sandboxes.create.failure.alreadyInConfig.developer.${
+            plural ? 'other' : 'one'
+          }`,
+          {
+            accountName: uiAccountDescription(accountId),
+            limit: devSandboxLimit,
+          }
+        )
+      );
+    } else {
+      const baseUrl = getHubSpotWebsiteOrigin(getValidEnv(getEnv(accountId)));
+      logger.error(
+        i18n(
+          `lib.sandboxes.create.failure.limit.developer.${
+            plural ? 'other' : 'one'
+          }`,
+          {
+            accountName: uiAccountDescription(accountId),
+            limit: devSandboxLimit,
+            link: `${baseUrl}/sandboxes-developer/${accountId}/development`,
+          }
+        )
+      );
+    }
+    logger.log('');
+  } else if (
+    isSpecifiedError(err, {
+      statusCode: 400,
+      category: 'VALIDATION_ERROR',
+      subCategory: 'SandboxErrors.NUM_STANDARD_SANDBOXES_LIMIT_EXCEEDED_ERROR',
+    }) &&
+    err.error &&
+    err.error.message
+  ) {
+    logger.log('');
+    const standardSandboxLimit = getSandboxLimit(err.error);
+    const plural = standardSandboxLimit !== 1;
+    const hasStandardSandboxes = getHasSandboxesByType(
+      accountConfig,
+      HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX
+    );
+    if (hasStandardSandboxes) {
+      logger.error(
+        i18n(
+          `lib.sandboxes.create.failure.alreadyInConfig.standard.${
+            plural ? 'other' : 'one'
+          }`,
+          {
+            accountName: uiAccountDescription(accountId),
+            limit: standardSandboxLimit,
+          }
+        )
+      );
+    } else {
+      const baseUrl = getHubSpotWebsiteOrigin(getValidEnv(getEnv(accountId)));
+      logger.error(
+        i18n(
+          `lib.sandboxes.create.failure.limit.standard.${
+            plural ? 'other' : 'one'
+          }`,
+          {
+            accountName: uiAccountDescription(accountId),
+            limit: standardSandboxLimit,
+            link: `${baseUrl}/sandboxes-developer/${accountId}/standard`,
+          }
+        )
+      );
+    }
+    logger.log('');
+  } else {
+    logErrorInstance(err);
+  }
+  throw err;
+}
+
 const ACTIVE_TASK_POLL_INTERVAL = 1000;
 
 const isTaskComplete = task => {
@@ -229,7 +382,7 @@ function pollSyncTaskStatus(
   syncStatusUrl,
   allowEarlyTermination = true
 ) {
-  const i18nKey = 'cli.lib.sandbox.sync.types';
+  const i18nKey = 'lib.sandbox.sync.types';
   const progressBar = CliProgressMultibarManager.init();
   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.
@@ -244,7 +397,7 @@ function pollSyncTaskStatus(
     logger.log('Exiting, sync will continue in the background.');
     logger.log('');
     logger.log(
-      i18n('cli.lib.sandbox.sync.info.syncStatus', {
+      i18n('lib.sandbox.sync.info.syncStatus', {
         url: syncStatusUrl,
       })
     );
@@ -344,7 +497,6 @@ module.exports = {
   sandboxTypeMap,
   sandboxApiTypeMap,
   syncTypes,
-  getSandboxName,
   getSandboxTypeAsString,
   getHasSandboxesByType,
   getSandboxLimit,
@@ -352,4 +504,5 @@ module.exports = {
   getAvailableSyncTypes,
   getSyncTypesWithContactRecordsPrompt,
   pollSyncTaskStatus,
+  handleSandboxCreateError,
 };

package/lib/serverlessLogs.js

@@ -52,7 +52,7 @@ const tailLogs = async ({
     initialAfter = latestLog && base64EncodeString(latestLog.id);
   } catch (e) {
     // A 404 means no latest log exists(never executed)
-    if (e.statusCode !== 404) {
+    if (e.response && e.response.status !== 404) {
       await logServerlessFunctionApiErrorInstance(
         accountId,
         e,
@@ -68,7 +68,7 @@ const tailLogs = async ({
       latestLog = await tailCall(after);
       nextAfter = latestLog.paging.next.after;
     } catch (e) {
-      if (e.statusCode !== 404) {
+      if (e.response && e.response.status !== 404) {
         logApiErrorInstance(
           e,
           new ApiErrorContext({

package/lib/ui/git.js

@@ -3,7 +3,7 @@ const { checkGitInclusion } = require('@hubspot/local-dev-lib/gitignore');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { i18n } = require('../lang');
 
-const i18nKey = 'cli.lib.ui.git';
+const i18nKey = 'lib.ui.git';
 
 function checkAndWarnGitInclusion(configPath) {
   try {