@adobe/helix-html-pipeline 5.10.0 → 5.11.1

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [5.11.1](https://github.com/adobe/helix-html-pipeline/compare/v5.11.0...v5.11.1) (2024-06-04)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/mdast-util-gridtables to v4.0.5 ([#612](https://github.com/adobe/helix-html-pipeline/issues/612)) ([f3cffb1](https://github.com/adobe/helix-html-pipeline/commit/f3cffb1a2e158a0fb7824223fbf17e2c4374dda2))
+
+# [5.11.0](https://github.com/adobe/helix-html-pipeline/compare/v5.10.0...v5.11.0) (2024-05-29)
+
+
+### Features
+
+* add contentbusid surrogate key for pipeline responses depending on content resources ([d26d19e](https://github.com/adobe/helix-html-pipeline/commit/d26d19e5e5ceb5830e7aea007ccfe8df306642be))
+* add ref--repo--owner_code surrogate key for pipeline responses depending on codebus resources ([96624fc](https://github.com/adobe/helix-html-pipeline/commit/96624fc6da8bd1bb748d76e157ef10d752e18e24))
+* add ref--repo-owner_code for all code resources ([40fb5cc](https://github.com/adobe/helix-html-pipeline/commit/40fb5ccb067831dac5a84ed66e636ef9167cc64e))
+* backport surrogate key changes ([a7ed342](https://github.com/adobe/helix-html-pipeline/commit/a7ed3421cf17039337c70b608c5bec72b7450502))
+
 # [5.10.0](https://github.com/adobe/helix-html-pipeline/compare/v5.9.10...v5.10.0) (2024-04-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "5.10.0",
+  "version": "5.11.1",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -16,7 +16,7 @@
     "test": "c8 mocha",
     "lint": "eslint .",
     "semantic-release": "semantic-release",
-    "semantic-release-dry": "semantic-release --dry-run --branches main,$CI_BRANCH",
+    "semantic-release-dry": "semantic-release --debug --dry-run --branches main,5.x,$CI_BRANCH",
     "prepare": "husky install"
   },
   "repository": {
@@ -45,20 +45,20 @@
   "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",
     "cookie": "0.6.0",
     "github-slugger": "2.0.0",
-    "hast-util-raw": "9.0.2",
+    "hast-util-raw": "9.0.3",
     "hast-util-select": "6.0.2",
     "hast-util-to-html": "9.0.1",
     "hast-util-to-string": "3.0.0",
     "hastscript": "9.0.0",
-    "jose": "5.2.4",
+    "jose": "5.3.0",
     "lodash.escape": "4.0.1",
     "mdast-util-to-hast": "13.1.0",
     "mdast-util-to-string": "4.0.0",
-    "mime": "4.0.1",
+    "mime": "4.0.3",
     "rehype-format": "5.0.0",
     "rehype-parse": "9.0.0",
     "remark-parse": "11.0.0",
@@ -76,22 +76,22 @@
     "@markedjs/html-differ": "4.0.2",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/npm": "12.0.0",
+    "@semantic-release/npm": "12.0.1",
     "c8": "9.1.0",
     "eslint": "8.57.0",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.29.1",
-    "esmock": "2.6.4",
+    "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",
-    "semantic-release": "23.0.8"
+    "semantic-release": "24.0.0"
   },
   "lint-staged": {
     "*.js": "eslint",

package/src/json-pipe.js

@@ -47,10 +47,12 @@ async function fetchJsonContent(state, req, res) {
     owner, repo, ref, contentBusId, partition, s3Loader, log, info,
   } = state;
   const { path } = state.info;
+  state.content.sourceBus = 'content';
   let ret = await s3Loader.getObject('helix-content-bus', `${contentBusId}/${partition}${path}`);
 
   // if not found, fall back to code bus
   if (ret.status === 404) {
+    state.content.sourceBus = 'code';
     ret = await s3Loader.getObject('helix-code-bus', `${owner}/${repo}/${ref}${path}`);
   }
 
@@ -61,7 +63,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;
   }
@@ -77,15 +87,24 @@ async function fetchJsonContent(state, req, res) {
 
     updateLastModified(state, res, extractLastModified(ret.headers));
   } else {
+    state.content.sourceBus = 'content';
     res.status = ret.status === 404 ? 404 : 502;
     res.error = `failed to load ${state.info.resourcePath}: ${ret.status}`;
   }
 }
 
-async function computeSurrogateKeys(path, contentBusId) {
+async function computeSurrogateKeys(state) {
   const keys = [];
-  keys.push(`${contentBusId}${path}`.replace(/\//g, '_')); // TODO: remove
-  keys.push(await computeSurrogateKey(`${contentBusId}${path}`));
+  const pathKey = state.content?.sourceBus === 'code'
+    ? `${state.ref}--${state.repo}--${state.owner}${state.info.path}`
+    : `${state.contentBusId}${state.info.path}`;
+
+  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;
 }
 
@@ -173,7 +192,7 @@ export async function jsonPipe(state, req) {
     });
 
     // set surrogate keys
-    const keys = await computeSurrogateKeys(state.info.path, state.contentBusId);
+    const keys = await computeSurrogateKeys(state);
     res.headers.set('x-surrogate-key', keys.join(' '));
 
     await setCustomResponseHeaders(state, req, res);
@@ -190,7 +209,7 @@ export async function jsonPipe(state, req) {
       await setCustomResponseHeaders(state, req, res);
     }
     if (res.status === 404) {
-      const keys = await computeSurrogateKeys(state.info.path, state.contentBusId);
+      const keys = await computeSurrogateKeys(state);
       res.headers.set('x-surrogate-key', keys.join(' '));
     }
     return res;

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

@@ -45,7 +45,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