@hubspot/cli 5.2.1-beta.9 → 5.3.0

package/commands/project/deploy.js

@@ -16,20 +16,55 @@ const {
   fetchProject,
 } = require('@hubspot/local-dev-lib/api/projects');
 const { loadAndValidateOptions } = require('../../lib/validation');
-const { getProjectConfig, pollDeployStatus } = require('../../lib/projects');
+const {
+  getProjectConfig,
+  pollDeployStatus,
+  getProjectDetailUrl,
+} = require('../../lib/projects');
 const { projectNamePrompt } = require('../../lib/prompts/projectNamePrompt');
-const { buildIdPrompt } = require('../../lib/prompts/buildIdPrompt');
+const {
+  deployBuildIdPrompt,
+} = require('../../lib/prompts/deployBuildIdPrompt');
 const { i18n } = require('../../lib/lang');
-const { uiBetaTag } = require('../../lib/ui');
+const { uiBetaTag, uiLink } = require('../../lib/ui');
 const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
 
 const i18nKey = 'commands.project.subcommands.deploy';
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const { uiCommandReference, uiAccountDescription } = require('../../lib/ui');
 
-exports.command = 'deploy [--project] [--buildId]';
+exports.command = 'deploy';
 exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
 
+const validateBuildId = (
+  buildId,
+  deployedBuildId,
+  latestBuildId,
+  projectName,
+  accountId
+) => {
+  if (Number(buildId) > latestBuildId) {
+    return i18n(`${i18nKey}.errors.buildIdDoesNotExist`, {
+      buildId: buildId,
+      projectName,
+      linkToProject: uiLink(
+        i18n(`${i18nKey}.errors.viewProjectsBuilds`),
+        getProjectDetailUrl(projectName, accountId)
+      ),
+    });
+  }
+  if (Number(buildId) === deployedBuildId) {
+    return i18n(`${i18nKey}.errors.buildAlreadyDeployed`, {
+      buildId: buildId,
+      linkToProject: uiLink(
+        i18n(`${i18nKey}.errors.viewProjectsBuilds`),
+        getProjectDetailUrl(projectName, accountId)
+      ),
+    });
+  }
+  return true;
+};
+
 exports.handler = async options => {
   await loadAndValidateOptions(options);
 
@@ -59,27 +94,47 @@ exports.handler = async options => {
   let buildIdToDeploy = buildIdOption;
 
   try {
-    if (!buildIdOption) {
-      const { latestBuild, deployedBuildId } = await fetchProject(
-        accountId,
-        projectName
+    const { latestBuild, deployedBuildId } = await fetchProject(
+      accountId,
+      projectName
+    );
+
+    if (!latestBuild || !latestBuild.buildId) {
+      logger.error(i18n(`${i18nKey}.errors.noBuilds`));
+      return process.exit(EXIT_CODES.ERROR);
+    }
+
+    if (buildIdToDeploy) {
+      const validationResult = validateBuildId(
+        buildIdToDeploy,
+        deployedBuildId,
+        latestBuild.buildId,
+        projectName,
+        accountId
       );
-      if (!latestBuild || !latestBuild.buildId) {
-        logger.error(i18n(`${i18nKey}.errors.noBuilds`));
-        process.exit(EXIT_CODES.ERROR);
+      if (validationResult !== true) {
+        logger.error(validationResult);
+        return process.exit(EXIT_CODES.ERROR);
       }
-      const buildIdPromptResponse = await buildIdPrompt(
+    } else {
+      const deployBuildIdPromptResponse = await deployBuildIdPrompt(
         latestBuild.buildId,
         deployedBuildId,
-        projectName
+        buildId =>
+          validateBuildId(
+            buildId,
+            deployedBuildId,
+            latestBuild.buildId,
+            projectName,
+            accountId
+          )
       );
-
-      buildIdToDeploy = buildIdPromptResponse.buildId;
+      buildIdToDeploy = deployBuildIdPromptResponse.buildId;
     }
 
     if (!buildIdToDeploy) {
       logger.error(i18n(`${i18nKey}.errors.noBuildId`));
-      process.exit(EXIT_CODES.ERROR);
+      return process.exit(EXIT_CODES.ERROR);
     }
 
     const deployResp = await deployProject(
@@ -88,13 +143,13 @@ exports.handler = async options => {
       buildIdToDeploy
     );
 
-    if (deployResp.error) {
+    if (!deployResp || deployResp.error) {
       logger.error(
         i18n(`${i18nKey}.errors.deploy`, {
           details: deployResp.error.message,
         })
       );
-      return;
+      return process.exit(EXIT_CODES.ERROR);
     }
 
     await pollDeployStatus(
@@ -104,7 +159,7 @@ exports.handler = async options => {
       buildIdToDeploy
     );
   } catch (e) {
-    if (e.statusCode === 404) {
+    if (e.response && e.response.status === 404) {
       logger.error(
         i18n(`${i18nKey}.errors.projectNotFound`, {
           projectName: chalk.bold(projectName),
@@ -112,13 +167,12 @@ exports.handler = async options => {
           command: uiCommandReference('hs project upload'),
         })
       );
-    }
-    if (e.statusCode === 400) {
-      logger.error(e.error.message);
+    } else if (e.response && e.response.status === 400) {
+      logger.error(e.message);
     } else {
       logApiErrorInstance(e, new ApiErrorContext({ accountId, projectName }));
     }
-    process.exit(EXIT_CODES.ERROR);
+    return process.exit(EXIT_CODES.ERROR);
   }
 };
 
@@ -128,16 +182,17 @@ exports.builder = yargs => {
       describe: i18n(`${i18nKey}.options.project.describe`),
       type: 'string',
     },
-    buildId: {
-      describe: i18n(`${i18nKey}.options.buildId.describe`),
+    build: {
+      alias: ['buildId'],
+      describe: i18n(`${i18nKey}.options.build.describe`),
       type: 'number',
     },
   });
 
-  yargs.example([['$0 project deploy', i18n(`${i18nKey}.examples.default`)]]);
   yargs.example([
+    ['$0 project deploy', i18n(`${i18nKey}.examples.default`)],
     [
-      '$0 project deploy --project="my-project" --buildId=5',
+      '$0 project deploy --project="my-project" --build=5',
       i18n(`${i18nKey}.examples.withOptions`),
     ],
   ]);

package/commands/project/listBuilds.js

@@ -124,7 +124,7 @@ exports.handler = async options => {
 
     await fetchAndDisplayBuilds(project, { limit });
   } catch (e) {
-    if (e.statusCode === 404) {
+    if (e.response && e.response.status === 404) {
       logger.error(`Project ${projectConfig.name} not found. `);
     } else {
       logApiErrorInstance(

package/commands/project/logs.js

@@ -49,7 +49,7 @@ const getPrivateAppsUrl = accountId => {
 // We currently cannot fetch logs directly to the CLI. See internal CLI issue #413 for more information.
 
 // const handleLogsError = (e, name, projectName) => {
-//   if (e.statusCode === 404) {
+//   if (e.response && e.response.status === 404) {
 //     logger.debug(`Log fetch error: ${e.message}`);
 //     logger.log(i18n(`${i18nKey}.logs.noLogsFound`, { name }));
 //   } else {

package/commands/project/migrateApp.js

@@ -5,14 +5,16 @@ const {
   getAccountId,
   addUseEnvironmentOptions,
 } = require('../../lib/commonOpts');
-const { trackCommandUsage } = require('../../lib/usageTracking');
+const {
+  trackCommandUsage,
+  trackCommandMetadataUsage,
+} = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const {
   createProjectPrompt,
 } = require('../../lib/prompts/createProjectPrompt');
 const { i18n } = require('../../lib/lang');
 const {
-  fetchPublicAppOptions,
   selectPublicAppPrompt,
 } = require('../../lib/prompts/selectPublicAppPrompt');
 const { poll } = require('../../lib/polling');
@@ -43,6 +45,9 @@ const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
 const { downloadProject } = require('@hubspot/local-dev-lib/api/projects');
 const { extractZipArchive } = require('@hubspot/local-dev-lib/archive');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
+const {
+  fetchPublicAppMetadata,
+} = require('@hubspot/local-dev-lib/api/appsDev');
 
 const i18nKey = 'commands.project.subcommands.migrateApp';
 
@@ -68,7 +73,7 @@ exports.handler = async options => {
       })
     );
     uiLine();
-    process.exit(EXIT_CODES.ERROR);
+    process.exit(EXIT_CODES.SUCCESS);
   }
 
   const { appId } =
@@ -77,33 +82,55 @@ exports.handler = async options => {
       : await selectPublicAppPrompt({
           accountId,
           accountName,
-          migrateApp: true,
+          isMigratingApp: true,
         });
 
-  const publicApps = await fetchPublicAppOptions(accountId, accountName);
-  const selectedApp = publicApps.find(a => a.id === appId);
-  const appName = selectedApp ? selectedApp.name : 'app';
-  if (!selectedApp) {
-    logger.error(i18n(`${i18nKey}.errors.invalidAppId`, { appId }));
+  let appName;
+  let preventProjectMigrations;
+  let listingInfo;
+  try {
+    const selectedApp = await fetchPublicAppMetadata(appId, accountId);
+    // preventProjectMigrations returns true if we have not added app to allowlist config.
+    // listingInfo will only exist for marketplace apps
+    preventProjectMigrations = selectedApp.preventProjectMigrations;
+    listingInfo = selectedApp.listingInfo;
+    if (preventProjectMigrations && listingInfo) {
+      logger.error(i18n(`${i18nKey}.errors.invalidApp`, { appId }));
+      process.exit(EXIT_CODES.ERROR);
+    }
+    appName = selectedApp.name;
+  } catch (error) {
+    logApiErrorInstance(error, new ApiErrorContext({ accountId }));
     process.exit(EXIT_CODES.ERROR);
   }
 
-  const { name, location } = await createProjectPrompt('', options, true);
+  let projectName;
+  let projectLocation;
+  try {
+    const { name, location } = await createProjectPrompt('', options, true);
 
-  const projectName = options.name || name;
-  const projectLocation = options.location || location;
+    projectName = options.name || name;
+    projectLocation = options.location || location;
 
-  const { projectExists } = await ensureProjectExists(accountId, projectName, {
-    allowCreate: false,
-    noLogs: true,
-  });
-
-  if (projectExists) {
-    logger.error(
-      i18n(`${i18nKey}.errors.projectAlreadyExists`, {
-        projectName,
-      })
+    const { projectExists } = await ensureProjectExists(
+      accountId,
+      projectName,
+      {
+        allowCreate: false,
+        noLogs: true,
+      }
     );
+
+    if (projectExists) {
+      logger.error(
+        i18n(`${i18nKey}.errors.projectAlreadyExists`, {
+          projectName,
+        })
+      );
+      process.exit(EXIT_CODES.ERROR);
+    }
+  } catch (error) {
+    logApiErrorInstance(error, new ApiErrorContext({ accountId }));
     process.exit(EXIT_CODES.ERROR);
   }
 
@@ -164,6 +191,13 @@ exports.handler = async options => {
         { includesRootDir: true, hideLogs: true }
       );
 
+      const isListed = Boolean(listingInfo);
+      trackCommandMetadataUsage(
+        'migrate-app',
+        { projectName, appId, status, preventProjectMigrations, isListed },
+        accountId
+      );
+
       SpinniesManager.succeed('migrateApp', {
         text: i18n(`${i18nKey}.migrationStatus.done`),
         succeedColor: 'white',
@@ -181,12 +215,20 @@ exports.handler = async options => {
       process.exit(EXIT_CODES.SUCCESS);
     }
   } catch (error) {
+    trackCommandMetadataUsage(
+      'migrate-app',
+      { projectName, appId, status: 'FAILURE', error },
+      accountId
+    );
     SpinniesManager.fail('migrateApp', {
       text: i18n(`${i18nKey}.migrationStatus.failure`),
       failColor: 'white',
     });
-    if (error.errors) {
-      error.errors.forEach(logApiErrorInstance);
+    // Migrations endpoints return a response object with an errors property. The errors property contains an array of errors.
+    if (error.errors && Array.isArray(error.errors)) {
+      error.errors.forEach(e =>
+        logApiErrorInstance(e, new ApiErrorContext({ accountId }))
+      );
     } else {
       logApiErrorInstance(error, new ApiErrorContext({ accountId }));
     }

package/commands/project/upload.js

@@ -92,7 +92,7 @@ exports.handler = async options => {
       logger.log(
         i18n(`${i18nKey}.logs.autoDeployDisabled`, {
           deployCommand: uiCommandReference(
-            `hs project deploy --buildId=${result.buildId}`
+            `hs project deploy --build=${result.buildId}`
           ),
         })
       );

package/commands/project.js

@@ -12,6 +12,7 @@ const open = require('./project/open');
 const dev = require('./project/dev');
 const add = require('./project/add');
 const migrateApp = require('./project/migrateApp');
+const cloneApp = require('./project/cloneApp');
 
 const i18nKey = 'commands.project';
 
@@ -22,18 +23,20 @@ exports.builder = yargs => {
   addConfigOptions(yargs);
   addAccountOptions(yargs);
 
-  // TODO: deploy must be updated
-  yargs.command(create).demandCommand(0, '');
-  yargs.command(add).demandCommand(0, '');
-  yargs.command(watch).demandCommand(0, '');
-  yargs.command(dev).demandCommand(0, '');
-  yargs.command(upload).demandCommand(0, '');
-  yargs.command(deploy).demandCommand(1, '');
-  yargs.command(logs).demandCommand(1, '');
-  yargs.command(listBuilds).demandCommand(0, '');
-  yargs.command(download).demandCommand(0, '');
-  yargs.command(open).demandCommand(0, '');
-  yargs.command(migrateApp).demandCommand(0, '');
+  yargs
+    .command(create)
+    .command(add)
+    .command(watch)
+    .command(dev)
+    .command(upload)
+    .command(deploy)
+    .command(logs)
+    .command(listBuilds)
+    .command(download)
+    .command(open)
+    .command(migrateApp)
+    .command(cloneApp)
+    .demandCommand(1, '');
 
   return yargs;
 };

package/commands/sandbox/create.js

@@ -9,7 +9,7 @@ const { loadAndValidateOptions } = require('../../lib/validation');
 const { i18n } = require('../../lib/lang');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const { getAccountConfig, getEnv } = require('@hubspot/local-dev-lib/config');
-const { uiFeatureHighlight, uiAccountDescription } = require('../../lib/ui');
+const { uiFeatureHighlight, uiBetaTag } = require('../../lib/ui');
 const {
   sandboxTypeMap,
   getAvailableSyncTypes,
@@ -18,10 +18,7 @@ const {
 } = require('../../lib/sandboxes');
 const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
 const { logger } = require('@hubspot/local-dev-lib/logger');
-const {
-  trackCommandUsage,
-  trackCommandMetadataUsage,
-} = require('../../lib/usageTracking');
+const { trackCommandUsage } = require('../../lib/usageTracking');
 const { sandboxTypePrompt } = require('../../lib/prompts/sandboxesPrompt');
 const { promptUser } = require('../../lib/prompts/promptUtils');
 const { syncSandbox } = require('../../lib/sandboxSync');
@@ -42,7 +39,7 @@ const {
 const i18nKey = 'commands.sandbox.subcommands.create';
 
 exports.command = 'create [--name] [--type]';
-exports.describe = i18n(`${i18nKey}.describe`);
+exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
 
 exports.handler = async options => {
   await loadAndValidateOptions(options);
@@ -120,34 +117,18 @@ exports.handler = async options => {
   }
   const sandboxName = name || namePrompt.name;
 
-  let sandboxSyncPromptResult = true;
-  let contactRecordsSyncPromptResult = true;
+  let contactRecordsSyncPromptResult = false;
   if (!force) {
-    const syncI18nKey = 'lib.sandbox.sync';
-    const sandboxLangKey =
-      sandboxType === HUBSPOT_ACCOUNT_TYPES.DEVELOPMENT_SANDBOX
-        ? 'developer'
-        : 'standard';
-    const { sandboxSyncPrompt } = await promptUser([
-      {
-        name: 'sandboxSyncPrompt',
-        type: 'confirm',
-        message: i18n(`${syncI18nKey}.confirm.createFlow.${sandboxLangKey}`, {
-          parentAccountName: uiAccountDescription(accountId),
-          sandboxName,
-        }),
-      },
-    ]);
-    sandboxSyncPromptResult = sandboxSyncPrompt;
-    // We can prompt for contact records before fetching types since we're starting with a fresh sandbox in create
-    if (sandboxSyncPrompt) {
+    const isStandardSandbox =
+      sandboxType === HUBSPOT_ACCOUNT_TYPES.STANDARD_SANDBOX;
+
+    // Prompt to sync contact records for standard sandboxes only
+    if (isStandardSandbox) {
       const { contactRecordsSyncPrompt } = await promptUser([
         {
           name: 'contactRecordsSyncPrompt',
           type: 'confirm',
-          message: i18n(
-            `${syncI18nKey}.confirm.syncContactRecords.${sandboxLangKey}`
-          ),
+          message: i18n('lib.sandbox.sync.confirm.syncContactRecords.standard'),
         },
       ]);
       contactRecordsSyncPromptResult = contactRecordsSyncPrompt;
@@ -163,15 +144,8 @@ exports.handler = async options => {
       force,
     });
 
-    // Prompt user to sync assets after sandbox creation
     const sandboxAccountConfig = getAccountConfig(result.sandbox.sandboxHubId);
     const handleSyncSandbox = async syncTasks => {
-      // Send tracking event for secondary action, in this case a sandbox sync within the sandbox create flow
-      trackCommandMetadataUsage(
-        'sandbox-sync',
-        { step: 'sandbox-create' },
-        result.sandbox.sandboxHubId
-      );
       await syncSandbox({
         accountConfig: sandboxAccountConfig,
         parentAccountConfig: accountConfig,
@@ -184,18 +158,13 @@ exports.handler = async options => {
         accountConfig,
         sandboxAccountConfig
       );
+
       if (!contactRecordsSyncPromptResult) {
         availableSyncTasks = availableSyncTasks.filter(
           t => t.type !== syncTypes.OBJECT_RECORDS
         );
       }
-      if (!force) {
-        if (sandboxSyncPromptResult) {
-          await handleSyncSandbox(availableSyncTasks);
-        }
-      } else {
-        await handleSyncSandbox(availableSyncTasks);
-      }
+      await handleSyncSandbox(availableSyncTasks);
     } catch (err) {
       logErrorInstance(err);
       throw err;

package/commands/sandbox/delete.js

@@ -33,12 +33,15 @@ const { promptUser } = require('../../lib/prompts/promptUtils');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
 
 const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
-const { uiAccountDescription } = require('../../lib/ui');
+const { uiAccountDescription, uiBetaTag } = require('../../lib/ui');
 
 const i18nKey = 'commands.sandbox.subcommands.delete';
 
 exports.command = 'delete [--account]';
-exports.describe = i18n(`${i18nKey}.describe`);
+exports.describe = exports.describe = uiBetaTag(
+  i18n(`${i18nKey}.describe`),
+  false
+);
 
 exports.handler = async options => {
   await loadAndValidateOptions(options, false);

package/commands/sandbox/sync.js

@@ -13,7 +13,12 @@ const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const { getAccountConfig, getEnv } = require('@hubspot/local-dev-lib/config');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
 const { promptUser } = require('../../lib/prompts/promptUtils');
-const { uiLine, uiAccountDescription } = require('../../lib/ui');
+const {
+  uiLine,
+  uiAccountDescription,
+  uiDeprecatedMessage,
+  uiDeprecatedDescription,
+} = require('../../lib/ui');
 const {
   isSandbox,
   isStandardSandbox,
@@ -35,11 +40,16 @@ const {
 const i18nKey = 'commands.sandbox.subcommands.sync';
 
 exports.command = 'sync';
-exports.describe = i18n(`${i18nKey}.describe`);
+exports.describe = uiDeprecatedDescription(
+  i18n(`${i18nKey}.describe`),
+  'hs sandbox sync'
+);
 
 exports.handler = async options => {
   await loadAndValidateOptions(options);
 
+  uiDeprecatedMessage('hs sandbox sync');
+
   const { force } = options; // For scripting purposes
   const accountId = getAccountId(options);
   const accountConfig = getAccountConfig(accountId);

package/commands/sandbox.js

@@ -1,5 +1,6 @@
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
 const { i18n } = require('../lib/lang');
+const { uiBetaTag } = require('../lib/ui');
 const create = require('./sandbox/create');
 const del = require('./sandbox/delete');
 const sync = require('./sandbox/sync');
@@ -7,7 +8,7 @@ const sync = require('./sandbox/sync');
 const i18nKey = 'commands.sandbox';
 
 exports.command = 'sandbox';
-exports.describe = i18n(`${i18nKey}.describe`);
+exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
 
 exports.builder = yargs => {
   addConfigOptions(yargs);