@hubspot/cli 6.1.1 → 6.2.0

package/lib/buildAccount.js

@@ -15,17 +15,14 @@ const { logger } = require('@hubspot/local-dev-lib/logger');
 const { i18n } = require('./lang');
 const { cliAccountNamePrompt } = require('./prompts/accountNamePrompt');
 const SpinniesManager = require('./ui/SpinniesManager');
-const {
-  debugErrorAndContext,
-  logErrorInstance,
-} = require('./errorHandlers/standardErrors');
+const { debugError, logError } = require('./errorHandlers/index');
 const {
   createDeveloperTestAccount,
-} = require('@hubspot/local-dev-lib/developerTestAccounts');
+} = require('@hubspot/local-dev-lib/api/developerTestAccounts');
 const {
   HUBSPOT_ACCOUNT_TYPES,
 } = require('@hubspot/local-dev-lib/constants/config');
-const { createSandbox } = require('@hubspot/local-dev-lib/sandboxes');
+const { createSandbox } = require('@hubspot/local-dev-lib/api/sandboxHubs');
 const { sandboxApiTypeMap, handleSandboxCreateError } = require('./sandboxes');
 const {
   handleDeveloperTestAccountCreateError,
@@ -134,10 +131,13 @@ async function buildNewAccount({
   try {
     if (isSandbox) {
       const sandboxApiType = sandboxApiTypeMap[accountType]; // API expects sandbox type as 1 or 2.
-      result = await createSandbox(accountId, name, sandboxApiType);
+
+      const { data } = await createSandbox(accountId, name, sandboxApiType);
+      result = { name, ...data };
       resultAccountId = result.sandbox.sandboxHubId;
     } else if (isDeveloperTestAccount) {
-      result = await createDeveloperTestAccount(accountId, name);
+      const { data } = await createDeveloperTestAccount(accountId, name);
+      result = data;
       resultAccountId = result.id;
     }
 
@@ -148,7 +148,7 @@ async function buildNewAccount({
       }),
     });
   } catch (err) {
-    debugErrorAndContext(err);
+    debugError(err);
 
     SpinniesManager.fail('buildNewAccount', {
       text: i18n(`${spinniesI18nKey}.fail`, {
@@ -181,7 +181,7 @@ async function buildNewAccount({
       force,
     });
   } catch (err) {
-    logErrorInstance(err);
+    logError(err);
     throw err;
   }
 

package/lib/developerTestAccounts.js

@@ -5,15 +5,15 @@ const { getAccountId, getConfig } = require('@hubspot/local-dev-lib/config');
 const { i18n } = require('./lang');
 const {
   fetchDeveloperTestAccounts,
-} = require('@hubspot/local-dev-lib/developerTestAccounts');
+} = require('@hubspot/local-dev-lib/api/developerTestAccounts');
 const {
   isMissingScopeError,
   isSpecifiedError,
-} = require('@hubspot/local-dev-lib/errors/apiErrors');
+} = require('@hubspot/local-dev-lib/errors/index');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { uiAccountDescription } = require('./ui');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
-const { logErrorInstance } = require('./errorHandlers/standardErrors');
+const { logError } = require('./errorHandlers/index');
 
 const getHasDevTestAccounts = appDeveloperAccountConfig => {
   const config = getConfig();
@@ -32,31 +32,31 @@ const getHasDevTestAccounts = appDeveloperAccountConfig => {
 
 const validateDevTestAccountUsageLimits = async accountConfig => {
   const accountId = getAccountId(accountConfig.portalId);
-  const response = await fetchDeveloperTestAccounts(accountId);
-  if (response) {
-    const limit = response.maxTestPortals;
-    const count = response.results.length;
-    if (count >= limit) {
-      const hasDevTestAccounts = getHasDevTestAccounts(accountConfig);
-      if (hasDevTestAccounts) {
-        throw new Error(
-          i18n('lib.developerTestAccount.create.failure.alreadyInConfig', {
-            accountName: accountConfig.name || accountId,
-            limit,
-          })
-        );
-      } else {
-        throw new Error(
-          i18n('lib.developerTestAccount.create.failure.limit', {
-            accountName: accountConfig.name || accountId,
-            limit,
-          })
-        );
-      }
+  const { data } = await fetchDeveloperTestAccounts(accountId);
+  if (!data) {
+    return null;
+  }
+  const limit = data.maxTestPortals;
+  const count = data.results.length;
+  if (count >= limit) {
+    const hasDevTestAccounts = getHasDevTestAccounts(accountConfig);
+    if (hasDevTestAccounts) {
+      throw new Error(
+        i18n('lib.developerTestAccount.create.failure.alreadyInConfig', {
+          accountName: accountConfig.name || accountId,
+          limit,
+        })
+      );
+    } else {
+      throw new Error(
+        i18n('lib.developerTestAccount.create.failure.limit', {
+          accountName: accountConfig.name || accountId,
+          limit,
+        })
+      );
     }
-    return response;
   }
-  return null;
+  return data;
 };
 
 function handleDeveloperTestAccountCreateError({
@@ -94,7 +94,7 @@ function handleDeveloperTestAccountCreateError({
     );
     logger.log('');
   } else {
-    logErrorInstance(err);
+    logError(err);
   }
   throw err;
 }

package/lib/errorHandlers/index.js

@@ -0,0 +1,101 @@
+const { logger } = require('@hubspot/local-dev-lib/logger');
+const {
+  isHubSpotHttpError,
+  isSystemError,
+  isFileSystemError,
+  isValidationError,
+  isMissingScopeError,
+} = require('@hubspot/local-dev-lib/errors/index');
+const { shouldSuppressError } = require('./suppressError');
+const { i18n } = require('../lang');
+const util = require('util');
+const { isAxiosError } = require('axios');
+
+const i18nKey = 'lib.errorHandlers.index';
+
+function logError(error, context = {}) {
+  debugError(error, context);
+
+  if (
+    shouldSuppressError(error, context) ||
+    shouldSuppressError(error, error.context)
+  ) {
+    return;
+  }
+
+  if (isHubSpotHttpError(error) && context) {
+    error.updateContext(context);
+  }
+
+  if (isHubSpotHttpError(error) || isFileSystemError(error)) {
+    if (isValidationError(error) || isMissingScopeError(error)) {
+      logger.error(error.formattedValidationErrors());
+    } else {
+      logger.error(error.message);
+    }
+  } else if (isSystemError(error)) {
+    logger.error(error.message);
+  } else if (error.message || error.reason) {
+    const message = [];
+
+    [error.message, error.reason].forEach(msg => {
+      if (msg) {
+        message.push(msg);
+      }
+    });
+    logger.error(message.join(' '));
+  } else {
+    // Unknown errors
+    logger.error(i18n(`${i18nKey}.unknownErrorOccurred`));
+  }
+}
+
+/**
+ * Logs (debug) the error and context objects.
+ *
+ * @param {Error}  error
+ * @param {ApiErrorContext} context
+ */
+function debugError(error, context = {}) {
+  if (isHubSpotHttpError(error)) {
+    logger.debug(error.toString());
+  } else {
+    logger.debug(i18n(`${i18nKey}.errorOccurred`, { error }));
+  }
+
+  if (error.cause) {
+    logger.debug(
+      i18n(`${i18nKey}.errorCause`, {
+        cause: isAxiosError(error.cause)
+          ? error.cause
+          : util.inspect(error.cause, false, null, true),
+      })
+    );
+  }
+  if (context) {
+    logger.debug(
+      i18n(`${i18nKey}.errorContext`, {
+        context: util.inspect(context, false, null, true),
+      })
+    );
+  }
+}
+
+class ApiErrorContext {
+  constructor(props = {}) {
+    /** @type {number} */
+    this.accountId = props.accountId;
+    /** @type {string} */
+    this.request = props.request || '';
+    /** @type {string} */
+    this.payload = props.payload || '';
+    /** @type {string} */
+    this.projectName = props.projectName || '';
+  }
+}
+
+module.exports = {
+  logError,
+  debugError,
+  ApiErrorContext,
+};

package/lib/errorHandlers/{overrideErrors.js → suppressError.js}

@@ -1,7 +1,7 @@
 const {
   isSpecifiedError,
   isMissingScopeError,
-} = require('@hubspot/local-dev-lib/errors/apiErrors');
+} = require('@hubspot/local-dev-lib/errors/index');
 const { logger } = require('@hubspot/local-dev-lib/logger');
 const { PLATFORM_VERSION_ERROR_TYPES } = require('../constants');
 const { i18n } = require('../lang');
@@ -12,7 +12,7 @@ const {
   uiCommandReference,
 } = require('../ui');
 
-const i18nKey = 'lib.errorHandlers.overrideErrors';
+const i18nKey = 'lib.errorHandlers.suppressErrors';
 
 function createPlatformVersionError(err, subCategory) {
   let translationKey = 'unspecifiedPlatformVersion';
@@ -58,7 +58,7 @@ function createPlatformVersionError(err, subCategory) {
   uiLine();
 }
 
-function overrideErrors(err, context) {
+function shouldSuppressError(err, context = {}) {
   if (isMissingScopeError(err)) {
     logger.error(
       i18n(`${i18nKey}.missingScopeError`, {
@@ -78,7 +78,7 @@ function overrideErrors(err, context) {
     })
   ) {
     createPlatformVersionError(
-      err,
+      err.data,
       PLATFORM_VERSION_ERROR_TYPES.PLATFORM_VERSION_NOT_SPECIFIED
     );
     return true;
@@ -90,7 +90,7 @@ function overrideErrors(err, context) {
     })
   ) {
     createPlatformVersionError(
-      err,
+      err.data,
       PLATFORM_VERSION_ERROR_TYPES.PLATFORM_VERSION_RETIRED
     );
     return true;
@@ -103,7 +103,7 @@ function overrideErrors(err, context) {
     })
   ) {
     createPlatformVersionError(
-      err,
+      err.data,
       PLATFORM_VERSION_ERROR_TYPES.PLATFORM_VERSION_SPECIFIED_DOES_NOT_EXIST
     );
     return true;
@@ -112,5 +112,5 @@ function overrideErrors(err, context) {
 }
 
 module.exports = {
-  overrideErrors,
+  shouldSuppressError,
 };

package/lib/hasFeature.js

@@ -0,0 +1,15 @@
+const {
+  fetchEnabledFeatures,
+} = require('@hubspot/local-dev-lib/api/localDevAuth');
+
+const hasFeature = async (accountId, feature) => {
+  const {
+    data: { enabledFeatures },
+  } = await fetchEnabledFeatures(accountId);
+
+  return enabledFeatures[feature];
+};
+
+module.exports = {
+  hasFeature,
+};

package/lib/localDev.js

@@ -6,7 +6,7 @@ const {
 const {
   isMissingScopeError,
   isSpecifiedError,
-} = require('@hubspot/local-dev-lib/errors/apiErrors');
+} = require('@hubspot/local-dev-lib/errors/index');
 const { getHubSpotWebsiteOrigin } = require('@hubspot/local-dev-lib/urls');
 const { getAccountConfig, getEnv } = require('@hubspot/local-dev-lib/config');
 const { createProject } = require('@hubspot/local-dev-lib/api/projects');
@@ -28,7 +28,6 @@ const { syncSandbox } = require('./sandboxSync');
 const {
   validateDevTestAccountUsageLimits,
 } = require('./developerTestAccounts');
-const { logErrorInstance } = require('./errorHandlers/standardErrors');
 const { uiCommandReference, uiLine, uiAccountDescription } = require('./ui');
 const SpinniesManager = require('./ui/SpinniesManager');
 const { i18n } = require('./lang');
@@ -47,10 +46,7 @@ const {
   PROJECT_BUILD_TEXT,
   PROJECT_DEPLOY_TEXT,
 } = require('./constants');
-const {
-  logApiErrorInstance,
-  ApiErrorContext,
-} = require('./errorHandlers/apiErrors');
+const { logError, ApiErrorContext } = require('./errorHandlers/index');
 const {
   PERSONAL_ACCESS_KEY_AUTH_METHOD,
 } = require('@hubspot/local-dev-lib/constants/auth');
@@ -82,11 +78,19 @@ const confirmDefaultAccountIsTarget = async accountConfig => {
   }
 };
 
-// Confirm the default account is a developer account if developing public apps
-const checkIfAppDeveloperAccount = accountConfig => {
-  if (!isAppDeveloperAccount(accountConfig)) {
+// Confirm the default account is supported for the type of apps being developed
+const checkIfDefaultAccountIsSupported = (accountConfig, hasPublicApps) => {
+  if (hasPublicApps && !isAppDeveloperAccount(accountConfig)) {
     logger.error(
-      i18n(`${i18nKey}.checkIfAppDevloperAccount`, {
+      i18n(`${i18nKey}.checkIfDefaultAccountIsSupported.publicApp`, {
+        useCommand: uiCommandReference('hs accounts use'),
+        authCommand: uiCommandReference('hs auth'),
+      })
+    );
+    process.exit(EXIT_CODES.SUCCESS);
+  } else if (!hasPublicApps && isAppDeveloperAccount(accountConfig)) {
+    logger.error(
+      i18n(`${i18nKey}.checkIfDefaultAccountIsSupported.privateApp`, {
         useCommand: uiCommandReference('hs accounts use'),
         authCommand: uiCommandReference('hs auth'),
       })
@@ -111,7 +115,7 @@ const checkIfParentAccountIsAuthed = accountConfig => {
 };
 
 // Confirm the default account is a developer account if developing public apps
-const validateAccountOption = (accountConfig, hasPublicApps) => {
+const checkIfAccountFlagIsSupported = (accountConfig, hasPublicApps) => {
   if (hasPublicApps) {
     if (!isDeveloperTestAccount) {
       logger.error(
@@ -184,7 +188,7 @@ const createSandboxForLocalDev = async (accountId, accountConfig, env) => {
         })
       );
     } else {
-      logErrorInstance(err);
+      logError(err);
     }
     process.exit(EXIT_CODES.ERROR);
   }
@@ -223,7 +227,7 @@ const createSandboxForLocalDev = async (accountId, accountConfig, env) => {
     });
     return targetAccountId;
   } catch (err) {
-    logErrorInstance(err);
+    logError(err);
     process.exit(EXIT_CODES.ERROR);
   }
 };
@@ -262,7 +266,7 @@ const createDeveloperTestAccountForLocalDev = async (
         })
       );
     } else {
-      logErrorInstance(err);
+      logError(err);
     }
     process.exit(EXIT_CODES.ERROR);
   }
@@ -288,7 +292,7 @@ const createDeveloperTestAccountForLocalDev = async (
 
     return result.id;
   } catch (err) {
-    logErrorInstance(err);
+    logError(err);
     process.exit(EXIT_CODES.ERROR);
   }
 };
@@ -367,7 +371,10 @@ const createNewProjectForLocalDev = async (
     });
 
     try {
-      const project = await createProject(targetAccountId, projectConfig.name);
+      const { data: project } = await createProject(
+        targetAccountId,
+        projectConfig.name
+      );
       SpinniesManager.succeed('createProject', {
         text: i18n(`${i18nKey}.createNewProjectForLocalDev.createdProject`, {
           accountIdentifier: uiAccountDescription(targetAccountId),
@@ -420,7 +427,7 @@ const createInitialBuildForNewProject = async (
       );
       logger.log();
     } else {
-      logApiErrorInstance(
+      logError(
         initialUploadResult.uploadError,
         new ApiErrorContext({
           accountId: targetAccountId,
@@ -465,8 +472,8 @@ const getAccountHomeUrl = accountId => {
 
 module.exports = {
   confirmDefaultAccountIsTarget,
-  checkIfAppDeveloperAccount,
-  validateAccountOption,
+  checkIfDefaultAccountIsSupported,
+  checkIfAccountFlagIsSupported,
   suggestRecommendedNestedAccount,
   createSandboxForLocalDev,
   createDeveloperTestAccountForLocalDev,

package/lib/marketplace-validate.js

@@ -14,7 +14,7 @@ const SLEEP_TIME = 2000;
 const kickOffValidation = async (accountId, assetType, src) => {
   const requestGroup = 'EXTERNAL_DEVELOPER';
   try {
-    const requestResult = await requestValidation(accountId, {
+    const { data: requestResult } = await requestValidation(accountId, {
       path: src,
       assetType,
       requestGroup,
@@ -29,7 +29,7 @@ const kickOffValidation = async (accountId, assetType, src) => {
 const pollForValidationFinish = async (accountId, validationId) => {
   try {
     const checkValidationStatus = async () => {
-      const validationStatus = await getValidationStatus(accountId, {
+      const { data: validationStatus } = await getValidationStatus(accountId, {
         validationId,
       });
 
@@ -47,7 +47,7 @@ const pollForValidationFinish = async (accountId, validationId) => {
 
 const fetchValidationResults = async (accountId, validationId) => {
   try {
-    const validationResults = await getValidationResults(accountId, {
+    const { data: validationResults } = await getValidationResults(accountId, {
       validationId,
     });
     return validationResults;

package/lib/oauth.js

@@ -1,7 +1,7 @@
 const express = require('express');
 const open = require('open');
 const {
-  default: OAuth2Manager,
+  OAuth2Manager,
 } = require('@hubspot/local-dev-lib/models/OAuth2Manager');
 const { getAccountConfig } = require('@hubspot/local-dev-lib/config');
 const { addOauthToAccountConfig } = require('@hubspot/local-dev-lib/oauth');

package/lib/polling.js

@@ -4,7 +4,7 @@ const poll = (callback, accountId, taskId) => {
   return new Promise((resolve, reject) => {
     const pollInterval = setInterval(async () => {
       try {
-        const pollResp = await callback(accountId, taskId);
+        const { data: pollResp } = await callback(accountId, taskId);
         const { status } = pollResp;
 
         if (status === POLLING_STATUS.SUCCESS) {

package/lib/projectLogsManager.js

@@ -54,10 +54,9 @@ class ProjectLogsManager {
       throw new Error(i18n(`${i18nKey}.errors.noProjectConfig`));
     }
 
-    const { topLevelComponentMetadata } = await fetchProjectComponentsMetadata(
-      this.accountId,
-      this.projectId
-    );
+    const {
+      data: { topLevelComponentMetadata },
+    } = await fetchProjectComponentsMetadata(this.accountId, this.projectId);
 
     const apps = topLevelComponentMetadata.filter(componentMetadata => {
       const { type } = componentMetadata;

package/lib/projectStructure.js

@@ -2,7 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const { walk } = require('@hubspot/local-dev-lib/fs');
 const { logger } = require('@hubspot/local-dev-lib/logger');
-const { logErrorInstance } = require('./errorHandlers/standardErrors');
+const { logError } = require('./errorHandlers/index');
 
 const COMPONENT_TYPES = Object.freeze({
   privateApp: 'private-app',
@@ -94,7 +94,7 @@ async function findProjectComponents(projectSourceDir) {
   try {
     projectFiles = await walk(projectSourceDir);
   } catch (e) {
-    logErrorInstance(e);
+    logError(e);
   }
 
   projectFiles.forEach(projectFile => {

package/lib/projects.js

@@ -33,10 +33,7 @@ const {
   fetchBuildWarnLogs,
   fetchDeployWarnLogs,
 } = require('@hubspot/local-dev-lib/api/projects');
-const {
-  isSpecifiedError,
-  isSpecifiedHubSpotAuthError,
-} = require('@hubspot/local-dev-lib/errors/apiErrors');
+const { isSpecifiedError } = require('@hubspot/local-dev-lib/errors/index');
 const { shouldIgnoreFile } = require('@hubspot/local-dev-lib/ignoreRules');
 const { getCwd, getAbsoluteFilePath } = require('@hubspot/local-dev-lib/path');
 const { downloadGithubRepoContents } = require('@hubspot/local-dev-lib/github');
@@ -45,10 +42,7 @@ const { EXIT_CODES } = require('./enums/exitCodes');
 const { uiLine, uiLink, uiAccountDescription } = require('../lib/ui');
 const { i18n } = require('./lang');
 const SpinniesManager = require('./ui/SpinniesManager');
-const {
-  logApiErrorInstance,
-  ApiErrorContext,
-} = require('./errorHandlers/apiErrors');
+const { logError, ApiErrorContext } = require('./errorHandlers/index');
 
 const i18nKey = 'lib.projects';
 
@@ -215,11 +209,11 @@ const pollFetchProject = async (accountId, projectName) => {
     });
     const pollInterval = setInterval(async () => {
       try {
-        const project = await fetchProject(accountId, projectName);
-        if (project) {
+        const response = await fetchProject(accountId, projectName);
+        if (response && response.data) {
           SpinniesManager.remove('pollFetchProject');
           clearInterval(pollInterval);
-          resolve(project);
+          resolve(response);
         }
       } catch (err) {
         if (
@@ -254,7 +248,7 @@ const ensureProjectExists = async (
 ) => {
   const accountIdentifier = uiAccountDescription(accountId);
   try {
-    const project = withPolling
+    const { data: project } = withPolling
       ? await pollFetchProject(accountId, projectName)
       : await fetchProject(accountId, projectName);
     return { projectExists: !!project, project };
@@ -278,7 +272,7 @@ const ensureProjectExists = async (
 
       if (shouldCreateProject) {
         try {
-          const project = await createProject(accountId, projectName);
+          const { data: project } = await createProject(accountId, projectName);
           logger.success(
             i18n(`${i18nKey}.ensureProjectExists.createSuccess`, {
               projectName,
@@ -287,7 +281,7 @@ const ensureProjectExists = async (
           );
           return { projectExists: true, project };
         } catch (err) {
-          return logApiErrorInstance(err, new ApiErrorContext({ accountId }));
+          return logError(err, new ApiErrorContext({ accountId }));
         }
       } else {
         if (!noLogs) {
@@ -302,14 +296,14 @@ const ensureProjectExists = async (
       }
     }
     if (
-      isSpecifiedHubSpotAuthError(err, {
+      isSpecifiedError(err, {
         statusCode: 401,
       })
     ) {
       logger.error(err.message);
       process.exit(EXIT_CODES.ERROR);
     }
-    logApiErrorInstance(err, new ApiErrorContext({ accountId }));
+    logError(err, new ApiErrorContext({ accountId }));
     process.exit(EXIT_CODES.ERROR);
   }
 };
@@ -364,7 +358,7 @@ const uploadProjectFiles = async (
   let error;
 
   try {
-    const upload = await uploadProject(
+    const { data: upload } = await uploadProject(
       accountId,
       projectName,
       filePath,
@@ -636,8 +630,10 @@ const makePollTaskStatusFunc = ({
     });
 
     const [
-      initialTaskStatus,
-      { topLevelComponentsWithChildren: taskStructure },
+      { data: initialTaskStatus },
+      {
+        data: { topLevelComponentsWithChildren: taskStructure },
+      },
     ] = await Promise.all([
       statusFn(accountId, taskName, taskId),
       structureFn(accountId, taskName, taskId),
@@ -711,9 +707,17 @@ const makePollTaskStatusFunc = ({
       const pollInterval = setInterval(async () => {
         let taskStatus;
         try {
-          taskStatus = await statusFn(accountId, taskName, taskId);
+          const { data } = await statusFn(accountId, taskName, taskId);
+          taskStatus = data;
         } catch (e) {
           logger.debug(e);
+          logError(
+            e,
+            new ApiErrorContext({
+              accountId,
+              projectName: taskName,
+            })
+          );
           return reject(
             new Error(
               i18n(
@@ -981,15 +985,21 @@ const displayWarnLogs = async (
 
   if (isDeploy) {
     try {
-      result = await fetchDeployWarnLogs(accountId, projectName, taskId);
+      const { data } = await fetchDeployWarnLogs(
+        accountId,
+        projectName,
+        taskId
+      );
+      result = data;
     } catch (e) {
-      logApiErrorInstance(e);
+      logError(e);
     }
   } else {
     try {
-      result = await fetchBuildWarnLogs(accountId, projectName, taskId);
+      const { data } = await fetchBuildWarnLogs(accountId, projectName, taskId);
+      result = data;
     } catch (e) {
-      logApiErrorInstance(e);
+      logError(e);
     }
   }