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

package/commands/project/dev.js

@@ -19,7 +19,7 @@ const {
   pollProjectBuildAndDeploy,
 } = require('../../lib/projects');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const { uiAccountDescription, uiLine } = require('../../lib/ui');
+const { uiAccountDescription, uiBetaMessage, uiLine } = require('../../lib/ui');
 const { confirmPrompt } = require('../../lib/prompts/promptUtils');
 const {
   selectTargetAccountPrompt,
@@ -29,6 +29,7 @@ const {
   LocalDevManager,
   UPLOAD_PERMISSIONS,
 } = require('../../lib/LocalDevManager');
+const LocalDevManagerV2 = require('../../lib/LocalDevManagerV2');
 const { isSandbox } = require('../../lib/sandboxes');
 const { getAccountConfig, getEnv } = require('@hubspot/cli-lib');
 const { sandboxNamePrompt } = require('../../lib/prompts/sandboxesPrompt');
@@ -38,7 +39,11 @@ const {
   getAvailableSyncTypes,
 } = require('../../lib/sandboxes');
 const { getValidEnv } = require('@hubspot/cli-lib/lib/environment');
-const { ERROR_TYPES } = require('@hubspot/cli-lib/lib/constants');
+const {
+  PROJECT_BUILD_TEXT,
+  PROJECT_DEPLOY_TEXT,
+  ERROR_TYPES,
+} = require('@hubspot/cli-lib/lib/constants');
 const {
   logErrorInstance,
   logApiErrorInstance,
@@ -67,7 +72,7 @@ exports.handler = async options => {
 
   const { projectConfig, projectDir } = await getProjectConfig();
 
-  logger.log(i18n(`${i18nKey}.logs.betaMessage`));
+  uiBetaMessage(i18n(`${i18nKey}.logs.betaMessage`));
 
   if (!projectConfig) {
     logger.error(i18n(`${i18nKey}.errors.noProjectConfig`));
@@ -176,7 +181,7 @@ exports.handler = async options => {
       targetAccountId,
       projectConfig.name
     );
-    if (sourceIntegration) {
+    if (options.extension || sourceIntegration) {
       uploadPermission = UPLOAD_PERMISSIONS.never;
     }
   }
@@ -253,6 +258,8 @@ exports.handler = async options => {
     );
 
     if (initialUploadResult.uploadError) {
+      SpinniesManager.fail('devModeSetup');
+
       if (
         isSpecifiedError(initialUploadResult.uploadError, {
           subCategory: ERROR_TYPES.PROJECT_LOCKED,
@@ -274,22 +281,63 @@ exports.handler = async options => {
     }
   }
 
+  // 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');
+
+    logger.log();
+    failedSubTasks.forEach(failedSubTask => {
+      console.log(failedSubTask.errorMessage);
+    });
+    logger.log();
+
+    process.exit(EXIT_CODES.ERROR);
+  }
+
   SpinniesManager.remove('devModeSetup');
 
-  const LocalDev = new LocalDevManager({
-    debug: options.debug,
-    extension: options.extension,
-    projectConfig,
-    projectDir,
-    targetAccountId,
-    uploadPermission,
-    devServerPath: options.devServerPath,
-  });
+  const LocalDev = options.extension
+    ? new LocalDevManagerV2({
+        debug: options.debug,
+        extension: options.extension,
+        projectConfig,
+        projectDir,
+        targetAccountId,
+      })
+    : new LocalDevManager({
+        debug: options.debug,
+        projectConfig,
+        projectDir,
+        targetAccountId,
+        uploadPermission,
+      });
 
   await LocalDev.start();
 
   // Let the user know when the initial build or deploy fails
-  if (initialUploadResult && !initialUploadResult.succeeded) {
+  if (
+    !options.extension &&
+    initialUploadResult &&
+    !initialUploadResult.succeeded
+  ) {
     if (initialUploadResult.buildResult.status === 'FAILURE') {
       LocalDev.logBuildError(initialUploadResult.buildResult);
     } else if (initialUploadResult.deployResult.status === 'FAILURE') {
@@ -312,12 +360,6 @@ exports.builder = yargs => {
     hidden: true,
   });
 
-  yargs.option('devServerPath', {
-    describe: i18n(`${i18nKey}.options.devServerPath.describe`),
-    type: 'string',
-    hidden: true,
-  });
-
   yargs.example([['$0 project dev', i18n(`${i18nKey}.examples.default`)]]);
 
   return yargs;

package/lang/en.lyaml

@@ -448,7 +448,7 @@ en:
           dev:
             describe: "Start local dev for the current project"
             logs:
-              betaMessage: "{{#yellow}}{{#bold}}[beta]{{/bold}}{{/yellow}} HubSpot projects local development"
+              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."
               placeholderAccountSelection: "Using default account as target account (for now)"
               projectMustExistExplanation: "The project {{ projectName }} does not exist in the target account {{ accountIdentifier}}. This command requires the project to exist in the target account."
@@ -465,8 +465,6 @@ en:
             options:
               extension:
                 describe: "The extension that you would like to run locally"
-              devServerPath:
-                describe: "Relative path to the dev server interface file"
             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."
@@ -850,6 +848,18 @@ en:
     lib:
       DevServerManager:
         portConflict: "The port {{ port }} is already in use."
+      LocalDevManagerV2:
+        failedToInitialize: "Missing required arguments to initialize Local Dev"
+        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"
+        exitingStart: "Stopping local dev server ..."
+        exitingSucceed: "Successfully exited"
+        exitingFail: "Failed to cleanup before exiting"
+        devServer:
+          cleanupError: "Failed to cleanup 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 ..."
@@ -859,7 +869,7 @@ en:
         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 {{ projectName}} locally on {{ accountIdentifier }}, waiting for changes ..."
+          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:
@@ -916,6 +926,7 @@ en:
           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"
       ui:
+        betaTag: "{{#bold}}[beta]{{/bold}}"
         betaWarning:
           header: "{{#yellow}}***************************** WARNING ****************************{{/yellow}}"
           footer: "{{#yellow}}******************************************************************{{/yellow}}"

package/lib/DevServerManager.js

@@ -19,13 +19,12 @@ class DevServerManager {
     this.devServers = {};
   }
 
-  setServer(key, serverInterfacePath) {
+  safeLoadServer() {
     try {
-      this.devServers[key] = require(serverInterfacePath);
+      const { DevModeInterface } = require('@hubspot/ui-extensions-dev-server');
+      this.devServers['uie'] = DevModeInterface;
     } catch (e) {
-      logger.debug(
-        `Failed to load dev server interface at ${serverInterfacePath}`
-      );
+      logger.debug('Failed to load dev server interface: ', e);
     }
   }
 
@@ -43,23 +42,12 @@ class DevServerManager {
     return this.path ? `${this.path}/${path}` : null;
   }
 
-  makeLogger(spinniesLogger, serverKey) {
-    return {
-      debug: (...args) => spinniesLogger(serverKey, '[DEBUG] ', ...args),
-      error: (...args) => spinniesLogger(serverKey, '[ERROR] ', ...args),
-      info: (...args) => spinniesLogger(serverKey, '[INFO] ', ...args),
-      log: (...args) => spinniesLogger(serverKey, '[INFO] ', ...args),
-      warn: (...args) => spinniesLogger(serverKey, '[WARN] ', ...args),
-    };
-  }
-
   async start({
     accountId,
     debug,
     extension,
     projectConfig,
     projectSourceDir,
-    spinniesLogger,
   }) {
     const app = express();
 
@@ -93,12 +81,12 @@ class DevServerManager {
     const projectFiles = await walk(projectSourceDir);
 
     // Initialize component servers
-    await this.iterateDevServers(async (serverInterface, serverKey) => {
+    await this.iterateDevServers(async serverInterface => {
       if (serverInterface.start) {
         await serverInterface.start({
+          accountId,
           debug,
           extension,
-          logger: this.makeLogger(spinniesLogger, serverKey),
           projectConfig,
           projectFiles,
         });
@@ -119,6 +107,7 @@ class DevServerManager {
           await serverInterface.cleanup();
         }
       });
+
       if (this.server) {
         await this.server.close();
       }

package/lib/LocalDevManager.js

@@ -54,8 +54,6 @@ class LocalDevManager {
     this.targetAccountId = options.targetAccountId;
     this.projectConfig = options.projectConfig;
     this.projectDir = options.projectDir;
-    this.extension = options.extension;
-    this.devServerPath = options.devServerPath;
     this.uploadPermission =
       options.uploadPermission || UPLOAD_PERMISSIONS.always;
     this.debug = options.debug || false;
@@ -102,12 +100,8 @@ class LocalDevManager {
 
     await this.devServerStart();
 
-    if (!this.devServerPath) {
-      this.uploadQueue.start();
-      await this.startWatching();
-    } else {
-      this.uploadPermission = UPLOAD_PERMISSIONS.never;
-    }
+    this.uploadQueue.start();
+    await this.startWatching();
 
     this.updateKeypressListeners();
 
@@ -485,10 +479,12 @@ class LocalDevManager {
           }),
           status: 'non-spinnable',
         });
+        const path =
+          event === WATCH_EVENTS.unlinkDir ? `${remotePath}/` : remotePath;
         await deleteFileFromBuild(
           this.targetAccountId,
           this.projectConfig.name,
-          remotePath
+          path
         );
         SpinniesManager.update(spinnerName, {
           text: i18n(`${i18nKey}.upload.uploadedRemoveChange`, {
@@ -667,13 +663,9 @@ class LocalDevManager {
 
   async devServerStart() {
     try {
-      if (this.devServerPath) {
-        DevServerManager.setServer('uie', this.devServerPath);
-      }
       await DevServerManager.start({
         accountId: this.targetAccountId,
         debug: this.debug,
-        extension: this.extension,
         spinniesLogger: this.handleServerLog,
         projectConfig: this.projectConfig,
         projectSourceDir: this.projectSourceDir,

package/lib/LocalDevManagerV2.js

@@ -0,0 +1,129 @@
+const path = require('path');
+const chalk = require('chalk');
+const { i18n } = require('./lang');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { handleKeypress } = require('@hubspot/cli-lib/lib/process');
+const SpinniesManager = require('./SpinniesManager');
+const DevServerManager = require('./DevServerManager');
+const { EXIT_CODES } = require('./enums/exitCodes');
+const { getProjectDetailUrl } = require('./projects');
+const { uiAccountDescription, uiBetaMessage, uiLink, uiLine } = require('./ui');
+
+const i18nKey = 'cli.lib.LocalDevManagerV2';
+
+class LocalDevManagerV2 {
+  constructor(options) {
+    this.targetAccountId = options.targetAccountId;
+    this.projectConfig = options.projectConfig;
+    this.projectDir = options.projectDir;
+    this.extension = options.extension;
+    this.debug = options.debug || false;
+
+    this.projectSourceDir = path.join(
+      this.projectDir,
+      this.projectConfig.srcDir
+    );
+
+    if (!this.targetAccountId || !this.projectConfig || !this.projectDir) {
+      logger.log(i18n(`${i18nKey}.failedToInitialize`));
+      process.exit(EXIT_CODES.ERROR);
+    }
+  }
+
+  async start() {
+    console.clear();
+    SpinniesManager.removeAll();
+    SpinniesManager.init();
+
+    uiBetaMessage(i18n(`${i18nKey}.betaMessage`));
+    logger.log();
+    logger.log(
+      chalk.hex('#FF8F59')(
+        i18n(`${i18nKey}.running`, {
+          accountIdentifier: uiAccountDescription(this.targetAccountId),
+          projectName: this.projectConfig.name,
+        })
+      )
+    );
+    logger.log(
+      uiLink(
+        i18n(`${i18nKey}.viewInHubSpotLink`),
+        getProjectDetailUrl(this.projectConfig.name, this.targetAccountId)
+      )
+    );
+    logger.log();
+    logger.log(i18n(`${i18nKey}.quitHelper`));
+    uiLine();
+    logger.log();
+
+    await this.devServerStart();
+
+    this.updateKeypressListeners();
+  }
+
+  async stop() {
+    SpinniesManager.add('cleanupMessage', {
+      text: i18n(`${i18nKey}.exitingStart`),
+    });
+
+    const cleanupSucceeded = await this.devServerCleanup();
+
+    if (!cleanupSucceeded) {
+      SpinniesManager.fail('cleanupMessage', {
+        text: i18n(`${i18nKey}.exitingFail`),
+      });
+      process.exit(EXIT_CODES.ERROR);
+    }
+
+    SpinniesManager.succeed('cleanupMessage', {
+      text: i18n(`${i18nKey}.exitingSucceed`),
+    });
+    process.exit(EXIT_CODES.SUCCESS);
+  }
+
+  updateKeypressListeners() {
+    handleKeypress(async key => {
+      if ((key.ctrl && key.name === 'c') || key.name === 'q') {
+        this.stop();
+      }
+    });
+  }
+
+  async devServerStart() {
+    try {
+      DevServerManager.safeLoadServer();
+      await DevServerManager.start({
+        accountId: this.targetAccountId,
+        debug: this.debug,
+        extension: this.extension,
+        projectConfig: this.projectConfig,
+        projectSourceDir: this.projectSourceDir,
+      });
+    } catch (e) {
+      if (this.debug) {
+        logger.error(e);
+      }
+      logger.error(
+        i18n(`${i18nKey}.devServer.startError`, { message: e.message })
+      );
+      process.exit(EXIT_CODES.ERROR);
+    }
+  }
+
+  async devServerCleanup() {
+    try {
+      await DevServerManager.cleanup();
+      return true;
+    } catch (e) {
+      if (this.debug) {
+        logger.error(e);
+      }
+      logger.error(
+        i18n(`${i18nKey}.devServer.cleanupError`, { message: e.message })
+      );
+      return false;
+    }
+  }
+}
+
+module.exports = LocalDevManagerV2;

package/lib/SpinniesManager.js

@@ -53,6 +53,9 @@ class SpinniesManager {
     // Default Spinnies fields
     this.spinners = {};
     this.isCursorHidden = false;
+    if (this.currentInterval) {
+      clearInterval(this.currentInterval);
+    }
     this.currentInterval = null;
     this.stream = process.stderr;
     this.lineCount = 0;

package/lib/ui.js

@@ -105,6 +105,12 @@ const uiFeatureHighlight = (commands, title) => {
   });
 };
 
+const uiBetaMessage = message => {
+  const i18nKey = 'cli.lib.ui';
+
+  logger.log(chalk.hex('#bda9ea')(i18n(`${i18nKey}.betaTag`)), message);
+};
+
 const uiBetaWarning = logMessage => {
   const i18nKey = 'cli.lib.ui.betaWarning';
 
@@ -115,6 +121,7 @@ const uiBetaWarning = logMessage => {
 
 module.exports = {
   uiAccountDescription,
+  uiBetaMessage,
   uiBetaWarning,
   uiFeatureHighlight,
   uiInfoSection,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "4.2.1-beta.0",
+  "version": "4.2.1-beta.1",
   "description": "CLI for working with HubSpot",
   "license": "Apache-2.0",
   "repository": {
@@ -10,6 +10,7 @@
   "dependencies": {
     "@hubspot/cli-lib": "^4.1.14",
     "@hubspot/serverless-dev-runtime": "4.1.8-beta.6",
+    "@hubspot/ui-extensions-dev-server": "^0.4.0",
     "archiver": "^5.3.0",
     "body-parser": "^1.19.0",
     "chalk": "^4.1.2",
@@ -35,7 +36,7 @@
     "mock-stdin": "^1.0.0"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=16"
   },
   "bin": {
     "hs": "./bin/hs",
@@ -44,5 +45,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2e2976ffd17135fbc4dcdb8a8b9d078613ed5d53"
+  "gitHead": "a79d4a4d6c61971986a7df3aaa8374cbe2405a0b"
 }