@hubspot/cli 5.1.3 → 5.1.4-beta.1

package/lib/projectsWatch.js

@@ -16,7 +16,8 @@ const {
   uploadFileToBuild,
   deleteFileFromBuild,
   queueBuild,
-} = require('@hubspot/cli-lib/api/dfs');
+} = require('@hubspot/local-dev-lib/api/projects');
+const { isSpecifiedError } = require('@hubspot/local-dev-lib/errors/apiErrors');
 const { ERROR_TYPES } = require('@hubspot/cli-lib/lib/constants');
 
 const i18nKey = 'cli.commands.project.subcommands.watch';
@@ -29,25 +30,40 @@ let currentBuildId = null;
 let handleBuildStatus, handleUserInput;
 let timer;
 
-const processStandByQueue = async (accountId, projectName) => {
+const processStandByQueue = async (accountId, projectName, platformVersion) => {
   queue.addAll(
     standbyeQueue.map(({ filePath, remotePath, action }) => {
       return async () => {
-        queueFileOrFolder(accountId, projectName, filePath, remotePath, action);
+        queueFileOrFolder(
+          accountId,
+          projectName,
+          platformVersion,
+          filePath,
+          remotePath,
+          action
+        );
       };
     })
   );
   standbyeQueue.length = 0;
-  debounceQueueBuild(accountId, projectName);
+  debounceQueueBuild(accountId, projectName, platformVersion);
 };
 
-const createNewStagingBuild = async (accountId, projectName) => {
-  currentBuildId = await createNewBuild(accountId, projectName);
+const createNewStagingBuild = async (
+  accountId,
+  projectName,
+  platformVersion
+) => {
+  currentBuildId = await createNewBuild(
+    accountId,
+    projectName,
+    platformVersion
+  );
 
   handleUserInput(accountId, projectName, currentBuildId);
 };
 
-const debounceQueueBuild = (accountId, projectName) => {
+const debounceQueueBuild = (accountId, projectName, platformVersion) => {
   if (timer) {
     clearTimeout(timer);
   }
@@ -58,12 +74,13 @@ const debounceQueueBuild = (accountId, projectName) => {
     await queue.onIdle();
 
     try {
-      await queueBuild(accountId, projectName);
+      await queueBuild(accountId, projectName, platformVersion);
       logger.debug(i18n(`${i18nKey}.debug.buildStarted`, { projectName }));
     } catch (err) {
       if (
-        err.error &&
-        err.error.subCategory === ERROR_TYPES.MISSING_PROJECT_PROVISION
+        isSpecifiedError(err, {
+          subCategory: ERROR_TYPES.MISSING_PROJECT_PROVISION,
+        })
       ) {
         logger.log(i18n(`${i18nKey}.logs.watchCancelledFromUi`));
         process.exit(0);
@@ -79,10 +96,10 @@ const debounceQueueBuild = (accountId, projectName) => {
 
     await handleBuildStatus(accountId, projectName, currentBuildId);
 
-    await createNewStagingBuild(accountId, projectName);
+    await createNewStagingBuild(accountId, projectName, platformVersion);
 
     if (standbyeQueue.length > 0) {
-      await processStandByQueue(accountId, projectName);
+      await processStandByQueue(accountId, projectName, platformVersion);
     }
 
     queue.start();
@@ -94,6 +111,7 @@ const debounceQueueBuild = (accountId, projectName) => {
 const queueFileOrFolder = async (
   accountId,
   projectName,
+  platformVersion,
   filePath,
   remotePath,
   action
@@ -107,7 +125,7 @@ const queueFileOrFolder = async (
     return;
   }
   if (!queue.isPaused) {
-    debounceQueueBuild(accountId, projectName);
+    debounceQueueBuild(accountId, projectName, platformVersion);
   }
 
   logger.debug(i18n(`${i18nKey}.debug.uploading`, { filePath, remotePath }));
@@ -130,14 +148,18 @@ const queueFileOrFolder = async (
   });
 };
 
-const createNewBuild = async (accountId, projectName) => {
+const createNewBuild = async (accountId, projectName, platformVersion) => {
   try {
     logger.debug(i18n(`${i18nKey}.debug.attemptNewBuild`));
-    const { buildId } = await provisionBuild(accountId, projectName);
+    const { buildId } = await provisionBuild(
+      accountId,
+      projectName,
+      platformVersion
+    );
     return buildId;
   } catch (err) {
     logApiErrorInstance(err, new ApiErrorContext({ accountId, projectName }));
-    if (err.error.subCategory !== ERROR_TYPES.PROJECT_LOCKED) {
+    if (isSpecifiedError(err, { subCategory: ERROR_TYPES.PROJECT_LOCKED })) {
       await cancelStagedBuild(accountId, projectName);
       logger.log(i18n(`${i18nKey}.logs.previousStagingBuildCancelled`));
     }
@@ -148,6 +170,7 @@ const createNewBuild = async (accountId, projectName) => {
 const handleWatchEvent = async (
   accountId,
   projectName,
+  platformVersion,
   projectSourceDir,
   filePath,
   action = 'upload'
@@ -165,6 +188,7 @@ const handleWatchEvent = async (
     await queueFileOrFolder(
       accountId,
       projectName,
+      platformVersion,
       filePath,
       remotePath,
       action
@@ -184,7 +208,11 @@ const createWatcher = async (
   handleBuildStatus = handleBuildStatusFn;
   handleUserInput = handleUserInputFn;
 
-  await createNewStagingBuild(accountId, projectConfig.name);
+  await createNewStagingBuild(
+    accountId,
+    projectConfig.name,
+    projectConfig.platformVersion
+  );
 
   const watcher = chokidar.watch(projectSourceDir, {
     ignoreInitial: true,
@@ -195,15 +223,28 @@ const createWatcher = async (
     logger.log(`\n> Press ${chalk.bold('q')} to quit watching\n`);
   });
   watcher.on('add', async path => {
-    handleWatchEvent(accountId, projectConfig.name, projectSourceDir, path);
+    handleWatchEvent(
+      accountId,
+      projectConfig.name,
+      projectConfig.platformVersion,
+      projectSourceDir,
+      path
+    );
   });
   watcher.on('change', async path => {
-    handleWatchEvent(accountId, projectConfig.name, projectSourceDir, path);
+    handleWatchEvent(
+      accountId,
+      projectConfig.name,
+      projectConfig.platformVersion,
+      projectSourceDir,
+      path
+    );
   });
   watcher.on('unlink', async path => {
     handleWatchEvent(
       accountId,
       projectConfig.name,
+      projectConfig.platformVersion,
       projectSourceDir,
       path,
       'deleteFile'
@@ -213,6 +254,7 @@ const createWatcher = async (
     handleWatchEvent(
       accountId,
       projectConfig.name,
+      projectConfig.platformVersion,
       projectSourceDir,
       path,
       'deleteFolder'

package/lib/prompts/accountsPrompt.js

@@ -1,15 +1,13 @@
 const { updateDefaultAccount } = require('@hubspot/local-dev-lib/config');
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
-const { getAccountName } = require('../sandboxes');
+const { uiAccountDescription } = require('../ui');
 
 const mapAccountChoices = portals =>
-  portals.map(p => {
-    return {
-      name: getAccountName(p),
-      value: p.name || p.portalId,
-    };
-  });
+  portals.map(p => ({
+    name: uiAccountDescription(p.portalId, false),
+    value: p.name || p.portalId,
+  }));
 
 const i18nKey = 'cli.commands.accounts.subcommands.use';
 

package/lib/prompts/downloadProjectPrompt.js

@@ -1,6 +1,6 @@
 const { promptUser } = require('./promptUtils');
 const { getAccountId } = require('@hubspot/local-dev-lib/config');
-const { fetchProjects } = require('@hubspot/cli-lib/api/dfs');
+const { fetchProjects } = require('@hubspot/local-dev-lib/api/projects');
 const {
   logApiErrorInstance,
   ApiErrorContext,

package/lib/prompts/projectDevTargetAccountPrompt.js

@@ -1,15 +1,16 @@
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
 const { uiAccountDescription, uiCommandReference } = require('../ui');
-const { isSandbox, getAccountName } = require('../sandboxes');
+const { isSandbox } = require('../sandboxes');
 const { getAccountId } = require('@hubspot/local-dev-lib/config');
 const { getSandboxUsageLimits } = require('@hubspot/local-dev-lib/sandboxes');
 const { logger } = require('@hubspot/cli-lib/logger');
+const { DEVELOPER_SANDBOX, STANDARD_SANDBOX } = require('../constants');
 
 const i18nKey = 'cli.lib.prompts.projectDevTargetAccountPrompt';
 
 const mapSandboxAccount = accountConfig => ({
-  name: getAccountName(accountConfig, false),
+  name: uiAccountDescription(accountConfig.portalId, false),
   value: {
     targetAccountId: getAccountId(accountConfig.name),
     createNewSandbox: false,
@@ -33,15 +34,18 @@ const selectTargetAccountPrompt = async (accounts, defaultAccountConfig) => {
     );
   let disabledMessage = false;
 
-  if (sandboxUsage['DEVELOPER'] && sandboxUsage['DEVELOPER'].available === 0) {
-    if (sandboxAccounts.length < sandboxUsage['DEVELOPER'].limit) {
+  if (
+    sandboxUsage[DEVELOPER_SANDBOX] &&
+    sandboxUsage[DEVELOPER_SANDBOX].available === 0
+  ) {
+    if (sandboxAccounts.length < sandboxUsage[DEVELOPER_SANDBOX].limit) {
       disabledMessage = i18n(`${i18nKey}.sandboxLimitWithSuggestion`, {
         authCommand: uiCommandReference('hs auth'),
-        limit: sandboxUsage['DEVELOPER'].limit,
+        limit: sandboxUsage[DEVELOPER_SANDBOX].limit,
       });
     } else {
       disabledMessage = i18n(`${i18nKey}.sandboxLimit`, {
-        limit: sandboxUsage['DEVELOPER'].limit,
+        limit: sandboxUsage[DEVELOPER_SANDBOX].limit,
       });
     }
   }
@@ -49,10 +53,10 @@ const selectTargetAccountPrompt = async (accounts, defaultAccountConfig) => {
   // Order choices by Developer Sandbox -> Standard Sandbox
   const choices = [
     ...sandboxAccounts
-      .filter(a => a.sandboxAccountType === 'DEVELOPER')
+      .filter(a => a.sandboxAccountType === DEVELOPER_SANDBOX)
       .map(mapSandboxAccount),
     ...sandboxAccounts
-      .filter(a => a.sandboxAccountType === 'STANDARD')
+      .filter(a => a.sandboxAccountType === STANDARD_SANDBOX)
       .map(mapSandboxAccount),
     {
       name: i18n(`${i18nKey}.createNewSandboxOption`),
@@ -85,12 +89,12 @@ const selectTargetAccountPrompt = async (accounts, defaultAccountConfig) => {
   return targetAccountInfo;
 };
 
-const confirmDefaultSandboxAccountPrompt = async (accountName, accountType) => {
+const confirmDefaultAccountPrompt = async (accountName, accountType) => {
   const { useDefaultAccount } = await promptUser([
     {
       name: 'useDefaultAccount',
       type: 'confirm',
-      message: i18n(`${i18nKey}.confirmDefaultSandboxAccount`, {
+      message: i18n(`${i18nKey}.confirmDefaultAccount`, {
         accountName,
         accountType,
       }),
@@ -101,5 +105,5 @@ const confirmDefaultSandboxAccountPrompt = async (accountName, accountType) => {
 
 module.exports = {
   selectTargetAccountPrompt,
-  confirmDefaultSandboxAccountPrompt,
+  confirmDefaultAccountPrompt,
 };

package/lib/prompts/projectsLogsPrompt.js

@@ -1,5 +1,5 @@
 const { i18n } = require('../lang');
-const { fetchProject } = require('@hubspot/cli-lib/api/dfs');
+const { fetchProject } = require('@hubspot/local-dev-lib/api/projects');
 const { promptUser } = require('./promptUtils');
 const { getAccountId } = require('../commonOpts');
 const { getProjectConfig, ensureProjectExists } = require('../projects');

package/lib/prompts/sandboxesPrompt.js

@@ -1,11 +1,13 @@
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
+const { accountNameExistsInConfig } = require('@hubspot/local-dev-lib/config');
+const { uiAccountDescription } = require('../ui');
 const {
-  getSandboxTypeAsString,
-  STANDARD_SANDBOX,
   DEVELOPER_SANDBOX,
-} = require('../sandboxes');
-const { accountNameExistsInConfig } = require('@hubspot/local-dev-lib/config');
+  STANDARD_SANDBOX,
+  STANDARD_SANDBOX_TYPE,
+  DEVELOPER_SANDBOX_TYPE,
+} = require('../constants');
 
 const i18nKey = 'cli.lib.prompts.sandboxesPrompt';
 
@@ -13,11 +15,8 @@ const mapSandboxAccountChoices = portals =>
   portals
     .filter(p => p.sandboxAccountType && p.sandboxAccountType !== null)
     .map(p => {
-      const sandboxName = `[${getSandboxTypeAsString(
-        p.sandboxAccountType
-      )} sandbox] `;
       return {
-        name: `${p.name} ${sandboxName}(${p.portalId})`,
+        name: uiAccountDescription(p.portalId, false),
         value: p.name || p.portalId,
       };
     });
@@ -34,8 +33,8 @@ const mapNonSandboxAccountChoices = portals =>
       };
     });
 
-const sandboxNamePrompt = (type = STANDARD_SANDBOX) => {
-  const isDeveloperSandbox = type === DEVELOPER_SANDBOX;
+const sandboxNamePrompt = (type = STANDARD_SANDBOX_TYPE) => {
+  const isDeveloperSandbox = type === DEVELOPER_SANDBOX_TYPE;
   const namePromptMessage = isDeveloperSandbox
     ? `${i18nKey}.name.developmentSandboxMessage`
     : `${i18nKey}.name.message`;
@@ -61,11 +60,11 @@ const sandboxNamePrompt = (type = STANDARD_SANDBOX) => {
 const sandboxTypeChoices = [
   {
     name: i18n(`${i18nKey}.type.developer`),
-    value: 'DEVELOPER',
+    value: DEVELOPER_SANDBOX,
   },
   {
     name: i18n(`${i18nKey}.type.standard`),
-    value: 'STANDARD',
+    value: STANDARD_SANDBOX,
   },
 ];
 
@@ -77,7 +76,7 @@ const sandboxTypePrompt = () => {
       type: 'list',
       look: false,
       choices: sandboxTypeChoices,
-      default: 'DEVELOPER',
+      default: DEVELOPER_SANDBOX,
     },
   ]);
 };

package/lib/{sandbox-create.js → sandboxCreate.js}

@@ -2,10 +2,7 @@ const SpinniesManager = require('./SpinniesManager');
 const {
   getSandboxLimit,
   getHasSandboxesByType,
-  saveSandboxToConfig,
   sandboxApiTypeMap,
-  STANDARD_SANDBOX,
-  DEVELOPER_SANDBOX,
 } = require('./sandboxes');
 const { i18n } = require('./lang');
 const { logger } = require('@hubspot/cli-lib/logger');
@@ -21,9 +18,99 @@ const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
 const { getEnv, getAccountId } = require('@hubspot/local-dev-lib/config');
 const { createSandbox } = require('@hubspot/local-dev-lib/sandboxes');
 const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
+const {
+  getAccessToken,
+  updateConfigWithAccessToken,
+} = require('@hubspot/local-dev-lib/personalAccessKey');
+const { uiAccountDescription } = require('./ui');
+const {
+  DEVELOPER_SANDBOX_TYPE,
+  STANDARD_SANDBOX_TYPE,
+} = require('./constants');
+const {
+  personalAccessKeyPrompt,
+} = require('./prompts/personalAccessKeyPrompt');
+const { enterAccountNamePrompt } = require('./prompts/enterAccountNamePrompt');
+const {
+  accountNameExistsInConfig,
+  writeConfig,
+  updateAccountConfig,
+} = require('@hubspot/local-dev-lib/config');
 
 const i18nKey = 'cli.lib.sandbox.create';
 
+/**
+ * @param {String} env - Environment (QA/Prod)
+ * @param {Object} result - Sandbox instance returned from API
+ * @param {Boolean} force - Force flag to skip prompt
+ * @returns {String} validName saved into config
+ */
+const saveSandboxToConfig = async (env, result, force = false) => {
+  let personalAccessKey = result.personalAccessKey;
+  if (!personalAccessKey) {
+    const configData = await personalAccessKeyPrompt({
+      env,
+      account: result.sandbox.sandboxHubId,
+    });
+    personalAccessKey = configData.personalAccessKey;
+  }
+
+  let updatedConfig;
+
+  try {
+    const token = await getAccessToken(personalAccessKey, env);
+    updatedConfig = await updateConfigWithAccessToken(
+      token,
+      personalAccessKey,
+      env
+    );
+  } catch (e) {
+    logErrorInstance(e);
+  }
+
+  if (!updatedConfig) {
+    throw new Error('Failed to update config with personal access key.');
+  }
+
+  let validName = updatedConfig.name;
+  if (!updatedConfig.name) {
+    const nameForConfig = result.sandbox.name
+      .toLowerCase()
+      .split(' ')
+      .join('-');
+    validName = nameForConfig;
+    const invalidAccountName = accountNameExistsInConfig(nameForConfig);
+    if (invalidAccountName) {
+      if (!force) {
+        logger.log('');
+        logger.warn(
+          i18n(
+            `cli.lib.prompts.enterAccountNamePrompt.errors.accountNameExists`,
+            { name: nameForConfig }
+          )
+        );
+        const { name: promptName } = await enterAccountNamePrompt(
+          nameForConfig + `_${result.sandbox.sandboxHubId}`
+        );
+        validName = promptName;
+      } else {
+        // Basic invalid name handling when force flag is passed
+        validName = nameForConfig + `_${result.sandbox.sandboxHubId}`;
+      }
+    }
+  }
+  updateAccountConfig({
+    ...updatedConfig,
+    environment: updatedConfig.env,
+    tokenInfo: updatedConfig.auth.tokenInfo,
+    name: validName,
+  });
+  writeConfig();
+
+  logger.log('');
+  return validName;
+};
+
 /**
  * @param {String} name - Name of sandbox
  * @param {String} type - Sandbox type to be created (standard/developer)
@@ -75,14 +162,14 @@ const buildSandbox = async ({
     if (isMissingScopeError(err)) {
       logger.error(
         i18n(`${i18nKey}.failure.scopes.message`, {
-          accountName: accountConfig.name || accountId,
+          accountName: uiAccountDescription(accountId),
         })
       );
       const websiteOrigin = getHubSpotWebsiteOrigin(env);
       const url = `${websiteOrigin}/personal-access-key/${accountId}`;
       logger.info(
         i18n(`${i18nKey}.failure.scopes.instructions`, {
-          accountName: accountConfig.name || accountId,
+          accountName: uiAccountDescription(accountId),
           url,
         })
       );
@@ -97,7 +184,7 @@ const buildSandbox = async ({
       logger.error(
         i18n(`${i18nKey}.failure.invalidUser`, {
           accountName: name,
-          parentAccountName: accountConfig.name || accountId,
+          parentAccountName: uiAccountDescription(accountId),
         })
       );
       logger.log('');
@@ -112,7 +199,7 @@ const buildSandbox = async ({
       logger.error(
         i18n(`${i18nKey}.failure.403Gating`, {
           accountName: name,
-          parentAccountName: accountConfig.name || accountId,
+          parentAccountName: uiAccountDescription(accountId),
           accountId,
         })
       );
@@ -132,7 +219,7 @@ const buildSandbox = async ({
       const plural = devSandboxLimit !== 1;
       const hasDevelopmentSandboxes = getHasSandboxesByType(
         accountConfig,
-        DEVELOPER_SANDBOX
+        DEVELOPER_SANDBOX_TYPE
       );
       if (hasDevelopmentSandboxes) {
         logger.error(
@@ -141,7 +228,7 @@ const buildSandbox = async ({
               plural ? 'other' : 'one'
             }`,
             {
-              accountName: accountConfig.name || accountId,
+              accountName: uiAccountDescription(accountId),
               limit: devSandboxLimit,
             }
           )
@@ -152,7 +239,7 @@ const buildSandbox = async ({
           i18n(
             `${i18nKey}.failure.limit.developer.${plural ? 'other' : 'one'}`,
             {
-              accountName: accountConfig.name || accountId,
+              accountName: uiAccountDescription(accountId),
               limit: devSandboxLimit,
               link: `${baseUrl}/sandboxes-developer/${accountId}/development`,
             }
@@ -175,7 +262,7 @@ const buildSandbox = async ({
       const plural = standardSandboxLimit !== 1;
       const hasStandardSandboxes = getHasSandboxesByType(
         accountConfig,
-        STANDARD_SANDBOX
+        STANDARD_SANDBOX_TYPE
       );
       if (hasStandardSandboxes) {
         logger.error(
@@ -184,7 +271,7 @@ const buildSandbox = async ({
               plural ? 'other' : 'one'
             }`,
             {
-              accountName: accountConfig.name || accountId,
+              accountName: uiAccountDescription(accountId),
               limit: standardSandboxLimit,
             }
           )
@@ -195,7 +282,7 @@ const buildSandbox = async ({
           i18n(
             `${i18nKey}.failure.limit.standard.${plural ? 'other' : 'one'}`,
             {
-              accountName: accountConfig.name || accountId,
+              accountName: uiAccountDescription(accountId),
               limit: standardSandboxLimit,
               link: `${baseUrl}/sandboxes-developer/${accountId}/standard`,
             }

package/lib/{sandbox-sync.js → sandboxSync.js}

@@ -5,8 +5,6 @@ const { i18n } = require('./lang');
 const {
   getAvailableSyncTypes,
   pollSyncTaskStatus,
-  getAccountName,
-  DEVELOPER_SANDBOX,
   sandboxTypeMap,
   syncTypes,
 } = require('./sandboxes');
@@ -22,6 +20,7 @@ const {
 const { getSandboxTypeAsString } = require('./sandboxes');
 const { getAccountId } = require('@hubspot/local-dev-lib/config');
 const { uiAccountDescription } = require('./ui');
+const { DEVELOPER_SANDBOX_TYPE } = require('./constants');
 
 const i18nKey = 'cli.lib.sandbox.sync';
 
@@ -89,7 +88,8 @@ const syncSandbox = async ({
     });
     if (
       skipPolling &&
-      sandboxTypeMap[accountConfig.sandboxAccountType] === DEVELOPER_SANDBOX
+      sandboxTypeMap[accountConfig.sandboxAccountType] ===
+        DEVELOPER_SANDBOX_TYPE
     ) {
       if (syncTasks.some(t => t.type === syncTypes.OBJECT_RECORDS)) {
         logger.log(i18n(`${i18nKey}.loading.skipPollingWithContacts`));
@@ -109,7 +109,7 @@ const syncSandbox = async ({
     if (isMissingScopeError(err)) {
       logger.error(
         i18n(`${i18nKey}.failure.missingScopes`, {
-          accountName: getAccountName(parentAccountConfig),
+          accountName: uiAccountDescription(parentAccountId),
         })
       );
     } else if (
@@ -122,7 +122,7 @@ const syncSandbox = async ({
       logger.error(
         i18n(`${i18nKey}.failure.invalidUser`, {
           accountName: uiAccountDescription(accountId),
-          parentAccountName: getAccountName(parentAccountConfig),
+          parentAccountName: uiAccountDescription(parentAccountId),
         })
       );
     } else if (
@@ -147,7 +147,7 @@ const syncSandbox = async ({
       // 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),
+          account: uiAccountDescription(accountId),
         })
       );
     } else if (
@@ -159,7 +159,7 @@ const syncSandbox = async ({
     ) {
       logger.error(
         i18n(`${i18nKey}.failure.objectNotFound`, {
-          account: getAccountName(accountConfig),
+          account: uiAccountDescription(accountId),
         })
       );
     } else {