@hubspot/cli 4.2.1-beta.1 → 4.2.1-beta.3

package/bin/cli.js

@@ -115,7 +115,7 @@ const argv = yargs
   .option('debug', {
     alias: 'd',
     default: false,
-    describe: 'set log level to debug',
+    describe: 'Set log level to debug',
     type: 'boolean',
   })
   .option('noHyperlinks', {

package/commands/accounts/clean.js

@@ -0,0 +1,139 @@
+const { logger } = require('@hubspot/cli-lib/logger');
+const {
+  accessTokenForPersonalAccessKey,
+} = require('@hubspot/cli-lib/personalAccessKey');
+const { getConfig } = require('@hubspot/cli-lib');
+
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const { i18n } = require('../../lib/lang');
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+const {
+  addConfigOptions,
+  addAccountOptions,
+  addUseEnvironmentOptions,
+  addTestingOptions,
+} = require('../../lib/commonOpts');
+const { getAccountName } = require('../../lib/sandboxes');
+const { promptUser } = require('../../lib/prompts/promptUtils');
+const { getTableContents } = require('@hubspot/cli-lib/lib/table');
+const SpinniesManager = require('../../lib/SpinniesManager');
+const { deleteAccount } = require('@hubspot/cli-lib/lib/config');
+const {
+  isSpecifiedHubSpotAuthError,
+} = require('@hubspot/cli-lib/errorHandlers/apiErrors');
+
+const i18nKey = 'cli.commands.accounts.subcommands.clean';
+
+exports.command = 'clean';
+exports.describe = i18n(`${i18nKey}.describe`);
+
+exports.handler = async options => {
+  const { qa } = options;
+  await loadAndValidateOptions(options, false);
+
+  const config = getConfig();
+
+  trackCommandUsage('accounts-clean', null);
+
+  const filteredTestAccounts = config.portals.filter(p =>
+    qa ? p.env === 'qa' : p.env !== 'qa'
+  );
+
+  if (filteredTestAccounts && filteredTestAccounts.length === 0) {
+    logger.log(i18n(`${i18nKey}.noResults`));
+    process.exit(EXIT_CODES.SUCCESS);
+  }
+
+  const accountsToRemove = [];
+  SpinniesManager.init({
+    succeedColor: 'white',
+  });
+  SpinniesManager.add('accountsClean', {
+    text: i18n(`${i18nKey}.loading.add`),
+  });
+
+  for (const account of filteredTestAccounts) {
+    try {
+      await accessTokenForPersonalAccessKey(account.portalId);
+    } catch (error) {
+      if (
+        isSpecifiedHubSpotAuthError(error, {
+          statusCode: 401,
+          category: 'INVALID_AUTHENTICATION',
+          subCategory: 'LocalDevAuthErrorType.PORTAL_NOT_ACTIVE',
+        }) ||
+        isSpecifiedHubSpotAuthError(error, {
+          statusCode: 404,
+          category: 'INVALID_AUTHENTICATION',
+          subCategory: 'LocalDevAuthErrorType.INVALID_PORTAL_ID',
+        })
+      ) {
+        accountsToRemove.push(account);
+      }
+    }
+  }
+
+  if (accountsToRemove.length > 0) {
+    const oneAccountFound = accountsToRemove.length === 1;
+    SpinniesManager.succeed('accountsClean', {
+      text: i18n(
+        oneAccountFound
+          ? `${i18nKey}.inactiveAccountsFound.one`
+          : `${i18nKey}.inactiveAccountsFound.other`,
+        {
+          count: accountsToRemove.length,
+        }
+      ),
+    });
+    logger.log(
+      getTableContents(
+        accountsToRemove.map(p => [getAccountName(p)]),
+        { border: { bodyLeft: '  ' } }
+      )
+    );
+    const { accountsCleanPrompt } = await promptUser([
+      {
+        name: 'accountsCleanPrompt',
+        type: 'confirm',
+        message: i18n(
+          oneAccountFound
+            ? `${i18nKey}.confirm.one`
+            : `${i18nKey}.confirm.other`,
+          {
+            count: accountsToRemove.length,
+          }
+        ),
+      },
+    ]);
+    if (accountsCleanPrompt) {
+      logger.log('');
+      for (const accountToRemove of accountsToRemove) {
+        await deleteAccount(accountToRemove.name);
+        logger.log(
+          i18n(`${i18nKey}.removeSuccess`, {
+            accountName: getAccountName(accountToRemove),
+          })
+        );
+      }
+    }
+  } else {
+    SpinniesManager.succeed('accountsClean', {
+      text: i18n(`${i18nKey}.noResults`),
+    });
+  }
+
+  logger.log('');
+  process.exit(EXIT_CODES.SUCCESS);
+};
+
+exports.builder = yargs => {
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+  addTestingOptions(yargs, true);
+
+  yargs.example([['$0 accounts clean']]);
+
+  return yargs;
+};

package/commands/accounts/list.js

@@ -71,7 +71,7 @@ const getPortalData = mappedPortalData => {
 };
 
 exports.handler = async options => {
-  await loadAndValidateOptions(options);
+  await loadAndValidateOptions(options, false);
 
   const accountId = getAccountId(options);
 

package/commands/accounts.js

@@ -5,6 +5,7 @@ const rename = require('./accounts/rename');
 const use = require('./accounts/use');
 const info = require('./accounts/info');
 const remove = require('./accounts/remove');
+const clean = require('./accounts/clean');
 
 const i18nKey = 'cli.commands.accounts';
 
@@ -24,6 +25,7 @@ exports.builder = yargs => {
     .command(use)
     .command(info)
     .command(remove)
+    .command(clean)
     .demandCommand(1, '');
 
   return yargs;

package/commands/project/add.js

@@ -11,7 +11,7 @@ const { loadAndValidateOptions } = require('../../lib/validation');
 const i18nKey = 'cli.commands.project.subcommands.add';
 
 exports.command = 'add';
-exports.describe = null; //i18n(`${i18nKey}.describe`);
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   await loadAndValidateOptions(options);

package/commands/project/dev.js

@@ -5,7 +5,10 @@ const {
   addUseEnvironmentOptions,
   addTestingOptions,
 } = require('../../lib/commonOpts');
-const { trackCommandUsage } = require('../../lib/usageTracking');
+const {
+  trackCommandUsage,
+  trackCommandMetadataUsage,
+} = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { i18n } = require('../../lib/lang');
 const { logger } = require('@hubspot/cli-lib/logger');
@@ -17,19 +20,22 @@ const {
   ensureProjectExists,
   handleProjectUpload,
   pollProjectBuildAndDeploy,
+  showPlatformVersionWarning,
 } = require('../../lib/projects');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const { uiAccountDescription, uiBetaMessage, uiLine } = require('../../lib/ui');
+const {
+  uiAccountDescription,
+  uiBetaMessage,
+  uiCommandReference,
+  uiLine,
+} = require('../../lib/ui');
 const { confirmPrompt } = require('../../lib/prompts/promptUtils');
 const {
   selectTargetAccountPrompt,
+  confirmDefaultSandboxAccountPrompt,
 } = require('../../lib/prompts/projectDevTargetAccountPrompt');
 const SpinniesManager = require('../../lib/SpinniesManager');
-const {
-  LocalDevManager,
-  UPLOAD_PERMISSIONS,
-} = require('../../lib/LocalDevManager');
-const LocalDevManagerV2 = require('../../lib/LocalDevManagerV2');
+const LocalDevManager = require('../../lib/LocalDevManager');
 const { isSandbox } = require('../../lib/sandboxes');
 const { getAccountConfig, getEnv } = require('@hubspot/cli-lib');
 const { sandboxNamePrompt } = require('../../lib/prompts/sandboxesPrompt');
@@ -60,7 +66,7 @@ const {
 const i18nKey = 'cli.commands.project.subcommands.dev';
 
 exports.command = 'dev [--account]';
-exports.describe = null; //i18n(`${i18nKey}.describe`);
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   await loadAndValidateOptions(options);
@@ -72,6 +78,9 @@ exports.handler = async options => {
 
   const { projectConfig, projectDir } = await getProjectConfig();
 
+  if (!options.debug) {
+    console.clear();
+  }
   uiBetaMessage(i18n(`${i18nKey}.logs.betaMessage`));
 
   if (!projectConfig) {
@@ -85,7 +94,23 @@ exports.handler = async options => {
   const defaultAccountIsSandbox = isSandbox(accountConfig);
 
   if (!targetAccountId && defaultAccountIsSandbox) {
-    targetAccountId = accountId;
+    logger.log();
+    const useDefaultSandboxAccount = await confirmDefaultSandboxAccountPrompt(
+      accountConfig.name,
+      accountConfig.sandboxAccountType
+    );
+
+    if (useDefaultSandboxAccount) {
+      targetAccountId = accountId;
+    } else {
+      logger.log(
+        i18n(`${i18nKey}.logs.declineDefaultSandboxExplanation`, {
+          useCommand: uiCommandReference('hs accounts use'),
+          devCommand: uiCommandReference('hs project dev'),
+        })
+      );
+      process.exit(EXIT_CODES.SUCCESS);
+    }
   }
 
   if (!targetAccountId) {
@@ -129,6 +154,13 @@ exports.handler = async options => {
     }
     try {
       const { name } = await sandboxNamePrompt(DEVELOPER_SANDBOX);
+
+      trackCommandMetadataUsage(
+        'sandbox-create',
+        { step: 'project-dev' },
+        accountId
+      );
+
       const { result } = await buildSandbox({
         name,
         type: DEVELOPER_SANDBOX,
@@ -159,40 +191,37 @@ exports.handler = async options => {
     }
   }
 
+  logger.log();
   const projectExists = await ensureProjectExists(
     targetAccountId,
     projectConfig.name,
     {
       allowCreate: false,
       noLogs: true,
-      withPolling: true,
+      withPolling: createNewSandbox,
     }
   );
 
-  const isNonSandboxAccount =
-    !defaultAccountIsSandbox && targetAccountId === accountId;
-
-  let uploadPermission = isNonSandboxAccount
-    ? UPLOAD_PERMISSIONS.manual
-    : UPLOAD_PERMISSIONS.always;
+  let deployedBuild;
 
   if (projectExists) {
-    const { sourceIntegration } = await fetchProject(
-      targetAccountId,
-      projectConfig.name
-    );
-    if (options.extension || sourceIntegration) {
-      uploadPermission = UPLOAD_PERMISSIONS.never;
-    }
+    const project = await fetchProject(targetAccountId, projectConfig.name);
+    deployedBuild = project.deployedBuild;
   }
 
   SpinniesManager.init();
 
+  if (!options.debug) {
+    console.clear();
+  }
+  uiBetaMessage(i18n(`${i18nKey}.logs.betaMessage`));
+
   if (!projectExists) {
     // Create the project without prompting if this is a newly created sandbox
     let shouldCreateProject = createNewSandbox;
 
     if (!shouldCreateProject) {
+      logger.log();
       uiLine();
       logger.warn(
         i18n(`${i18nKey}.logs.projectMustExistExplanation`, {
@@ -211,6 +240,8 @@ exports.handler = async options => {
     }
 
     if (shouldCreateProject) {
+      await showPlatformVersionWarning(accountId, projectConfig);
+
       try {
         SpinniesManager.add('createProject', {
           text: i18n(`${i18nKey}.status.creatingProject`, {
@@ -232,23 +263,16 @@ exports.handler = async options => {
       }
     } else {
       // We cannot continue if the project does not exist in the target account
+      logger.log();
       logger.log(i18n(`${i18nKey}.logs.choseNotToCreateProject`));
       process.exit(EXIT_CODES.SUCCESS);
     }
   }
 
-  SpinniesManager.add('devModeSetup', {
-    text: i18n(`${i18nKey}.status.startupMessage`, {
-      projectName: projectConfig.name,
-    }),
-    isParent: true,
-  });
-
   let initialUploadResult;
 
-  // Create an initial build if the project was newly created in the account or if
-  // our upload permission is set to "always"
-  if (!projectExists || uploadPermission === UPLOAD_PERMISSIONS.always) {
+  // Create an initial build if the project was newly created in the account
+  if (!projectExists) {
     initialUploadResult = await handleProjectUpload(
       targetAccountId,
       projectConfig,
@@ -258,8 +282,6 @@ exports.handler = async options => {
     );
 
     if (initialUploadResult.uploadError) {
-      SpinniesManager.fail('devModeSetup');
-
       if (
         isSpecifiedError(initialUploadResult.uploadError, {
           subCategory: ERROR_TYPES.PROJECT_LOCKED,
@@ -279,72 +301,42 @@ exports.handler = async options => {
       }
       process.exit(EXIT_CODES.ERROR);
     }
-  }
-
-  // Let the user know when the initial build or deploy fails
-  // Do this before starting the dev server for v2 behavior because we cannot
-  // run a server on a broken project
-  if (
-    options.extension &&
-    initialUploadResult &&
-    !initialUploadResult.succeeded
-  ) {
-    SpinniesManager.fail('devModeSetup');
-
-    let subTasks = [];
-
-    if (initialUploadResult.buildResult.status === 'FAILURE') {
-      subTasks =
-        initialUploadResult.buildResult[PROJECT_BUILD_TEXT.SUBTASK_KEY];
-    } else if (initialUploadResult.deployResult.status === 'FAILURE') {
-      subTasks =
-        initialUploadResult.deployResult[PROJECT_DEPLOY_TEXT.SUBTASK_KEY];
-    }
 
-    const failedSubTasks = subTasks.filter(task => task.status === 'FAILURE');
+    if (!initialUploadResult.succeeded) {
+      let subTasks = [];
 
-    logger.log();
-    failedSubTasks.forEach(failedSubTask => {
-      console.log(failedSubTask.errorMessage);
-    });
-    logger.log();
+      if (initialUploadResult.buildResult.status === 'FAILURE') {
+        subTasks =
+          initialUploadResult.buildResult[PROJECT_BUILD_TEXT.SUBTASK_KEY];
+      } else if (initialUploadResult.deployResult.status === 'FAILURE') {
+        subTasks =
+          initialUploadResult.deployResult[PROJECT_DEPLOY_TEXT.SUBTASK_KEY];
+      }
 
-    process.exit(EXIT_CODES.ERROR);
-  }
+      const failedSubTasks = subTasks.filter(task => task.status === 'FAILURE');
 
-  SpinniesManager.remove('devModeSetup');
-
-  const LocalDev = options.extension
-    ? new LocalDevManagerV2({
-        debug: options.debug,
-        extension: options.extension,
-        projectConfig,
-        projectDir,
-        targetAccountId,
-      })
-    : new LocalDevManager({
-        debug: options.debug,
-        projectConfig,
-        projectDir,
-        targetAccountId,
-        uploadPermission,
+      logger.log();
+      failedSubTasks.forEach(failedSubTask => {
+        console.log(failedSubTask.errorMessage);
       });
+      logger.log();
 
-  await LocalDev.start();
-
-  // Let the user know when the initial build or deploy fails
-  if (
-    !options.extension &&
-    initialUploadResult &&
-    !initialUploadResult.succeeded
-  ) {
-    if (initialUploadResult.buildResult.status === 'FAILURE') {
-      LocalDev.logBuildError(initialUploadResult.buildResult);
-    } else if (initialUploadResult.deployResult.status === 'FAILURE') {
-      LocalDev.logDeployError(initialUploadResult.deployResult);
+      process.exit(EXIT_CODES.ERROR);
     }
+
+    deployedBuild = initialUploadResult.buildResult;
   }
 
+  const LocalDev = new LocalDevManager({
+    debug: options.debug,
+    deployedBuild,
+    projectConfig,
+    projectDir,
+    targetAccountId,
+  });
+
+  await LocalDev.start();
+
   handleExit(LocalDev.stop);
 };
 
@@ -354,12 +346,6 @@ exports.builder = yargs => {
   addUseEnvironmentOptions(yargs, true);
   addTestingOptions(yargs, true);
 
-  yargs.option('extension', {
-    describe: i18n(`${i18nKey}.options.extension.describe`),
-    type: 'string',
-    hidden: true,
-  });
-
   yargs.example([['$0 project dev', i18n(`${i18nKey}.examples.default`)]]);
 
   return yargs;

package/commands/project/download.js

@@ -17,10 +17,7 @@ const {
   downloadProject,
   fetchProjectBuilds,
 } = require('@hubspot/cli-lib/api/dfs');
-const {
-  createProjectConfig,
-  ensureProjectExists,
-} = require('../../lib/projects');
+const { ensureProjectExists, getProjectConfig } = require('../../lib/projects');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const {
   downloadProjectPrompt,
@@ -36,6 +33,13 @@ exports.describe = i18n(`${i18nKey}.describe`);
 exports.handler = async options => {
   await loadAndValidateOptions(options);
 
+  const { projectConfig } = await getProjectConfig();
+
+  if (projectConfig) {
+    logger.error(i18n(`${i18nKey}.warnings.cannotDownloadWithinProject`));
+    process.exit(EXIT_CODES.ERROR);
+  }
+
   const { project, dest, buildNumber } = options;
   let { project: promptedProjectName } = await downloadProjectPrompt(options);
   let projectName = promptedProjectName || project;
@@ -63,17 +67,6 @@ exports.handler = async options => {
 
     const absoluteDestPath = dest ? path.resolve(getCwd(), dest) : getCwd();
 
-    const projectConfigCreated = await createProjectConfig(
-      absoluteDestPath,
-      projectName,
-      { name: 'no-template' }
-    );
-
-    if (!projectConfigCreated) {
-      logger.log(i18n(`${i18nKey}.logs.downloadCancelled`));
-      process.exit(EXIT_CODES.SUCCESS);
-    }
-
     let buildNumberToDownload = buildNumber;
 
     if (!buildNumberToDownload) {
@@ -98,10 +91,8 @@ exports.handler = async options => {
     await extractZipArchive(
       zippedProject,
       projectName,
-      path.resolve(absoluteDestPath, 'src'),
-      {
-        includesRootDir: false,
-      }
+      path.resolve(absoluteDestPath),
+      { includesRootDir: false }
     );
 
     logger.log(

package/commands/project/listBuilds.js

@@ -7,6 +7,7 @@ const {
   addUseEnvironmentOptions,
 } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
+const { i18n } = require('../../lib/lang');
 const {
   logApiErrorInstance,
   ApiErrorContext,
@@ -31,8 +32,10 @@ const {
 const moment = require('moment');
 const { promptUser } = require('../../lib/prompts/promptUtils');
 
+const i18nKey = 'cli.commands.project.subcommands.listBuilds';
+
 exports.command = 'list-builds [path]';
-exports.describe = false;
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
   await loadAndValidateOptions(options);

package/commands/project/upload.js

@@ -16,6 +16,7 @@ const {
   logFeedbackMessage,
   validateProjectConfig,
   pollProjectBuildAndDeploy,
+  showPlatformVersionWarning,
 } = require('../../lib/projects');
 const { i18n } = require('../../lib/lang');
 const { getAccountConfig } = require('@hubspot/cli-lib');
@@ -48,6 +49,8 @@ exports.handler = async options => {
 
   validateProjectConfig(projectConfig, projectDir);
 
+  await showPlatformVersionWarning(accountId, projectConfig);
+
   await ensureProjectExists(accountId, projectConfig.name, { forceCreate });
 
   try {

package/commands/project/watch.js

@@ -21,6 +21,7 @@ const {
   pollDeployStatus,
   validateProjectConfig,
   logFeedbackMessage,
+  showPlatformVersionWarning,
 } = require('../../lib/projects');
 const {
   cancelStagedBuild,
@@ -97,6 +98,8 @@ exports.handler = async options => {
 
   validateProjectConfig(projectConfig, projectDir);
 
+  await showPlatformVersionWarning(accountId, projectConfig);
+
   await ensureProjectExists(accountId, projectConfig.name);
 
   try {

package/commands/project.js

@@ -1,4 +1,5 @@
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
+const { i18n } = require('../lib/lang');
 const deploy = require('./project/deploy');
 const create = require('./project/create');
 const upload = require('./project/upload');
@@ -10,24 +11,26 @@ const open = require('./project/open');
 const dev = require('./project/dev');
 const add = require('./project/add');
 
+const i18nKey = 'cli.commands.project';
+
 exports.command = 'project';
-exports.describe = false; //'Commands for working with projects';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);
   addAccountOptions(yargs, true);
 
   // TODO: deploy must be updated
-  yargs.command(deploy).demandCommand(1, '');
   yargs.command(create).demandCommand(0, '');
-  yargs.command(upload).demandCommand(0, '');
+  yargs.command(add).demandCommand(0, '');
   yargs.command(watch).demandCommand(0, '');
-  yargs.command(listBuilds).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(dev).demandCommand(0, '');
-  yargs.command(add).demandCommand(0, '');
 
   return yargs;
 };

package/commands/sandbox/create.js

@@ -22,7 +22,10 @@ const {
 } = require('../../lib/sandboxes');
 const { getValidEnv } = require('@hubspot/cli-lib/lib/environment');
 const { logger } = require('@hubspot/cli-lib/logger');
-const { trackCommandUsage } = require('../../lib/usageTracking');
+const {
+  trackCommandUsage,
+  trackCommandMetadataUsage,
+} = require('../../lib/usageTracking');
 const {
   sandboxTypePrompt,
   sandboxNamePrompt,
@@ -153,6 +156,12 @@ exports.handler = async options => {
     // 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,