@madgex/fert 4.2.2 → 4.2.5

package/.github/workflows/release.yml

@@ -28,6 +28,9 @@ jobs:
           ssh-agent -a $SSH_AUTH_SOCK > /dev/null
           ssh-add - <<< "${{ secrets.MADGEX_GITHUB_SSH_KEY }}"
 
+      - name: Authenticate with private NPM package
+        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.MADGEX_NPM_TOKEN }}" > /home/runner/.npmrc
+
       - name: Install dependencies
         run: npm ci
         env:

package/bin/commands/configs.js

@@ -1,12 +1,8 @@
 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 { getSchemaKeyMeta } = require('../utils/getSchemaKeyMeta.js');
+const { getSchemaMeta } = require('../utils/getSchemaMeta.js');
 const ora = require('ora');
 const { mkdir, writeFile } = require('node:fs/promises');
 const Path = require('node:path');
@@ -26,34 +22,34 @@ const handleDownload = async (fertConfig, api, options) => {
 
   try {
     for (const [schemaName, schema] of Object.entries(api.schemas)) {
-      const configs = await api.getSchemaKeys(schemaName);
+      const schemaMeta = getSchemaMeta(api.getSchema(schemaName));
+
+      if (schemaMeta.readOnly) {
+        // skip read-only config files
+        continue;
+      }
+
+      const configs = api.getSchemaKeys(schemaName);
 
       for (const configKey of configs) {
-        const meta = getSchemaKeyMeta(schema, configKey);
+        const meta = getSchemaMeta(schema, configKey);
         if (meta.readOnly) {
+          // skip read-only config keys
           continue;
         }
 
         try {
-          const data = await api.getConfig(schemaName, configKey, {
-            useSchema: false,
-          });
-          if (!data.isDefault) {
-            let result = data.result;
-            try {
-              result = JSON.parse(result);
-            } catch (error) {
-              log.debug(
-                `Unable to JSON parse ${chalk.cyan(data.response?.url || schemaName + '/' + configKey)} error:`,
-                error.message
-              );
-            }
-
-            resultObj[schemaName] = {
-              ...result[schemaName],
-              [configKey]: result,
-            };
+          const data = await api.getConfig(schemaName, configKey);
+
+          if (data.isDefault) {
+            continue;
           }
+
+          if (!resultObj[schemaName]) {
+            resultObj[schemaName] = {};
+          }
+
+          resultObj[schemaName][configKey] = data.result;
         } catch (error) {
           log.debug(
             `Unable to retrieve ${chalk.cyan(error.url || schemaName + '/' + configKey)}`,
@@ -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/configs.test.js

@@ -11,7 +11,7 @@ describe('configs', () => {
   let writeFileMock;
   let handleDownload;
   let handleQuery;
-  let handlePublish;
+  let collateConfigs;
 
   beforeEach(async (t) => {
     fertConfig = {
@@ -26,6 +26,10 @@ describe('configs', () => {
       schemas: {
         'jsfe-config': Joi.object({
           StrConfig: Joi.string().default('My new JSFE config'),
+          NumConfig: Joi.number().default(0),
+          StrConfigReadOnly: Joi.string()
+            .default('I am read-only')
+            .meta({ readOnly: true }),
         }),
       },
       fetch: async () => ({
@@ -49,7 +53,10 @@ describe('configs', () => {
 
     // Clear require cache to ensure we get a fresh copy with our mocks
     delete require.cache[require.resolve('./configs')];
-    ({ handleDownload, handleQuery, handlePublish } = require('./configs'));
+    ({ handleDownload, handleQuery } = require('./configs'));
+
+    delete require.cache[require.resolve('../utils/configs')];
+    ({ collateConfigs } = require('../utils/configs'));
   });
 
   describe('handleDownload', () => {
@@ -115,18 +122,30 @@ describe('configs', () => {
     });
   });
 
-  describe.skip('handlePublish', () => {
-    let options;
+  describe('handlePublish', () => {
+    it('sets and deletes correct configs', async () => {
+      const localConfigs = {
+        'jsfe-config': {
+          path: '',
+          data: {
+            StrConfig: 'default value',
+            // NumConfig is purposefully omitted & should be deleted from the api
+          },
+        },
+      };
 
-    beforeEach(async () => {
-      options = { publish: true };
-    });
+      const { toSet, toRemove } = await collateConfigs(api, localConfigs);
+
+      assert.deepStrictEqual(toSet, {
+        'jsfe-config': {
+          StrConfig: 'default value',
+        },
+      });
 
-    it('publishes the configs', async () => {
-      await handlePublish(fertConfig, api, options);
+      assert.deepStrictEqual(toRemove, { 'jsfe-config': ['NumConfig'] });
     });
   });
-  describe.skip('handleQuery', () => {
+  describe('handleQuery', () => {
     let options;
 
     beforeEach(async () => {

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,
@@ -154,12 +176,29 @@ const collateConfigs = (api, localConfigs) => {
 
   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;
+      }
+
       const configDefault = api._getDefaultConfig(configName);
 
       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];
+        }
+      }
+
       toRemove[configName] = Object.keys(unsetKeysWithDefaults);
       toSet[configName] = config;
     }
@@ -217,4 +256,5 @@ module.exports = {
   getConfigAPI,
   validateLocalConfigs,
   updateProjectConfigs,
+  collateConfigs,
 };

package/bin/utils/getSchemaMeta.js

@@ -0,0 +1,21 @@
+const getSchemaMeta = function (schema, key = null) {
+  if (!schema || typeof schema.describe !== 'function') {
+    throw new Error('Schema is required');
+  }
+
+  try {
+    if (key) {
+      const keySchema = schema.extract(key);
+      if (!keySchema) {
+        throw new Error(`Key "${key}" not found in schema`);
+      }
+      return keySchema.describe().metas?.[0] || {};
+    }
+
+    return schema.describe().metas?.[0] || {};
+  } catch (error) {
+    throw new Error('Invalid Joi schema', { cause: error });
+  }
+};
+
+module.exports = { getSchemaMeta };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@madgex/fert",
-  "version": "4.2.2",
+  "version": "4.2.5",
   "description": "Tool to help build the V6 branding",
   "bin": {
     "fert": "./bin/cli.js"
@@ -31,7 +31,7 @@
     "@hapi/inert": "^7.1.0",
     "@hapi/vision": "^7.0.3",
     "@hapipal/toys": "^4.0.0",
-    "@madgex/config-api-sdk": "^1.6.0",
+    "@madgex/config-api-sdk": "^1.6.1",
     "@madgex/design-system": "^9.1.9",
     "@private/header-footer-podlet-server": "github:wiley/madgex-header-footer-podlet",
     "axios": "^1.7.9",
@@ -69,6 +69,7 @@
     "eslint-plugin-prettier": "^5.2.1",
     "globals": "^15.14.0",
     "husky": "^9.1.7",
+    "joi": "^17.13.3",
     "lint-staged": "^15.3.0",
     "prettier": "^3.4.2",
     "semantic-release": "^24.2.0"

package/bin/utils/getSchemaKeyMeta.js

@@ -1,14 +0,0 @@
-const getSchemaKeyMeta = function (schema, key) {
-  if (!schema) throw new Error('Schema is required');
-  if (!key) throw new Error('Key is required');
-
-  const keySchema = schema.extract(key);
-  if (!keySchema) {
-    throw new Error(`Key "${key}" not found in schema`);
-  }
-
-  const metas = keySchema.describe().metas;
-  return Array.isArray(metas) && metas.length > 0 ? metas[0] : {};
-};
-
-module.exports = { getSchemaKeyMeta };