@adobe/helix-config 3.7.0 → 3.8.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.8.0](https://github.com/adobe/helix-config/compare/v3.7.1...v3.8.0) (2024-07-18)
+
+
+### Features
+
+* make ConfigStore.validate() overridable ([#139](https://github.com/adobe/helix-config/issues/139)) ([6a85c7f](https://github.com/adobe/helix-config/commit/6a85c7fbefb3687c8c4f8ae2117886507192aaac))
+
+## [3.7.1](https://github.com/adobe/helix-config/compare/v3.7.0...v3.7.1) (2024-07-17)
+
+
+### Bug Fixes
+
+* include head surrogate key ([#137](https://github.com/adobe/helix-config/issues/137)) ([02cc43a](https://github.com/adobe/helix-config/commit/02cc43aa1a948c69a79f0256ebd90029cfe65f3a)), closes [#135](https://github.com/adobe/helix-config/issues/135)
+
 # [3.7.0](https://github.com/adobe/helix-config/compare/v3.6.3...v3.7.0) (2024-07-17)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/config-view.js

@@ -257,13 +257,17 @@ async function resolveConfig(ctx, rso, scope) {
   return config;
 }
 
-async function getSurrogateKey(opts, profile) {
+async function getSurrogateKey(opts, config) {
   const { site, org } = opts;
+  const profile = config?.extends?.profile;
   const keys = [
     await computeSurrogateKey(`${org}_config.json`),
   ];
   if (site) {
     keys.push(await computeSurrogateKey(`${site}--${org}_config.json`));
+    if (config?.code?.owner && config?.code?.repo && opts.scope === SCOPE_PIPELINE) {
+      keys.push(`${opts.ref}--${config.code.repo}--${config.code.owner}_head`);
+    }
   }
   if (profile) {
     keys.push(await computeSurrogateKey(`p:${profile}--${org}_config.json`));
@@ -359,7 +363,7 @@ export async function getConfigResponse(ctx, opts) {
   const rso = { ref, site, org };
   const config = await resolveConfig(ctx, rso, scope);
   const surrogateHeaders = {
-    'x-surrogate-key': await getSurrogateKey(opts, config?.extends?.profile),
+    'x-surrogate-key': await getSurrogateKey(opts, config),
   };
   if (!config) {
     return new PipelineResponse('', {

package/src/storage/config-store.js

@@ -177,6 +177,15 @@ export class ConfigStore {
       : `/orgs/${this.org}/${this.type}/${this.name}.json`;
   }
 
+  /**
+   * Validates the config and throws an error if not valid.
+   * @param {object} data the data of the config to be updated
+   * @returns {Promise<boolean|undefined>}
+   */
+  async validate(data) {
+    return validate(data, this.type);
+  }
+
   async create(ctx, data, relPath = '') {
     if (relPath) {
       throw new StatusCodeError(409, 'create not supported on substructures.');
@@ -195,7 +204,7 @@ export class ConfigStore {
       updateContentSource(ctx, data.content);
       updateCodeSource(ctx, data.code);
     }
-    await validate(data, this.type);
+    await this.validate(data, this.type);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
     await this.purge(ctx, null, data);
   }
@@ -315,7 +324,7 @@ export class ConfigStore {
       updateContentSource(ctx, config.content);
       updateCodeSource(ctx, config.code);
     }
-    await validate(config, this.type);
+    await this.validate(config, this.type);
     await storage.put(this.key, JSON.stringify(config), 'application/json');
     await this.purge(ctx, buf ? JSON.parse(buf) : null, config);
     return ret ?? redact(data, frag);
@@ -330,7 +339,7 @@ export class ConfigStore {
     const frag = getFragmentInfo(this.type, relPath);
     if (frag) {
       const data = deepPut(JSON.parse(buf), relPath, null);
-      await validate(data, this.type);
+      await this.validate(data, this.type);
       await storage.put(this.key, JSON.stringify(data), 'application/json');
       await this.purge(ctx, JSON.parse(buf), data);
       return;