@hubspot/cli 5.4.0 → 6.0.0

package/commands/project/dev.js

@@ -86,11 +86,20 @@ exports.handler = async options => {
   validateProjectConfig(projectConfig, projectDir);
 
   const components = await findProjectComponents(projectDir);
-  const componentTypes = getProjectComponentTypes(components);
+  const runnableComponents = components.filter(component => component.runnable);
+  const componentTypes = getProjectComponentTypes(runnableComponents);
   const hasPrivateApps = !!componentTypes[COMPONENT_TYPES.privateApp];
   const hasPublicApps = !!componentTypes[COMPONENT_TYPES.publicApp];
 
-  if (hasPrivateApps && hasPublicApps) {
+  if (runnableComponents.length === 0) {
+    logger.error(
+      i18n(`${i18nKey}.errors.noRunnableComponents`, {
+        projectDir,
+        command: uiCommandReference('hs project add'),
+      })
+    );
+    process.exit(EXIT_CODES.SUCCESS);
+  } else if (hasPrivateApps && hasPublicApps) {
     logger.error(i18n(`${i18nKey}.errors.invalidProjectComponents`));
     process.exit(EXIT_CODES.SUCCESS);
   }
@@ -114,9 +123,6 @@ exports.handler = async options => {
     }
   }
 
-  let createNewSandbox = false;
-  let createNewDeveloperTestAccount = false;
-
   // The user is targeting an account type that we recommend developing on
   if (!targetProjectAccountId && defaultAccountIsRecommendedType) {
     targetTestingAccountId = accountId;
@@ -145,6 +151,9 @@ exports.handler = async options => {
     checkIfAppDeveloperAccount(accountConfig);
   }
 
+  let createNewSandbox = false;
+  let createNewDeveloperTestAccount = false;
+
   if (!targetProjectAccountId) {
     const {
       targetAccountId,
@@ -224,7 +233,7 @@ exports.handler = async options => {
   }
 
   const LocalDev = new LocalDevManager({
-    components,
+    runnableComponents,
     debug: options.debug,
     deployedBuild,
     isGithubLinked,

package/commands/project/download.js

@@ -108,7 +108,10 @@ exports.handler = async options => {
     );
     process.exit(EXIT_CODES.SUCCESS);
   } catch (e) {
-    logApiErrorInstance(e, new ApiErrorContext({ accountId, projectName }));
+    logApiErrorInstance(
+      e,
+      new ApiErrorContext({ accountId, request: 'project download' })
+    );
     process.exit(EXIT_CODES.ERROR);
   }
 };

package/commands/project/installDeps.js

@@ -0,0 +1,78 @@
+const {
+  installPackages,
+  getProjectPackageJsonLocations,
+} = require('../../lib/dependencyManagement');
+const { logger } = require('@hubspot/local-dev-lib/logger');
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+const { getProjectConfig } = require('../../lib/projects');
+const { promptUser } = require('../../lib/prompts/promptUtils');
+const path = require('path');
+const { i18n } = require('../../lib/lang');
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const { getAccountId } = require('../../lib/commonOpts');
+
+const i18nKey = `commands.project.subcommands.installDeps`;
+
+exports.command = 'install-deps [packages..]';
+// Intentionally making this null to hide command
+exports.describe = null;
+// exports.describe = uiBetaTag(i18n(`${i18nKey}.help.describe`), false);
+
+exports.handler = async ({ packages }) => {
+  try {
+    const accountId = getAccountId();
+    trackCommandUsage('project-install-deps', null, accountId);
+
+    const projectConfig = await getProjectConfig();
+    if (!projectConfig || !projectConfig.projectDir) {
+      logger.error(i18n(`${i18nKey}.noProjectConfig`));
+      return process.exit(EXIT_CODES.ERROR);
+    }
+
+    const { projectDir } = projectConfig;
+
+    let installLocations = await getProjectPackageJsonLocations();
+    if (packages) {
+      const { selectedInstallLocations } = await promptUser([
+        {
+          name: 'selectedInstallLocations',
+          type: 'checkbox',
+          when: () => packages && packages.length > 0,
+          message: i18n(`${i18nKey}.installLocationPrompt`),
+          choices: installLocations.map(dir => ({
+            name: path.relative(projectDir, dir),
+            value: dir,
+          })),
+          validate: choices => {
+            if (choices === undefined || choices.length === 0) {
+              return i18n(`${i18nKey}.installLocationPromptRequired`);
+            }
+            return true;
+          },
+        },
+      ]);
+      if (selectedInstallLocations) {
+        installLocations = selectedInstallLocations;
+      }
+    }
+
+    await installPackages({
+      packages,
+      installLocations,
+    });
+  } catch (e) {
+    logger.debug(e);
+    logger.error(e.message);
+    return process.exit(EXIT_CODES.ERROR);
+  }
+};
+
+exports.builder = yargs => {
+  yargs.example([
+    ['$0 project install-deps', i18n(`${i18nKey}.help.installAppDepsExample`)],
+    [
+      '$0 project install-deps dependency1 dependency2',
+      i18n(`${i18nKey}.help.addDepToSubComponentExample`),
+    ],
+  ]);
+};

package/commands/project/logs.js

@@ -4,253 +4,111 @@ const {
   ENVIRONMENTS,
 } = require('@hubspot/local-dev-lib/constants/environments');
 const {
-  addAccountOptions,
-  addConfigOptions,
   getAccountId,
   addUseEnvironmentOptions,
 } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 const { logger } = require('@hubspot/local-dev-lib/logger');
-// const { outputLogs } = require('../../lib/ui/serverlessFunctionLogs');
-const {
-  fetchProject,
-  fetchDeployComponentsMetadata,
-} = require('@hubspot/local-dev-lib/api/projects');
 const { getTableContents, getTableHeader } = require('../../lib/ui/table');
-// const {
-//   logApiErrorInstance,
-//   ApiErrorContext,
-// } = require('../../lib/errorHandlers/apiErrors');
-// const {
-//   getFunctionLogs,
-//   getLatestFunctionLog,
-//   getProjectAppFunctionLogs,
-//   getLatestProjectAppFunctionLog,
-// } = require('@hubspot/local-dev-lib/api/functions');
+const { logApiErrorInstance } = require('../../lib/errorHandlers/apiErrors');
 
-const { ensureProjectExists } = require('../../lib/projects');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { uiBetaTag, uiLine, uiLink } = require('../../lib/ui');
 const { projectLogsPrompt } = require('../../lib/prompts/projectsLogsPrompt');
-// const { tailLogs } = require('../../lib/serverlessLogs');
 const { i18n } = require('../../lib/lang');
-// const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+const ProjectLogsManager = require('../../lib/projectLogsManager');
 
 const i18nKey = 'commands.project.subcommands.logs';
 
 const getPrivateAppsUrl = accountId => {
   const baseUrl = getHubSpotWebsiteOrigin(
-    getEnv() === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
+    getEnv(accountId) === 'qa' ? ENVIRONMENTS.QA : ENVIRONMENTS.PROD
   );
 
   return `${baseUrl}/private-apps/${accountId}`;
 };
 
-// We currently cannot fetch logs directly to the CLI. See internal CLI issue #413 for more information.
-
-// const handleLogsError = (e, name, projectName) => {
-//   if (e.response && e.response.status === 404) {
-//     logger.debug(`Log fetch error: ${e.message}`);
-//     logger.log(i18n(`${i18nKey}.logs.noLogsFound`, { name }));
-//   } else {
-//     logApiErrorInstance(
-//       e,
-//       new ApiErrorContext({ accountId: getAccountId(), projectName })
-//     );
-//     process.exit(EXIT_CODES.ERROR);
-//   }
-// };
-
-// const handleFunctionLog = async (accountId, options) => {
-//   const {
-//     latest,
-//     follow,
-//     compact,
-//     appPath,
-//     functionName,
-//     projectName,
-//   } = options;
-
-//   let logsResp;
-
-//   const tailCall = async after => {
-//     try {
-//       return appPath
-//         ? getProjectAppFunctionLogs(
-//             accountId,
-//             functionName,
-//             projectName,
-//             appPath,
-//             {
-//               after,
-//             }
-//           )
-//         : getFunctionLogs(accountId, functionName, { after });
-//     } catch (e) {
-//       handleLogsError(e, functionName, projectName);
-//     }
-//   };
-
-//   const fetchLatest = async () => {
-//     return appPath
-//       ? getLatestProjectAppFunctionLog(
-//           accountId,
-//           functionName,
-//           projectName,
-//           appPath
-//         )
-//       : getLatestFunctionLog(accountId, functionName, projectName);
-//   };
-
-//   if (follow) {
-//     await tailLogs({
-//       accountId,
-//       compact,
-//       tailCall,
-//       fetchLatest,
-//       name: functionName,
-//     });
-//   } else if (latest) {
-//     try {
-//       logsResp = await fetchLatest();
-//     } catch (e) {
-//       handleLogsError(e, functionName, projectName);
-//       return true;
-//     }
-//   } else {
-//     try {
-//       logsResp = await tailCall();
-//     } catch (e) {
-//       handleLogsError(e, functionName, projectName);
-//       return true;
-//     }
-//   }
-
-//   if (logsResp) {
-//     outputLogs(logsResp, options);
-//     return true;
-//   }
-//   return false;
-// };
+function logTable(tableHeader, logsInfo) {
+  logger.log(i18n(`${i18nKey}.logs.showingLogs`));
+  logger.log(
+    getTableContents([tableHeader, logsInfo], { border: { bodyLeft: '  ' } })
+  );
+}
+
+function logPreamble() {
+  if (ProjectLogsManager.isPublicFunction) {
+    logTable(
+      getTableHeader([
+        i18n(`${i18nKey}.table.accountHeader`),
+        i18n(`${i18nKey}.table.functionHeader`),
+        i18n(`${i18nKey}.table.endpointHeader`),
+      ]),
+      [
+        ProjectLogsManager.accountId,
+        ProjectLogsManager.functionName,
+        ProjectLogsManager.endpointName,
+      ]
+    );
+    logger.log(
+      uiLink(
+        i18n(`${i18nKey}.logs.hubspotLogsDirectLink`),
+        `${getPrivateAppsUrl(ProjectLogsManager.accountId)}/${
+          ProjectLogsManager.appId
+        }/logs/serverlessGatewayExecution?path=${
+          ProjectLogsManager.endpointName
+        }`
+      )
+    );
+  } else {
+    logTable(
+      getTableHeader([
+        i18n(`${i18nKey}.table.accountHeader`),
+        i18n(`${i18nKey}.table.functionHeader`),
+      ]),
+      [ProjectLogsManager.accountId, ProjectLogsManager.functionName]
+    );
+    logger.log(
+      uiLink(
+        i18n(`${i18nKey}.logs.hubspotLogsDirectLink`),
+        `${getPrivateAppsUrl(ProjectLogsManager.accountId)}/${
+          ProjectLogsManager.appId
+        }/logs/crm?serverlessFunction=${ProjectLogsManager.functionName}`
+      )
+    );
+  }
+  logger.log();
+  uiLine();
+}
 
-exports.command = 'logs [--project] [--app] [--function] [--endpoint]';
+exports.command = 'logs';
 exports.describe = uiBetaTag(i18n(`${i18nKey}.describe`), false);
 
 exports.handler = async options => {
-  await loadAndValidateOptions(options);
-
   const accountId = getAccountId(options);
+  trackCommandUsage('project-logs', null, accountId);
 
-  const {
-    projectName: promptProjectName,
-    appName: promptAppName,
-    functionName: promptFunctionName,
-    endpointName: promptEndpointName,
-  } = await projectLogsPrompt(accountId, options);
-
-  const projectName = options.project || promptProjectName;
-  const appName = options.app || promptAppName;
-  const functionName =
-    options.function || promptFunctionName || options.endpoint;
-  const endpointName = options.endpoint || promptEndpointName;
+  await loadAndValidateOptions(options);
 
-  // let relativeAppPath;
-  let appId;
+  try {
+    await ProjectLogsManager.init(accountId);
 
-  if (appName && !endpointName) {
-    await ensureProjectExists(accountId, projectName, {
-      allowCreate: false,
+    const { functionName } = await projectLogsPrompt({
+      functionChoices: ProjectLogsManager.getFunctionNames(),
+      promptOptions: options,
+      projectName: ProjectLogsManager.projectName,
     });
 
-    // const { deployedBuild, id: projectId } = await fetchProject(
-    //   accountId,
-    //   projectName
-    // );
-    const { id: projectId } = await fetchProject(accountId, projectName);
-
-    const { results: deployComponents } = await fetchDeployComponentsMetadata(
-      accountId,
-      projectId
-    );
-
-    const appComponent = deployComponents.find(
-      c => c.componentName === appName
-    );
-
-    if (appComponent) {
-      appId = appComponent.componentIdentifier;
-    }
-
-    // if (deployedBuild && deployedBuild.subbuildStatuses) {
-    //   const appSubbuild = deployedBuild.subbuildStatuses.find(
-    //     subbuild => subbuild.buildName === appName
-    //   );
-    //   if (appSubbuild) {
-    //     relativeAppPath = appSubbuild.rootPath;
-    //   } else {
-    //     logger.error(
-    //       i18n(`${i18nKey}.errors.invalidAppName`, {
-    //         appName: options.app,
-    //         projectName,
-    //       })
-    //     );
-    //     process.exit(EXIT_CODES.ERROR);
-    //   }
-    // }
-  }
-
-  trackCommandUsage('project-logs', null, accountId);
-
-  const logsInfo = [accountId, `"${projectName}"`];
-  let tableHeader;
+    ProjectLogsManager.setFunction(functionName);
 
-  if (endpointName) {
-    logsInfo.push(`"${endpointName}"`);
-    tableHeader = getTableHeader([
-      i18n(`${i18nKey}.table.accountHeader`),
-      i18n(`${i18nKey}.table.projectHeader`),
-      i18n(`${i18nKey}.table.endpointHeader`),
-    ]);
-  } else {
-    logsInfo.push(`"${appName}"`);
-    logsInfo.push(functionName);
-    tableHeader = getTableHeader([
-      i18n(`${i18nKey}.table.accountHeader`),
-      i18n(`${i18nKey}.table.projectHeader`),
-      i18n(`${i18nKey}.table.appHeader`),
-      i18n(`${i18nKey}.table.functionHeader`),
-    ]);
+    logPreamble();
+  } catch (e) {
+    logApiErrorInstance(e, {
+      accountId: getAccountId(),
+      projectName: ProjectLogsManager.projectName,
+    });
+    return process.exit(EXIT_CODES.ERROR);
   }
-
-  logger.log(i18n(`${i18nKey}.logs.showingLogs`));
-  logger.log(
-    getTableContents([tableHeader, logsInfo], { border: { bodyLeft: '  ' } })
-  );
-
-  logger.log(
-    appId
-      ? uiLink(
-          i18n(`${i18nKey}.logs.hubspotLogsDirectLink`),
-          `${getPrivateAppsUrl(accountId)}/${appId}/logs/extensions`
-        )
-      : uiLink(
-          i18n(`${i18nKey}.logs.hubspotLogsLink`),
-          getPrivateAppsUrl(accountId)
-        )
-  );
-  logger.log();
-  uiLine();
-
-  //   const showFinalMessage = await handleFunctionLog(accountId, {
-  //     ...options,
-  //     projectName,
-  //     appPath: relativeAppPath,
-  //     functionName: functionName || endpointName,
-  //   });
-
-  //   if (showFinalMessage) {
-  //     uiLine();
-  //   }
 };
 
 exports.builder = yargs => {
@@ -262,22 +120,6 @@ exports.builder = yargs => {
         requiresArg: true,
         type: 'string',
       },
-      endpoint: {
-        alias: 'endpoint',
-        describe: i18n(`${i18nKey}.options.endpoint.describe`),
-        requiresArg: true,
-        type: 'string',
-      },
-      app: {
-        describe: i18n(`${i18nKey}.options.app.describe`),
-        requiresArg: true,
-        type: 'string',
-      },
-      project: {
-        describe: i18n(`${i18nKey}.options.project.describe`),
-        requiresArg: true,
-        type: 'string',
-      },
       latest: {
         alias: 'l',
         describe: i18n(`${i18nKey}.options.latest.describe`),
@@ -295,21 +137,17 @@ exports.builder = yargs => {
       limit: {
         describe: i18n(`${i18nKey}.options.limit.describe`),
         type: 'number',
-        default: 10,
       },
     })
-    .conflicts('tail', 'limit');
-
-  yargs.example([['$0 project logs', i18n(`${i18nKey}.examples.default`)]]);
-  yargs.example([
-    [
-      '$0 project logs --project=my-project --app=app --function=my-function',
-      i18n(`${i18nKey}.examples.withOptions`),
-    ],
-  ]);
+    .conflicts('tail', 'limit')
+    .example([
+      ['$0 project logs', i18n(`${i18nKey}.examples.default`)],
+      [
+        '$0 project logs --function=my-function',
+        i18n(`${i18nKey}.examples.withOptions`),
+      ],
+    ]);
 
-  addConfigOptions(yargs);
-  addAccountOptions(yargs);
   addUseEnvironmentOptions(yargs);
 
   return yargs;

package/commands/project/migrateApp.js

@@ -86,14 +86,12 @@ exports.handler = async options => {
         });
 
   let appName;
-  let preventProjectMigrations;
-  let listingInfo;
   try {
     const selectedApp = await fetchPublicAppMetadata(appId, accountId);
     // preventProjectMigrations returns true if we have not added app to allowlist config.
     // listingInfo will only exist for marketplace apps
-    preventProjectMigrations = selectedApp.preventProjectMigrations;
-    listingInfo = selectedApp.listingInfo;
+    const preventProjectMigrations = selectedApp.preventProjectMigrations;
+    const listingInfo = selectedApp.listingInfo;
     if (preventProjectMigrations && listingInfo) {
       logger.error(i18n(`${i18nKey}.errors.invalidApp`, { appId }));
       process.exit(EXIT_CODES.ERROR);
@@ -191,10 +189,9 @@ exports.handler = async options => {
         { includesRootDir: true, hideLogs: true }
       );
 
-      const isListed = Boolean(listingInfo);
       trackCommandMetadataUsage(
         'migrate-app',
-        { projectName, appId, status, preventProjectMigrations, isListed },
+        { type: projectName, assetType: appId, successful: status },
         accountId
       );
 

package/commands/project/upload.js

@@ -75,7 +75,7 @@ exports.handler = async options => {
           result.uploadError,
           new ApiErrorContext({
             accountId,
-            projectName: projectConfig.name,
+            request: 'project upload',
           })
         );
       }
@@ -102,8 +102,10 @@ exports.handler = async options => {
       process.exit(EXIT_CODES.SUCCESS);
     }
   } catch (e) {
-    const projectName = projectConfig.name;
-    logApiErrorInstance(e, new ApiErrorContext({ accountId, projectName }));
+    logApiErrorInstance(
+      e,
+      new ApiErrorContext({ accountId, request: 'project upload' })
+    );
     process.exit(EXIT_CODES.ERROR);
   }
 };

package/commands/project/watch.js

@@ -71,10 +71,7 @@ const handleUserInput = (accountId, projectName, currentBuildId) => {
         ) {
           process.exit(EXIT_CODES.SUCCESS);
         } else {
-          logApiErrorInstance(
-            err,
-            new ApiErrorContext({ accountId, projectName: projectName })
-          );
+          logApiErrorInstance(err, new ApiErrorContext({ accountId }));
           process.exit(EXIT_CODES.ERROR);
         }
       }
@@ -146,7 +143,7 @@ exports.handler = async options => {
             result.uploadError,
             new ApiErrorContext({
               accountId,
-              projectName: projectConfig.name,
+              request: 'project upload',
             })
           );
         }
@@ -156,10 +153,7 @@ exports.handler = async options => {
       await startWatching();
     }
   } catch (e) {
-    logApiErrorInstance(
-      e,
-      new ApiErrorContext({ accountId, projectName: projectConfig.name })
-    );
+    logApiErrorInstance(e, new ApiErrorContext({ accountId }));
   }
 };
 

package/commands/project.js

@@ -13,6 +13,7 @@ const dev = require('./project/dev');
 const add = require('./project/add');
 const migrateApp = require('./project/migrateApp');
 const cloneApp = require('./project/cloneApp');
+const installDeps = require('./project/installDeps');
 
 const i18nKey = 'commands.project';
 
@@ -36,6 +37,7 @@ exports.builder = yargs => {
     .command(open)
     .command(migrateApp)
     .command(cloneApp)
+    .command(installDeps)
     .demandCommand(1, '');
 
   return yargs;

package/commands/sandbox/create.js

@@ -145,6 +145,7 @@ exports.handler = async options => {
     });
 
     const sandboxAccountConfig = getAccountConfig(result.sandbox.sandboxHubId);
+    // For v1 sandboxes, keep sync here. Once we migrate to v2, this will be handled by BE automatically
     const handleSyncSandbox = async syncTasks => {
       await syncSandbox({
         accountConfig: sandboxAccountConfig,

package/commands/sandbox.js

@@ -3,7 +3,6 @@ const { i18n } = require('../lib/lang');
 const { uiBetaTag } = require('../lib/ui');
 const create = require('./sandbox/create');
 const del = require('./sandbox/delete');
-const sync = require('./sandbox/sync');
 
 const i18nKey = 'commands.sandbox';
 
@@ -17,7 +16,6 @@ exports.builder = yargs => {
   yargs
     .command(create)
     .command(del)
-    .command(sync)
     .demandCommand(1, '');
 
   return yargs;