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

package/commands/sandbox/delete.js

@@ -28,8 +28,8 @@ const { promptUser } = require('../../lib/prompts/promptUtils');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
 const {
   isSpecifiedError,
+  isSpecifiedHubSpotAuthError,
 } = require('@hubspot/cli-lib/errorHandlers/apiErrors');
-const { HubSpotAuthError } = require('@hubspot/cli-lib/lib/models/Errors');
 const { getAccountName } = require('../../lib/sandboxes');
 const { getValidEnv } = require('@hubspot/cli-lib/lib/environment');
 
@@ -168,19 +168,15 @@ exports.handler = async options => {
   } catch (err) {
     debugErrorAndContext(err);
 
-    if (err instanceof HubSpotAuthError) {
+    if (isSpecifiedHubSpotAuthError(err, { statusCode: 401 })) {
       // Intercept invalid key error
       // This command uses the parent portal PAK to delete a sandbox, so we must specify which account needs a new key
-      const regex = /\bYour personal access key is invalid\b/;
-      const match = err.message.match(regex);
-      if (match && match[0]) {
-        logger.log('');
-        logger.error(
-          i18n(`${i18nKey}.failure.invalidKey`, {
-            account: getAccountName(parentAccount),
-          })
-        );
-      }
+      logger.log('');
+      logger.error(
+        i18n(`${i18nKey}.failure.invalidKey`, {
+          account: getAccountName(parentAccount),
+        })
+      );
     } else if (
       isSpecifiedError(err, {
         statusCode: 403,

package/commands/sandbox.js

@@ -1,12 +1,13 @@
 const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
+const { i18n } = require('../lib/lang');
 const create = require('./sandbox/create');
 const del = require('./sandbox/delete');
 const sync = require('./sandbox/sync');
 
-// const i18nKey = 'cli.commands.sandbox';
+const i18nKey = 'cli.commands.sandbox';
 
 exports.command = 'sandbox';
-exports.describe = false; // i18n(`${i18nKey}.describe`);
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.builder = yargs => {
   addConfigOptions(yargs, true);

package/lang/en.lyaml

@@ -67,6 +67,18 @@ en:
               nameBased: "Print information for the account in the config with name equal to \"MyAccount\""
             name: "{{#bold}}Account name{{/bold}}: {{ name }}"
             scopeGroups: "{{#bold}}Scopes available{{/bold}}:"
+          clean:
+            describe: "Checks for inactive accounts and removes them from the CLI config"
+            noResults: "No inactive accounts found to remove."
+            loading:
+              add: "Looking for inactive accounts…"
+            inactiveAccountsFound:
+              one: "1 inactive account found:"
+              other: "{{ count }} inactive accounts found:"
+            confirm:
+              one: "Remove 1 inactive account from the CLI config?"
+              other: "Remove {{ count }} inactive accounts from the CLI config?"
+            removeSuccess: "Removed {{ accountName }} from the CLI config."
       auth:
         describe: "Configure authentication for a HubSpot account. Supported authentication protocols are {{ supportedProtocols }}."
         errors:
@@ -444,9 +456,10 @@ en:
             describe: "Shortcut of the link you'd like to open"
         selectLink: "Select a link to open"
       project:
+        describe: "{{#bold}}[beta]{{/bold}} Commands for working with projects. For more information, visit our documentation: https://developers.hubspot.com/docs/platform/build-and-deploy-using-hubspot-projects"
         subcommands:
           dev:
-            describe: "Start local dev for the current project"
+            describe: "{{#bold}}[beta]{{/bold}} Start local dev for the current project"
             logs:
               betaMessage: "HubSpot projects local development"
               nonSandboxWarning: "Testing in a sandbox is strongly recommended. To switch the target account, select an option below or run {{#bold}}`hs accounts use`{{/bold}} before running the command again."
@@ -454,24 +467,20 @@ en:
               projectMustExistExplanation: "The project {{ projectName }} does not exist in the target account {{ accountIdentifier}}. This command requires the project to exist in the target account."
               choseNotToCreateProject: "Exiting because this command requires the project to exist in the target account."
               initialUploadMessage: "HubSpot Local Dev Server Startup"
+              declineDefaultSandboxExplanation: "To develop on a different account, run {{ useCommand }} to change your default account, then re-run {{ devCommand }}."
             status:
               creatingProject: "Creating project {{ projectName }} in {{ accountIdentifier }}"
               createdProject: "Created project {{ projectName }} in {{ accountIdentifier }}"
               failedToCreateProject: "Failed to create project in the target account."
-              startupMessage: "Starting local dev server for {{#bold}}{{ projectName }}{{/bold}} ..."
             prompt:
               createProject: "Create new project {{ projectName}} in {{#bold}}[{{ accountIdentifier }}]{{/bold}}?"
-              targetNonSandbox: "Continue testing in a non-sandbox account?"
-            options:
-              extension:
-                describe: "The extension that you would like to run locally"
             errors:
               noProjectConfig: "No project detected. Please run this command again from a project directory."
-              projectLockedError: "Your project is locked. This may mean that another user is running the {{#bold}}`hs project dev`{{/bold}} command for this project. If this is you, unlock the project in Projects UI."
+              projectLockedError: "Your project is locked. This may mean that another user is running the {{#bold}}`hs project watch`{{/bold}} command for this project. If this is you, unlock the project in Projects UI."
             examples:
               default: "Start local dev for the current project"
           create:
-            describe: "Create a new project"
+            describe: "{{#bold}}[beta]{{/bold}} Create a new project"
             logs:
               welcomeMessage: "Welcome to HubSpot Developer Projects!"
             examples:
@@ -486,7 +495,7 @@ en:
               templateSource:
                 describe: "Path to custom GitHub repository from which to create project template"
           add:
-            describe: "Create a new component within a project"
+            describe: "{{#bold}}[beta]{{/bold}} Create a new component within a project"
             options:
               name:
                 describe: "Component name"
@@ -501,7 +510,7 @@ en:
             examples:
               default: "Create a component within your project"
           deploy:
-            describe: "Deploy a project build"
+            describe: "{{#bold}}[beta]{{/bold}} Deploy a project build"
             debug:
               deploying: "Deploying project at path: {{ path }}"
             errors:
@@ -516,8 +525,10 @@ en:
                 describe: "Project build ID to be deployed"
               project:
                 describe: "Project name"
+          listBuilds:
+            describe: "{{#bold}}[beta]{{/bold}} List the project's builds"
           logs:
-            describe: "Get execution logs for a serverless function within a project"
+            describe: "{{#bold}}[beta]{{/bold}} Get execution logs for a serverless function within a project"
             errors:
               invalidAppName: "Could not find app with name \"{{ appName }}\" in project \"{{ projectName }}\""
             logs:
@@ -552,7 +563,7 @@ en:
               endpoint:
                 describe: "Public endpoint path"
           upload:
-            describe: "Upload your project files and create a new build"
+            describe: "{{#bold}}[beta]{{/bold}} Upload your project files and create a new build"
             examples:
               default: "Upload a project"
             logs:
@@ -570,7 +581,7 @@ en:
               path:
                 describe: "Path to a project folder"
           watch:
-            describe: "Watch your local project for changes and automatically upload changed files to a new build in HubSpot"
+            describe: "{{#bold}}[beta]{{/bold}} Watch your local project for changes and automatically upload changed files to a new build in HubSpot"
             examples:
               default: "Watch a project within the myProjectFolder folder"
             logs:
@@ -582,7 +593,7 @@ en:
               initialUpload:
                 describe: "Upload directory before watching for updates"
           download:
-            describe: "Download your project files from HubSpot and write to a path on your computer"
+            describe: "{{#bold}}[beta]{{/bold}} Download your project files from HubSpot and write to a path on your computer"
             examples:
               default: "Download the project myProject into myProjectFolder folder"
             logs:
@@ -591,6 +602,8 @@ en:
             errors:
               downloadFailed: "Something went wrong downloading the project"
               projectNotFound: "Your project {{ projectName }} could not be found in {{ accountId }}"
+            warnings:
+              cannotDownloadWithinProject: "Cancelling project download. Please run the command again outside the context of an existing project."
             options:
               buildNumber:
                 describe: "The build number to download"
@@ -599,7 +612,7 @@ en:
               dest:
                 describe: "Destination folder for the project"
           open:
-            describe: "Open available projects for the specified account"
+            describe: "{{#bold}}[beta]{{/bold}} Open the specified project's details page in the browser"
             options:
               project:
                 describe: "Name of project to open"
@@ -848,58 +861,35 @@ en:
     lib:
       DevServerManager:
         portConflict: "The port {{ port }} is already in use."
-      LocalDevManagerV2:
+        notInitialized: "The Dev Server Manager must be initialized before it is started."
+        noCompatibleComponents: "Skipping call to {{ serverKey }} because there are no compatible components in the project."
+      LocalDevManager:
         failedToInitialize: "Missing required arguments to initialize Local Dev"
+        noComponents: "There are no components in this project."
+        noDeployedBuild: "There is no deployed build for this project in {{ accountIdentifier }}."
+        noRunnableComponents: "There are no components in this project that support local development."
         betaMessage: "HubSpot projects local development"
         running: "Running {{#bold}}{{ projectName }}{{/bold}} locally on {{ accountIdentifier }}, waiting for changes ..."
         quitHelper: "Press {{#bold}}'q'{{/bold}} to stop the local dev server"
-        viewInHubSpotLink: "View in HubSpot"
+        viewInHubSpotLink: "View project in HubSpot"
         exitingStart: "Stopping local dev server ..."
         exitingSucceed: "Successfully exited"
         exitingFail: "Failed to cleanup before exiting"
+        uploadWarning:
+          appLabel: "[App]"
+          uiExtensionLabel: "[UI Extension]"
+          configEdit: "You edited the configuration file {{#bold}}{{ path }}{{/bold}}. Changes to configuration files cannot be handled by the local dev server."
+          missingComponents: "The deployed build for this project does not contain {{#bold}}'{{ missingComponents }}'{{/bold}}. This may cause issues in local development."
+          header: "{{ reason }} To reflect these changes:"
+          stopDev: "  * Stop {{ command }}"
+          runUpload: "  * Run {{ command }}"
+          runUploadWithAccount: "  * Run {{ command }}"
+          restartDev: "  * Re-run {{ command }}"
         devServer:
           cleanupError: "Failed to cleanup local dev server: {{ message }}"
+          setupError: "Failed to setup local dev server: {{ message }}"
           startError: "Failed to start local dev server: {{ message }}"
-      LocalDevManager:
-        failedToInitialize: "Missing required arguments to initialize Local Dev Manager"
-        exitingStart: "Stopping local dev server ..."
-        exitingSucceed: "Successfully exited"
-        exitingFail: "Failed to clean up before exiting"
-        previousStagingBuildCancelled: "Failed to create a staging build because the project was already locked. It is now unlocked. Run the command again."
-        cancelledFromUI: "The dev process has been cancelled from the UI. Any changes made since cancelling have not been uploaded. To resume dev mode, rerun {{#yellow}}`hs project dev`{{/yellow}}."
-        header:
-          betaMessage: "{{#yellow}}{{#bold}}[beta]{{/bold}}{{/yellow}} HubSpot projects local development"
-          running: "Running {{#bold}}{{ projectName }}{{/bold}} locally on {{ accountIdentifier }}, waiting for changes ..."
-          quitHelper: "Press {{#bold}}'q'{{/bold}} to stop the local dev server"
-          viewInHubSpotLink: "View in HubSpot"
-          status:
-            clean: "{{#bold}}Status:{{/bold}} {{#green}}Everything up to date{{/green}}"
-            buildError: "{{#bold}}Status:{{/bold}} {{#red}}Latest build failed{{/red}}"
-            deployError: "{{#bold}}Status:{{/bold}} {{#red}}Latest deploy failed{{/red}}"
-            uploadPending: "{{#bold}}Status:{{/bold}} {{#yellow}}Upload is pending{{/yellow}}"
-            noUploadsAllowed: "{{#bold}}Status:{{/bold}} {{#red}}Change requires upload, but uploads are not allowed{{/red}}"
-            manualUploadRequired: "{{#bold}}Status:{{/bold}} {{#yellow}}Change requires manual upload{{/yellow}}"
-            manualUpload: "{{#bold}}Status:{{/bold}} {{#green}}Manually uploading pending changes{{/green}}"
-        upload:
-          noUploadsAllowed: "The change to {{ filePath }} requires an upload, but the CLI cannot upload to a project that is using a github integration."
-          manualUploadSkipped: "Manually upload and deploy project to production account: {{#green}}(n){{/green}}"
-          manualUploadConfirmed: "Manually upload and deploy project to production account: {{#green}}(Y){{/green}}"
-          manualUploadRequired: "Project file changes require a manual upload and deploy ..."
-          manualUploadExplanation1: "{{#yellow}}> Dev server is running on a {{#bold}}non-sandbox account{{/bold}}.{{/yellow}}"
-          manualUploadExplanation2: "{{#yellow}}> Uploading changes may overwrite production data.{{/yellow}}"
-          manualUploadPrompt: "? Manually upload and deploy project? {{#green}}Y/n{{/green}}"
-          extensionNotAllowed: "Extension not allowed for {{ filePath }}"
-          fileIgnored: "File ignored: {{ filePath }}"
-          uploadingAddChange: "[INFO] Uploading {{ filePath }}"
-          uploadedAddChange: "[INFO] Uploaded {{ filePath }}"
-          uploadingRemoveChange: "[INFO] Removing {{ filePath }}"
-          uploadedRemoveChange: "[INFO] Removed {{ filePath }}"
-          uploadingChanges: "{{#bold}}Building #{{ buildId }} and deploying recent changes on {{ accountIdentifier }}{{/bold}}"
-          uploadedChangesSucceeded: "{{#bold}}Built #{{ buildId }} and deployed recent changes on {{ accountIdentifier }}{{/bold}}"
-          uploadedChangesFailed: "{{#bold}}Failed to build #{{ buildId }} and deploy recent changes on {{ accountIdentifier }}{{/bold}}"
-        devServer:
-          startError: "{{#red}}[ERROR]{{/red}} Failed to start local dev server"
-          cleanupError: "{{#red}}[ERROR]{{/red}} Failed to cleanup local dev server"
+          fileChangeError: "Failed to notify local dev server of file change: {{ message }}"
       projects:
         uploadProjectFiles:
           add: "Uploading {{#bold}}{{ projectName }}{{/bold}} project files to {{ accountIdentifier }}"
@@ -914,6 +904,8 @@ en:
           createPrompt: "The project {{ projectName }} does not exist in {{ accountIdentifier }}. Would you like to create it?"
           createSuccess: "New project {{#bold}}{{ projectName }}{{/bold}} successfully created in {{#bold}}{{ accountIdentifier }}{{/bold}}."
           notFound: "Your project {{#bold}}{{ projectName }}{{/bold}} could not be found in {{#bold}}{{ accountIdentifier }}{{/bold}}."
+        pollFetchProject:
+          checkingProject: "Checking if project exists in {{ accountIdentifier }}"
         makePollTaskStatusFunc:
           componentCountSingular: "Found 1 component in this project"
           componentCount: "Found {{ numComponents }} components in this project"
@@ -925,8 +917,11 @@ en:
         logFeedbackMessage:
           feedbackHeader: "We'd love to hear your feedback!"
           feedbackMessage: "How are you liking the new projects and developer tools? \n > Run `{{#yellow}}hs feedback{{/yellow}}` to let us know what you think!\n"
+        showPlatformVersionWarning:
+          noPlatformVersion: "No platformVersion found in hsproject.json. Falling back to version \"{{ defaultVersion }}\"."
+          noPlatformVersionAlt: "No platformVersion found in hsproject.json. Falling back to default version."
       ui:
-        betaTag: "{{#bold}}[beta]{{/bold}}"
+        betaTag: "{{#bold}}[BETA]{{/bold}}"
         betaWarning:
           header: "{{#yellow}}***************************** WARNING ****************************{{/yellow}}"
           footer: "{{#yellow}}******************************************************************{{/yellow}}"
@@ -992,9 +987,10 @@ en:
       prompts:
         projectDevTargetAccountPrompt:
           createNewSandboxOption: "<Test on a new development sandbox>"
-          chooseDefaultAccountOption: "<{{#bold}}!{{/bold}} Test on this production account {{#bold}}!{{/bold}}>"
+          chooseDefaultAccountOption: "<{{#bold}}\U00002757{{/bold}} Test on this production account {{#bold}}\U00002757{{/bold}}>"
           promptMessage: "[--account] Choose a sandbox under {{ accountIdentifier }} to test with:"
           sandboxLimit: "You’ve reached the limit of {{ limit }} development sandboxes"
+          confirmDefaultSandboxAccount: "Continue testing on {{#bold}}{{ accountName }} ({{ accountType }}){{/bold}}? (Y/n)"
         projectLogsPrompt:
           projectName:
             message: "[--project] Enter the project name:"

package/lib/DevServerManager.js

@@ -1,31 +1,30 @@
-const express = require('express');
-const bodyParser = require('body-parser');
-const cors = require('cors');
-const { walk } = require('@hubspot/cli-lib/lib/walk');
-const { getProjectDetailUrl } = require('./projects');
-const { i18n } = require('./lang');
-const { EXIT_CODES } = require('./enums/exitCodes');
+const httpClient = require('@hubspot/cli-lib/http');
 const { logger } = require('@hubspot/cli-lib/logger');
+const { COMPONENT_TYPES } = require('./projectStructure');
+const { i18n } = require('./lang');
+const { promptUser } = require('./prompts/promptUtils');
+const { DevModeInterface } = require('@hubspot/ui-extensions-dev-server');
 
 const i18nKey = 'cli.lib.DevServerManager';
 
-const DEFAULT_PORT = 8080;
+const SERVER_KEYS = {
+  app: 'app',
+};
 
 class DevServerManager {
   constructor() {
     this.initialized = false;
+    this.started = false;
+    this.componentsByType = {};
     this.server = null;
     this.path = null;
-    this.devServers = {};
-  }
-
-  safeLoadServer() {
-    try {
-      const { DevModeInterface } = require('@hubspot/ui-extensions-dev-server');
-      this.devServers['uie'] = DevModeInterface;
-    } catch (e) {
-      logger.debug('Failed to load dev server interface: ', e);
-    }
+    this.devServers = {
+      [SERVER_KEYS.app]: {
+        componentType: COMPONENT_TYPES.app,
+        serverInterface: DevModeInterface,
+      },
+    };
+    this.debug = false;
   }
 
   async iterateDevServers(callback) {
@@ -33,84 +32,87 @@ class DevServerManager {
 
     for (let i = 0; i < serverKeys.length; i++) {
       const serverKey = serverKeys[i];
-      const serverInterface = this.devServers[serverKey];
-      await callback(serverInterface, serverKey);
+      const devServer = this.devServers[serverKey];
+
+      const compatibleComponents =
+        this.componentsByType[devServer.componentType] || {};
+
+      if (Object.keys(compatibleComponents).length) {
+        await callback(devServer.serverInterface, compatibleComponents);
+      } else {
+        logger.debug(i18n(`${i18nKey}.noCompatibleComponents`, { serverKey }));
+      }
     }
   }
 
-  generateURL(path) {
-    return this.path ? `${this.path}/${path}` : null;
+  arrangeComponentsByType(components) {
+    return components.reduce((acc, component) => {
+      if (!acc[component.type]) {
+        acc[component.type] = {};
+      }
+
+      acc[component.type][component.config.name] = component;
+
+      return acc;
+    }, {});
   }
 
-  async start({
-    accountId,
-    debug,
-    extension,
-    projectConfig,
-    projectSourceDir,
-  }) {
-    const app = express();
-
-    // Install Middleware
-    app.use(bodyParser.json({ limit: '50mb' }));
-    app.use(bodyParser.urlencoded({ limit: '50mb', extended: true }));
-    app.use(cors());
-
-    // Configure
-    app.set('trust proxy', true);
-
-    // Initialize a base route
-    app.get('/', (req, res) => {
-      res.send('HubSpot local dev server');
-    });
-
-    // Initialize URL redirects
-    app.get('/hs/project', (req, res) => {
-      res.redirect(getProjectDetailUrl(projectConfig.name, accountId));
-    });
-
-    // Start server
-    this.server = await app.listen(DEFAULT_PORT).on('error', err => {
-      if (err.code === 'EADDRINUSE') {
-        logger.error(i18n(`${i18nKey}.portConflict`, { port: DEFAULT_PORT }));
-        logger.log();
-        process.exit(EXIT_CODES.ERROR);
-      }
-    });
-
-    const projectFiles = await walk(projectSourceDir);
-
-    // Initialize component servers
-    await this.iterateDevServers(async serverInterface => {
-      if (serverInterface.start) {
-        await serverInterface.start({
-          accountId,
-          debug,
-          extension,
-          projectConfig,
-          projectFiles,
-        });
+  async setup({ components, debug, onUploadRequired }) {
+    this.debug = debug;
+    this.componentsByType = this.arrangeComponentsByType(components);
+
+    await this.iterateDevServers(
+      async (serverInterface, compatibleComponents) => {
+        if (serverInterface.setup) {
+          await serverInterface.setup({
+            components: compatibleComponents,
+            debug,
+            onUploadRequired,
+            promptUser,
+          });
+        }
       }
-    });
-
-    this.path = this.server.address()
-      ? `http://localhost:${this.server.address().port}`
-      : null;
+    );
 
     this.initialized = true;
   }
 
-  async cleanup() {
+  async start({ accountId, projectConfig }) {
     if (this.initialized) {
+      await this.iterateDevServers(async serverInterface => {
+        if (serverInterface.start) {
+          await serverInterface.start({
+            accountId,
+            debug: this.debug,
+            httpClient,
+            projectConfig,
+          });
+        }
+      });
+    } else {
+      throw new Error(i18n(`${i18nKey}.notInitialized`));
+    }
+
+    this.started = true;
+  }
+
+  fileChange({ filePath, event }) {
+    if (this.started) {
+      this.iterateDevServers(async serverInterface => {
+        if (serverInterface.fileChange) {
+          await serverInterface.fileChange(filePath, event);
+        }
+      });
+    }
+  }
+
+  async cleanup() {
+    if (this.started) {
       await this.iterateDevServers(async serverInterface => {
         if (serverInterface.cleanup) {
           await serverInterface.cleanup();
         }
       });
-
-      if (this.server) {
-        await this.server.close();
-      }
     }
   }
 }