@hubspot/cli 5.2.1-beta.8 → 5.3.0

package/lib/prompts/deployBuildIdPrompt.js

@@ -0,0 +1,22 @@
+const { promptUser } = require('./promptUtils');
+const { i18n } = require('../lang');
+
+const i18nKey = 'lib.prompts.deployBuildIdPrompt';
+
+const deployBuildIdPrompt = (latestBuildId, deployedBuildId, validate) => {
+  return promptUser({
+    name: 'buildId',
+    message: i18n(`${i18nKey}.enterBuildId`),
+    default: () => {
+      if (latestBuildId === deployedBuildId) {
+        return;
+      }
+      return latestBuildId;
+    },
+    validate,
+  });
+};
+
+module.exports = {
+  deployBuildIdPrompt,
+};

package/lib/prompts/installPublicAppPrompt.js

@@ -12,20 +12,29 @@ const installPublicAppPrompt = async (
   targetAccountId,
   clientId,
   scopes,
-  redirectUrls
+  redirectUrls,
+  isReinstall = false
 ) => {
   logger.log('');
-  logger.log(i18n(`${i18nKey}.explanation`));
+  if (isReinstall) {
+    logger.log(i18n(`${i18nKey}.reinstallExplanation`));
+  } else {
+    logger.log(i18n(`${i18nKey}.explanation`));
+  }
 
   const { shouldOpenBrowser } = await promptUser({
     name: 'shouldOpenBrowser',
     type: 'confirm',
-    message: i18n(`${i18nKey}.prompt`),
+    message: i18n(
+      isReinstall ? `${i18nKey}.reinstallPrompt` : `${i18nKey}.prompt`
+    ),
   });
 
-  if (!shouldOpenBrowser) {
+  if (!isReinstall && !shouldOpenBrowser) {
     logger.log(i18n(`${i18nKey}.decline`));
     process.exit(EXIT_CODES.SUCCESS);
+  } else if (!shouldOpenBrowser) {
+    return;
   }
 
   const websiteOrigin = getHubSpotWebsiteOrigin(env);

package/lib/prompts/personalAccessKeyPrompt.js

@@ -7,7 +7,7 @@ const { deleteEmptyConfigFile } = require('@hubspot/local-dev-lib/config');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { promptUser } = require('./promptUtils');
-const { accountNamePrompt } = require('./enterAccountNamePrompt');
+const { getCliAccountNamePromptConfig } = require('./accountNamePrompt');
 const { i18n } = require('../lang');
 const { uiInfoSection } = require('../ui');
 const { EXIT_CODES } = require('../enums/exitCodes');
@@ -124,7 +124,7 @@ const SCOPES = {
 };
 
 const OAUTH_FLOW = [
-  accountNamePrompt(),
+  getCliAccountNamePromptConfig(),
   ACCOUNT_ID,
   CLIENT_ID,
   CLIENT_SECRET,

package/lib/prompts/sandboxesPrompt.js

@@ -1,6 +1,5 @@
 const { promptUser } = require('./promptUtils');
 const { i18n } = require('../lang');
-const { accountNameExistsInConfig } = require('@hubspot/local-dev-lib/config');
 const { uiAccountDescription } = require('../ui');
 const {
   HUBSPOT_ACCOUNT_TYPES,
@@ -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/selectPublicAppPrompt.js

@@ -10,17 +10,35 @@ const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 const i18nKey = 'lib.prompts.selectPublicAppPrompt';
 
-const fetchPublicAppOptions = async (accountId, accountName) => {
+const fetchPublicAppOptions = async (
+  accountId,
+  accountName,
+  isMigratingApp = false
+) => {
   try {
     const publicApps = await fetchPublicAppsForPortal(accountId);
     const filteredPublicApps = publicApps.filter(
       app => !app.projectId && !app.sourceId
     );
 
-    if (!filteredPublicApps.length) {
+    if (
+      !filteredPublicApps.length ||
+      (isMigratingApp &&
+        !filteredPublicApps.some(
+          app => !app.preventProjectMigrations || !app.listingInfo
+        ))
+    ) {
+      const headerTranslationKey = isMigratingApp
+        ? 'noAppsMigration'
+        : 'noAppsClone';
+      const messageTranslationKey = isMigratingApp
+        ? 'noAppsMigrationMessage'
+        : 'noAppsCloneMessage';
       uiLine();
-      logger.error(i18n(`${i18nKey}.errors.noApps`));
-      logger.log(i18n(`${i18nKey}.errors.noAppsMessage`, { accountName }));
+      logger.error(i18n(`${i18nKey}.errors.${headerTranslationKey}`));
+      logger.log(
+        i18n(`${i18nKey}.errors.${messageTranslationKey}`, { accountName })
+      );
       uiLine();
       process.exit(EXIT_CODES.SUCCESS);
     }
@@ -35,30 +53,32 @@ const fetchPublicAppOptions = async (accountId, accountName) => {
 const selectPublicAppPrompt = async ({
   accountId,
   accountName,
-  promptOptions = {},
-  migrateApp = false,
+  isMigratingApp = false,
 }) => {
-  const publicApps = await fetchPublicAppOptions(accountId, accountName);
-  const translationKey = migrateApp ? 'selectAppIdMigrate' : 'selectAppIdClone';
+  const publicApps = await fetchPublicAppOptions(
+    accountId,
+    accountName,
+    isMigratingApp
+  );
+  const translationKey = isMigratingApp
+    ? 'selectAppIdMigrate'
+    : 'selectAppIdClone';
 
   return promptUser([
     {
       name: 'appId',
-      message: () => {
-        return promptOptions.appId &&
-          !publicApps.find(a => a.id === promptOptions.appId)
-          ? i18n(`${i18nKey}.errors.invalidAppId`, {
-              appId: promptOptions.appId,
-            })
-          : i18n(`${i18nKey}.${translationKey}`, {
-              accountName,
-            });
-      },
-      when:
-        !promptOptions.appId ||
-        !publicApps.find(a => a.id === promptOptions.appId),
+      message: i18n(`${i18nKey}.${translationKey}`, {
+        accountName,
+      }),
       type: 'list',
       choices: publicApps.map(app => {
+        const { preventProjectMigrations, listingInfo } = app;
+        if (isMigratingApp && preventProjectMigrations && listingInfo) {
+          return {
+            name: `${app.name} (${app.id})`,
+            disabled: i18n(`${i18nKey}.errors.cannotBeMigrated`),
+          };
+        }
         return {
           name: `${app.name} (${app.id})`,
           value: app.id,
@@ -69,6 +89,5 @@ const selectPublicAppPrompt = async ({
 };
 
 module.exports = {
-  fetchPublicAppOptions,
   selectPublicAppPrompt,
 };

package/lib/sandboxSync.js

@@ -2,12 +2,7 @@ const SpinniesManager = require('./ui/SpinniesManager');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { i18n } = require('./lang');
-const { isDevelopmentSandbox } = require('./accountTypes');
-const {
-  getAvailableSyncTypes,
-  pollSyncTaskStatus,
-  syncTypes,
-} = require('./sandboxes');
+const { getAvailableSyncTypes } = require('./sandboxes');
 const { initiateSync } = require('@hubspot/local-dev-lib/sandboxes');
 const {
   debugErrorAndContext,
@@ -19,7 +14,13 @@ const {
 } = require('@hubspot/local-dev-lib/errors/apiErrors');
 const { getSandboxTypeAsString } = require('./sandboxes');
 const { getAccountId } = require('@hubspot/local-dev-lib/config');
-const { uiAccountDescription } = require('./ui');
+const {
+  uiAccountDescription,
+  uiLine,
+  uiLink,
+  uiCommandDisabledBanner,
+} = require('./ui');
+const { isDevelopmentSandbox } = require('./accountTypes');
 
 const i18nKey = 'lib.sandbox.sync';
 
@@ -28,8 +29,6 @@ const i18nKey = 'lib.sandbox.sync';
  * @param {Object} parentAccountConfig - Account config of parent portal
  * @param {String} env - Environment (QA/Prod)
  * @param {Array} syncTasks - Array of available sync tasks
- * @param {Boolean} allowEarlyTermination - Option to allow a keypress to terminate early
- * @param {Boolean} skipPolling - Option to skip progress bars for polling and let sync run in background
  * @returns
  */
 const syncSandbox = async ({
@@ -37,15 +36,14 @@ const syncSandbox = async ({
   parentAccountConfig,
   env,
   syncTasks,
-  allowEarlyTermination = true,
-  skipPolling = false,
+  slimInfoMessage = false,
 }) => {
   const accountId = getAccountId(accountConfig.portalId);
   const parentAccountId = getAccountId(parentAccountConfig.portalId);
+  const isDevSandbox = isDevelopmentSandbox(accountConfig);
   SpinniesManager.init({
     succeedColor: 'white',
   });
-  let initiateSyncResponse;
   let availableSyncTasks = syncTasks;
 
   const baseUrl = getHubSpotWebsiteOrigin(env);
@@ -70,29 +68,27 @@ const syncSandbox = async ({
       text: i18n(`${i18nKey}.loading.startSync`),
     });
 
-    initiateSyncResponse = await initiateSync(
+    await initiateSync(
       parentAccountId,
       accountId,
       availableSyncTasks,
       accountId
     );
-
-    if (allowEarlyTermination) {
-      logger.log(i18n(`${i18nKey}.info.earlyExit`));
-    }
+    let spinniesText = isDevSandbox
+      ? `${i18nKey}.loading.succeedDevSb`
+      : `${i18nKey}.loading.succeed`;
     SpinniesManager.succeed('sandboxSync', {
-      text: i18n(`${i18nKey}.loading.succeed`, {
-        accountName: uiAccountDescription(accountId),
-      }),
+      text: i18n(
+        slimInfoMessage ? `${i18nKey}.loading.successDevSbInfo` : spinniesText,
+        {
+          accountName: uiAccountDescription(accountId),
+          url: uiLink(
+            i18n(`${i18nKey}.info.syncStatusDetailsLinkText`),
+            syncStatusUrl
+          ),
+        }
+      ),
     });
-    if (skipPolling && isDevelopmentSandbox(accountConfig)) {
-      if (syncTasks.some(t => t.type === syncTypes.OBJECT_RECORDS)) {
-        logger.log(i18n(`${i18nKey}.loading.skipPollingWithContacts`));
-      } else {
-        logger.log(i18n(`${i18nKey}.loading.skipPolling`));
-      }
-      logger.log('');
-    }
   } catch (err) {
     debugErrorAndContext(err);
 
@@ -157,6 +153,15 @@ const syncSandbox = async ({
           account: uiAccountDescription(accountId),
         })
       );
+    } else if (
+      isSpecifiedError(err, {
+        statusCode: 404,
+      })
+    ) {
+      uiCommandDisabledBanner(
+        'hs sandbox sync',
+        'https://app.hubspot.com/l/docs/guides/crm/project-cli-commands#developer-projects-cli-commands-beta'
+      );
     } else {
       logErrorInstance(err);
     }
@@ -164,46 +169,22 @@ const syncSandbox = async ({
     throw err;
   }
 
-  if (!skipPolling) {
-    try {
-      logger.log('');
-      logger.log('Sync progress:');
-      // Poll sync task status to show progress bars
-      await pollSyncTaskStatus(
-        parentAccountId,
-        initiateSyncResponse.id,
-        syncStatusUrl,
-        allowEarlyTermination
-      );
-
-      logger.log('');
-      SpinniesManager.add('syncComplete', {
-        text: i18n(`${i18nKey}.polling.syncing`),
-      });
-      SpinniesManager.succeed('syncComplete', {
-        text: i18n(`${i18nKey}.polling.succeed`),
-      });
-      logger.log('');
-      logger.log(
-        i18n(`${i18nKey}.info.syncStatus`, {
-          url: syncStatusUrl,
-        })
-      );
-    } catch (err) {
-      // If polling fails at this point, we do not track a failed sync since it is running in the background.
-      logErrorInstance(err);
-
-      SpinniesManager.add('syncComplete', {
-        text: i18n(`${i18nKey}.polling.syncing`),
-      });
-      SpinniesManager.fail('syncComplete', {
-        text: i18n(`${i18nKey}.polling.fail`, {
-          url: syncStatusUrl,
-        }),
-      });
-
-      throw err;
-    }
+  if (!slimInfoMessage) {
+    logger.log();
+    uiLine();
+    logger.info(
+      i18n(
+        `${i18nKey}.info.${isDevSandbox ? 'syncMessageDevSb' : 'syncMessage'}`,
+        {
+          url: uiLink(
+            i18n(`${i18nKey}.info.syncStatusDetailsLinkText`),
+            syncStatusUrl
+          ),
+        }
+      )
+    );
+    uiLine();
+    logger.log();
   }
 };
 

package/lib/sandboxes.js

@@ -1,9 +1,6 @@
-const { i18n, MISSING_LANGUAGE_DATA_PREFIX } = require('./lang');
-const { handleExit, handleKeypress } = require('./process');
+const { i18n } = require('./lang');
 const { logger } = require('@hubspot/local-dev-lib/logger');
-const { EXIT_CODES } = require('./enums/exitCodes');
 const {
-  fetchTaskStatus,
   fetchTypes,
   getSandboxUsageLimits,
 } = require('@hubspot/local-dev-lib/sandboxes');
@@ -12,7 +9,6 @@ const {
   getAccountId,
   getEnv,
 } = require('@hubspot/local-dev-lib/config');
-const CliProgressMultibarManager = require('./ui/CliProgressMultibarManager');
 const { promptUser } = require('./prompts/promptUtils');
 const { isDevelopmentSandbox } = require('./accountTypes');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
@@ -97,21 +93,22 @@ const getSyncTypesWithContactRecordsPrompt = async (
   syncTasks,
   skipPrompt = false
 ) => {
-  // Fetches sync types based on default account. Parent account required for fetch
-
+  // TODO: remove this entire helper once hs sandbox sync is fully deprecated
+  const isDevSandbox = isDevelopmentSandbox(accountConfig);
+  if (isDevSandbox) {
+    // Disable dev sandbox from syncing contacts
+    return syncTasks.filter(t => t.type !== syncTypes.OBJECT_RECORDS);
+  }
   if (
     syncTasks &&
     syncTasks.some(t => t.type === syncTypes.OBJECT_RECORDS) &&
     !skipPrompt
   ) {
-    const langKey = isDevelopmentSandbox(accountConfig)
-      ? 'developer'
-      : 'standard';
     const { contactRecordsSyncPrompt } = await promptUser([
       {
         name: 'contactRecordsSyncPrompt',
         type: 'confirm',
-        message: i18n(`lib.sandbox.sync.confirm.syncContactRecords.${langKey}`),
+        message: i18n('lib.sandbox.sync.confirm.syncContactRecords.standard'),
       },
     ]);
     if (!contactRecordsSyncPrompt) {
@@ -356,143 +353,6 @@ function handleSandboxCreateError({
   throw err;
 }
 
-const ACTIVE_TASK_POLL_INTERVAL = 1000;
-
-const isTaskComplete = task => {
-  if (!task) {
-    return false;
-  }
-  return task.status === 'COMPLETE';
-};
-
-const incrementBy = (value, multiplier = 3) => {
-  return Math.min(value + Math.floor(Math.random() * multiplier), 99);
-};
-
-/**
- * @param {Number} accountId - Parent portal ID (needs sandbox scopes)
- * @param {String} taksId - Task ID to poll
- * @param {String} syncStatusUrl - Link to UI to check polling status
- * @param {Boolean} allowEarlyTermination - Option to allow a keypress to terminate early
- * @returns {Promise} Interval runs until sync task status is equal to 'COMPLETE'
- */
-function pollSyncTaskStatus(
-  accountId,
-  taskId,
-  syncStatusUrl,
-  allowEarlyTermination = true
-) {
-  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.
-  };
-  let progressCounter = {};
-  let pollInterval;
-  // Handle manual exit for return key and ctrl+c
-  const onTerminate = () => {
-    clearInterval(pollInterval);
-    progressBar.stop();
-    logger.log('');
-    logger.log('Exiting, sync will continue in the background.');
-    logger.log('');
-    logger.log(
-      i18n('lib.sandbox.sync.info.syncStatus', {
-        url: syncStatusUrl,
-      })
-    );
-    process.exit(EXIT_CODES.SUCCESS);
-  };
-  if (allowEarlyTermination) {
-    handleExit(onTerminate);
-    handleKeypress(key => {
-      if (
-        (key && key.ctrl && key.name == 'c') ||
-        key.name === 'enter' ||
-        key.name === 'return'
-      ) {
-        onTerminate();
-      }
-    });
-  }
-  return new Promise((resolve, reject) => {
-    pollInterval = setInterval(async () => {
-      const taskResult = await fetchTaskStatus(accountId, taskId).catch(reject);
-      if (taskResult.tasks) {
-        // Array of sync tasks, eg: workflows, pipelines, object-schemas, etc. with each task containing a status of 'PENDING', 'IN_PROGRESS', 'COMPLETE', and 'FAILURE'
-        for (const task of taskResult.tasks) {
-          // For each sync task, show a progress bar and increment bar each time we run this interval until status is 'COMPLETE'
-          let taskType = task.type;
-          const taskTypeLabel = i18n(`${i18nKey}.${taskType}.label`);
-          if (taskTypeLabel.startsWith(MISSING_LANGUAGE_DATA_PREFIX)) {
-            continue;
-          }
-          if (!progressBar.get(taskType) && !mergeTasks[taskType]) {
-            // skip creation of lead-flows bar because we're combining lead-flows into the forms bar, otherwise create a bar instance for the type
-            progressCounter[taskType] = 0;
-            progressBar.create(taskType, 100, 0, {
-              label: taskTypeLabel,
-            });
-          } else if (mergeTasks[taskType]) {
-            // It's a lead-flow here, merge status into the forms progress bar
-            if (!progressCounter[mergeTasks[taskType]]) {
-              progressCounter[mergeTasks[taskType]] = 0;
-            }
-            const formsTask = taskResult.tasks.filter(
-              t => t.type === mergeTasks[taskType]
-            )[0];
-            const formsTaskStatus = formsTask.status;
-            const leadFlowsTaskStatus = task.status;
-            if (
-              formsTaskStatus !== 'COMPLETE' ||
-              leadFlowsTaskStatus !== 'COMPLETE'
-            ) {
-              // Randomly increment bar while sync is in progress. Sandboxes currently does not have an accurate measurement for progress.
-              progressCounter[mergeTasks[taskType]] = incrementBy(
-                progressCounter[mergeTasks[taskType]]
-              );
-              progressBar.update(
-                mergeTasks[taskType],
-                progressCounter[mergeTasks[taskType]],
-                {
-                  label: i18n(`${i18nKey}.${mergeTasks[taskType]}.label`),
-                }
-              );
-            }
-          }
-          if (progressBar.get(taskType) && task.status === 'COMPLETE') {
-            progressBar.update(taskType, 100, {
-              label: taskTypeLabel,
-            });
-          } else if (
-            // Do not start incrementing for tasks still in PENDING state
-            progressBar.get(taskType) &&
-            task.status === 'PROCESSING'
-          ) {
-            // Randomly increment bar while sync is in progress. Sandboxes currently does not have an accurate measurement for progress.
-            progressCounter[taskType] = incrementBy(
-              progressCounter[taskType],
-              taskType === syncTypes.OBJECT_RECORDS ? 2 : 3 // slower progress for object-records, sync can take up to a few minutes
-            );
-            progressBar.update(taskType, progressCounter[taskType], {
-              label: taskTypeLabel,
-            });
-          }
-        }
-      } else {
-        clearInterval(pollInterval);
-        reject();
-        progressBar.stop();
-      }
-      if (isTaskComplete(taskResult)) {
-        clearInterval(pollInterval);
-        resolve(taskResult);
-        progressBar.stop();
-      }
-    }, ACTIVE_TASK_POLL_INTERVAL);
-  });
-}
-
 module.exports = {
   sandboxTypeMap,
   sandboxApiTypeMap,
@@ -503,6 +363,5 @@ module.exports = {
   validateSandboxUsageLimits,
   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({