@madgex/fert 4.2.4 → 4.2.6

package/bin/commands/configs.js

@@ -1,9 +1,5 @@
 const { resolveConfig } = require('../utils/index.js');
-const {
-  getConfigAPI,
-  validateLocalConfigs,
-  updateProjectConfigs,
-} = require('../utils/configs.js');
+const { getConfigAPI, updateProjectConfigs } = require('../utils/configs.js');
 const chalk = require('chalk');
 const { log } = require('../utils/logging.js');
 const { getSchemaMeta } = require('../utils/getSchemaMeta.js');
@@ -97,9 +93,7 @@ const handlePublish = async (fertConfig, api, options) => {
   }
 
   try {
-    await validateLocalConfigs(fertConfig, { catch: false });
     await updateProjectConfigs(fertConfig, { environment: options.publish });
-    console.log('upload');
   } catch (err) {
     log.debug(err);
     process.exit(1);

package/bin/commands/publish.js

@@ -5,10 +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 {
-  validateLocalConfigs,
-  updateProjectConfigs,
-} = require('../utils/configs.js');
+const { updateProjectConfigs } = require('../utils/configs.js');
 const {
   getCloudFrontDistributionsForDomain,
 } = require('../utils/lookup-cf-distribution-ids');
@@ -77,11 +74,9 @@ module.exports = async (root, options) => {
     const uploadResult = await assetStore.uploadDir(localDir);
 
     // validate & upload local configs to configuration API
-    await validateLocalConfigs(fertConfig);
-    await updateProjectConfigs(fertConfig),
-      {
-        environment: fertConfig.currBranch === 'master' ? 'production' : 'dev',
-      };
+    await updateProjectConfigs(fertConfig, {
+      environment: fertConfig.currBranch === 'master' ? 'production' : 'dev',
+    });
 
     log.success(
       `Publish complete in ${(uploadResult.duration / 1000).toFixed(0)}s\n`

package/bin/utils/configs.js

@@ -35,6 +35,15 @@ const validateLocalConfigs = async (fertConfig, options = { catch: true }) => {
     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}`
+          );
+        }
+
+        // check the entire config against the config validation
         const { error } = schema.validate(localConfigs[configName].data);
         if (error) {
           throw new Error(
@@ -42,6 +51,17 @@ const validateLocalConfigs = async (fertConfig, options = { catch: true }) => {
           );
         }
 
+        // 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);
@@ -125,6 +145,8 @@ const updateProjectConfigs = async (
   }
 
   try {
+    await validateLocalConfigs(fertConfig, { catch: false });
+
     const api = await getConfigAPI({
       clientPropertyId: fertConfig.clientPropertyId,
       environment,
@@ -135,7 +157,8 @@ const updateProjectConfigs = async (
     const { toRemove, toSet } = collateConfigs(api, localConfigs);
 
     spinner.text = 'Updating configs…';
-    await Promise.all([removeConfigs(api, toRemove), setConfigs(api, toSet)]);
+    await setConfigs(api, toSet, spinner);
+    await removeConfigs(api, toRemove, spinner);
 
     const { host } = new URL(api.options.apiUrl);
     spinner.succeed(`Project configs applied to ${chalk.bold(host)}`);
@@ -204,24 +227,28 @@ const getUnsetKeysWithDefaults = (defaults = {}, config = {}) => {
   return diff;
 };
 
-const removeConfigs = async (api, toRemove) => {
+const removeConfigs = async (api, toRemove, spinner) => {
   const deletePromises = Object.entries(toRemove).flatMap(
     ([configName, keys]) =>
-      keys.map((key) =>
-        api.deleteConfig(configName, key).catch((error) => {
+      keys.map(async (key) => {
+        try {
+          await api.deleteConfig(configName, key);
+          spinner.text = `Removed key ${chalk.bold(key)} from config: ${chalk.bold(configName)}`;
+        } catch (error) {
           log.error('Failed to remove config', { configName, key, error });
-        })
-      )
+        }
+      })
   );
 
   await Promise.all(deletePromises);
 };
 
-const setConfigs = async (api, toSet) => {
+const setConfigs = async (api, toSet, spinner) => {
   const setPromises = Object.entries(toSet).flatMap(([configName, config]) =>
     Object.entries(config).map(async ([key, value]) => {
       try {
         await api.setConfig(configName, key, value);
+        spinner.text = `Set key ${chalk.bold(key)} for config: ${chalk.bold(configName)}`;
       } catch (error) {
         log.error('Failed to set config', { configName, key, value, error });
       }
@@ -230,6 +257,7 @@ const setConfigs = async (api, toSet) => {
 
   await Promise.all(setPromises);
 };
+
 module.exports = {
   getConfigAPI,
   validateLocalConfigs,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@madgex/fert",
-  "version": "4.2.4",
+  "version": "4.2.6",
   "description": "Tool to help build the V6 branding",
   "bin": {
     "fert": "./bin/cli.js"