@adobe/helix-config 5.4.10 → 5.6.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [5.6.0](https://github.com/adobe/helix-config/compare/v5.5.0...v5.6.0) (2025-08-06)
+
+
+### Features
+
+* include x-hlx-version header ([8b95c95](https://github.com/adobe/helix-config/commit/8b95c9517d543a76188ff449523ae0965a79a540))
+
+# [5.5.0](https://github.com/adobe/helix-config/compare/v5.4.10...v5.5.0) (2025-07-29)
+
+
+### Features
+
+* add timing information ([#304](https://github.com/adobe/helix-config/issues/304)) ([7b2e50e](https://github.com/adobe/helix-config/commit/7b2e50e92bb1d1c186622169136b20a0fb64308e))
+
 ## [5.4.10](https://github.com/adobe/helix-config/compare/v5.4.9...v5.4.10) (2025-07-11)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "5.4.10",
+  "version": "5.6.0",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -44,11 +44,11 @@
     "eslint": "9.4.0",
     "husky": "9.1.7",
     "junit-report-builder": "5.1.1",
-    "lint-staged": "16.1.2",
+    "lint-staged": "16.1.4",
     "mocha": "11.7.1",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.6.0",
-    "semantic-release": "24.2.6"
+    "semantic-release": "24.2.7"
   },
   "lint-staged": {
     "*.js": "eslint",
@@ -56,6 +56,7 @@
   },
   "dependencies": {
     "@adobe/helix-shared-config": "11.1.8",
+    "@adobe/helix-shared-server-timing": "1.0.0",
     "@adobe/helix-shared-utils": "3.0.2"
   }
 }

package/src/ConfigContext.d.ts

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import {S3Loader} from "./S3Loader";
+import {RequestTimer} from "@adobe/helix-shared-server-timing";
 
 export declare enum ConfigScope {
   delivery = 'delivery',
@@ -22,5 +23,6 @@ export declare class ConfigContext {
   withLog(log: Console): ConfigContext;
   withEnv(env: object): ConfigContext;
   withS3Loader(loader: S3Loader): ConfigContext;
+  withTimer(timer: RequestTimer);
 }
 

package/src/ConfigContext.js

@@ -53,6 +53,8 @@ export class ConfigContext {
 
   fetch = null;
 
+  timer = null;
+
   withLog(log) {
     this.log = log;
     return this;
@@ -67,4 +69,9 @@ export class ConfigContext {
     this.loader = loader;
     return this;
   }
+
+  withTimer(timer) {
+    this.timer = timer;
+    return this;
+  }
 }

package/src/config-legacy.js

@@ -122,6 +122,8 @@ async function resolveAdminAccess(ctx, admin) {
  * @returns {Promise<ConfigObject|null>} the config object or {@code null} if not found.
  */
 export async function resolveLegacyConfig(ctx, rso, scope) {
+  ctx.timer?.update('legacy-helix-config');
+
   // set owner==org and repo==site and fetch from helix-config for now
   const cfg = await fetchHelixConfig(ctx, rso);
   if (!cfg) {
@@ -167,6 +169,7 @@ export async function resolveLegacyConfig(ctx, rso, scope) {
     head: helixConfig.head?.data ?? helixConfig.head ?? {},
   };
   cfg.data = config;
+  ctx.timer?.update('legacy-config-all');
   const configAllPreview = await fetchConfigAll(ctx, config.content.contentBusId, 'preview');
   const configAllLive = await fetchConfigAll(ctx, config.content.contentBusId, 'live');
   const { access, admin } = configAllPreview?.config?.data || {};
@@ -206,6 +209,7 @@ export async function resolveLegacyConfig(ctx, rso, scope) {
     if (configAllLive?.metadata) {
       config.metadata.live = configAllLive.metadata;
     }
+    ctx.timer?.update('robots-txt');
     config.robots = await fetchRobotsTxt(ctx, rso.org, rso.site);
     if (!config.robots.txt) {
       delete config.robots;

package/src/config-view.js

@@ -285,10 +285,12 @@ async function loadProfile(ctx, rso, name) {
 async function resolveConfig(ctx, rso, scope) {
   // try to load site config from config-bus
   const key = `orgs/${rso.org}/sites/${rso.site}.json`;
+  ctx.timer?.update('load-config');
   const res = await ctx.loader.getObject(HELIX_CONFIG_BUS, key);
   if (!res.body) {
     const config = await resolveLegacyConfig(ctx, rso, scope);
     if (config) {
+      ctx.timer?.update('profile');
       const profile = await loadProfile(ctx, rso, 'default');
       config.data.tokens = profile?.data.tokens || {};
       config.data.secrets = profile?.data.secrets || {};
@@ -306,6 +308,7 @@ async function resolveConfig(ctx, rso, scope) {
       profile: 'default',
     };
   }
+  ctx.timer?.update('profile');
   const profile = await loadProfile(ctx, rso, site.data.extends.profile);
   site.merge(profile);
 
@@ -321,11 +324,13 @@ async function resolveConfig(ctx, rso, scope) {
 
   const config = site.data;
   if (scope === SCOPE_PIPELINE) {
+    ctx.timer?.update('metadata');
     config.metadata = {
       preview: await loadMetadata(ctx, config, 'preview'),
       live: await loadMetadata(ctx, config, 'live'),
     };
     if (!config.robots) {
+      ctx.timer?.update('robots-txt');
       const robots = await fetchRobotsTxt(ctx, config.code.owner, config.code.repo);
       if (robots.txt) {
         config.robots = robots;
@@ -333,6 +338,7 @@ async function resolveConfig(ctx, rso, scope) {
     }
   }
   if (scope === SCOPE_PIPELINE || scope === SCOPE_DELIVERY) {
+    ctx.timer?.update('head.html');
     config.head = await loadHeadHtml(ctx, config, rso.ref);
   }
   return site;
@@ -530,12 +536,14 @@ export async function getConfigResponse(ctx, opts) {
       },
     });
   }
+  headers['x-hlx-version'] = siteConfig.data.legacy ? 4 : 5;
 
   const config = siteConfig.data;
   if (scope === SCOPE_PIPELINE || config.extends?.profile === 'default') {
     delete config.extends;
   }
 
+  ctx.timer?.update('org-config');
   const orgConfig = await loadOrgConfig(ctx, org);
 
   // normalize access config
@@ -691,7 +699,7 @@ export async function getOrgConfigResponse(ctx, opts) {
   const surrogateHeaders = {
     'x-surrogate-key': await getSurrogateKey(opts),
   };
-
+  ctx.timer?.update('org-config');
   const orgConfig = await loadOrgConfig(ctx, org);
   if (!orgConfig) {
     return new PipelineResponse('', {