@hubspot/cli 5.2.1-beta.8 → 5.3.0

package/commands/project/cloneApp.js

@@ -0,0 +1,208 @@
+const path = require('path');
+const fs = require('fs');
+const {
+  addAccountOptions,
+  addConfigOptions,
+  getAccountId,
+  addUseEnvironmentOptions,
+} = require('../../lib/commonOpts');
+const {
+  trackCommandUsage,
+  trackCommandMetadataUsage,
+} = require('../../lib/usageTracking');
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { i18n } = require('../../lib/lang');
+const {
+  selectPublicAppPrompt,
+} = require('../../lib/prompts/selectPublicAppPrompt');
+const {
+  createProjectPrompt,
+} = require('../../lib/prompts/createProjectPrompt');
+const { poll } = require('../../lib/polling');
+const {
+  uiLine,
+  uiCommandReference,
+  uiAccountDescription,
+} = require('../../lib/ui');
+const SpinniesManager = require('../../lib/ui/SpinniesManager');
+const {
+  logApiErrorInstance,
+  ApiErrorContext,
+} = require('../../lib/errorHandlers/apiErrors');
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+const { isAppDeveloperAccount } = require('../../lib/accountTypes');
+const { writeProjectConfig } = require('../../lib/projects');
+const { PROJECT_CONFIG_FILE } = require('../../lib/constants');
+const {
+  cloneApp,
+  checkCloneStatus,
+  downloadClonedProject,
+} = require('@hubspot/local-dev-lib/api/projects');
+const { getCwd } = require('@hubspot/local-dev-lib/path');
+const { logger } = require('@hubspot/local-dev-lib/logger');
+const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
+const { extractZipArchive } = require('@hubspot/local-dev-lib/archive');
+const {
+  fetchPublicAppMetadata,
+} = require('@hubspot/local-dev-lib/api/appsDev');
+
+const i18nKey = 'commands.project.subcommands.cloneApp';
+
+exports.command = 'clone-app';
+exports.describe = null; // uiBetaTag(i18n(`${i18nKey}.describe`), false);
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options);
+
+  const accountId = getAccountId(options);
+  const accountConfig = getAccountConfig(accountId);
+  const accountName = uiAccountDescription(accountId);
+
+  trackCommandUsage('clone-app', {}, accountId);
+
+  if (!isAppDeveloperAccount(accountConfig)) {
+    uiLine();
+    logger.error(i18n(`${i18nKey}.errors.invalidAccountTypeTitle`));
+    logger.log(
+      i18n(`${i18nKey}.errors.invalidAccountTypeDescription`, {
+        useCommand: uiCommandReference('hs accounts use'),
+        authCommand: uiCommandReference('hs auth'),
+      })
+    );
+    uiLine();
+    process.exit(EXIT_CODES.SUCCESS);
+  }
+
+  let appId;
+  let name;
+  let location;
+  let preventProjectMigrations;
+  let listingInfo;
+  try {
+    appId = options.appId;
+    if (!appId) {
+      const appIdResponse = await selectPublicAppPrompt({
+        accountId,
+        accountName,
+        options,
+        isMigratingApp: false,
+      });
+      appId = appIdResponse.appId;
+    }
+    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;
+
+    const projectResponse = await createProjectPrompt('', options, true);
+    name = projectResponse.name;
+    location = projectResponse.location;
+  } catch (error) {
+    logApiErrorInstance(error, new ApiErrorContext({ accountId }));
+    process.exit(EXIT_CODES.ERROR);
+  }
+  try {
+    SpinniesManager.init();
+
+    SpinniesManager.add('cloneApp', {
+      text: i18n(`${i18nKey}.cloneStatus.inProgress`),
+    });
+
+    const { exportId } = await cloneApp(accountId, appId);
+    const { status } = await poll(checkCloneStatus, accountId, exportId);
+    if (status === 'SUCCESS') {
+      // Ensure correct project folder structure exists
+      const baseDestPath = path.resolve(getCwd(), location);
+      const absoluteDestPath = path.resolve(baseDestPath, 'src', 'app');
+      fs.mkdirSync(absoluteDestPath, { recursive: true });
+
+      // Extract zipped app files and place them in correct directory
+      const zippedApp = await downloadClonedProject(accountId, exportId);
+      await extractZipArchive(zippedApp, name, absoluteDestPath, {
+        includesRootDir: true,
+        hideLogs: true,
+      });
+
+      // Create hsproject.json file
+      const configPath = path.join(baseDestPath, PROJECT_CONFIG_FILE);
+      const configContent = {
+        name,
+        srcDir: 'src',
+        platformVersion: '2023.2',
+      };
+      const success = writeProjectConfig(configPath, configContent);
+
+      const isListed = Boolean(listingInfo);
+      trackCommandMetadataUsage(
+        'clone-app',
+        {
+          projectName: name,
+          appId,
+          status,
+          preventProjectMigrations,
+          isListed,
+        },
+        accountId
+      );
+
+      SpinniesManager.succeed('cloneApp', {
+        text: i18n(`${i18nKey}.cloneStatus.done`),
+        succeedColor: 'white',
+      });
+      if (!success) {
+        logger.error(
+          i18n(`${i18nKey}.errors.couldNotWriteConfigPath`),
+          configPath
+        );
+      }
+      logger.log('');
+      uiLine();
+      logger.success(i18n(`${i18nKey}.cloneStatus.success`, { location }));
+      logger.log('');
+      process.exit(EXIT_CODES.SUCCESS);
+    }
+  } catch (error) {
+    trackCommandMetadataUsage(
+      'clone-app',
+      { projectName: name, appId, status: 'FAILURE', error },
+      accountId
+    );
+
+    SpinniesManager.fail('cloneApp', {
+      text: i18n(`${i18nKey}.cloneStatus.failure`),
+      failColor: 'white',
+    });
+    // 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 }));
+    }
+  }
+};
+
+exports.builder = yargs => {
+  yargs.options({
+    location: {
+      describe: i18n(`${i18nKey}.options.location.describe`),
+      type: 'string',
+    },
+    appId: {
+      describe: i18n(`${i18nKey}.options.appId.describe`),
+      type: 'number',
+    },
+  });
+
+  yargs.example([
+    ['$0 project clone-app', i18n(`${i18nKey}.examples.default`)],
+  ]);
+
+  addConfigOptions(yargs);
+  addAccountOptions(yargs);
+  addUseEnvironmentOptions(yargs);
+
+  return yargs;
+};

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');
@@ -32,6 +34,7 @@ const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const { promptUser } = require('../../lib/prompts/promptUtils');
 const { isAppDeveloperAccount } = require('../../lib/accountTypes');
 const { ensureProjectExists } = require('../../lib/projects');
+const { handleKeypress } = require('../../lib/process');
 const {
   migrateApp,
   checkMigrationStatus,
@@ -42,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';
 
@@ -58,15 +64,16 @@ exports.handler = async options => {
   trackCommandUsage('migrate-app', {}, accountId);
 
   if (!isAppDeveloperAccount(accountConfig)) {
-    logger.error(
-      i18n(`${i18nKey}.errors.invalidAccountType`, {
-        accountName,
-        accountType: accountConfig.accountType,
+    uiLine();
+    logger.error(i18n(`${i18nKey}.errors.invalidAccountTypeTitle`));
+    logger.log(
+      i18n(`${i18nKey}.errors.invalidAccountTypeDescription`, {
         useCommand: uiCommandReference('hs accounts use'),
         authCommand: uiCommandReference('hs auth'),
       })
     );
-    process.exit(EXIT_CODES.ERROR);
+    uiLine();
+    process.exit(EXIT_CODES.SUCCESS);
   }
 
   const { appId } =
@@ -75,38 +82,61 @@ exports.handler = async options => {
       : await selectPublicAppPrompt({
           accountId,
           accountName,
-          options,
-          migrateApp: true,
+          isMigratingApp: true,
         });
 
-  const publicApps = await fetchPublicAppOptions(accountId, accountName);
-  if (!publicApps.find(a => a.id === appId)) {
-    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);
-
-  const projectName = options.name || name;
-  const projectLocation = options.location || location;
+  let projectName;
+  let projectLocation;
+  try {
+    const { name, location } = await createProjectPrompt('', options, true);
 
-  const { projectExists } = await ensureProjectExists(accountId, projectName, {
-    allowCreate: false,
-    noLogs: true,
-  });
+    projectName = options.name || name;
+    projectLocation = options.location || location;
 
-  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);
   }
 
   logger.log('');
   uiLine();
-  logger.log(uiBetaTag(i18n(`${i18nKey}.warning.title`), false));
+  logger.log(uiBetaTag(i18n(`${i18nKey}.warning.title`, { appName }), false));
   logger.log(i18n(`${i18nKey}.warning.projectConversion`));
   logger.log(i18n(`${i18nKey}.warning.appConfig`));
   logger.log('');
@@ -122,6 +152,7 @@ exports.handler = async options => {
     type: 'confirm',
     message: i18n(`${i18nKey}.createAppPrompt`),
   });
+  process.stdin.resume();
 
   if (!shouldCreateApp) {
     process.exit(EXIT_CODES.SUCCESS);
@@ -134,6 +165,14 @@ exports.handler = async options => {
       text: i18n(`${i18nKey}.migrationStatus.inProgress`),
     });
 
+    handleKeypress(async key => {
+      if ((key.ctrl && key.name === 'c') || key.name === 'q') {
+        SpinniesManager.remove('migrateApp');
+        logger.log(i18n(`${i18nKey}.migrationInterrupted`));
+        process.exit(EXIT_CODES.SUCCESS);
+      }
+    });
+
     const migrateResponse = await migrateApp(accountId, appId, projectName);
     const { id } = migrateResponse;
     const pollResponse = await poll(checkMigrationStatus, accountId, id);
@@ -152,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',
@@ -169,14 +215,23 @@ 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',
     });
-    logApiErrorInstance(
-      error.error || error,
-      new ApiErrorContext({ accountId })
-    );
+    // 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 }));
+    }
 
     process.exit(EXIT_CODES.ERROR);
   }

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;
 };