@adobe/helix-html-pipeline 6.11.0 → 6.12.1

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [6.12.1](https://github.com/adobe/helix-html-pipeline/compare/v6.12.0...v6.12.1) (2024-06-01)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/mdast-util-gridtables to v4.0.5 ([156fde7](https://github.com/adobe/helix-html-pipeline/commit/156fde71d727e11e1dc7bd31e5f88071bedf9d4c))
+
+# [6.12.0](https://github.com/adobe/helix-html-pipeline/compare/v6.11.0...v6.12.0) (2024-05-22)
+
+
+### Features
+
+* add contentbusid surrogate key for pipeline responses depending on content resources ([e821162](https://github.com/adobe/helix-html-pipeline/commit/e821162b9afc649fbb53ef550d51fd61b4ccc346))
+* add ref--repo--owner_code surrogate key for pipeline responses depending on codebus resources ([797aad2](https://github.com/adobe/helix-html-pipeline/commit/797aad2a1b34aa7eb95fc9ef57a65b60afed2c76))
+* add ref--repo-owner_code for all code resources ([edaa518](https://github.com/adobe/helix-html-pipeline/commit/edaa518db81259d4c247c6cc8445277f41a3ccfb))
+
 # [6.11.0](https://github.com/adobe/helix-html-pipeline/compare/v6.10.3...v6.11.0) (2024-05-13)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "6.11.0",
+  "version": "6.12.1",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -45,7 +45,7 @@
   "dependencies": {
     "@adobe/helix-markdown-support": "7.1.2",
     "@adobe/helix-shared-utils": "3.0.2",
-    "@adobe/mdast-util-gridtables": "4.0.4",
+    "@adobe/mdast-util-gridtables": "4.0.5",
     "@adobe/remark-gridtables": "3.0.4",
     "github-slugger": "2.0.0",
     "hast-util-raw": "9.0.3",
@@ -83,9 +83,9 @@
     "esmock": "2.6.5",
     "husky": "9.0.11",
     "js-yaml": "4.1.0",
-    "jsdom": "24.0.0",
+    "jsdom": "24.1.0",
     "junit-report-builder": "3.2.1",
-    "lint-staged": "15.2.2",
+    "lint-staged": "15.2.5",
     "mocha": "10.4.0",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",

package/src/json-pipe.js

@@ -61,7 +61,15 @@ async function fetchJsonContent(state, req, res) {
     res.body = '';
     res.headers.delete('content-type');
     res.headers.set('location', redirectLocation);
-    res.headers.set('x-surrogate-key', await computeSurrogateKey(`${contentBusId}${info.path}`));
+    const keys = [];
+    if (state.content.sourceBus === 'content') {
+      keys.push(await computeSurrogateKey(`${contentBusId}${info.path}`));
+      keys.push(contentBusId);
+    } else {
+      keys.push(`${ref}--${repo}--${owner}_code`);
+      keys.push(await computeSurrogateKey(`${ref}--${repo}--${owner}${info.path}`));
+    }
+    res.headers.set('x-surrogate-key', keys.join(' '));
     res.error = 'moved';
     return;
   }
@@ -92,8 +100,12 @@ async function computeSurrogateKeys(state) {
   if (state.info.path === '/config.json') {
     keys.push(await computeSurrogateKey(`${state.site}--${state.org}_config.json`));
   }
-  keys.push(pathKey.replace(/\//g, '_')); // TODO: remove
   keys.push(await computeSurrogateKey(pathKey));
+  if (state.content?.sourceBus === 'content') {
+    keys.push(state.contentBusId);
+  } else {
+    keys.push(`${state.ref}--${state.repo}--${state.owner}_code`);
+  }
   return keys;
 }
 

package/src/robots-pipe.js

@@ -120,7 +120,6 @@ async function computeSurrogateKeys(state) {
 
   const pathKey = `${state.ref}--${state.repo}--${state.owner}${state.info.path}`;
   keys.push(await computeSurrogateKey(`${state.site}--${state.org}_config.json`));
-  keys.push(pathKey.replace(/\//g, '_')); // TODO: remove
   keys.push(await computeSurrogateKey(pathKey));
   return keys;
 }

package/src/steps/fetch-404.js

@@ -38,5 +38,5 @@ export default async function fetch404(state, req, res) {
 
   // set 404 keys in any case
   const pathKey = await getPathKey(state);
-  res.headers.set('x-surrogate-key', `${pathKey} ${ref}--${repo}--${owner}_404`);
+  res.headers.set('x-surrogate-key', `${pathKey} ${ref}--${repo}--${owner}_404 ${ref}--${repo}--${owner}_code`);
 }

package/src/steps/fetch-content.js

@@ -41,7 +41,15 @@ export default async function fetchContent(state, req, res) {
       redirectLocation += '.plain.html';
     }
     res.headers.set('location', redirectLocation);
-    res.headers.set('x-surrogate-key', await computeSurrogateKey(`${contentBusId}${info.path}`));
+    const keys = [];
+    if (isCode) {
+      keys.push(await computeSurrogateKey(`${ref}--${repo}--${owner}${info.path}`));
+      keys.push(`${ref}--${repo}--${owner}_code`);
+    } else {
+      keys.push(await computeSurrogateKey(`${contentBusId}${info.path}`));
+      keys.push(contentBusId);
+    }
+    res.headers.set('x-surrogate-key', keys.join(' '));
     res.error = 'moved';
     return;
   }

package/src/steps/set-x-surrogate-key-header.js

@@ -49,6 +49,7 @@ export default async function setXSurrogateKeyHeader(state, req, res) {
     hash,
     `${contentBusId}_metadata`,
     `${ref}--${repo}--${owner}_head`,
+    contentBusId,
   ];
 
   // for folder-mapped resources, we also need to include the surrogate key of the mapped metadata