@hubspot/cli 3.0.12 → 3.0.13-beta.2

package/lib/validators/marketplaceValidators/module/ModuleDependencyValidator.js

@@ -0,0 +1,101 @@
+const path = require('path');
+
+const { logger } = require('@hubspot/cli-lib/logger');
+const { HUBSPOT_FOLDER } = require('@hubspot/cli-lib/lib/constants');
+const { fetchModuleDependencies } = require('@hubspot/cli-lib/api/marketplace');
+const { isRelativePath } = require('@hubspot/cli-lib/path');
+
+const RelativeValidator = require('../RelativeValidator');
+const { VALIDATOR_KEYS } = require('../../constants');
+
+class ModuleDependencyValidator extends RelativeValidator {
+  constructor(options) {
+    super(options);
+
+    this.errors = {
+      FAILED_TO_FETCH_DEPS: {
+        key: 'failedDepFetch',
+        getCopy: ({ filePath }) =>
+          `Internal Error. Failed to fetch dependencies for ${filePath}. Please try again`,
+      },
+      EXTERNAL_DEPENDENCY: {
+        key: 'externalDependency',
+        getCopy: ({ filePath, referencedFilePath }) =>
+          `External dependency. ${filePath} references a file (${referencedFilePath}) that is outside of the module's immediate folder.`,
+      },
+      ABSOLUTE_DEPENDENCY_PATH: {
+        key: 'absoluteDependencyPath',
+        getCopy: ({ filePath, referencedFilePath }) =>
+          `Relative path required. ${filePath} references a file (${referencedFilePath}) using an absolute path`,
+      },
+    };
+  }
+
+  failedToFetchDependencies(err, relativePath, validationErrors) {
+    logger.debug(
+      `Failed to fetch dependencies for ${relativePath}: `,
+      err.error
+    );
+
+    validationErrors.push(
+      this.getError(this.errors.FAILED_TO_FETCH_DEPS, relativePath)
+    );
+  }
+
+  async getAllDependenciesByPath(relativePath, accountId, validationErrors) {
+    let deps = [];
+    const file_deps = await fetchModuleDependencies(
+      accountId,
+      relativePath
+    ).catch(err => {
+      this.failedToFetchDependencies(err, relativePath, validationErrors);
+      return null;
+    });
+    if (file_deps) {
+      deps = file_deps.dependencies || [];
+    }
+    return deps;
+  }
+
+  isExternalDep(relPath, relativeDepPath) {
+    const moduleDir = path.parse(relPath).dir;
+    const depDir = path.parse(relativeDepPath).dir;
+    return !depDir.startsWith(moduleDir);
+  }
+
+  // Validates:
+  // - Module does not contain external dependencies
+  // - All paths are either @hubspot or relative
+  async validate(relativePath, accountId) {
+    let validationErrors = [];
+
+    const dependencyData = await this.getAllDependenciesByPath(
+      relativePath,
+      accountId,
+      validationErrors
+    );
+    dependencyData.forEach(dependency => {
+      if (!dependency.startsWith(HUBSPOT_FOLDER)) {
+        if (!isRelativePath(dependency)) {
+          validationErrors.push(
+            this.getError(this.errors.ABSOLUTE_DEPENDENCY_PATH, relativePath, {
+              referencedFilePath: dependency,
+            })
+          );
+        } else if (this.isExternalDep(relativePath, dependency)) {
+          validationErrors.push(
+            this.getError(this.errors.EXTERNAL_DEPENDENCY, relativePath, {
+              referencedFilePath: dependency,
+            })
+          );
+        }
+      }
+    });
+    return validationErrors;
+  }
+}
+
+module.exports = new ModuleDependencyValidator({
+  name: 'Module dependency',
+  key: VALIDATOR_KEYS.moduleDependency,
+});

package/lib/validators/marketplaceValidators/module/ModuleValidator.js

@@ -0,0 +1,102 @@
+const { logger } = require('@hubspot/cli-lib/logger');
+const { fetchModuleMeta } = require('@hubspot/cli-lib/api/marketplace');
+const RelativeValidator = require('../RelativeValidator');
+const { VALIDATOR_KEYS } = require('../../constants');
+
+class ModuleValidator extends RelativeValidator {
+  constructor(options) {
+    super(options);
+
+    this.errors = {
+      FAILED_TO_FETCH_META_JSON: {
+        key: 'failedMetaFetch',
+        getCopy: ({ filePath }) =>
+          `Internal error. Failed to fetch meta.json for ${filePath}. Please try again.`,
+      },
+      MISSING_META_JSON: {
+        key: 'missingMetaJSON',
+        getCopy: ({ filePath }) =>
+          `Module ${filePath} is missing the meta.json file`,
+      },
+      INVALID_META_JSON: {
+        key: 'invalidMetaJSON',
+        getCopy: ({ filePath }) =>
+          `Module ${filePath} has invalid json in the meta.json file`,
+      },
+      MISSING_LABEL: {
+        key: 'missingLabel',
+        getCopy: ({ filePath }) =>
+          `Missing required property for ${filePath}. The meta.json file is missing the "label" property`,
+      },
+      MISSING_ICON: {
+        key: 'missingIcon',
+        getCopy: ({ filePath }) =>
+          `Missing required property for ${filePath}. The meta.json file is missing the "icon" property`,
+      },
+    };
+  }
+  failedToFetchDependencies(err, relativePath, validationErrors) {
+    logger.debug(
+      `Failed to fetch dependencies for ${relativePath}: `,
+      err.error
+    );
+    validationErrors.push(
+      this.getError(this.errors.FAILED_TO_FETCH_META_JSON, relativePath)
+    );
+  }
+
+  async getModuleMetaByPath(relativePath, accountId, validationErrors) {
+    const moduleMeta = await fetchModuleMeta(accountId, relativePath).catch(
+      err => {
+        this.failedToFetchDependencies(err, relativePath, validationErrors);
+        return null;
+      }
+    );
+    return moduleMeta;
+  }
+
+  // Validates:
+  // - Module folder contains a meta.json file
+  // - Module meta.json file contains valid json
+  // - Module meta.json file has a "label" field
+  // - Module meta.json file has an "icon" field
+  async validate(relativePath, accountId) {
+    let validationErrors = [];
+    const metaJSONFile = await this.getModuleMetaByPath(
+      relativePath,
+      accountId,
+      validationErrors
+    );
+    if (!metaJSONFile) {
+      validationErrors.push(
+        this.getError(this.errors.MISSING_META_JSON, relativePath)
+      );
+    }
+    let metaJSON;
+    try {
+      metaJSON = JSON.parse(metaJSONFile.source);
+    } catch (err) {
+      validationErrors.push(
+        this.getError(this.errors.INVALID_META_JSON, relativePath)
+      );
+    }
+    if (metaJSON) {
+      if (!metaJSON.label) {
+        validationErrors.push(
+          this.getError(this.errors.MISSING_LABEL, relativePath)
+        );
+      }
+      if (!metaJSON.icon) {
+        validationErrors.push(
+          this.getError(this.errors.MISSING_ICON, relativePath)
+        );
+      }
+    }
+    return validationErrors;
+  }
+}
+
+module.exports = new ModuleValidator({
+  name: 'Module',
+  key: VALIDATOR_KEYS.module,
+});

package/lib/validators/marketplaceValidators/theme/SectionValidator.js

@@ -2,12 +2,12 @@ const {
   ANNOTATION_KEYS,
   buildAnnotationValueGetter,
 } = require('@hubspot/cli-lib/templates');
-const BaseValidator = require('../BaseValidator');
+const AbsoluteValidator = require('../AbsoluteValidator');
 const { VALIDATOR_KEYS } = require('../../constants');
 
 const SECTION_LIMIT = 50;
 
-class SectionValidator extends BaseValidator {
+class SectionValidator extends AbsoluteValidator {
   constructor(options) {
     super(options);
 

package/lib/validators/marketplaceValidators/theme/TemplateValidator.js

@@ -3,7 +3,7 @@ const {
   buildAnnotationValueGetter,
   isCodedFile,
 } = require('@hubspot/cli-lib/templates');
-const BaseValidator = require('../BaseValidator');
+const AbsoluteValidator = require('../AbsoluteValidator');
 const { VALIDATOR_KEYS } = require('../../constants');
 
 const TEMPLATE_LIMIT = 50;
@@ -50,7 +50,7 @@ const VALIDATIONS_BY_TYPE = {
   blog_post: { allowed: true, label: true, screenshot: true },
 };
 
-class TemplateValidator extends BaseValidator {
+class TemplateValidator extends AbsoluteValidator {
   constructor(options) {
     super(options);
 

package/lib/validators/marketplaceValidators/theme/ThemeConfigValidator.js

@@ -2,10 +2,10 @@ const fs = require('fs');
 const path = require('path');
 
 const { isRelativePath } = require('@hubspot/cli-lib/path');
-const BaseValidator = require('../BaseValidator');
+const AbsoluteValidator = require('../AbsoluteValidator');
 const { VALIDATOR_KEYS } = require('../../constants');
 
-class ThemeValidator extends BaseValidator {
+class ThemeValidator extends AbsoluteValidator {
   constructor(options) {
     super(options);
 
@@ -84,7 +84,7 @@ class ThemeValidator extends BaseValidator {
           );
         } else {
           const absoluteScreenshotPath = path.resolve(
-            this._absoluteThemePath,
+            this._absolutePath,
             themeJSON.screenshot_path
           );
           if (!fs.existsSync(absoluteScreenshotPath)) {

package/lib/validators/marketplaceValidators/theme/{DependencyValidator.js → ThemeDependencyValidator.js}

@@ -6,13 +6,15 @@ const {
   HUBL_EXTENSIONS,
   HUBSPOT_FOLDER,
 } = require('@hubspot/cli-lib/lib/constants');
-const { fetchDependencies } = require('@hubspot/cli-lib/api/marketplace');
+const {
+  fetchTemplateDependencies,
+} = require('@hubspot/cli-lib/api/marketplace');
 const { getExt, isRelativePath } = require('@hubspot/cli-lib/path');
 
-const BaseValidator = require('../BaseValidator');
+const AbsoluteValidator = require('../AbsoluteValidator');
 const { VALIDATOR_KEYS } = require('../../constants');
 
-class DependencyValidator extends BaseValidator {
+class ThemeDependencyValidator extends AbsoluteValidator {
   constructor(options) {
     super(options);
 
@@ -53,12 +55,13 @@ class DependencyValidator extends BaseValidator {
           if (!(source && source.trim())) {
             return { file, deps };
           }
-          const file_deps = await fetchDependencies(accountId, source).catch(
-            err => {
-              this.failedToFetchDependencies(err, file, validationErrors);
-              return null;
-            }
-          );
+          const file_deps = await fetchTemplateDependencies(
+            accountId,
+            source
+          ).catch(err => {
+            this.failedToFetchDependencies(err, file, validationErrors);
+            return null;
+          });
           if (file_deps) {
             deps = file_deps.dependencies || [];
           }
@@ -117,7 +120,7 @@ class DependencyValidator extends BaseValidator {
   }
 }
 
-module.exports = new DependencyValidator({
-  name: 'Dependency',
-  key: VALIDATOR_KEYS.dependency,
+module.exports = new ThemeDependencyValidator({
+  name: 'Theme dependency',
+  key: VALIDATOR_KEYS.themeDependency,
 });

package/lib/validators/marketplaceValidators/theme/{ModuleValidator.js → ThemeModuleValidator.js}

@@ -2,12 +2,12 @@ const fs = require('fs');
 const path = require('path');
 
 const { isModuleFolderChild } = require('@hubspot/cli-lib/modules');
-const BaseValidator = require('../BaseValidator');
+const AbsoluteValidator = require('../AbsoluteValidator');
 const { VALIDATOR_KEYS } = require('../../constants');
 
 const MODULE_LIMIT = 50;
 
-class ModuleValidator extends BaseValidator {
+class ThemeModuleValidator extends AbsoluteValidator {
   constructor(options) {
     super(options);
 
@@ -111,7 +111,7 @@ class ModuleValidator extends BaseValidator {
   }
 }
 
-module.exports = new ModuleValidator({
-  name: 'Module',
-  key: VALIDATOR_KEYS.module,
+module.exports = new ThemeModuleValidator({
+  name: 'Theme modules',
+  key: VALIDATOR_KEYS.themeModule,
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/cli",
-  "version": "3.0.12",
+  "version": "3.0.13-beta.2",
   "description": "CLI for working with HubSpot",
   "license": "Apache-2.0",
   "repository": {
@@ -8,8 +8,8 @@
     "url": "https://github.com/HubSpot/hubspot-cms-tools"
   },
   "dependencies": {
-    "@hubspot/cli-lib": "^3.0.12",
-    "@hubspot/serverless-dev-runtime": "^3.0.12",
+    "@hubspot/cli-lib": "3.0.13-beta.2",
+    "@hubspot/serverless-dev-runtime": "3.0.13-beta.2",
     "archiver": "^5.3.0",
     "chalk": "^4.1.2",
     "express": "^4.17.1",
@@ -19,7 +19,6 @@
     "moment": "^2.29.1",
     "open": "^7.0.3",
     "ora": "^4.0.3",
-    "shelljs": "0.8.3",
     "spinnies": "^0.5.1",
     "supports-hyperlinks": "^2.2.0",
     "tmp": "^0.2.1",
@@ -39,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "837c419fdb8dec12ad25c5c2965b9174409a0ee2"
+  "gitHead": "ff694f8c61c2326159f7ad4d3f2cfdb18f8c1875"
 }

package/bin/hubspot

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-require('./cli');

package/commands/config/set/defaultAccount.js

@@ -1,94 +0,0 @@
-const { logger } = require('@hubspot/cli-lib/logger');
-const {
-  getConfig,
-  getConfigPath,
-  updateDefaultAccount,
-} = require('@hubspot/cli-lib/lib/config');
-const { loadAndValidateOptions } = require('../../../lib/validation');
-
-const { getAccountId } = require('../../../lib/commonOpts');
-const { trackCommandUsage } = require('../../../lib/usageTracking');
-const { promptUser } = require('../../../lib/prompts/promptUtils');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
-
-const i18nKey =
-  'cli.commands.config.subcommands.set.subcommands.defaultAccount';
-
-const selectAccountFromConfig = async config => {
-  const { default: selectedDefault } = await promptUser([
-    {
-      type: 'list',
-      look: false,
-      name: 'default',
-      pageSize: 20,
-      message: i18n(`${i18nKey}.promptMessage`),
-      choices: config.portals.map(p => p.name || p.portalId),
-      default: config.defaultPortal,
-    },
-  ]);
-
-  return selectedDefault;
-};
-
-exports.command = 'default-account [newDefault]';
-exports.describe = i18n(`${i18nKey}.describe`);
-
-exports.handler = async options => {
-  await loadAndValidateOptions(options);
-
-  const accountId = getAccountId(options);
-  const config = getConfig();
-  const configPath = getConfigPath();
-  const { newDefault: specifiedNewDefault } = options;
-  let newDefault;
-
-  trackCommandUsage('config-set-default-account', {}, accountId);
-
-  if (!specifiedNewDefault) {
-    newDefault = await selectAccountFromConfig(config);
-  } else if (
-    specifiedNewDefault &&
-    config.portals.find(
-      p => p.name === specifiedNewDefault || p.portalId === specifiedNewDefault
-    )
-  ) {
-    newDefault = specifiedNewDefault;
-  } else {
-    logger.error(
-      i18n(`${i18nKey}.errors.accountNotFound`, {
-        specifiedAccount: specifiedNewDefault,
-        configPath,
-      })
-    );
-    newDefault = await selectAccountFromConfig(config);
-  }
-
-  updateDefaultAccount(newDefault);
-
-  return logger.success(
-    i18n(`${i18nKey}.success.defaultAccountUpdated`, {
-      accountName: newDefault,
-    })
-  );
-};
-
-exports.builder = yargs => {
-  yargs.positional('newDefault', {
-    describe: i18n(`${i18nKey}.positionals.newDefault.describe`),
-    type: 'string',
-  });
-
-  yargs.example([
-    ['$0 config set default-account', i18n(`${i18nKey}.examples.default`)],
-    [
-      '$0 config set default-account MyAccount',
-      i18n(`${i18nKey}.examples.nameBased`),
-    ],
-    [
-      '$0 config set default-account 1234567',
-      i18n(`${i18nKey}.examples.idBased`),
-    ],
-  ]);
-
-  return yargs;
-};

package/commands/server.js

@@ -1,80 +0,0 @@
-#!/usr/bin/env node
-const path = require('path');
-const shell = require('shelljs');
-const {
-  loadConfig,
-  validateConfig,
-  checkAndWarnGitInclusion,
-  getConfigPath,
-} = require('@hubspot/cli-lib');
-const { logger } = require('@hubspot/cli-lib/logger');
-const { getCwd } = require('@hubspot/cli-lib/path');
-
-const { version } = require('../package.json');
-const { updateServerContext } = require('../lib/server/updateContext');
-
-const {
-  addConfigOptions,
-  addLoggerOptions,
-  addAccountOptions,
-  addUseEnvironmentOptions,
-  setLogLevel,
-  getAccountId,
-} = require('../lib/commonOpts');
-const { logDebugInfo } = require('../lib/debugInfo');
-const { i18n } = require('@hubspot/cli-lib/lib/lang');
-
-const i18nKey = 'cli.commands.server';
-const { EXIT_CODES } = require('../lib/enums/exitCodes');
-
-function configureServerCommand(program) {
-  program
-    .version(version)
-    .description(i18n(`${i18nKey}.description`))
-    .option('--serverConfig <serverConfig>')
-    .option('--contextDir [contextDir]')
-    .arguments('<src>')
-    .action(async (src, options) => {
-      setLogLevel(options);
-      logDebugInfo(options);
-      const { config: configPath, serverConfig, contextDir } = options;
-      loadConfig(configPath, options);
-      checkAndWarnGitInclusion(getConfigPath());
-
-      if (!validateConfig()) {
-        process.exit(EXIT_CODES.ERROR);
-      }
-
-      const accountId = getAccountId(options);
-
-      // TODO: add flag to bypass
-      logger.log(i18n(`${i18nKey}.fetching`, { accountId }));
-      await updateServerContext(accountId, path.join(getCwd(), contextDir));
-
-      const cwd = getCwd();
-      const cmd = `
-    docker run -p 8080:8080 \
-    -v ${cwd}/${src}:/local-cms-server/${src} \
-    -v ${cwd}/${contextDir}:/local-cms-server/${contextDir} \
-    -v ${cwd}/${serverConfig}:/local-cms-server/${serverConfig} \
-    hubspot/local-cms-server
-  `;
-
-      logger.log(i18n(`${i18nKey}.startingServer`));
-      logger.debug(
-        i18n(`${i18nKey}.runningServer`, {
-          cmd,
-        })
-      );
-      shell.exec(cmd, { async: true });
-    });
-
-  addLoggerOptions(program);
-  addAccountOptions(program);
-  addConfigOptions(program);
-  addUseEnvironmentOptions(program);
-}
-
-module.exports = {
-  configureServerCommand,
-};

package/lib/server/updateContext.js

@@ -1,105 +0,0 @@
-const path = require('path');
-const fs = require('fs-extra');
-const { logger } = require('@hubspot/cli-lib/logger');
-const {
-  logErrorInstance,
-  ApiErrorContext,
-} = require('@hubspot/cli-lib/errorHandlers');
-const { fetchContent } = require('@hubspot/cli-lib/api/content');
-const { fetchBlogs } = require('@hubspot/cli-lib/api/blogs');
-const { fetchMenus } = require('@hubspot/cli-lib/api/designManager');
-
-async function writeObjects(accountId, contextPath, objectType, objects) {
-  const dest = path.join(contextPath, objectType, accountId.toString());
-  logger.debug('Writing %s data to %s', objectType, dest);
-  fs.mkdirpSync(dest);
-  return Promise.all(
-    objects.map(async object => {
-      const filepath = path.join(dest, `${object.id}.json`);
-      return fs.writeJson(filepath, object);
-    })
-  );
-}
-
-async function fetchAll(accountId, apiHelper, params) {
-  let objects = [];
-  let count = 0;
-  let totalObjects = null;
-  let offset = 0;
-
-  while (totalObjects === null || count < totalObjects) {
-    const response = await apiHelper(accountId, { ...params, offset });
-    if (totalObjects === null) {
-      totalObjects = response.total;
-    }
-
-    logger.debug(`Fetched ${response.objects.length} objects`);
-    count += response.objects.length;
-    offset += response.objects.length;
-    objects = objects.concat(response.objects);
-  }
-  return Promise.resolve(objects);
-}
-
-function copyDefaultContext(contextPath) {
-  const defaultContextPath = path.resolve(__dirname, '../../defaults/context');
-  const files = fs.readdirSync(defaultContextPath);
-  files.forEach(file => {
-    if (path.extname(file) !== '.json') {
-      return;
-    }
-    const destPath = path.join(contextPath, file);
-    if (!fs.existsSync(destPath)) {
-      logger.debug(`Copying context file "${file}" to "${destPath}"`);
-      fs.copySync(path.resolve(defaultContextPath, file), destPath);
-    }
-  });
-}
-
-async function updateServerContext(accountId, contextPath) {
-  copyDefaultContext(contextPath);
-
-  try {
-    const blogs = await fetchAll(accountId, fetchBlogs, { casing: 'snake_r' });
-    await writeObjects(accountId, contextPath, 'blogs', blogs);
-  } catch (e) {
-    logErrorInstance(
-      e,
-      new ApiErrorContext({
-        accountId,
-      })
-    );
-  }
-  try {
-    const contentObjects = await fetchAll(accountId, fetchContent, {
-      casing: 'snake_r',
-    });
-    await writeObjects(accountId, contextPath, 'content', contentObjects);
-  } catch (e) {
-    logErrorInstance(
-      e,
-      new ApiErrorContext({
-        accountId,
-      })
-    );
-  }
-  try {
-    const menus = await fetchAll(accountId, fetchMenus, {
-      casing: 'snake_r',
-    });
-    await writeObjects(accountId, contextPath, 'menus', menus);
-  } catch (e) {
-    logErrorInstance(
-      e,
-      new ApiErrorContext({
-        accountId,
-      })
-    );
-  }
-
-  return Promise.resolve();
-}
-
-module.exports = {
-  updateServerContext,
-};