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

package/lib/sandbox-sync.js

@@ -0,0 +1,199 @@
+const Spinnies = require('spinnies');
+const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const {
+  getAvailableSyncTypes,
+  pollSyncTaskStatus,
+  getAccountName,
+  DEVELOPER_SANDBOX,
+  sandboxTypeMap,
+  syncTypes,
+} = require('./sandboxes');
+const { initiateSync } = require('@hubspot/cli-lib/sandboxes');
+const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
+const {
+  isSpecifiedError,
+  isMissingScopeError,
+} = require('@hubspot/cli-lib/errorHandlers/apiErrors');
+const { getSandboxTypeAsString } = require('./sandboxes');
+const { getAccountId } = require('@hubspot/cli-lib');
+const { uiAccountDescription } = require('./ui');
+
+const i18nKey = 'cli.lib.sandbox.sync';
+
+/**
+ * @param {Object} accountConfig - Account config of sandbox portal
+ * @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 ({
+  accountConfig,
+  parentAccountConfig,
+  env,
+  syncTasks,
+  allowEarlyTermination = true,
+  skipPolling = false,
+}) => {
+  const accountId = getAccountId(accountConfig.portalId);
+  const parentAccountId = getAccountId(parentAccountConfig.portalId);
+  const spinnies = new Spinnies({
+    succeedColor: 'white',
+  });
+  let initiateSyncResponse;
+  let availableSyncTasks = syncTasks;
+
+  const baseUrl = getHubSpotWebsiteOrigin(env);
+  const syncStatusUrl = `${baseUrl}/sandboxes-developer/${parentAccountId}/${getSandboxTypeAsString(
+    accountConfig.sandboxAccountType
+  )}`;
+
+  try {
+    // If no sync tasks exist, fetch sync types based on default account. Parent account required for fetch
+    if (
+      !availableSyncTasks ||
+      (typeof availableSyncTasks === 'object' &&
+        availableSyncTasks.length === 0)
+    ) {
+      availableSyncTasks = await getAvailableSyncTypes(
+        parentAccountConfig,
+        accountConfig
+      );
+    }
+
+    spinnies.add('sandboxSync', {
+      text: i18n(`${i18nKey}.loading.startSync`),
+    });
+
+    initiateSyncResponse = await initiateSync(
+      parentAccountId,
+      accountId,
+      availableSyncTasks,
+      accountId
+    );
+
+    if (allowEarlyTermination) {
+      logger.log(i18n(`${i18nKey}.info.earlyExit`));
+    }
+    spinnies.succeed('sandboxSync', {
+      text: i18n(`${i18nKey}.loading.succeed`, {
+        accountName: uiAccountDescription(accountId),
+      }),
+    });
+    if (
+      skipPolling &&
+      sandboxTypeMap[accountConfig.sandboxAccountType] === DEVELOPER_SANDBOX
+    ) {
+      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) {
+    spinnies.fail('sandboxSync', {
+      text: i18n(`${i18nKey}.loading.fail`),
+    });
+
+    logger.log('');
+    if (isMissingScopeError(err)) {
+      logger.error(
+        i18n(`${i18nKey}.failure.missingScopes`, {
+          accountName: getAccountName(parentAccountConfig),
+        })
+      );
+    } else if (
+      isSpecifiedError(err, {
+        statusCode: 429,
+        category: 'RATE_LIMITS',
+        subCategory: 'sandboxes-sync-api.SYNC_IN_PROGRESS',
+      })
+    ) {
+      logger.error(
+        i18n(`${i18nKey}.failure.syncInProgress`, {
+          url: `${baseUrl}/sandboxes-developer/${parentAccountId}/syncactivitylog`,
+        })
+      );
+    } else if (
+      isSpecifiedError(err, {
+        statusCode: 403,
+        category: 'BANNED',
+        subCategory: 'sandboxes-sync-api.SYNC_NOT_ALLOWED_INVALID_USERID',
+      })
+    ) {
+      // 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),
+        })
+      );
+    } else if (
+      isSpecifiedError(err, {
+        statusCode: 404,
+        category: 'OBJECT_NOT_FOUND',
+        subCategory: 'SandboxErrors.SANDBOX_NOT_FOUND',
+      })
+    ) {
+      logger.error(
+        i18n(`${i18nKey}.failure.objectNotFound`, {
+          account: getAccountName(accountConfig),
+        })
+      );
+    } else {
+      logErrorInstance(err);
+    }
+    logger.log('');
+    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('');
+      spinnies.add('syncComplete', {
+        text: i18n(`${i18nKey}.polling.syncing`),
+      });
+      spinnies.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);
+
+      spinnies.add('syncComplete', {
+        text: i18n(`${i18nKey}.polling.syncing`),
+      });
+      spinnies.fail('syncComplete', {
+        text: i18n(`${i18nKey}.polling.fail`, {
+          url: syncStatusUrl,
+        }),
+      });
+
+      throw err;
+    }
+  }
+};
+
+module.exports = {
+  syncSandbox,
+};