@madgex/fert 5.0.4 → 5.0.5

package/bin/commands/publish.js

@@ -5,9 +5,7 @@ const { resolveConfig } = require('../utils');
 const { log } = require('../utils/logging');
 const getAwsParam = require('./publish-tasks/get-aws-parameter');
 const AssetStoreUploader = require('./publish-tasks/asset-store-uploader');
-const {
-  getCloudFrontDistributionsForDomain,
-} = require('../utils/lookup-cf-distribution-ids');
+const { getCloudFrontDistributionsForDomain } = require('../utils/lookup-cf-distribution-ids');
 const {
   ASSET_STORE_API,
   AWS_PARAM_NAME,
@@ -23,13 +21,12 @@ module.exports = async (options) => {
 
   // handle legacy options
   if (options.target === 'prod') {
+    // eslint-disable-next-line no-param-reassign
     options.target = 'production';
   }
 
   if (!validTargets.includes(options.target)) {
-    throw Error(
-      `Missing or invalid --target option. Choose from [${validTargets}]`
-    );
+    throw Error(`Missing or invalid --target option. Choose from [${validTargets}]`);
   }
 
   if (options.dryRun) {
@@ -46,29 +43,18 @@ module.exports = async (options) => {
   const apiUrl = Hoek.reachTemplate(templateCtx, ASSET_STORE_API);
   const remoteBasePath = Hoek.reachTemplate(templateCtx, REMOTE_UPLOAD_BASE);
   const apiKeyParamPath = Hoek.reachTemplate(templateCtx, AWS_PARAM_NAME);
-  const assetStoreInvPath = Hoek.reachTemplate(
-    templateCtx,
-    ASSET_STORE_INVALIDATION_PATH
-  );
-  const brandedSiteInvPath = Hoek.reachTemplate(
-    templateCtx,
-    BRANDED_SITE_INVALIDATION_PATH
-  );
+  const assetStoreInvPath = Hoek.reachTemplate(templateCtx, ASSET_STORE_INVALIDATION_PATH);
+  const brandedSiteInvPath = Hoek.reachTemplate(templateCtx, BRANDED_SITE_INVALIDATION_PATH);
 
   const apiKey = await getAwsParam(apiKeyParamPath);
 
   const siteUrl = new URL(fertConfig.config.JobseekerSiteWebSitePath);
-  const clientCloudFrontDists = await getCloudFrontDistributionsForDomain(
-    siteUrl.hostname,
-    options
-  );
+  const clientCloudFrontDists = await getCloudFrontDistributionsForDomain(siteUrl.hostname, options);
 
   log.info(
     `\nPublishing ${chalk.cyan(localDir)} to ${chalk.green.bold(
-      options.target
-    )} for ${chalk.green(fertConfig.client.brandName)} ${chalk.dim(
-      `(${fertConfig.clientPropertyId})`
-    )}\n`
+      options.target,
+    )} for ${chalk.green(fertConfig.client.brandName)} ${chalk.dim(`(${fertConfig.clientPropertyId})`)}\n`,
   );
 
   try {
@@ -84,9 +70,7 @@ module.exports = async (options) => {
       uploadResult = await assetStore.uploadDir(localDir);
     }
 
-    log.success(
-      `Publish complete in ${((uploadResult?.duration || 1) / 1000).toFixed(0)}s\n`
-    );
+    log.success(`Publish complete in ${((uploadResult?.duration || 1) / 1000).toFixed(0)}s\n`);
 
     // invalidate cloudfront cache
     await assetStore.invalidatePaths([assetStoreInvPath]);
@@ -95,11 +79,7 @@ module.exports = async (options) => {
       await assetStore.invalidatePaths([brandedSiteInvPath], dist.id);
     }
 
-    log.info(
-      `\nNote cloudfront invalidations may take upto ${chalk.yellow(
-        '30 seconds'
-      )} to complete.\n`
-    );
+    log.info(`\nNote cloudfront invalidations may take upto ${chalk.yellow('30 seconds')} to complete.\n`);
   } catch (error) {
     log.error('An error occurred during the publish process', error);
   }

package/bin/utils/configs.js

@@ -16,11 +16,7 @@ const { CONFIG_DIR } = require('../../constants');
  * @returns {Promise<void>} - Returns a promise that resolves if all configurations are valid.
  * @throws {Error} - Throws an error if any configuration is invalid.
  */
-const validateLocalConfigs = async ({
-  workingDir,
-  clientPropertyId,
-  throwable = true,
-}) => {
+const validateLocalConfigs = async ({ workingDir, clientPropertyId, throwable = true }) => {
   Hoek.assert(clientPropertyId, 'clientPropertyId is required');
   Hoek.assert(workingDir, 'workingDir is required');
 
@@ -36,55 +32,44 @@ const validateLocalConfigs = async ({
   });
   const localConfigs = loadLocalConfigs(workingDir);
 
-  const validationPromises = Object.keys(localConfigs).map(
-    async (configName) => {
-      try {
-        const schema = api.getSchema(configName);
-        const isSchemaReadOnly = api._isSchemaReadOnly(schema);
+  const validationPromises = Object.keys(localConfigs).map(async (configName) => {
+    try {
+      const schema = api.getSchema(configName);
+      const isSchemaReadOnly = api._isSchemaReadOnly(schema);
 
-        if (isSchemaReadOnly) {
-          throw Error(
-            `You're trying to set values on a read-only (usually V5) config schema: ${configName}`
-          );
-        }
+      if (isSchemaReadOnly) {
+        throw Error(`You're trying to set values on a read-only (usually V5) config schema: ${configName}`);
+      }
 
-        // check the entire config against the config validation
-        const { error } = schema.validate(localConfigs[configName].data);
-        if (error) {
-          throw new Error(
-            `Config invalid: ${chalk.bold(localConfigs[configName].path)} - ${error.message}`
-          );
-        }
+      // check the entire config against the config validation
+      const { error } = schema.validate(localConfigs[configName].data);
+      if (error) {
+        throw new Error(`Config invalid: ${chalk.bold(localConfigs[configName].path)} - ${error.message}`);
+      }
 
-        // validate all keys individually against the schema keys to ensure we're not trying to set any read-only keys
-        const config = localConfigs[configName].data;
-        for (const key in config) {
-          const keySchema = schema.extract(key);
-          if (api._isSchemaReadOnly(keySchema)) {
-            throw new Error(
-              `You're trying to set a read-only key on a config schema: ${configName}/${key}`
-            );
-          }
+      // validate all keys individually against the schema keys to ensure we're not trying to set any read-only keys
+      const config = localConfigs[configName].data;
+      for (const key in config) {
+        const keySchema = schema.extract(key);
+        if (api._isSchemaReadOnly(keySchema)) {
+          throw new Error(`You're trying to set a read-only key on a config schema: ${configName}/${key}`);
         }
+      }
 
-        log.success(`Config validated:`, chalk.bold(configName));
-      } catch (err) {
-        log.error(err.message);
+      log.success(`Config validated:`, chalk.bold(configName));
+    } catch (err) {
+      log.error(err.message);
 
-        if (throwable) {
-          throw err;
-        }
+      if (throwable) {
+        throw err;
       }
     }
-  );
+  });
 
   await Promise.all(validationPromises);
 };
 
-const getConfigAPI = async ({
-  clientPropertyId,
-  environment = 'production',
-} = {}) => {
+const getConfigAPI = async ({ clientPropertyId, environment = 'production' } = {}) => {
   const { ConfigAPI } = await import('@madgex/config-api-sdk');
 
   const api = new ConfigAPI({
@@ -143,11 +128,7 @@ const loadLocalConfigs = (workingDir) => {
  *
  * @returns {Promise<boolean>} - Returns a promise that resolves to true if the update is successful.
  */
-const updateProjectConfigs = async ({
-  clientPropertyId,
-  workingDir,
-  environment = 'production',
-} = {}) => {
+const updateProjectConfigs = async ({ clientPropertyId, workingDir, environment = 'production' } = {}) => {
   Hoek.assert(clientPropertyId, 'clientPropertyId is required');
   Hoek.assert(workingDir, 'workingDir is required');
 
@@ -174,7 +155,7 @@ const updateProjectConfigs = async ({
     const { host } = new URL(api.options.apiUrl);
     log.info(``);
     log.info(`Project configs applied to ${chalk.bold(host)}`);
-    return true;
+    return;
   } catch (error) {
     log.info(``);
     log.error('Failed to apply project configs', error);
@@ -186,48 +167,37 @@ const collateConfigs = (api, localConfigs) => {
   const toRemove = {};
   const toSet = {};
 
-  Object.entries(localConfigs).forEach(
-    ([configName, { data: config = {} } = {}]) => {
-      const schema = api.getSchema(configName);
-      const isSchemaReadOnly = api._isSchemaReadOnly(schema);
+  Object.entries(localConfigs).forEach(([configName, { data: config = {} } = {}]) => {
+    const schema = api.getSchema(configName);
+    const isSchemaReadOnly = api._isSchemaReadOnly(schema);
 
-      if (isSchemaReadOnly) {
-        log.warn(`Skipping read-only schema: ${configName}`);
-        return;
-      }
+    if (isSchemaReadOnly) {
+      log.warn(`Skipping read-only schema: ${configName}`);
+      return;
+    }
 
-      const configDefault = api._getDefaultConfig(configName);
+    const configDefault = api._getDefaultConfig(configName);
 
-      const unsetKeysWithDefaults = getUnsetKeysWithDefaults(
-        configDefault,
-        config
-      );
+    const unsetKeysWithDefaults = getUnsetKeysWithDefaults(configDefault, config);
 
-      // remove any keys that are read-only from the unset keys collection
-      // we don't want to be deleting those!
-      for (const key in unsetKeysWithDefaults) {
-        if (api._isSchemaReadOnly(schema.extract(key))) {
-          delete unsetKeysWithDefaults[key];
-        }
+    // remove any keys that are read-only from the unset keys collection
+    // we don't want to be deleting those!
+    for (const key in unsetKeysWithDefaults) {
+      if (api._isSchemaReadOnly(schema.extract(key))) {
+        delete unsetKeysWithDefaults[key];
       }
-
-      toRemove[configName] = Object.keys(unsetKeysWithDefaults);
-      toSet[configName] = config;
     }
-  );
+
+    toRemove[configName] = Object.keys(unsetKeysWithDefaults);
+    toSet[configName] = config;
+  });
 
   return { toRemove, toSet };
 };
 
 const getUnsetKeysWithDefaults = (defaults = {}, config = {}) => {
-  Hoek.assert(
-    typeof defaults === 'object' && defaults !== null,
-    'defaults must be an object'
-  );
-  Hoek.assert(
-    typeof config === 'object' && config !== null,
-    'config must be an object'
-  );
+  Hoek.assert(typeof defaults === 'object' && defaults !== null, 'defaults must be an object');
+  Hoek.assert(typeof config === 'object' && config !== null, 'config must be an object');
 
   const diff = {};
   for (const key in defaults) {
@@ -243,17 +213,12 @@ const removeConfigs = async (api, toRemove) => {
     keys.map(async (key) => {
       try {
         await api.deleteConfig(configName, key);
-        log.success(
-          `Successfully removed ${chalk.bold(key)} from ${chalk.bold(configName)}`
-        );
+        log.success(`Successfully removed ${chalk.bold(key)} from ${chalk.bold(configName)}`);
       } catch (error) {
-        log.error(
-          `Failed to remove ${chalk.bold(key)} from ${chalk.bold(configName)}:`,
-          error
-        );
+        log.error(`Failed to remove ${chalk.bold(key)} from ${chalk.bold(configName)}:`, error);
         throw error;
       }
-    })
+    }),
   );
 
   return Promise.all(operations);
@@ -264,17 +229,12 @@ const setConfigs = async (api, toSet) => {
     Object.entries(config).map(async ([key, value]) => {
       try {
         await api.setConfig(configName, key, value);
-        log.success(
-          `Successfully set ${chalk.bold(key)} in ${chalk.bold(configName)}`
-        );
+        log.success(`Successfully set ${chalk.bold(key)} in ${chalk.bold(configName)}`);
       } catch (error) {
-        log.error(
-          `Failed to set ${chalk.bold(key)} in ${chalk.bold(configName)}:`,
-          error
-        );
+        log.error(`Failed to set ${chalk.bold(key)} in ${chalk.bold(configName)}:`, error);
         throw error;
       }
-    })
+    }),
   );
 
   return Promise.all(operations);

package/bin/utils/cpid-lookup.js

@@ -19,8 +19,8 @@ exports.doCpidLookup = async (clientPropertyId) => {
     .catch((error) => {
       log.error(
         `Unable to lookup CPID [${chalk.yellow(
-          clientPropertyId
-        )}] from ${chalk.cyan(API_URL)}: ${chalk.redBright(error.message)}\n`
+          clientPropertyId,
+        )}] from ${chalk.cyan(API_URL)}: ${chalk.redBright(error.message)}\n`,
       );
 
       throw Error(error.message);

package/bin/utils/cpid-matches-git-remote.js

@@ -26,10 +26,7 @@ exports.cpIdMatchesGitRemote = async (fertConfig) => {
     baseDir: fertConfig.workingDir,
   };
   const git = simpleGit(simpleGitOptions);
-  Hoek.assert(
-    await git.checkIsRepo(),
-    `detected fert config in${fertConfigDir}, but it is not a git repository`
-  );
+  Hoek.assert(await git.checkIsRepo(), `detected fert config in${fertConfigDir}, but it is not a git repository`);
 
   // Validate that the CPID in the fert config matches the CPID in the git remote URL
   try {
@@ -38,22 +35,20 @@ exports.cpIdMatchesGitRemote = async (fertConfig) => {
     const repo = parts[parts.length - 1].trim();
     const remoteUrlCpid = repo.split('madgex-')[1].trim().replace('.git', '');
 
-    if (remoteUrlCpid == fertConfig.clientPropertyId) {
+    if (remoteUrlCpid === fertConfig.clientPropertyId) {
       return true;
     }
 
     // Big ugly console message for high visibility.
     console.log(
       dedent`
-        ${chalk.bgRed.bold(
-          '💀 💀 💀 Client Property IDs do not match! 💀 💀 💀 '
-        )}
+        ${chalk.bgRed.bold('💀 💀 💀 Client Property IDs do not match! 💀 💀 💀 ')}
         ${chalk.red('CPID from fert.config.js:')} ${fertConfig.clientPropertyId}
         ${chalk.red('CPID from Git remote URL:')} ${remoteUrlCpid}
         ${chalk.bgYellow.bold(
-          '🤓 Please ensure that the Client Property Id from the fert.config.js and the git remote match 🧐 '
+          '🤓 Please ensure that the Client Property Id from the fert.config.js and the git remote match 🧐 ',
         )}\n
-      `
+      `,
     );
   } catch (error) {
     console.log(error);

package/bin/utils/getSchemaMeta.js

@@ -1,4 +1,4 @@
-const getSchemaMeta = function (schema, key = null) {
+const getSchemaMeta = function getSchemaMeta(schema, key = null) {
   if (!schema || typeof schema.describe !== 'function') {
     throw new Error('Schema is required');
   }

package/bin/utils/index.js

@@ -1,11 +1,8 @@
 const path = require('node:path');
 const fs = require('node:fs');
+// eslint-disable-next-line n/no-unsupported-features/node-builtins
 const { glob } = require('node:fs/promises');
-const {
-  VERSION,
-  FERT_CONFIG_FILENAME,
-  FERT_SERVICE_CONFIG_FILENAME,
-} = require('../../constants');
+const { VERSION, FERT_CONFIG_FILENAME, FERT_SERVICE_CONFIG_FILENAME } = require('../../constants');
 const chalk = require('chalk');
 const uuidValidator = require('uuid-validate');
 const Hoek = require('@hapi/hoek');
@@ -56,7 +53,7 @@ exports.resolveConfig = async (options = {}) => {
 
   // workingDir based on service folder
   const { dir: workingDir, serviceConfig } = serviceConfigs.find(
-    (item) => item.serviceConfig.serviceName === options.serviceName
+    (item) => item.serviceConfig.serviceName === options.serviceName,
   );
   const fertConfig = Hoek.applyToDefaults(
     defaults,
@@ -64,20 +61,17 @@ exports.resolveConfig = async (options = {}) => {
     {
       ...this.loadConfigFromFile({ dir: rootDir }),
       ...serviceConfig,
-    }
+    },
   );
 
   // Check Fert cpid is valid
   Hoek.assert(
     uuidValidator(fertConfig.clientPropertyId),
-    `Invalid clientPropertyId specified in fert.config.js: ${fertConfig.clientPropertyId}`
+    `Invalid clientPropertyId specified in fert.config.js: ${fertConfig.clientPropertyId}`,
   );
 
   // Check Fert serviceName is valid
-  Hoek.assert(
-    typeof fertConfig.serviceName === 'string',
-    `serviceName required: ${fertConfig.serviceName}`
-  );
+  Hoek.assert(typeof fertConfig.serviceName === 'string', `serviceName required: ${fertConfig.serviceName}`);
   // get & store the current git branch
   fertConfig.currBranch = (await git.branch()).current;
 
@@ -86,7 +80,7 @@ exports.resolveConfig = async (options = {}) => {
 
   Hoek.assert(
     fertCpidMatchesGitRemote,
-    `CPID mismatch, please correct before retrying: ${fertConfig.clientPropertyId}`
+    `CPID mismatch, please correct before retrying: ${fertConfig.clientPropertyId}`,
   );
 
   const client = await cpidLookup(fertConfig.clientPropertyId);
@@ -145,11 +139,7 @@ exports.loadServiceConfigFiles = async () => {
   return serviceConfigs;
 };
 
-exports.loadConfigFromFile = ({
-  dir = process.cwd(),
-  filename = FERT_CONFIG_FILENAME,
-  silent = false,
-}) => {
+exports.loadConfigFromFile = ({ dir = process.cwd(), filename = FERT_CONFIG_FILENAME, silent = false }) => {
   const configPath = path.resolve(dir, filename);
   try {
     // always return fresh config
@@ -162,14 +152,13 @@ exports.loadConfigFromFile = ({
     return fertConfig;
   } catch (err) {
     if (!silent) {
-      log.error(
-        `Failed to load ${filename} - ensure you're running fert on a branding repo & config exists.\n`
-      );
+      log.error(`Failed to load ${filename} - ensure you're running fert on a branding repo & config exists.\n`);
 
       console.error(err);
       throw err;
     }
   }
+  return null;
 };
 
 exports.ensureTrailingSlash = (str) => {
@@ -178,17 +167,17 @@ exports.ensureTrailingSlash = (str) => {
   return lastChar === '/' ? str : `${str}/`;
 };
 
-exports.exists = async (path) => {
+exports.exists = async (_path) => {
   try {
-    fs.access(path);
+    fs.access(_path);
     return true;
   } catch {
     return false;
   }
 };
 
-exports.isEmptyDir = function isEmptyDir(path) {
-  const files = fs.readdirSync(path);
+exports.isEmptyDir = function isEmptyDir(_path) {
+  const files = fs.readdirSync(_path);
   return files.length === 0 || (files.length === 1 && files[0] === '.git');
 };
 

package/bin/utils/lookup-cf-distribution-ids.js

@@ -1,7 +1,4 @@
-const {
-  CloudFrontClient,
-  ListDistributionsCommand,
-} = require('@aws-sdk/client-cloudfront');
+const { CloudFrontClient, ListDistributionsCommand } = require('@aws-sdk/client-cloudfront');
 const { persistentCacheWithTtl } = require('./persistent-cache-with-ttl');
 const assert = require('node:assert');
 const { ONE_WEEK, AWS_REGION } = require('../../constants');
@@ -19,9 +16,7 @@ exports.doGetAllCloudFrontDistributions = async () => {
   let isTruncated = false;
 
   do {
-    const list = await cloudfront.send(
-      new ListDistributionsCommand({ Marker })
-    );
+    const list = await cloudfront.send(new ListDistributionsCommand({ Marker }));
 
     Marker = list.DistributionList.NextMarker;
     isTruncated = list.DistributionList.IsTruncated;

package/bin/utils/resolve-external-assets.js

@@ -6,18 +6,14 @@ class LinkAsset {
       this.href = arg;
     } else if (typeof arg === 'object') {
       if (!arg.href) {
-        throw new Error(
-          'External assets - the link is missing the href property'
-        );
+        throw new Error('External assets - the link is missing the href property');
       }
 
       for (const [key, value] of Object.entries(arg)) {
         this[key] = value;
       }
     } else {
-      throw new Error(
-        'External assets - the value should be a string or an object'
-      );
+      throw new Error('External assets - the value should be a string or an object');
     }
   }
 }
@@ -29,13 +25,12 @@ class ScriptAsset {
       this.src = arg;
     } else if (typeof arg === 'object') {
       if (!arg.src) {
-        throw new Error(
-          'External assets - the script is missing the src property'
-        );
+        throw new Error('External assets - the script is missing the src property');
       }
 
       // in case defer has been set to false in the config, we remove it so it's not added to the object
       if (arg.defer === false) {
+        // eslint-disable-next-line no-param-reassign
         delete arg.defer;
       }
 
@@ -48,9 +43,7 @@ class ScriptAsset {
         delete this.async;
       }
     } else {
-      throw new Error(
-        'External assets - the value should be a string or an object'
-      );
+      throw new Error('External assets - the value should be a string or an object');
     }
   }
 }
@@ -70,9 +63,7 @@ function resolveExternalAssets(assets = {}) {
   }
 
   if (assets.scripts) {
-    const scriptArr = Array.isArray(assets.scripts)
-      ? assets.scripts
-      : [assets.scripts];
+    const scriptArr = Array.isArray(assets.scripts) ? assets.scripts : [assets.scripts];
 
     scriptArr.forEach((item) => {
       result.scripts.push(new ScriptAsset(item));

package/constants.js

@@ -2,9 +2,7 @@ const fs = require('node:fs');
 const path = require('node:path');
 const os = require('node:os');
 
-const { version: VERSION } = JSON.parse(
-  fs.readFileSync(path.resolve(__dirname, './package.json')).toString()
-);
+const { version: VERSION } = JSON.parse(fs.readFileSync(path.resolve(__dirname, './package.json')).toString());
 
 const ONE_MINUTE = 60000;
 const ONE_HOUR = ONE_MINUTE * 60;
@@ -16,8 +14,7 @@ module.exports = {
   TMP_DIR: fs.realpathSync(os.tmpdir()),
   FERT_PACKAGE_DIR: path.resolve('./'),
   AWS_REGION: 'eu-west-1',
-  PROPERTY_ID_API:
-    'https://property-identification-api.cs.madgexhosting.net/properties/',
+  PROPERTY_ID_API: 'https://property-identification-api.cs.madgexhosting.net/properties/',
   ASSETS_API_URL: 'https://asset-store.job.madgexhosting.net',
   BRAND_JSON_FILENAME: 'brand.json',
   FERT_CONFIG_FILENAME: 'fert.config.js',
@@ -34,8 +31,7 @@ module.exports = {
   /**
    * important to have the correct service name and cpid so assets are uploaded to the correct unique place per-service.
    */
-  REMOTE_UPLOAD_BASE:
-    '/api/assets/{fertConfig.serviceName}/{fertConfig.clientPropertyId}',
+  REMOTE_UPLOAD_BASE: '/api/assets/{fertConfig.serviceName}/{fertConfig.clientPropertyId}',
   /**
    * invalidates the real asset store key path, which is related to `REMOTE_UPLOAD_BASE`
    * asset-store puts things in `rootClientPropertyId` based on the AWS_PARAM_NAME used, and the rest of the path relates to `REMOTE_UPLOAD_BASE`
@@ -50,16 +46,6 @@ module.exports = {
    */
   BRANDED_SITE_INVALIDATION_PATH: `/_/{fertConfig.serviceName}/assets/*`,
   ASSET_STORE_USER_GUID: 'a386d4b6-f2df-4b80-ad1f-0349e23f530b',
-  TEMPLATES: [
-    {
-      name: 'basic',
-      display: 'Basic - blank canvas',
-    },
-    {
-      name: 'bigworkbag',
-      display: 'BigWorkBag - populated, example project',
-    },
-  ],
   ONE_MINUTE,
   ONE_HOUR,
   ONE_DAY,