@hubspot/cli 5.0.2-beta.1 → 5.0.3-beta.1

package/commands/sandbox/sync.js

@@ -10,7 +10,7 @@ const { logger } = require('@hubspot/cli-lib/logger');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { i18n } = require('../../lib/lang');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const { getAccountConfig, getEnv } = require('@hubspot/cli-lib');
+const { getAccountConfig, getEnv } = require('@hubspot/local-dev-lib/config');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
 const { promptUser } = require('../../lib/prompts/promptUtils');
 const { uiLine } = require('../../lib/ui');
@@ -23,13 +23,9 @@ const {
   getSyncTypesWithContactRecordsPrompt,
 } = require('../../lib/sandboxes');
 const { syncSandbox } = require('../../lib/sandbox-sync');
-const { getValidEnv } = require('@hubspot/cli-lib/lib/environment');
-const {
-  isSpecifiedError,
-} = require('@hubspot/cli-lib/errorHandlers/apiErrors');
-const {
-  logErrorInstance,
-} = require('@hubspot/cli-lib/errorHandlers/standardErrors');
+const { getValidEnv } = require('@hubspot/local-dev-lib/environment');
+const { isSpecifiedError } = require('../../lib/errorHandlers/apiErrors');
+const { logErrorInstance } = require('../../lib/errorHandlers/standardErrors');
 
 const i18nKey = 'cli.commands.sandbox.subcommands.sync';
 

package/commands/secrets/addSecret.js

@@ -2,7 +2,7 @@ const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logServerlessFunctionApiErrorInstance,
   ApiErrorContext,
-} = require('@hubspot/cli-lib/errorHandlers');
+} = require('../../lib/errorHandlers/apiErrors');
 const { addSecret } = require('@hubspot/cli-lib/api/secrets');
 
 const { loadAndValidateOptions } = require('../../lib/validation');

package/commands/secrets/deleteSecret.js

@@ -2,7 +2,7 @@ const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logServerlessFunctionApiErrorInstance,
   ApiErrorContext,
-} = require('@hubspot/cli-lib/errorHandlers');
+} = require('../../lib/errorHandlers/apiErrors');
 const { deleteSecret } = require('@hubspot/cli-lib/api/secrets');
 
 const { loadAndValidateOptions } = require('../../lib/validation');

package/commands/secrets/listSecrets.js

@@ -2,7 +2,7 @@ const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logServerlessFunctionApiErrorInstance,
   ApiErrorContext,
-} = require('@hubspot/cli-lib/errorHandlers');
+} = require('../../lib/errorHandlers/apiErrors');
 const { fetchSecrets } = require('@hubspot/cli-lib/api/secrets');
 
 const { loadAndValidateOptions } = require('../../lib/validation');

package/commands/secrets/updateSecret.js

@@ -2,7 +2,7 @@ const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logServerlessFunctionApiErrorInstance,
   ApiErrorContext,
-} = require('@hubspot/cli-lib/errorHandlers');
+} = require('../../lib/errorHandlers/apiErrors');
 const { updateSecret } = require('@hubspot/cli-lib/api/secrets');
 
 const { loadAndValidateOptions } = require('../../lib/validation');

package/commands/upload.js

@@ -10,12 +10,12 @@ const {
 } = require('@hubspot/cli-lib/path');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
-  logErrorInstance,
   ApiErrorContext,
   logApiUploadErrorInstance,
-} = require('@hubspot/cli-lib/errorHandlers');
+} = require('../lib/errorHandlers/apiErrors');
+const { logErrorInstance } = require('../lib/errorHandlers/standardErrors');
 const { validateSrcAndDestPaths } = require('@hubspot/cli-lib/modules');
-const { shouldIgnoreFile } = require('@hubspot/cli-lib/ignoreRules');
+const { shouldIgnoreFile } = require('@hubspot/local-dev-lib/ignoreRules');
 
 const {
   addConfigOptions,

package/lang/en.lyaml

@@ -885,6 +885,8 @@ en:
           options:
             describe: "Options to pass to javascript fields files"
     lib:
+      process:
+        exitDebug: "Attempting to gracefully exit. Triggered by {{ signal }}"
       DevServerManager:
         portConflict: "The port {{ port }} is already in use."
         notInitialized: "The Dev Server Manager must be initialized before it is started."
@@ -917,6 +919,8 @@ en:
           startError: "Failed to start local dev server: {{ message }}"
           fileChangeError: "Failed to notify local dev server of file change: {{ message }}"
       projects:
+        config:
+          srcOutsideProjectDir: "Invalid value for 'srcDir' in {{ projectConfig }}: {{#bold}}srcDir: \"{{ srcDir }}\"{{/bold}}\n\t'srcDir' must be a relative path to a folder under the project root, such as \".\" or \"./src\""
         uploadProjectFiles:
           add: "Uploading {{#bold}}{{ projectName }}{{/bold}} project files to {{ accountIdentifier }}"
           fail: "Failed to upload {{#bold}}{{ projectName }}{{/bold}} project files to {{ accountIdentifier }}"
@@ -994,6 +998,10 @@ en:
             sandboxSyncStandardCommand:
               command: "hs sandbox sync"
               message: "Run {{ command }} to to update all supported assets to your sandbox from production"
+            sampleProjects:
+              linkText: "HubSpot's sample projects"
+              url: "https://developers.hubspot.com/docs/platform/sample-projects?utm_source=cli&utm_content=project_create_whats_next"
+              message: "See {{ link }}"
       commonOpts:
         options:
           portal:
@@ -1259,6 +1267,37 @@ en:
               label: "Lead Flows"
             marketing-email:
               label: "Marketing emails"
+      errorHandlers:
+        standardErrors:
+          errorOccurred: "Error: {{ error }}"
+          errorContext: "Context: {{ context }}"
+          systemErrorOccurred: "A system error has occurred: {{ errorMessage }}"
+          genericErrorOccurred: "A {{ name }} has occurred."
+          unknownErrorOccurred: "An unknown error has occurred"
+        fileSystemErrors:
+          errorOccurred: "An error occurred while {{ fileAction }} {{ filepath }}."
+          errorExplanation: "This is the result of a system error: {{ errorMessage }}"
+        apiErrors:
+          messageDetail: "{{ request }} in account {{ accountId }}"
+          unableToUpload: 'Unable to upload "{{ payload }}.'
+          codes:
+            400: "The {{ messageDetail }} was bad."
+            401: "The {{ messageDetail }} was unauthorized."
+            403MissingScope: "Couldn't run the project command because there are scopes missing in your production account. To update scopes, deactivate your current personal access key for {{ accountId }}, and generate a new one. Then run `hs auth` to update the CLI with the new key."
+            403Gating: "The current target account {{ accountId }} does not have access to HubSpot projects. To opt in to the CRM Development Beta and use projects, visit https://app.hubspot.com/l/whats-new/betas?productUpdateId=13860216."
+            403: "The {{ messageDetail }} was forbidden."
+            404Request: 'The {{ action }} failed because "{{ request }}" was not found in account {{ accountId }}.'
+            404: "The {{ messageDetail }} was not found."
+            429: "The {{ messageDetail }} surpassed the rate limit. Retry in one minute."
+            503: "The {{ messageDetail }} could not be handled at this time. Please try again or visit https://help.hubspot.com/ to submit a ticket or contact HubSpot Support if the issue persists."
+            500generic: "The {{ messageDetail }} failed due to a server error. Please try again or visit https://help.hubspot.com/ to submit a ticket or contact HubSpot Support if the issue persists."
+            400generic: "The {{ messageDetail }} failed due to a client error."
+            generic: "The {{ messageDetail }} failed."
+          verifyAccessKeyAndUserAccess:
+            fetchScopeDataError: "Error verifying access of scopeGroup {{ scopeGroup }}: {{ error }}"
+            portalMissingScope: "Your account does not have access to this action. Talk to an account admin to request it."
+            userMissingScope: "You don't have access to this action. Ask an account admin to change your permissions in Users & Teams settings."
+            genericMissingScope: "Your access key does not allow this action. Please generate a new access key by running `hs auth personalaccesskey`."
 
 
 

package/lib/DevServerManager.js

@@ -4,6 +4,12 @@ const { COMPONENT_TYPES } = require('./projectStructure');
 const { i18n } = require('./lang');
 const { promptUser } = require('./prompts/promptUtils');
 const { DevModeInterface } = require('@hubspot/ui-extensions-dev-server');
+const {
+  startPortManagerServer,
+  portManagerHasActiveServers,
+  stopPortManagerServer,
+  requestPorts,
+} = require('@hubspot/local-dev-lib/portManager');
 
 const i18nKey = 'cli.lib.DevServerManager';
 
@@ -61,6 +67,7 @@ class DevServerManager {
     this.debug = debug;
     this.componentsByType = this.arrangeComponentsByType(components);
 
+    await startPortManagerServer();
     await this.iterateDevServers(
       async (serverInterface, compatibleComponents) => {
         if (serverInterface.setup) {
@@ -86,6 +93,7 @@ class DevServerManager {
             debug: this.debug,
             httpClient,
             projectConfig,
+            requestPorts,
           });
         }
       });
@@ -113,6 +121,12 @@ class DevServerManager {
           await serverInterface.cleanup();
         }
       });
+
+      const hasActiveServers = await portManagerHasActiveServers();
+
+      if (!hasActiveServers) {
+        await stopPortManagerServer();
+      }
     }
   }
 }

package/lib/LocalDevManager.js

@@ -7,7 +7,7 @@ const { logger } = require('@hubspot/cli-lib/logger');
 const {
   getAccountId,
   getConfigDefaultAccount,
-} = require('@hubspot/cli-lib/lib/config');
+} = require('@hubspot/local-dev-lib/config');
 const { PROJECT_CONFIG_FILE } = require('@hubspot/cli-lib/lib/constants');
 const SpinniesManager = require('./SpinniesManager');
 const DevServerManager = require('./DevServerManager');
@@ -141,25 +141,30 @@ class LocalDevManager {
     this.compareLocalProjectToDeployed(runnableComponents);
   }
 
-  async stop() {
-    SpinniesManager.add('cleanupMessage', {
-      text: i18n(`${i18nKey}.exitingStart`),
-    });
-
+  async stop(showProgress = true) {
+    if (showProgress) {
+      SpinniesManager.add('cleanupMessage', {
+        text: i18n(`${i18nKey}.exitingStart`),
+      });
+    }
     await this.stopWatching();
 
     const cleanupSucceeded = await this.devServerCleanup();
 
     if (!cleanupSucceeded) {
-      SpinniesManager.fail('cleanupMessage', {
-        text: i18n(`${i18nKey}.exitingFail`),
-      });
+      if (showProgress) {
+        SpinniesManager.fail('cleanupMessage', {
+          text: i18n(`${i18nKey}.exitingFail`),
+        });
+      }
       process.exit(EXIT_CODES.ERROR);
     }
 
-    SpinniesManager.succeed('cleanupMessage', {
-      text: i18n(`${i18nKey}.exitingSucceed`),
-    });
+    if (showProgress) {
+      SpinniesManager.succeed('cleanupMessage', {
+        text: i18n(`${i18nKey}.exitingSucceed`),
+      });
+    }
     process.exit(EXIT_CODES.SUCCESS);
   }
 

package/lib/__tests__/commonOpts.js

@@ -1,14 +1,14 @@
+const { Mode, DEFAULT_MODE } = require('@hubspot/cli-lib');
 const {
-  Mode,
-  DEFAULT_MODE,
   getAndLoadConfigIfNeeded,
   getAccountId,
   getAccountConfig,
   loadConfigFromEnvironment,
-} = require('@hubspot/cli-lib');
+} = require('@hubspot/local-dev-lib/config');
 const { getMode } = require('../commonOpts');
 
 jest.mock('@hubspot/cli-lib');
+jest.mock('@hubspot/local-dev-lib/config');
 
 describe('@hubspot/cli/lib/commonOpts', () => {
   describe('getMode()', () => {

package/lib/__tests__/projects.test.js

@@ -0,0 +1,144 @@
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const { EXIT_CODES } = require('../enums/exitCodes');
+const projects = require('../projects');
+
+describe('@hubspot/cli/lib/projects', () => {
+  describe('validateProjectConfig()', () => {
+    let realProcess;
+    let projectDir;
+    let exitMock;
+    let errorSpy;
+
+    beforeAll(() => {
+      projectDir = fs.mkdtempSync(path.join(os.tmpdir(), 'projects-'));
+      fs.mkdirSync(path.join(projectDir, 'src'));
+
+      realProcess = process;
+      errorSpy = jest.spyOn(console, 'error');
+    });
+
+    beforeEach(() => {
+      exitMock = jest.fn();
+      global.process = { ...realProcess, exit: exitMock };
+    });
+
+    afterEach(() => {
+      errorSpy.mockClear();
+    });
+
+    afterAll(() => {
+      global.process = realProcess;
+      errorSpy.mockRestore();
+    });
+
+    it('rejects undefined configuration', () => {
+      projects.validateProjectConfig(null, projectDir);
+
+      expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+      expect(errorSpy).toHaveBeenCalledWith(
+        expect.stringMatching(/.*config not found.*/)
+      );
+    });
+
+    it('rejects configuration with missing name', () => {
+      projects.validateProjectConfig({ srcDir: '.' }, projectDir);
+
+      expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+      expect(errorSpy).toHaveBeenCalledWith(
+        expect.stringMatching(/.*missing required fields*/)
+      );
+    });
+
+    it('rejects configuration with missing srcDir', () => {
+      projects.validateProjectConfig({ name: 'hello' }, projectDir);
+
+      expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+      expect(errorSpy).toHaveBeenCalledWith(
+        expect.stringMatching(/.*missing required fields.*/)
+      );
+    });
+
+    describe('rejects configuration with srcDir outside project directory', () => {
+      it('for parent directory', () => {
+        projects.validateProjectConfig(
+          { name: 'hello', srcDir: '..' },
+          projectDir
+        );
+
+        expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+        expect(errorSpy).toHaveBeenCalledWith(
+          expect.stringContaining('srcDir: ".."')
+        );
+      });
+
+      it('for root directory', () => {
+        projects.validateProjectConfig(
+          { name: 'hello', srcDir: '/' },
+          projectDir
+        );
+
+        expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+        expect(errorSpy).toHaveBeenCalledWith(
+          expect.stringContaining('srcDir: "/"')
+        );
+      });
+
+      it('for complicated directory', () => {
+        const srcDir = './src/././../src/../../src';
+
+        projects.validateProjectConfig({ name: 'hello', srcDir }, projectDir);
+
+        expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+        expect(errorSpy).toHaveBeenCalledWith(
+          expect.stringContaining(`srcDir: "${srcDir}"`)
+        );
+      });
+    });
+
+    it('rejects configuration with srcDir that does not exist', () => {
+      projects.validateProjectConfig(
+        { name: 'hello', srcDir: 'foo' },
+        projectDir
+      );
+
+      expect(exitMock).toHaveBeenCalledWith(EXIT_CODES.ERROR);
+      expect(errorSpy).toHaveBeenCalledWith(
+        expect.stringMatching(/.*could not be found in.*/)
+      );
+    });
+
+    describe('accepts configuration with valid srcDir', () => {
+      it('for current directory', () => {
+        projects.validateProjectConfig(
+          { name: 'hello', srcDir: '.' },
+          projectDir
+        );
+
+        expect(exitMock).not.toHaveBeenCalled();
+        expect(errorSpy).not.toHaveBeenCalled();
+      });
+
+      it('for relative directory', () => {
+        projects.validateProjectConfig(
+          { name: 'hello', srcDir: './src' },
+          projectDir
+        );
+
+        expect(exitMock).not.toHaveBeenCalled();
+        expect(errorSpy).not.toHaveBeenCalled();
+      });
+
+      it('for implied relative directory', () => {
+        projects.validateProjectConfig(
+          { name: 'hello', srcDir: 'src' },
+          projectDir
+        );
+
+        expect(exitMock).not.toHaveBeenCalled();
+        expect(errorSpy).not.toHaveBeenCalled();
+      });
+    });
+  });
+});

package/lib/__tests__/validation.js

@@ -1,4 +1,4 @@
-const { getAccountConfig } = require('@hubspot/cli-lib');
+const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
 const { getOauthManager } = require('@hubspot/cli-lib/oauth');
 const {
   accessTokenForPersonalAccessKey,
@@ -8,6 +8,7 @@ const { getAccountId } = require('../commonOpts');
 const { validateAccount } = require('../validation');
 
 jest.mock('@hubspot/cli-lib');
+jest.mock('@hubspot/local-dev-lib/config');
 jest.mock('@hubspot/cli-lib/logger');
 jest.mock('@hubspot/cli-lib/oauth');
 jest.mock('@hubspot/cli-lib/personalAccessKey');

package/lib/commonOpts.js

@@ -1,11 +1,10 @@
 const Logger = require('@hubspot/cli-lib/logger');
+const { DEFAULT_MODE, Mode } = require('@hubspot/cli-lib');
 const {
   getAccountId: getAccountIdFromConfig,
   getAccountConfig,
   getAndLoadConfigIfNeeded,
-  DEFAULT_MODE,
-  Mode,
-} = require('@hubspot/cli-lib');
+} = require('@hubspot/local-dev-lib/config');
 const { i18n } = require('./lang');
 
 const i18nKey = 'cli.lib.commonOpts';