@hubspot/cli 5.3.1 → 5.4.1-beta.0

package/bin/cli.js

@@ -15,6 +15,8 @@ const {
 const { getIsInProject } = require('../lib/projects');
 const pkg = require('../package.json');
 const { i18n } = require('../lib/lang');
+const { EXIT_CODES } = require('../lib/enums/exitCodes');
+const { UI_COLORS, uiCommandReference } = require('../lib/ui');
 
 const removeCommand = require('../commands/remove');
 const initCommand = require('../commands/init');
@@ -41,7 +43,6 @@ const accountsCommand = require('../commands/accounts');
 const sandboxesCommand = require('../commands/sandbox');
 const cmsCommand = require('../commands/cms');
 const feedbackCommand = require('../commands/feedback');
-const { EXIT_CODES } = require('../lib/enums/exitCodes');
 
 const notifier = updateNotifier({
   pkg: { ...pkg, name: '@hubspot/cli' },
@@ -51,12 +52,30 @@ const notifier = updateNotifier({
 
 const i18nKey = 'commands.generalErrors';
 
-const CLI_UPGRADE_MESSAGE =
-  chalk.bold('The CMS CLI is now the HubSpot CLI') +
-  '\n\nTo upgrade, run:\n\nnpm uninstall -g @hubspot/cms-cli\nand npm install -g @hubspot/cli';
+const CMS_CLI_PACKAGE_NAME = '@hubspot/cms-cli';
 
 notifier.notify({
-  message: pkg.name === '@hubspot/cms-cli' ? CLI_UPGRADE_MESSAGE : null,
+  message:
+    pkg.name === CMS_CLI_PACKAGE_NAME
+      ? i18n(`${i18nKey}.updateNotify.cmsUpdateNotification`, {
+          packageName: CMS_CLI_PACKAGE_NAME,
+          updateCommand: uiCommandReference('{updateCommand}'),
+        })
+      : i18n(`${i18nKey}.updateNotify.cliUpdateNotification`, {
+          updateCommand: uiCommandReference('{updateCommand}'),
+        }),
+  defer: false,
+  boxenOptions: {
+    borderColor: UI_COLORS.MARIGOLD_DARK,
+    margin: 1,
+    padding: 1,
+    textAlignment: 'center',
+    borderStyle: 'round',
+    title:
+      pkg.name === CMS_CLI_PACKAGE_NAME
+        ? null
+        : chalk.bold(i18n(`${i18nKey}.updateNotify.notifyTitle`)),
+  },
 });
 
 const getTerminalWidth = () => {

package/commands/__tests__/projects.test.js

@@ -0,0 +1,105 @@
+const { command, describe: projectDescribe, builder } = require('../project');
+
+jest.mock('../project/deploy');
+jest.mock('../project/create');
+jest.mock('../project/upload');
+jest.mock('../project/listBuilds');
+jest.mock('../project/logs');
+jest.mock('../project/watch');
+jest.mock('../project/download');
+jest.mock('../project/open');
+jest.mock('../project/dev');
+jest.mock('../project/add');
+jest.mock('../project/migrateApp');
+jest.mock('../project/cloneApp');
+jest.mock('../project/installDeps');
+jest.mock('../../lib/commonOpts');
+
+const deploy = require('../project/deploy');
+const create = require('../project/create');
+const upload = require('../project/upload');
+const listBuilds = require('../project/listBuilds');
+const logs = require('../project/logs');
+const watch = require('../project/watch');
+const download = require('../project/download');
+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 installDeps = require('../project/installDeps');
+const { addConfigOptions, addAccountOptions } = require('../../lib/commonOpts');
+
+describe('commands/projects', () => {
+  describe('command', () => {
+    it('should have the correct command structure', () => {
+      expect(command).toEqual('project');
+    });
+  });
+
+  describe('describe', () => {
+    it('should contain the beta tag', () => {
+      expect(projectDescribe).toContain('[BETA]');
+    });
+    it('should provide an accurate description of what the command is doing', () => {
+      expect(projectDescribe).toContain(
+        'Commands for working with projects. For more information, visit our documentation: https://developers.hubspot.com/docs/platform/build-and-deploy-using-hubspot-projects'
+      );
+    });
+  });
+
+  describe('builder', () => {
+    let yargs;
+
+    const subcommands = [
+      ['create', create],
+      ['add', add],
+      ['watch', watch],
+      ['dev', dev],
+      ['upload', upload],
+      ['deploy', deploy],
+      ['logs', logs],
+      ['listBuilds', listBuilds],
+      ['download', download],
+      ['open', open],
+      ['migrateApp', migrateApp],
+      ['cloneApp', cloneApp],
+      ['installDeps', installDeps],
+    ];
+
+    beforeEach(() => {
+      yargs = {
+        command: jest.fn().mockImplementation(() => yargs),
+        demandCommand: jest.fn().mockImplementation(() => yargs),
+      };
+    });
+
+    it('should add the config options', () => {
+      builder(yargs);
+      expect(addConfigOptions).toHaveBeenCalledTimes(1);
+      expect(addConfigOptions).toHaveBeenCalledWith(yargs);
+    });
+
+    it('should add the account options', () => {
+      builder(yargs);
+      expect(addAccountOptions).toHaveBeenCalledTimes(1);
+      expect(addAccountOptions).toHaveBeenCalledWith(yargs);
+    });
+
+    it('should add the correct number of sub commands', () => {
+      builder(yargs);
+      expect(yargs.command).toHaveBeenCalledTimes(subcommands.length);
+    });
+
+    it.each(subcommands)('should attach the %s subcommand', (name, module) => {
+      builder(yargs);
+      expect(yargs.command).toHaveBeenCalledWith(module);
+    });
+
+    it('should demand the command takes one positional argument', () => {
+      builder(yargs);
+      expect(yargs.demandCommand).toHaveBeenCalledTimes(1);
+      expect(yargs.demandCommand).toHaveBeenCalledWith(1, '');
+    });
+  });
+});

package/commands/accounts/clean.js

@@ -54,7 +54,7 @@ exports.handler = async options => {
 
   for (const account of filteredTestAccounts) {
     try {
-      await accessTokenForPersonalAccessKey(account.portalId);
+      await accessTokenForPersonalAccessKey(account.portalId, true);
     } catch (error) {
       if (
         isSpecifiedHubSpotAuthError(error, {

package/commands/cms/convertFields.js

@@ -13,6 +13,7 @@ const {
 
 const { trackConvertFieldsUsage } = require('../../lib/usageTracking');
 const { logErrorInstance } = require('../../lib/errorHandlers/standardErrors');
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 const i18nKey = 'commands.convertFields';
 
 exports.command = 'convert-fields';
@@ -24,23 +25,27 @@ const invalidPath = src => {
       path: src,
     })
   );
+  process.exit(EXIT_CODES.ERROR);
 };
 
 exports.handler = async options => {
-  const src = path.resolve(getCwd(), options.src);
-  const themeJSONPath = getThemeJSONPath(src);
-  const projectRoot = themeJSONPath
-    ? path.dirname(themeJSONPath)
-    : path.dirname(getCwd());
   let stats;
+  let projectRoot;
+  let src;
+
   try {
+    src = path.resolve(getCwd(), options.src);
+    const themeJSONPath = getThemeJSONPath(options.src);
+    projectRoot = themeJSONPath
+      ? path.dirname(themeJSONPath)
+      : path.dirname(getCwd());
     stats = fs.statSync(src);
     if (!stats.isFile() && !stats.isDirectory()) {
-      invalidPath(src);
+      invalidPath(options.src);
       return;
     }
   } catch (e) {
-    invalidPath(src);
+    invalidPath(options.src);
   }
 
   trackConvertFieldsUsage('process');
@@ -88,6 +93,7 @@ exports.builder = yargs => {
   yargs.option('src', {
     describe: i18n(`${i18nKey}.positionals.src.describe`),
     type: 'string',
+    demandOption: i18n(`${i18nKey}.errors.missingSrc`),
   });
   yargs.option('fieldOptions', {
     describe: i18n(`${i18nKey}.options.options.describe`),

package/commands/project/__tests__/deploy.test.js

@@ -423,7 +423,7 @@ describe('commands/project/deploy', () => {
 
       expect(logger.error).toHaveBeenCalledTimes(1);
       expect(logger.error).toHaveBeenCalledWith(
-        `The request in account ${accountId} failed due to a client error.`
+        `The request for 'project deploy' in account ${accountId} failed due to a client error.`
       );
       expect(processExitSpy).toHaveBeenCalledTimes(1);
       expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);

package/commands/project/__tests__/installDeps.test.js

@@ -0,0 +1,168 @@
+jest.mock('../../../lib/projects');
+jest.mock('@hubspot/local-dev-lib/logger');
+jest.mock('../../../lib/dependencyManagement');
+jest.mock('../../../lib/prompts/promptUtils');
+jest.mock('../../../lib/usageTracking');
+jest.mock('../../../lib/commonOpts');
+
+const { getProjectConfig } = require('../../../lib/projects');
+const { EXIT_CODES } = require('../../../lib/enums/exitCodes');
+const { logger } = require('@hubspot/local-dev-lib/logger');
+const { trackCommandUsage } = require('../../../lib/usageTracking');
+const { getAccountId } = require('../../../lib/commonOpts');
+const {
+  installPackages,
+  getProjectPackageJsonLocations,
+} = require('../../../lib/dependencyManagement');
+const { promptUser } = require('../../../lib/prompts/promptUtils');
+const {
+  command,
+  describe: installDepsDescribe,
+  builder,
+  handler,
+} = require('../installDeps');
+const path = require('path');
+
+describe('commands/project/installDeps', () => {
+  describe('command', () => {
+    it('should have the correct command string', () => {
+      expect(command).toEqual('install-deps [packages..]');
+    });
+  });
+
+  describe('describe', () => {
+    it('should have the correct description', () => {
+      expect(installDepsDescribe).toEqual(null);
+    });
+  });
+
+  describe('builder', () => {
+    let yargs;
+    beforeEach(() => {
+      yargs = {
+        example: jest.fn().mockImplementation(() => yargs),
+      };
+    });
+
+    it('should add correct examples', () => {
+      builder(yargs);
+      expect(yargs.example).toHaveBeenCalledTimes(1);
+      expect(yargs.example).toHaveBeenCalledWith([
+        ['$0 project install-deps', 'Install the dependencies for the project'],
+        [
+          '$0 project install-deps dependency1 dependency2',
+          'Install the dependencies to one or more project subcomponents',
+        ],
+      ]);
+    });
+  });
+
+  describe('handler', () => {
+    let processExitSpy;
+
+    beforeEach(() => {
+      processExitSpy = jest.spyOn(process, 'exit').mockImplementation(() => {});
+    });
+
+    it('should track the command usage', async () => {
+      const accountId = 999999;
+      getAccountId.mockReturnValue(accountId);
+      await handler({});
+
+      expect(getAccountId).toHaveBeenCalledTimes(1);
+      expect(trackCommandUsage).toHaveBeenCalledTimes(1);
+      expect(trackCommandUsage).toHaveBeenCalledWith(
+        'project-install-deps',
+        null,
+        accountId
+      );
+    });
+
+    it('should handle exceptions', async () => {
+      const error = new Error('Something went super wrong');
+
+      getProjectConfig.mockImplementationOnce(() => {
+        throw error;
+      });
+
+      await handler({});
+
+      expect(logger.debug).toHaveBeenCalledTimes(1);
+      expect(logger.debug).toHaveBeenCalledWith(error);
+
+      expect(logger.error).toHaveBeenCalledTimes(1);
+      expect(logger.error).toHaveBeenCalledWith(error.message);
+
+      expect(processExitSpy).toHaveBeenCalledTimes(1);
+      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+    });
+
+    it('should log an error and exit when the project config is not defined', async () => {
+      getProjectConfig.mockResolvedValueOnce(null);
+      await handler({});
+
+      expect(logger.error).toHaveBeenCalledTimes(1);
+      expect(logger.error).toHaveBeenCalledWith(
+        'No project detected. Run this command from a project directory.'
+      );
+      expect(processExitSpy).toHaveBeenCalledTimes(1);
+      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+    });
+
+    it('should log an error and exit when the project config has no projectDir', async () => {
+      getProjectConfig.mockResolvedValueOnce({ projectDir: null });
+      await handler({});
+
+      expect(logger.error).toHaveBeenCalledTimes(1);
+      expect(logger.error).toHaveBeenCalledWith(
+        'No project detected. Run this command from a project directory.'
+      );
+      expect(processExitSpy).toHaveBeenCalledTimes(1);
+      expect(processExitSpy).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+    });
+
+    it('should prompt for input when packages is defined', async () => {
+      const projectDir = 'src';
+      getProjectConfig.mockResolvedValue({ projectDir });
+      const packageJsonLocation = path.join(projectDir, 'directory1');
+      promptUser.mockResolvedValueOnce(packageJsonLocation);
+      getProjectPackageJsonLocations.mockResolvedValue([packageJsonLocation]);
+      await handler({ packages: ['@hubspot/local-dev-lib'] });
+      expect(getProjectPackageJsonLocations).toHaveBeenCalledTimes(1);
+      expect(promptUser).toHaveBeenCalledTimes(1);
+      expect(promptUser).toHaveBeenCalledWith([
+        {
+          name: 'selectedInstallLocations',
+          type: 'checkbox',
+          when: expect.any(Function),
+          choices: [
+            {
+              name: 'directory1',
+              value: packageJsonLocation,
+            },
+          ],
+          message: 'Choose the project components to install the dependencies:',
+          validate: expect.any(Function),
+        },
+      ]);
+    });
+
+    it('should call installPackages correctly', async () => {
+      const projectDir = 'src';
+      const packageJsonLocation = path.join(projectDir, 'directory1');
+      const installLocations = [packageJsonLocation];
+      const packages = ['@hubspot/local-dev-lib'];
+
+      getProjectConfig.mockResolvedValue({ projectDir });
+      promptUser.mockResolvedValueOnce(packageJsonLocation);
+      getProjectPackageJsonLocations.mockResolvedValue(installLocations);
+      await handler({ packages });
+
+      expect(installPackages).toHaveBeenCalledTimes(1);
+      expect(installPackages).toHaveBeenCalledWith({
+        packages,
+        installLocations,
+      });
+    });
+  });
+});