@hubspot/cli 3.0.9 → 3.0.10-beta.11

package/commands/project/logs.js

@@ -0,0 +1,192 @@
+const Spinnies = require('spinnies');
+const { getCwd } = require('@hubspot/cli-lib/path');
+const {
+  addAccountOptions,
+  addConfigOptions,
+  getAccountId,
+  addUseEnvironmentOptions,
+} = require('../../lib/commonOpts');
+const { trackCommandUsage } = require('../../lib/usageTracking');
+const { logger } = require('@hubspot/cli-lib/logger');
+const { outputLogs } = require('@hubspot/cli-lib/lib/logs');
+const {
+  getProjectAppFunctionLogs,
+  getLatestProjectAppFunctionLog,
+} = require('@hubspot/cli-lib/api/functions');
+const { getProjectConfig } = require('../../lib/projects');
+const { loadAndValidateOptions } = require('../../lib/validation');
+const { tailLogs } = require('../../lib/serverlessLogs');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.project.subcommands.logs';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
+
+const handleLogsError = (e, accountId, projectName, appPath, functionName) => {
+  if (e.statusCode === 404) {
+    logger.error(
+      i18n(`${i18nKey}.errors.logs`, {
+        accountId,
+        appPath,
+        functionName,
+        projectName,
+      })
+    );
+  }
+};
+
+const appFunctionLog = async (accountId, options) => {
+  const {
+    latest,
+    follow,
+    compact,
+    appPath,
+    functionName,
+    projectName,
+  } = options;
+
+  let logsResp;
+
+  if (follow) {
+    const spinnies = new Spinnies();
+
+    spinnies.add('tailLogs', {
+      text: i18n(`${i18nKey}.loading`),
+    });
+    const tailCall = after =>
+      getProjectAppFunctionLogs(accountId, functionName, projectName, appPath, {
+        after,
+      });
+    const fetchLatest = () => {
+      try {
+        return getLatestProjectAppFunctionLog(
+          accountId,
+          functionName,
+          projectName,
+          appPath
+        );
+      } catch (e) {
+        handleLogsError(e, accountId, projectName, appPath, functionName);
+      }
+    };
+
+    await tailLogs({
+      accountId,
+      compact,
+      spinnies,
+      tailCall,
+      fetchLatest,
+    });
+  } else if (latest) {
+    try {
+      logsResp = await getLatestProjectAppFunctionLog(
+        accountId,
+        functionName,
+        projectName,
+        appPath
+      );
+    } catch (e) {
+      handleLogsError(e, accountId, projectName, appPath, functionName);
+    }
+  } else {
+    try {
+      logsResp = await getProjectAppFunctionLogs(
+        accountId,
+        functionName,
+        projectName,
+        appPath,
+        {}
+      );
+    } catch (e) {
+      handleLogsError(e, accountId, projectName, appPath, functionName);
+    }
+  }
+
+  if (logsResp) {
+    return outputLogs(logsResp, options);
+  }
+};
+
+exports.command = 'logs [functionName]';
+exports.describe = i18n(`${i18nKey}.describe`);
+
+exports.handler = async options => {
+  await loadAndValidateOptions(options);
+
+  const { latest, functionName, appPath } = options;
+  let projectName = options.projectName;
+
+  if (!functionName) {
+    logger.error(i18n(`${i18nKey}.errors.functionNameRequired`));
+    process.exit(EXIT_CODES.ERROR);
+  } else if (!projectName) {
+    const projectConfig = await getProjectConfig(getCwd());
+    if (projectConfig && projectConfig.name) {
+      projectName = projectConfig.name;
+    } else {
+      logger.error(i18n(`${i18nKey}.errors.projectNameRequired`));
+      process.exit(EXIT_CODES.ERROR);
+    }
+  } else if (!appPath) {
+    logger.error(i18n(`${i18nKey}.errors.appPathRequired`));
+    process.exit(EXIT_CODES.ERROR);
+  }
+
+  const accountId = getAccountId(options);
+
+  trackCommandUsage('project-logs', { latest }, accountId);
+
+  appFunctionLog(accountId, { ...options, projectName });
+};
+
+exports.builder = yargs => {
+  yargs.positional('functionName', {
+    describe: i18n(`${i18nKey}.positionals.functionName.describe`),
+    type: 'string',
+    demandOption: true,
+  });
+  yargs
+    .options({
+      appPath: {
+        describe: i18n(`${i18nKey}.options.appPath.describe`),
+        type: 'string',
+        demandOption: true,
+      },
+      projectName: {
+        describe: i18n(`${i18nKey}.options.projectName.describe`),
+        type: 'string',
+      },
+      latest: {
+        alias: 'l',
+        describe: i18n(`${i18nKey}.options.latest.describe`),
+        type: 'boolean',
+      },
+      compact: {
+        describe: i18n(`${i18nKey}.options.compact.describe`),
+        type: 'boolean',
+      },
+      follow: {
+        alias: ['t', 'tail', 'f'],
+        describe: i18n(`${i18nKey}.options.follow.describe`),
+        type: 'boolean',
+      },
+      limit: {
+        alias: ['limit', 'n', 'max-count'],
+        describe: i18n(`${i18nKey}.options.limit.describe`),
+        type: 'number',
+      },
+    })
+    .conflicts('follow', 'limit');
+
+  yargs.example([
+    [
+      '$0 project logs my-function --appName="app" --projectName="my-project"',
+      i18n(`${i18nKey}.examples.default`),
+    ],
+  ]);
+
+  addConfigOptions(yargs, true);
+  addAccountOptions(yargs, true);
+  addUseEnvironmentOptions(yargs, true);
+
+  return yargs;
+};

package/commands/project/upload.js

@@ -7,55 +7,45 @@ const Spinnies = require('spinnies');
 const {
   addAccountOptions,
   addConfigOptions,
-  setLogLevel,
   getAccountId,
   addUseEnvironmentOptions,
 } = require('../../lib/commonOpts');
 const { trackCommandUsage } = require('../../lib/usageTracking');
-const { logDebugInfo } = require('../../lib/debugInfo');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const {
   logApiErrorInstance,
   ApiErrorContext,
 } = require('@hubspot/cli-lib/errorHandlers');
+const { uiLine, uiAccountDescription } = require('../../lib/ui');
 const { logger } = require('@hubspot/cli-lib/logger');
 const { uploadProject } = require('@hubspot/cli-lib/api/dfs');
 const { shouldIgnoreFile } = require('@hubspot/cli-lib/ignoreRules');
-const { getCwd } = require('@hubspot/cli-lib/path');
-const { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const {
   getProjectConfig,
   validateProjectConfig,
   pollBuildStatus,
   ensureProjectExists,
+  pollDeployStatus,
 } = require('../../lib/projects');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
 
-const loadAndValidateOptions = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
-
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
-};
+const i18nKey = 'cli.commands.project.subcommands.upload';
+const { EXIT_CODES } = require('../../lib/enums/exitCodes');
 
 exports.command = 'upload [path]';
 exports.describe = false;
 
 const uploadProjectFiles = async (accountId, projectName, filePath) => {
-  const spinnies = new Spinnies();
+  const spinnies = new Spinnies({
+    succeedColor: 'white',
+  });
+  const accountIdentifier = uiAccountDescription(accountId);
 
   spinnies.add('upload', {
-    text: `Uploading ${chalk.bold(projectName)} project files to ${chalk.bold(
-      accountId
-    )}`,
+    text: i18n(`${i18nKey}.loading.upload.add`, {
+      accountIdentifier,
+      projectName,
+    }),
   });
 
   let buildId;
@@ -66,25 +56,24 @@ const uploadProjectFiles = async (accountId, projectName, filePath) => {
     buildId = upload.buildId;
 
     spinnies.succeed('upload', {
-      text: `Uploaded ${chalk.bold(projectName)} project files to ${chalk.bold(
-        accountId
-      )}`,
+      text: i18n(`${i18nKey}.loading.upload.succeed`, {
+        accountIdentifier,
+        projectName,
+      }),
     });
 
     logger.debug(
-      `Project "${projectName}" uploaded and build #${buildId} created`
+      i18n(`${i18nKey}.debug.buildCreated`, {
+        buildId,
+        projectName,
+      })
     );
   } catch (err) {
-    if (err.statusCode === 404) {
-      return logger.error(
-        `Project '${projectName}' does not exist. Try running 'hs project init' first.`
-      );
-    }
-
     spinnies.fail('upload', {
-      text: `Failed to upload ${chalk.bold(
-        projectName
-      )} project files to ${chalk.bold(accountId)}`,
+      text: i18n(`${i18nKey}.loading.upload.fail`, {
+        accountIdentifier,
+        projectName,
+      }),
     });
 
     logApiErrorInstance(
@@ -94,50 +83,106 @@ const uploadProjectFiles = async (accountId, projectName, filePath) => {
         projectName,
       })
     );
+    process.exit(EXIT_CODES.ERROR);
   }
 
-  try {
-    await pollBuildStatus(accountId, projectName, buildId);
-  } catch (err) {
-    logger.log(err);
-  }
+  return { buildId };
 };
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
-  const { path: projectPath } = options;
+  const { forceCreate, path: projectPath } = options;
   const accountId = getAccountId(options);
 
   trackCommandUsage('project-upload', { projectPath }, accountId);
 
-  const projectDir = projectPath
-    ? path.resolve(getCwd(), projectPath)
-    : getCwd();
-  const projectConfig = await getProjectConfig(projectDir);
+  const { projectConfig, projectDir } = await getProjectConfig(projectPath);
 
   validateProjectConfig(projectConfig, projectDir);
 
-  await ensureProjectExists(accountId, projectConfig.name);
+  await ensureProjectExists(accountId, projectConfig.name, forceCreate);
 
   const tempFile = tmp.fileSync({ postfix: '.zip' });
 
-  logger.debug(`Compressing build files to '${tempFile.name}'`);
+  logger.debug(
+    i18n(`${i18nKey}.debug.compressing`, {
+      path: tempFile.name,
+    })
+  );
 
   const output = fs.createWriteStream(tempFile.name);
   const archive = archiver('zip');
 
   output.on('close', async function() {
-    logger.debug(`Project files compressed: ${archive.pointer()} bytes`);
+    let exitCode = EXIT_CODES.SUCCESS;
+    logger.debug(
+      i18n(`${i18nKey}.debug.compressed`, {
+        byteCount: archive.pointer(),
+      })
+    );
 
-    await uploadProjectFiles(accountId, projectConfig.name, tempFile.name);
+    const { buildId } = await uploadProjectFiles(
+      accountId,
+      projectConfig.name,
+      tempFile.name
+    );
+
+    const {
+      isAutoDeployEnabled,
+      deployStatusTaskLocator,
+      status,
+    } = await pollBuildStatus(accountId, projectConfig.name, buildId);
+
+    if (status === 'FAILURE') {
+      exitCode = EXIT_CODES.ERROR;
+      return;
+    } else if (isAutoDeployEnabled && deployStatusTaskLocator) {
+      logger.log(
+        i18n(`${i18nKey}.logs.buildSucceededAutomaticallyDeploying`, {
+          accountIdentifier: uiAccountDescription(accountId),
+          buildId,
+        })
+      );
+      const { status } = await pollDeployStatus(
+        accountId,
+        projectConfig.name,
+        deployStatusTaskLocator.id,
+        buildId
+      );
+      if (status === 'FAILURE') {
+        exitCode = EXIT_CODES.ERROR;
+      }
+    } else {
+      uiLine();
+      logger.log(
+        chalk.bold(
+          i18n(`${i18nKey}.logs.buildSucceeded`, {
+            buildId,
+          })
+        )
+      );
+      logger.log(i18n(`${i18nKey}.logs.readyToGoLive`));
+      logger.log(
+        i18n(`${i18nKey}.logs.runCommand`, {
+          command: chalk.hex('f5c26b')('hs project deploy'),
+        })
+      );
+      uiLine();
+    }
 
     try {
       tempFile.removeCallback();
-      logger.debug(`Cleaned up temporary file ${tempFile.name}`);
+      logger.debug(
+        i18n(`${i18nKey}.debug.cleanedUpTempFile`, {
+          path: tempFile.name,
+        })
+      );
     } catch (e) {
       logger.error(e);
     }
+
+    process.exit(exitCode);
   });
 
   archive.on('error', function(err) {
@@ -157,11 +202,19 @@ exports.handler = async options => {
 
 exports.builder = yargs => {
   yargs.positional('path', {
-    describe: 'Path to a project folder',
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
 
-  yargs.example([['$0 project upload myProjectFolder', 'Upload a project']]);
+  yargs.option('forceCreate', {
+    describe: i18n(`${i18nKey}.options.forceCreate.describe`),
+    type: 'boolean',
+    default: false,
+  });
+
+  yargs.example([
+    ['$0 project upload myProjectFolder', i18n(`${i18nKey}.examples.default`)],
+  ]);
 
   addConfigOptions(yargs, true);
   addAccountOptions(yargs, true);

package/commands/project.js

@@ -1,24 +1,23 @@
-const {
-  addConfigOptions,
-  addAccountOptions,
-  addOverwriteOptions,
-} = require('../lib/commonOpts');
+const { addConfigOptions, addAccountOptions } = require('../lib/commonOpts');
 const deploy = require('./project/deploy');
-const init = require('./project/init');
+const create = require('./project/create');
 const upload = require('./project/upload');
+const listBuilds = require('./project/listBuilds');
+const logs = require('./project/logs');
 
 exports.command = 'project';
 exports.describe = false; //'Commands for working with projects';
 
 exports.builder = yargs => {
-  addOverwriteOptions(yargs, true);
   addConfigOptions(yargs, true);
   addAccountOptions(yargs, true);
 
   // TODO: deploy must be updated
   yargs.command(deploy).demandCommand(1, '');
-  yargs.command(init).demandCommand(0, '');
+  yargs.command(create).demandCommand(0, '');
   yargs.command(upload).demandCommand(0, '');
+  yargs.command(listBuilds).demandCommand(0, '');
+  yargs.command(logs).demandCommand(1, '');
 
   return yargs;
 };

package/commands/remove.js

@@ -1,9 +1,4 @@
 const { deleteFile } = require('@hubspot/cli-lib/api/fileMapper');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logApiErrorInstance,
@@ -14,26 +9,21 @@ const {
   addConfigOptions,
   addAccountOptions,
   addUseEnvironmentOptions,
-  setLogLevel,
   getAccountId,
 } = require('../lib/commonOpts');
-const { logDebugInfo } = require('../lib/debugInfo');
-const { validateAccount } = require('../lib/validation');
+const { loadAndValidateOptions } = require('../lib/validation');
 const { trackCommandUsage } = require('../lib/usageTracking');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.remove';
 
 exports.command = 'remove <path>';
-exports.describe = 'Delete a file or folder from HubSpot';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  setLogLevel(options);
-  logDebugInfo(options);
-  const { config: configPath, path: hsPath } = options;
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  const { path: hsPath } = options;
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
+  await loadAndValidateOptions(options);
 
   const accountId = getAccountId(options);
 
@@ -41,9 +31,11 @@ exports.handler = async options => {
 
   try {
     await deleteFile(accountId, hsPath);
-    logger.log(`Deleted "${hsPath}" from account ${accountId}`);
+    logger.log(i18n(`${i18nKey}.deleted`, { accountId, path: hsPath }));
   } catch (error) {
-    logger.error(`Deleting "${hsPath}" from account ${accountId} failed`);
+    logger.error(
+      i18n(`${i18nKey}.errors.deleteFailed`, { accountId, path: hsPath })
+    );
     logApiErrorInstance(
       error,
       new ApiErrorContext({
@@ -59,7 +51,7 @@ exports.builder = yargs => {
   addAccountOptions(yargs, true);
   addUseEnvironmentOptions(yargs, true);
   yargs.positional('path', {
-    describe: 'Remote hubspot path',
+    describe: i18n(`${i18nKey}.positionals.path.describe`),
     type: 'string',
   });
   return yargs;

package/commands/sandbox/create.js

@@ -10,12 +10,15 @@ const { logger } = require('@hubspot/cli-lib/logger');
 const { createSandbox } = require('@hubspot/cli-lib/sandboxes');
 const { loadAndValidateOptions } = require('../../lib/validation');
 const { createSandbox: prompt } = require('../../lib/prompts/sandboxes');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.sandbox.subcommands.create';
 
 exports.command = 'create [name]';
 exports.describe = false;
 
 exports.handler = async options => {
-  loadAndValidateOptions(options);
+  await loadAndValidateOptions(options);
 
   const { name } = options;
   const accountId = getAccountId(options);
@@ -29,31 +32,33 @@ exports.handler = async options => {
 
   const sandboxName = name || namePrompt.name;
 
-  logger.debug(`Creating sandbox '${sandboxName}'`);
+  logger.debug(
+    i18n(`${i18nKey}.debug.creating`, {
+      name: sandboxName,
+    })
+  );
 
   return createSandbox(accountId, sandboxName).then(
     ({ name, sandboxHubId }) => {
       logger.success(
-        `Sandbox '${name}' with portalId '${sandboxHubId}' created successfully.`
-      );
-      logger.info(
-        `Run 'hs auth' to authenticate with the new sandbox account.`
+        i18n(`${i18nKey}.describe`, {
+          name,
+          sandboxHubId,
+        })
       );
+      logger.info(i18n(`${i18nKey}.info.auth`));
     }
   );
 };
 
 exports.builder = yargs => {
   yargs.positional('name', {
-    describe: 'Name to use for created sandbox',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
 
   yargs.example([
-    [
-      '$0 sandbox create MySandboxAccount',
-      'Create a sandbox account named MySandboxAccount.',
-    ],
+    ['$0 sandbox create MySandboxAccount', i18n(`${i18nKey}.examples.default`)],
   ]);
 
   addConfigOptions(yargs, true);

package/commands/secrets/addSecret.js

@@ -1,8 +1,3 @@
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-} = require('@hubspot/cli-lib');
 const { logger } = require('@hubspot/cli-lib/logger');
 const {
   logServerlessFunctionApiErrorInstance,
@@ -10,33 +5,28 @@ const {
 } = require('@hubspot/cli-lib/errorHandlers');
 const { addSecret } = require('@hubspot/cli-lib/api/secrets');
 
-const { validateAccount } = require('../../lib/validation');
+const { loadAndValidateOptions } = require('../../lib/validation');
 const { trackCommandUsage } = require('../../lib/usageTracking');
 
 const {
   addConfigOptions,
   addAccountOptions,
   addUseEnvironmentOptions,
-  setLogLevel,
   getAccountId,
 } = require('../../lib/commonOpts');
-const { logDebugInfo } = require('../../lib/debugInfo');
 const { secretValuePrompt } = require('../../lib/secretPrompt');
+const { i18n } = require('@hubspot/cli-lib/lib/lang');
+
+const i18nKey = 'cli.commands.secrets.subcommands.add';
 
 exports.command = 'add <name>';
-exports.describe = 'Add a HubSpot secret';
+exports.describe = i18n(`${i18nKey}.describe`);
 
 exports.handler = async options => {
-  const { config: configPath, name: secretName } = options;
+  const { name: secretName } = options;
 
-  setLogLevel(options);
-  logDebugInfo(options);
-  loadConfig(configPath, options);
-  checkAndWarnGitInclusion();
+  await loadAndValidateOptions(options);
 
-  if (!(validateConfig() && (await validateAccount(options)))) {
-    process.exit(1);
-  }
   const accountId = getAccountId(options);
   trackCommandUsage('secrets-add', {}, accountId);
 
@@ -44,11 +34,18 @@ exports.handler = async options => {
     const { secretValue } = await secretValuePrompt();
 
     await addSecret(accountId, secretName, secretValue);
-    logger.log(
-      `The secret "${secretName}" was added to the HubSpot account: ${accountId}`
+    logger.success(
+      i18n(`${i18nKey}.success.add`, {
+        accountId,
+        secretName,
+      })
     );
   } catch (e) {
-    logger.error(`The secret "${secretName}" was not added`);
+    logger.error(
+      i18n(`${i18nKey}.errors.add`, {
+        secretName,
+      })
+    );
     await logServerlessFunctionApiErrorInstance(
       accountId,
       e,
@@ -65,7 +62,7 @@ exports.builder = yargs => {
   addAccountOptions(yargs, true);
   addUseEnvironmentOptions(yargs, true);
   yargs.positional('name', {
-    describe: 'Name of the secret',
+    describe: i18n(`${i18nKey}.positionals.name.describe`),
     type: 'string',
   });
   return yargs;