@hubspot/cli 5.2.1-beta.9 → 5.3.0

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({

package/lib/ui/index.js

@@ -139,13 +139,87 @@ const uiBetaTag = (message, log = true) => {
   }
 };
 
+const uiDeprecatedTag = (message, log = true) => {
+  const i18nKey = 'lib.ui';
+
+  const terminalUISupport = getTerminalUISupport();
+  const tag = i18n(`${i18nKey}.deprecatedTag`);
+
+  const result = `${
+    terminalUISupport.color ? chalk.yellow(tag) : tag
+  } ${message}`;
+
+  if (log) {
+    logger.log(result);
+  } else {
+    return result;
+  }
+};
+
+const uiCommandDisabledBanner = (
+  command,
+  url = undefined,
+  message = undefined
+) => {
+  const i18nKey = 'lib.ui';
+
+  const tag =
+    message ||
+    i18n(`${i18nKey}.disabledMessage`, {
+      command: uiCommandReference(command),
+      url: url ? uiLink(i18n(`${i18nKey}.disabledUrlText`), url) : undefined,
+      npmCommand: uiCommandReference('npm i -g @hubspot/cli@latest'),
+    });
+
+  logger.log();
+  uiLine();
+  logger.error(tag);
+  uiLine();
+  logger.log();
+};
+
+const uiDeprecatedDescription = (
+  message,
+  command,
+  url = undefined,
+  log = false
+) => {
+  const i18nKey = 'lib.ui';
+
+  const tag = i18n(`${i18nKey}.deprecatedDescription`, {
+    message,
+    command: uiCommandReference(command),
+    url,
+  });
+  return uiDeprecatedTag(tag, log);
+};
+
+const uiDeprecatedMessage = (command, url = undefined, message = undefined) => {
+  const i18nKey = 'lib.ui';
+
+  const tag =
+    message ||
+    i18n(`${i18nKey}.deprecatedMessage`, {
+      command: uiCommandReference(command),
+      url: url ? uiLink(i18n(`${i18nKey}.deprecatedUrlText`), url) : undefined,
+    });
+
+  logger.log();
+  uiDeprecatedTag(tag, true);
+  logger.log();
+};
+
 module.exports = {
   UI_COLORS,
   uiAccountDescription,
   uiCommandReference,
   uiBetaTag,
+  uiDeprecatedTag,
   uiFeatureHighlight,
   uiInfoSection,
   uiLine,
   uiLink,
+  uiDeprecatedMessage,
+  uiDeprecatedDescription,
+  uiCommandDisabledBanner,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "5.2.1-beta.9",
+  "version": "5.3.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/local-dev-lib": "1.5.0",
-    "@hubspot/serverless-dev-runtime": "5.2.1-beta.9",
+    "@hubspot/local-dev-lib": "1.10.0",
+    "@hubspot/serverless-dev-runtime": "5.3.0",
     "@hubspot/theme-preview-dev-server": "0.0.7",
     "@hubspot/ui-extensions-dev-server": "0.8.20",
     "archiver": "^5.3.0",
@@ -33,6 +33,7 @@
     "yargs": "15.4.1"
   },
   "devDependencies": {
+    "axios": "^1.7.2",
     "mock-stdin": "^1.0.0"
   },
   "engines": {
@@ -45,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3b67796a5b4eee5dd8d78fd7407d5b44e81cd3da"
+  "gitHead": "f55582baa2ac86396c72861b31998e54580c8c6a"
 }

package/lib/prompts/buildIdPrompt.js

@@ -1,35 +0,0 @@
-const { promptUser } = require('./promptUtils');
-const { i18n } = require('../lang');
-
-const i18nKey = 'lib.prompts.buildIdPrompt';
-
-const buildIdPrompt = (latestBuildId, deployedBuildId, projectName) => {
-  return promptUser({
-    name: 'buildId',
-    message: i18n(`${i18nKey}.enterBuildId`),
-    default: () => {
-      if (latestBuildId === deployedBuildId) {
-        return;
-      }
-      return latestBuildId;
-    },
-    validate: val => {
-      if (Number(val) > latestBuildId) {
-        return i18n(`${i18nKey}.errors.buildIdDoesNotExist`, {
-          buildId: val,
-          projectName,
-        });
-      }
-      if (Number(val) === deployedBuildId) {
-        return i18n(`${i18nKey}.errors.buildAlreadyDeployed`, {
-          buildId: val,
-        });
-      }
-      return true;
-    },
-  });
-};
-
-module.exports = {
-  buildIdPrompt,
-};

package/lib/ui/CliProgressMultibarManager.js

@@ -1,66 +0,0 @@
-// https://github.com/npkgz/cli-progress/blob/master/README.md
-const ProgressMultibarManager = require('cli-progress');
-
-class CliProgressMultibarManager {
-  constructor() {
-    this.multibar = null;
-    this.barInstances = {};
-  }
-
-  init(options) {
-    if (!this.multibar) {
-      this.multibar = new ProgressMultibarManager.MultiBar(
-        {
-          hideCursor: true,
-          format: '[{bar}] {percentage}% | {label}',
-          gracefulExit: true,
-          ...options,
-        },
-        ProgressMultibarManager.Presets.rect
-      );
-    }
-
-    return {
-      get: this.get.bind(this),
-      create: this.create.bind(this),
-      update: this.update.bind(this),
-      increment: this.increment.bind(this),
-      remove: this.multibar.remove.bind(this.multibar),
-      stop: this.multibar.stop.bind(this.multibar),
-      log: this.multibar.log.bind(this.multibar),
-    };
-  }
-
-  get(barName) {
-    return this.barInstances[barName];
-  }
-
-  create(barName, total = 100, startValue = 0, options = {}) {
-    if (!this.multibar) {
-      return;
-    }
-    if (!this.barInstances[barName]) {
-      this.barInstances[barName] = this.multibar.create(
-        total,
-        startValue,
-        options
-      );
-    }
-  }
-
-  update(barName, value, options = {}) {
-    const barInstance = this.barInstances[barName];
-    if (barInstance) {
-      barInstance.update(value, options);
-    }
-  }
-
-  increment(barName, value, options = {}) {
-    const barInstance = this.barInstances[barName];
-    if (barInstance) {
-      barInstance.increment(value, options);
-    }
-  }
-}
-
-module.exports = new CliProgressMultibarManager();