@adobe/helix-config 5.6.6 → 5.6.8

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.6.8](https://github.com/adobe/helix-config/compare/v5.6.7...v5.6.8) (2025-10-03)
+
+
+### Bug Fixes
+
+* return 502 for potential storage errors ([#321](https://github.com/adobe/helix-config/issues/321)) ([45c4b5b](https://github.com/adobe/helix-config/commit/45c4b5bbd6dc3c66a63667aed08370e5778927b3))
+
+## [5.6.7](https://github.com/adobe/helix-config/compare/v5.6.6...v5.6.7) (2025-09-29)
+
+
+### Bug Fixes
+
+* ensure no node dependencies ([#320](https://github.com/adobe/helix-config/issues/320)) ([d1dec47](https://github.com/adobe/helix-config/commit/d1dec472f67bae6ebfb92105e4e1324c6fb37056))
+
 ## [5.6.6](https://github.com/adobe/helix-config/compare/v5.6.5...v5.6.6) (2025-09-25)
 
 

package/eslint.config.js

@@ -18,10 +18,6 @@ export default defineConfig([
     'coverage/*',
   ]),
   {
-    rules: {
-      // see https://github.com/import-js/eslint-plugin-import/issues/1868
-      'import/no-unresolved': ['error', { ignore: ['@adobe/helix-shared-config/modifiers'] }]
-    },
     plugins: {
       import: recommended.plugins.import,
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "5.6.6",
+  "version": "5.6.8",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -55,7 +55,6 @@
     "*.cjs": "eslint"
   },
   "dependencies": {
-    "@adobe/helix-shared-config": "11.1.10",
     "@adobe/helix-shared-server-timing": "1.0.0",
     "@adobe/helix-shared-utils": "3.0.2"
   }

package/src/ModifiersConfig.js

@@ -0,0 +1,177 @@
+/*
+ * Copyright 2022 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/**
+ * Converts all non-valid characters to `-`.
+ * @param {string} text input text
+ * @returns {string} the meta name
+ */
+function toMetaName(text) {
+  return text
+    .toLowerCase()
+    .replace(/[^0-9a-z:_]/gi, '-');
+}
+
+/**
+ * The modifiers class help manage the metadata and headers modifiers.
+ */
+export class ModifiersConfig {
+  /**
+   * Converts a globbing expression to regexp. Note that only `*` and `**` are supported yet.
+   * @param {string} glob
+   * @returns {RegExp}
+   */
+  static globToRegExp(glob) {
+    const reString = glob
+      .replaceAll('**', '|')
+      .replaceAll('*', '[^/]*')
+      .replaceAll('|', '.*');
+    return new RegExp(`^${reString}$`);
+  }
+
+  /**
+   * Converts all keys in a row object to lowercase
+   * @param {Object} obj A row of data from a sheet
+   * @returns {Object} A row with all keys converted to lowercase
+   */
+  static toLowerKeys(obj) {
+    return Object.keys(obj).reduce((prev, key) => {
+      // eslint-disable-next-line no-param-reassign
+      prev[key.toLowerCase()] = obj[key];
+      return prev;
+    }, Object.create(null));
+  }
+
+  /**
+   * Empty modifiers
+   * @type {ModifiersConfig}
+   */
+  static EMPTY = new ModifiersConfig({});
+
+  /**
+   * Parses a sheet that is in a modifier format into a list of key/value pairs
+   *
+   * @example
+   *
+   * | url   | key | value | Title   | Description    |
+   * |-------|-----|-------|---------|----------------|
+   * | "/*"  | "A" | "B"   | ""      | ""             |
+   * | "/*"  | "C" | "D"   | ""      | ""             |
+   * | "/f"  | ""  | ""    | "Hero"  | "Once upon..." |
+   *
+   * becomes:
+   *
+   * {
+   *   "/*": [
+   *     { "key": "A", "value": "B" },
+   *     { "key": "C", "value": "D" },
+   *   ],
+   *   "/f": [
+   *     { "key": "title", "value": "Hero" },
+   *     { "key": "description", "value": "Once upon..." },
+   *   ]
+   * }
+   *
+   *
+   * @param {object[]} sheet The sheet to parse
+   * @param {ModifierKeyFilter} keyFilter filter to apply on keys
+   * @returns {ModifierMap} An object containing an array of key/value pairs for every glob
+   */
+  static parseModifierSheet(sheet, keyFilter = () => true) {
+    /** @type ModifierMap */
+    const res = Object.create(null);
+    for (let row of sheet) {
+      row = ModifiersConfig.toLowerKeys(row);
+      const {
+        url, key, value, ...rest
+      } = row;
+      if (url) {
+        const put = (k, v) => {
+          if (keyFilter(k)) {
+            let entry = res[url];
+            if (!entry) {
+              entry = Object.create(null);
+              res[url] = entry;
+            }
+            entry[k] = v;
+          }
+        };
+
+        // note that all values are strings, i.e. never another falsy value
+        if ('key' in row && 'value' in row && key && value) {
+          put(key.toLowerCase(), value);
+        } else {
+          Object.entries(rest).forEach(([k, v]) => {
+            if (k && v) {
+              put(k, v);
+            }
+          });
+        }
+      }
+    }
+    // convert res back to key/value pairs
+    for (const [url, mods] of Object.entries(res)) {
+      res[url] = Object.entries(mods).map(([key, value]) => ({ key, value }));
+    }
+    return res;
+  }
+
+  /**
+   * Creates a new `ModifiersConfig` from the given sheet.
+   *
+   * @see ModifiersConfig.parseModifierSheet
+   * @param {object[]} sheet The sheet to parse
+   * @param {ModifierKeyFilter} keyFilter filter to apply on keys
+   * @returns {ModifiersConfig} A ModifiersConfig instance.
+   */
+  static fromModifierSheet(sheet, keyFilter) {
+    return new ModifiersConfig(ModifiersConfig.parseModifierSheet(sheet, keyFilter));
+  }
+
+  /**
+   * Creates a new ModifiersConfig class.
+   * @param {ModifierMap} [map] The modifier map.
+   * @param {ModifierKeyFilter} keyFilter filter to apply on modifier keys
+   */
+  constructor(map, keyFilter = () => true) {
+    if (!map) {
+      return;
+    }
+    this.modifiers = Object.entries(map).map(([url, mods]) => {
+      const pat = url.indexOf('*') >= 0 ? ModifiersConfig.globToRegExp(url) : url;
+      return {
+        pat,
+        mods: mods.filter(({ key }) => keyFilter(key)),
+      };
+    });
+  }
+
+  /**
+   * Returns the modifier object for the given path.
+   * @param {string} path
+   * @return {object} the modifiers
+   */
+  getModifiers(path) {
+    if (!this.modifiers) {
+      return Object.create(null);
+    }
+    const modifiers = Object.create(null);
+    for (const { pat, mods } of this.modifiers) {
+      if (pat === path || (pat instanceof RegExp && pat.test(path))) {
+        for (const { key, value } of mods) {
+          modifiers[toMetaName(key)] = value;
+        }
+      }
+    }
+    return modifiers;
+  }
+}

package/src/config-view.js

@@ -9,7 +9,6 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { ModifiersConfig } from '@adobe/helix-shared-config/modifiers';
 import { computeSurrogateKey } from '@adobe/helix-shared-utils';
 // eslint-disable-next-line import/no-unresolved
 import { PipelineResponse } from './PipelineResponse.js';
@@ -22,6 +21,8 @@ import {
 import { resolveLegacyConfig, fetchRobotsTxt, toArray } from './config-legacy.js';
 import { deepGetOrCreate, prune } from './utils.js';
 import { ConfigObject } from './config-object.js';
+import { ModifiersConfig } from './ModifiersConfig.js';
+import { StatusCodeError } from './status-code-error.js';
 
 /**
  * @typedef Config
@@ -288,6 +289,10 @@ async function resolveConfig(ctx, rso, scope) {
   ctx.timer?.update('load-config');
   const res = await ctx.loader.getObject(HELIX_CONFIG_BUS, key);
   if (!res.body) {
+    if (res.status !== 404) {
+      ctx.log.error('error loading config %s: %d', key, res.status);
+      throw new StatusCodeError('error loading config', res.status);
+    }
     const config = await resolveLegacyConfig(ctx, rso, scope);
     if (config) {
       ctx.timer?.update('profile');
@@ -523,7 +528,19 @@ export async function getConfigResponse(ctx, opts) {
   }
 
   const rso = { ref, site, org };
-  const siteConfig = await resolveConfig(ctx, rso, scope);
+  let siteConfig;
+  try {
+    siteConfig = await resolveConfig(ctx, rso, scope);
+  } catch (e) {
+    return new PipelineResponse('', {
+      status: 502,
+      headers: {
+        'x-surrogate-key': await getSurrogateKey(opts, null),
+        /* c8 ignore next */
+        'x-error': `${e.message} (${e.statusCode || 500})`,
+      },
+    });
+  }
   const headers = {
     'x-surrogate-key': await getSurrogateKey(opts, siteConfig?.data),
   };

package/src/legacy-config-merge.js

@@ -11,8 +11,8 @@
  */
 /* eslint-disable no-continue,no-param-reassign */
 import { logLevelForStatusCode, propagateStatusCode } from '@adobe/helix-shared-utils';
-import { ModifiersConfig } from '@adobe/helix-shared-config';
 import { flatJson2object } from './flatJson2Object.js';
+import { ModifiersConfig } from './ModifiersConfig.js';
 
 export const CONFIG_JSON_PATH = '/.helix/config.json';
 

package/src/status-code-error.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+export class StatusCodeError extends Error {
+  /**
+   * Constructs a StatusCodeError.
+   * @constructor
+   * @param {string} msg Error message
+   * @param {number} statusCode Status code of the error response
+   */
+  constructor(msg, statusCode) {
+    super(msg?.value ?? msg);
+    this.statusCode = statusCode;
+  }
+}