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

package/commands/customObject/schema/list.js

@@ -4,7 +4,7 @@ const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const { loadAndValidateOptions } = require('../../../lib/validation');
 const { trackCommandUsage } = require('../../../lib/usageTracking');
 const { getAccountId } = require('../../../lib/commonOpts');
-const { listSchemas } = require('@hubspot/cli-lib/schema');
+const { listSchemas } = require('../../../lib/schema');
 const { i18n } = require('../../../lib/lang');
 
 const i18nKey = 'cli.commands.customObject.subcommands.schema.subcommands.list';

package/commands/functions/list.js

@@ -4,7 +4,7 @@ const {
   logApiErrorInstance,
   ApiErrorContext,
 } = require('@hubspot/cli-lib/errorHandlers');
-const { getFunctionArrays } = require('@hubspot/cli-lib/lib/functions');
+const { getFunctionArrays } = require('../../lib/getFunctionArrays');
 const {
   getTableContents,
   getTableHeader,

package/commands/init.js

@@ -7,7 +7,7 @@ const {
   updateDefaultAccount,
 } = require('@hubspot/cli-lib/lib/config');
 const { addConfigOptions } = require('../lib/commonOpts');
-const { handleExit } = require('@hubspot/cli-lib/lib/process');
+const { handleExit } = require('../lib/process');
 const { checkAndUpdateGitignore } = require('@hubspot/cli-lib/lib/git');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 const {

package/commands/lint.js

@@ -1,7 +1,5 @@
-const {
-  lint,
-  printHublValidationResult,
-} = require('@hubspot/cli-lib/validate');
+const { lint } = require('@hubspot/cli-lib/validate');
+const { printHublValidationResult } = require('../lib/hublValidate');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { logErrorInstance } = require('@hubspot/cli-lib/errorHandlers');
 

package/commands/project/dev.js

@@ -10,11 +10,11 @@ const {
   trackCommandMetadataUsage,
 } = require('../../lib/usageTracking');
 const { loadAndValidateOptions } = require('../../lib/validation');
+const { handleExit } = require('../../lib/process');
 const { i18n } = require('../../lib/lang');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { getConfigAccounts } = require('@hubspot/cli-lib/lib/config');
 const { createProject, fetchProject } = require('@hubspot/cli-lib/api/dfs');
-const { handleExit } = require('@hubspot/cli-lib/lib/process');
 const {
   getProjectConfig,
   ensureProjectExists,

package/commands/project/watch.js

@@ -1,5 +1,5 @@
 const { i18n } = require('../../lib/lang');
-const { createWatcher } = require('@hubspot/cli-lib/projectsWatch');
+const { createWatcher } = require('../../lib/projectsWatch');
 const {
   logApiErrorInstance,
   ApiErrorContext,
@@ -30,7 +30,7 @@ const {
 } = require('@hubspot/cli-lib/api/dfs');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { EXIT_CODES } = require('../../lib/enums/exitCodes');
-const { handleKeypress, handleExit } = require('@hubspot/cli-lib/lib/process');
+const { handleKeypress, handleExit } = require('../../lib/process');
 
 const i18nKey = 'cli.commands.project.subcommands.watch';
 

package/lang/en.lyaml

@@ -587,12 +587,31 @@ en:
               default: "Watch a project within the myProjectFolder folder"
             logs:
               processExited: "Stopping watcher..."
+              watchCancelledFromUi: "The watch process has been cancelled from the UI. Any changes made since cancelling have not been uploaded. To resume watching, rerun {{#yellow}}`hs project watch`{{/yellow}}."
+              resuming: "Resuming watcher..."
+              uploadSucceeded: "Uploaded file \"{{ filePath }}\" to \"{{ remotePath }}\""
+              deleteFileSucceeded: "Deleted file \"{{ remotePath }}\""
+              deleteFolderSucceeded: "Deleted folder \"{{ remotePath }}\""
+              watching: "Watcher is ready and watching \"{{ projectDir }}\". Any changes detected will be automatically uploaded."
+              previousStagingBuildCancelled: "Killed the previous watch process. Please try running `hs project watch` again"
             positionals:
               path:
                 describe: "Path to a project folder"
             options:
               initialUpload:
                 describe: "Upload directory before watching for updates"
+            debug:
+              pause: "Pausing watcher, attempting to queue build"
+              buildStarted: "Build queued."
+              extensionNotAllowed: "Skipping \"{{ filePath }}\" due to unsupported extension"
+              ignored: "Skipping \"{{ filePath }}\" due to an ignore rule"
+              uploading: "Attempting to upload file \"{{ filePath }}\" to \"{{ remotePath }}\""
+              attemptNewBuild: "Attempting to create a new build"
+              fileAlreadyQueued: "File \"{{ filePath }}\" is already queued for upload"
+            errors:
+              uploadFailed: "Failed to upload file \"{{ filePath }}\" to \"{{ remotePath }}\""
+              deleteFileFailed: "Failed to delete file \"{{ remotePath }}\""
+              deleteFolderFailed: "Failed to delete folder \"{{ remotePath }}\""
           download:
             describe: "Download your project files from HubSpot and write to a path on your computer"
             examples:
@@ -874,7 +893,7 @@ en:
         failedToInitialize: "Missing required arguments to initialize Local Dev"
         noDeployedBuild: "There is no deployed build for this project in {{ accountIdentifier }}. Run {{ uploadCommand }} to upload and deploy your project."
         noComponents: "There are no components in this project."
-        noRunnableComponents: "There are no components in this project that support local development."
+        noRunnableComponents: "No supported components were found under {{#bold}}{{ projectSourceDir }}{{/bold}}. Run {{ command }} to see a list of available components."
         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"
@@ -885,7 +904,7 @@ en:
         uploadWarning:
           appLabel: "[App]"
           uiExtensionLabel: "[UI Extension]"
-          missingComponents: "The deployed build for this project does not contain {{#bold}}'{{ missingComponents }}'{{/bold}}. This may cause issues in local development."
+          missingComponents: "Couldn't find the following components in the deployed build for this project: {{#bold}}'{{ missingComponents }}'{{/bold}}. This may cause issues in local development."
           defaultWarning: "Changing project configuration requires a new project build."
           header: "{{ warning }} To reflect these changes and continue testing:"
           stopDev: "  * Stop {{ command }}"
@@ -907,6 +926,7 @@ en:
           emptySource: "Source directory \"{{ srcDir }}\" is empty. Add files to your project and rerun `{{#yellow}}hs project upload{{/yellow}}` to upload them to HubSpot."
           compressed: "Project files compressed: {{ byteCount }} bytes"
           compressing: "Compressing build files to \"{{ path }}\""
+          fileFiltered: "Ignore rule triggered for \"{{ filename }}\""
         ensureProjectExists:
           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}}."

package/lib/LocalDevManager.js

@@ -2,8 +2,8 @@ const path = require('path');
 const chokidar = require('chokidar');
 const chalk = require('chalk');
 const { i18n } = require('./lang');
+const { handleKeypress } = require('./process');
 const { logger } = require('@hubspot/cli-lib/logger');
-const { handleKeypress } = require('@hubspot/cli-lib/lib/process');
 const {
   getAccountId,
   getConfigDefaultAccount,
@@ -89,7 +89,12 @@ class LocalDevManager {
 
     // The project does not contain any components that support local development
     if (!runnableComponents.length) {
-      logger.error(i18n(`${i18nKey}.noRunnableComponents`));
+      logger.error(
+        i18n(`${i18nKey}.noRunnableComponents`, {
+          projectSourceDir: this.projectSourceDir,
+          command: uiCommandReference('hs project add'),
+        })
+      );
       process.exit(EXIT_CODES.SUCCESS);
     }
 

package/lib/getFunctionArrays.js

@@ -0,0 +1,18 @@
+const moment = require('moment');
+
+const getFunctionArrays = resp => {
+  return resp.objects.map(func => {
+    const { route, method, created, updated, secretNames } = func;
+    return [
+      route,
+      method,
+      secretNames.join(', '),
+      moment(created).format(),
+      moment(updated).format(),
+    ];
+  });
+};
+
+module.exports = {
+  getFunctionArrays,
+};

package/lib/hublValidate.js

@@ -0,0 +1,32 @@
+const { logger } = require('@hubspot/cli-lib/logger');
+
+const getErrorsFromHublValidationObject = validation =>
+  (validation && validation.meta && validation.meta.template_errors) || [];
+
+function printHublValidationError(err) {
+  const { severity, message, lineno, startPosition } = err;
+  const method = severity === 'FATAL' ? 'error' : 'warn';
+  logger[method]('[%d, %d]: %s', lineno, startPosition, message);
+}
+
+function printHublValidationResult({ file, validation }) {
+  let count = 0;
+  const errors = getErrorsFromHublValidationObject(validation);
+  if (!errors.length) {
+    return count;
+  }
+  logger.group(file);
+  errors.forEach(err => {
+    if (err.reason !== 'SYNTAX_ERROR') {
+      return;
+    }
+    ++count;
+    printHublValidationError(err);
+  });
+  logger.groupEnd(file);
+  return count;
+}
+
+module.exports = {
+  printHublValidationResult,
+};

package/lib/oauth.js

@@ -3,7 +3,7 @@ const open = require('open');
 const OAuth2Manager = require('@hubspot/cli-lib/lib/models/OAuth2Manager');
 const { getAccountConfig } = require('@hubspot/cli-lib/lib/config');
 const { addOauthToAccountConfig } = require('@hubspot/cli-lib/oauth');
-const { handleExit } = require('@hubspot/cli-lib/lib/process');
+const { handleExit } = require('./process');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/cli-lib/lib/urls');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { ENVIRONMENTS } = require('@hubspot/cli-lib/lib/constants');

package/lib/process.js

@@ -0,0 +1,42 @@
+const readline = require('readline');
+
+const handleExit = callback => {
+  const terminationSignals = [
+    'beforeExit',
+    'SIGINT',
+    'SIGUSR1',
+    'SIGUSR2',
+    'uncaughtException',
+    'SIGTERM',
+    'SIGHUP',
+  ];
+  terminationSignals.forEach(signal => {
+    process.removeAllListeners(signal);
+
+    process.on(signal, async () => {
+      await callback();
+    });
+  });
+};
+
+const handleKeypress = callback => {
+  readline.createInterface(process.stdin, process.stdout);
+  readline.emitKeypressEvents(process.stdin);
+
+  if (process.stdin.isTTY) {
+    process.stdin.setRawMode(true);
+  }
+
+  process.stdin.removeAllListeners('keypress');
+
+  process.stdin.on('keypress', (str, key) => {
+    if (key) {
+      callback(key);
+    }
+  });
+};
+
+module.exports = {
+  handleExit,
+  handleKeypress,
+};

package/lib/projects.js

@@ -522,9 +522,27 @@ const handleProjectUpload = async (
 
   archive.pipe(output);
 
-  archive.directory(srcDir, false, file =>
-    shouldIgnoreFile(file.name, true) ? false : file
-  );
+  let loggedIgnoredNodeModule = false;
+
+  archive.directory(srcDir, false, file => {
+    const ignored = shouldIgnoreFile(file.name, true);
+    if (ignored) {
+      const isNodeModule = file.name.includes('node_modules');
+
+      if (!isNodeModule || !loggedIgnoredNodeModule) {
+        logger.debug(
+          i18n(`${i18nKey}.handleProjectUpload.fileFiltered`, {
+            filename: file.name,
+          })
+        );
+      }
+
+      if (isNodeModule && !loggedIgnoredNodeModule) {
+        loggedIgnoredNodeModule = true;
+      }
+    }
+    return ignored ? false : file;
+  });
 
   archive.finalize();
 

package/lib/projectsWatch.js

@@ -0,0 +1,225 @@
+const chokidar = require('chokidar');
+const path = require('path');
+const chalk = require('chalk');
+const { default: PQueue } = require('p-queue');
+const {
+  logApiErrorInstance,
+  ApiErrorContext,
+} = require('@hubspot/cli-lib/errorHandlers');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { isAllowedExtension } = require('@hubspot/cli-lib/path');
+const { shouldIgnoreFile } = require('@hubspot/cli-lib/ignoreRules');
+const {
+  cancelStagedBuild,
+  provisionBuild,
+  uploadFileToBuild,
+  deleteFileFromBuild,
+  queueBuild,
+} = require('@hubspot/cli-lib/api/dfs');
+const { ERROR_TYPES } = require('@hubspot/cli-lib/lib/constants');
+
+const i18nKey = 'cli.commands.project.subcommands.watch';
+
+const queue = new PQueue({
+  concurrency: 10,
+});
+const standbyeQueue = [];
+let currentBuildId = null;
+let handleBuildStatus, handleUserInput;
+let timer;
+
+const processStandByQueue = async (accountId, projectName) => {
+  queue.addAll(
+    standbyeQueue.map(({ filePath, remotePath, action }) => {
+      return async () => {
+        queueFileOrFolder(accountId, projectName, filePath, remotePath, action);
+      };
+    })
+  );
+  standbyeQueue.length = 0;
+  debounceQueueBuild(accountId, projectName);
+};
+
+const createNewStagingBuild = async (accountId, projectName) => {
+  currentBuildId = await createNewBuild(accountId, projectName);
+
+  handleUserInput(accountId, projectName, currentBuildId);
+};
+
+const debounceQueueBuild = (accountId, projectName) => {
+  if (timer) {
+    clearTimeout(timer);
+  }
+
+  timer = setTimeout(async () => {
+    logger.debug(i18n(`${i18nKey}.debug.pause`, { projectName }));
+    queue.pause();
+    await queue.onIdle();
+
+    try {
+      await queueBuild(accountId, projectName);
+      logger.debug(i18n(`${i18nKey}.debug.buildStarted`, { projectName }));
+    } catch (err) {
+      if (
+        err.error &&
+        err.error.subCategory === ERROR_TYPES.MISSING_PROJECT_PROVISION
+      ) {
+        logger.log(i18n(`${i18nKey}.logs.watchCancelledFromUi`));
+        process.exit(0);
+      } else {
+        logApiErrorInstance(
+          err,
+          new ApiErrorContext({ accountId, projectName })
+        );
+      }
+
+      return;
+    }
+
+    await handleBuildStatus(accountId, projectName, currentBuildId);
+
+    await createNewStagingBuild(accountId, projectName);
+
+    if (standbyeQueue.length > 0) {
+      await processStandByQueue(accountId, projectName);
+    }
+
+    queue.start();
+    logger.log(i18n(`${i18nKey}.logs.resuming`));
+    logger.log(`\n> Press ${chalk.bold('q')} to quit watching\n`);
+  }, 2000);
+};
+
+const queueFileOrFolder = async (
+  accountId,
+  projectName,
+  filePath,
+  remotePath,
+  action
+) => {
+  if (action === 'upload' && !isAllowedExtension(filePath)) {
+    logger.debug(i18n(`${i18nKey}.debug.extensionNotAllowed`, { filePath }));
+    return;
+  }
+  if (shouldIgnoreFile(filePath, true)) {
+    logger.debug(i18n(`${i18nKey}.debug.ignored`, { filePath }));
+    return;
+  }
+  if (!queue.isPaused) {
+    debounceQueueBuild(accountId, projectName);
+  }
+
+  logger.debug(i18n(`${i18nKey}.debug.uploading`, { filePath, remotePath }));
+
+  return queue.add(async () => {
+    try {
+      if (action === 'upload') {
+        await uploadFileToBuild(accountId, projectName, filePath, remotePath);
+      } else if (action === 'deleteFile' || action === 'deleteFolder') {
+        await deleteFileFromBuild(accountId, projectName, remotePath);
+      }
+      logger.log(
+        i18n(`${i18nKey}.logs.${action}Succeeded`, { filePath, remotePath })
+      );
+    } catch (err) {
+      logger.debug(
+        i18n(`${i18nKey}.errors.${action}Failed`, { filePath, remotePath })
+      );
+    }
+  });
+};
+
+const createNewBuild = async (accountId, projectName) => {
+  try {
+    logger.debug(i18n(`${i18nKey}.debug.attemptNewBuild`));
+    const { buildId } = await provisionBuild(accountId, projectName);
+    return buildId;
+  } catch (err) {
+    logApiErrorInstance(err, new ApiErrorContext({ accountId, projectName }));
+    if (err.error.subCategory !== ERROR_TYPES.PROJECT_LOCKED) {
+      await cancelStagedBuild(accountId, projectName);
+      logger.log(i18n(`${i18nKey}.logs.previousStagingBuildCancelled`));
+    }
+    process.exit(1);
+  }
+};
+
+const handleWatchEvent = async (
+  accountId,
+  projectName,
+  projectSourceDir,
+  filePath,
+  action = 'upload'
+) => {
+  const remotePath = path.relative(projectSourceDir, filePath);
+  if (queue.isPaused) {
+    standbyeQueue.find(file => file.filePath === filePath)
+      ? logger.debug(i18n(`${i18nKey}.debug.fileAlreadyQueued`, { filePath }))
+      : standbyeQueue.push({
+          filePath,
+          remotePath,
+          action,
+        });
+  } else {
+    await queueFileOrFolder(
+      accountId,
+      projectName,
+      filePath,
+      remotePath,
+      action
+    );
+  }
+};
+
+const createWatcher = async (
+  accountId,
+  projectConfig,
+  projectDir,
+  handleBuildStatusFn,
+  handleUserInputFn
+) => {
+  const projectSourceDir = path.join(projectDir, projectConfig.srcDir);
+
+  handleBuildStatus = handleBuildStatusFn;
+  handleUserInput = handleUserInputFn;
+
+  await createNewStagingBuild(accountId, projectConfig.name);
+
+  const watcher = chokidar.watch(projectSourceDir, {
+    ignoreInitial: true,
+    ignored: file => shouldIgnoreFile(file),
+  });
+  watcher.on('ready', async () => {
+    logger.log(i18n(`${i18nKey}.logs.watching`, { projectDir }));
+    logger.log(`\n> Press ${chalk.bold('q')} to quit watching\n`);
+  });
+  watcher.on('add', async path => {
+    handleWatchEvent(accountId, projectConfig.name, projectSourceDir, path);
+  });
+  watcher.on('change', async path => {
+    handleWatchEvent(accountId, projectConfig.name, projectSourceDir, path);
+  });
+  watcher.on('unlink', async path => {
+    handleWatchEvent(
+      accountId,
+      projectConfig.name,
+      projectSourceDir,
+      path,
+      'deleteFile'
+    );
+  });
+  watcher.on('unlinkDir', async path => {
+    handleWatchEvent(
+      accountId,
+      projectConfig.name,
+      projectSourceDir,
+      path,
+      'deleteFolder'
+    );
+  });
+};
+
+module.exports = {
+  createWatcher,
+};

package/lib/sandboxes.js

@@ -6,6 +6,7 @@ const {
 } = require('@hubspot/cli-lib');
 const chalk = require('chalk');
 const { i18n } = require('./lang');
+const { handleExit, handleKeypress } = require('./process');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   updateConfigWithPersonalAccessKey,
@@ -17,7 +18,6 @@ const {
   fetchTypes,
   getSandboxUsageLimits,
 } = require('@hubspot/cli-lib/sandboxes');
-const { handleExit, handleKeypress } = require('@hubspot/cli-lib/lib/process');
 const { accountNameExistsInConfig } = require('@hubspot/cli-lib/lib/config');
 const CliProgressMultibarManager = require('./CliProgressMultibarManager');
 const { promptUser } = require('./prompts/promptUtils');

package/lib/schema.js

@@ -0,0 +1,31 @@
+const chalk = require('chalk');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { table, getBorderCharacters } = require('table');
+const { fetchSchemas } = require('@hubspot/cli-lib/api/schema');
+
+const logSchemas = schemas => {
+  const data = schemas
+    .map(r => [r.labels.singular, r.name, r.objectTypeId || ''])
+    .sort((a, b) => (a[1] > b[1] ? 1 : -1));
+  data.unshift([
+    chalk.bold('Label'),
+    chalk.bold('Name'),
+    chalk.bold('objectTypeId'),
+  ]);
+
+  const tableConfig = {
+    singleLine: true,
+    border: getBorderCharacters('honeywell'),
+  };
+
+  logger.log(data.length ? table(data, tableConfig) : 'No Schemas were found');
+};
+
+const listSchemas = async accountId => {
+  const response = await fetchSchemas(accountId);
+  logSchemas(response.results);
+};
+
+module.exports = {
+  listSchemas,
+};

package/lib/serverlessLogs.js

@@ -1,5 +1,6 @@
 const https = require('https');
 const SpinniesManager = require('./SpinniesManager');
+const { handleExit, handleKeypress } = require('./process');
 const chalk = require('chalk');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { outputLogs } = require('@hubspot/cli-lib/lib/logs');
@@ -9,7 +10,6 @@ const {
   ApiErrorContext,
 } = require('@hubspot/cli-lib/errorHandlers');
 const { base64EncodeString } = require('@hubspot/cli-lib/lib/encoding');
-const { handleExit, handleKeypress } = require('@hubspot/cli-lib/lib/process');
 
 const { EXIT_CODES } = require('../lib/enums/exitCodes');
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "5.0.2-beta.0",
+  "version": "5.0.2-beta.1",
   "description": "CLI for working with HubSpot",
   "license": "Apache-2.0",
   "repository": {
@@ -10,7 +10,7 @@
   "dependencies": {
     "@hubspot/cli-lib": "^5.0.1",
     "@hubspot/serverless-dev-runtime": "4.2.1-beta.3",
-    "@hubspot/ui-extensions-dev-server": "^0.7.2",
+    "@hubspot/ui-extensions-dev-server": "^0.8.0",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
     "chokidar": "^3.0.1",
@@ -24,7 +24,9 @@
     "moment": "^2.29.1",
     "open": "^7.0.3",
     "ora": "^4.0.3",
+    "p-queue": "^6.0.2",
     "strip-ansi": "^5.2.0",
+    "table": "^6.6.0",
     "tmp": "^0.2.1",
     "update-notifier": "^5.1.0",
     "yargs": "15.4.1"
@@ -42,5 +44,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "539e279526f9554f840b857bf4873a3b856684a3"
+  "gitHead": "ffa9b2bd4597057e8b0c640c9ceb9c37a12df19c"
 }