@madgex/fert 6.0.2 → 6.2.0

package/README.md

@@ -212,7 +212,7 @@ Run for 1 service from the service folder:
 | `--target`  | Where to publish the `dist` directory assets.<br/>`dev` \| `production` (`string`) |
 | `--dry-run` | Dry run, dont actually upload anything                                             |
 
-Send all files and directories created in the `dist` directory to either development or production versions of the Asset Store API. Files uploaded to the Asset Store API are available via a CloudFront-based CDN.
+Send all files and directories created in the `dist` directory to either development or production versions of the Asset Store API. Files uploaded to the Asset Store API are available via a CloudFront-based CDN
 
 **Outline of implementation**
 

package/bin/cli.js

@@ -47,6 +47,7 @@ const run = () => {
       'Download known configs from the Configuration API for environment "dev" or "production"',
     )
     .option('--query [configName]', 'Describe known keys for a config, omit to list all known configs')
+    .option('--skip-key-delete', 'Skip deleting keys not present in local config files on publish')
     .action((...args) => configsCommand(...args));
 
   cli

package/bin/commands/configs.js

@@ -93,6 +93,7 @@ export async function handlePublish({ workingDir, clientPropertyId }, api, optio
       workingDir,
       clientPropertyId,
       environment: options.publish,
+      skipKeyDelete: options.skipKeyDelete,
     });
   } catch (err) {
     log.debug(err);

package/bin/commands/dev-server.js

@@ -5,7 +5,6 @@ import chalk from 'chalk';
 import open from 'open';
 import chokidar from 'chokidar4';
 import { resolveConfig, findFertConfigDir } from '../utils/index.js';
-import { log } from '../utils/logging.js';
 import { validateLocalConfigs } from '../utils/configs.js';
 import { devServer } from '../../server/server.js';
 import { buildTokens, buildExternalAssets } from './build.js';
@@ -62,9 +61,20 @@ export async function createDevServer(options = {}) {
   });
 
   // start server
-  const server = await devServer({ start: true, fertConfig });
 
-  log.info(`\nDev server: ${chalk.cyan.bold(server.info.uri)}`);
+  /**
+   * having a port number to start with helps keep the ports changing too much in development
+   */
+  const STARTING_PORT_FOR_SERVICE_FOR_CONVENIENCE = {
+    'jobseekers-frontend': 4001,
+    'recruiterservices-frontend': 4021,
+  };
+
+  const server = await devServer({
+    start: true,
+    fertConfig,
+    port: STARTING_PORT_FOR_SERVICE_FOR_CONVENIENCE[fertConfig.serviceName],
+  });
 
   if (options.open) {
     await open(server.info.uri);

package/bin/utils/configs.js

@@ -53,7 +53,7 @@ export async function validateLocalConfigs({ workingDir, clientPropertyId, throw
       // 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);
+        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}`);
         }
@@ -124,10 +124,16 @@ export async function loadLocalConfigs(workingDir) {
  * @param {string} options.workingDir - required, Working dir for configs - should usually be 'root' where fert.config.js is
  * @param {string} options.clientPropertyId - required, clientPropertyId
  * @param {string} options.environment - default=production, clientPropertyId
+ * @param {boolean} [options.skipKeyDelete] - Whether to skip deleting keys not present in local files during publish
  *
  * @returns {Promise<boolean>} - Returns a promise that resolves to true if the update is successful.
  */
-export async function updateProjectConfigs({ clientPropertyId, workingDir, environment = 'production' } = {}) {
+export async function updateProjectConfigs({
+  clientPropertyId,
+  workingDir,
+  environment = 'production',
+  skipKeyDelete = false,
+} = {}) {
   Hoek.assert(clientPropertyId, 'clientPropertyId is required');
   Hoek.assert(workingDir, 'workingDir is required');
 
@@ -149,7 +155,12 @@ export async function updateProjectConfigs({ clientPropertyId, workingDir, envir
     const { toRemove, toSet } = collateConfigs(api, localConfigs);
 
     // Will throw on first failure
-    await Promise.all([setConfigs(api, toSet), removeConfigs(api, toRemove)]);
+    if (skipKeyDelete) {
+      log.warn('Skipping deleting config keys - can no longer ensure config parity!');
+      await setConfigs(api, toSet); // only set
+    } else {
+      await Promise.all([setConfigs(api, toSet), removeConfigs(api, toRemove)]);
+    }
 
     const { host } = new URL(api.options.apiUrl);
     log.info(``);
@@ -182,7 +193,7 @@ export function collateConfigs(api, localConfigs) {
     // 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))) {
+      if (api._isSchemaReadOnly(schema.extract([key]))) {
         delete unsetKeysWithDefaults[key];
       }
     }

package/bin/utils/getSchemaMeta.js

@@ -5,7 +5,7 @@ export function getSchemaMeta(schema, key = null) {
 
   try {
     if (key) {
-      const keySchema = schema.extract(key);
+      const keySchema = schema.extract([key]);
       if (!keySchema) {
         throw new Error(`Key "${key}" not found in schema`);
       }

package/bin/utils/logging.js

@@ -13,6 +13,9 @@ export const log = {
   error: (...args) => {
     console.log(chalk.red.bold('✖'), ...args);
   },
+  warn: (...args) => {
+    console.log(chalk.yellow.bold('⚠'), ...args);
+  },
   debug: (...args) => {
     debugLog(...args);
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@madgex/fert",
-  "version": "6.0.2",
+  "version": "6.2.0",
   "description": "Tool to help build the V6 branding",
   "bin": {
     "fert": "./bin/cli.js"
@@ -24,15 +24,15 @@
   "author": "Madgex",
   "license": "UNLICENSED",
   "dependencies": {
-    "@aws-sdk/client-cloudfront": "^3.799.0",
-    "@aws-sdk/client-ssm": "^3.799.0",
+    "@aws-sdk/client-cloudfront": "^3.812.0",
+    "@aws-sdk/client-ssm": "^3.812.0",
     "@hapi/hapi": "^21.4.0",
     "@hapi/hoek": "^11.0.7",
     "@hapi/inert": "^7.1.0",
     "@hapi/vision": "^7.0.3",
     "@hapipal/toys": "^4.0.0",
-    "@madgex/design-system": "^10.0.2",
-    "@madgex/config-api-sdk": "^1.8.0",
+    "@madgex/design-system": "^10.0.5",
+    "@madgex/config-api-sdk": "^1.9.1",
     "@private/header-footer-podlet-server": "github:wiley/madgex-header-footer-podlet",
     "axios": "^1.9.0",
     "cac": "^6.7.14",
@@ -41,7 +41,7 @@
     "debug": "^4.4.0",
     "dedent": "^1.5.3",
     "find-up-simple": "^1.0.1",
-    "flat-cache": "^6.1.8",
+    "flat-cache": "^6.1.9",
     "form-data": "^4.0.2",
     "joi": "^17.13.3",
     "lodash": "^4.17.21",
@@ -54,19 +54,19 @@
     "simple-git": "^3.27.0",
     "simple-update-notifier": "^2.0.0",
     "uuid-validate": "^0.0.3",
-    "vite": "^6.3.4",
+    "vite": "^6.3.5",
     "vite-plugin-static-copy": "^2.3.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.8.0",
-    "@commitlint/config-conventional": "^19.8.0",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@madgex/eslint-config-madgex": "^2.3.0",
     "@madgex/prettier-config-madgex": "^2.0.0",
-    "eslint": "^9.25.1",
+    "eslint": "^9.27.0",
     "husky": "^9.1.7",
-    "lint-staged": "^15.5.1",
+    "lint-staged": "^16.0.0",
     "prettier": "^3.5.3",
-    "semantic-release": "^24.2.3"
+    "semantic-release": "^24.2.4"
   },
   "lint-staged": {
     "*.{js,json}": [

package/server/server.js

@@ -1,4 +1,5 @@
 import path from 'node:path';
+import chalk from 'chalk';
 import Hapi from '@hapi/hapi';
 import Toys from '@hapipal/toys';
 import Vision from '@hapi/vision';
@@ -14,9 +15,9 @@ import routesPublic from './routes/public.js';
 import routesViews from './routes/views.js';
 import extensionErrorLogging from './extensions/error-logging.js';
 
-export async function devServer({ start, fertConfig = {} } = {}) {
+export async function devServer({ start, fertConfig = {}, port } = {}) {
   const server = Hapi.server({
-    port: 0, // 0 === random unused port
+    port: port || 0, // 0 === random unused port
     host: fertConfig.cli?.host ?? 'localhost',
   });
 
@@ -91,10 +92,20 @@ export async function devServer({ start, fertConfig = {} } = {}) {
   server.ext(extensionErrorLogging);
 
   if (start) {
-    await server.start();
-
-    log.debug(`Hapi server started at ${server.info.uri}`);
-
+    try {
+      await server.start();
+      log.info(`\nDev server ${fertConfig.serviceName}: ${chalk.cyan.bold(server.info.uri)}`);
+    } catch (err) {
+      if (err.message.includes('EADDRINUSE')) {
+        // stop server, we are throwing it away and starting a new one just to increment port!
+        await server.stop();
+        log.info(`Port ${server.settings.port} is in use, trying another one...`);
+        // returning devServer, it will be awaited and its result returned to the original call in dev-server.js
+        return devServer({ start, fertConfig, port: port + 1 });
+      } else {
+        throw err;
+      }
+    }
     return server;
   }