@adobe/helix-html-pipeline 6.14.10 → 6.14.11

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [6.14.11](https://github.com/adobe/helix-html-pipeline/compare/v6.14.10...v6.14.11) (2024-09-30)
+
+
+### Bug Fixes
+
+* scoped keys for prefix content ([82966df](https://github.com/adobe/helix-html-pipeline/commit/82966df9c749a1f03c7423cd9da51f685d788133))
+
 ## [6.14.10](https://github.com/adobe/helix-html-pipeline/compare/v6.14.9...v6.14.10) (2024-09-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "6.14.10",
+  "version": "6.14.11",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/json-pipe.js

@@ -65,6 +65,13 @@ async function fetchJsonContent(state, req, res) {
     if (state.content.sourceBus === 'content') {
       keys.push(await computeSurrogateKey(`${contentBusId}${info.path}`));
       keys.push(contentBusId);
+      const contentKeyPrefix = partition === 'preview' ? 'p_' : '';
+      if (partition === 'preview') {
+        // temporarily provide additional preview content keys
+        // TODO: eventually provide either (prefixed) preview or (unprefixed) live content keys
+        keys.push(`${contentKeyPrefix}${await computeSurrogateKey(`${contentBusId}${info.path}`)}`);
+        keys.push(`${contentKeyPrefix}${contentBusId}`);
+      }
     } else {
       keys.push(`${ref}--${repo}--${owner}_code`);
       keys.push(await computeSurrogateKey(`${ref}--${repo}--${owner}${info.path}`));
@@ -104,6 +111,13 @@ async function computeSurrogateKeys(state) {
   if (state.content.sourceBus.includes('content')) {
     keys.push(await computeSurrogateKey(`${state.contentBusId}${state.info.path}`));
     keys.push(state.contentBusId);
+    const contentKeyPrefix = state.partition === 'preview' ? 'p_' : '';
+    if (state.partition === 'preview') {
+      // temporarily provide additional preview content keys
+      // TODO: eventually provide either (prefixed) preview or (unprefixed) live content keys
+      keys.push(`${contentKeyPrefix}${await computeSurrogateKey(`${state.contentBusId}${state.info.path}`)}`);
+      keys.push(`${contentKeyPrefix}${state.contentBusId}`);
+    }
   }
 
   return keys;

package/src/steps/fetch-404.js

@@ -22,7 +22,7 @@ import { getPathKey } from './set-x-surrogate-key-header.js';
  */
 export default async function fetch404(state, req, res) {
   const {
-    owner, repo, ref, contentBusId,
+    owner, repo, ref, contentBusId, partition,
   } = state;
   const ret = await state.s3Loader.getObject('helix-code-bus', `${owner}/${repo}/${ref}/404.html`);
   if (ret.status === 200) {
@@ -46,12 +46,25 @@ export default async function fetch404(state, req, res) {
     `${ref}--${repo}--${owner}_404`,
     `${ref}--${repo}--${owner}_code`,
   ];
+  const contentKeyPrefix = partition === 'preview' ? 'p_' : '';
+  if (partition === 'preview') {
+    // temporarily provide additional preview content keys
+    // TODO: eventually provide either (prefixed) preview or (unprefixed) live content keys
+    keys.push(`${contentKeyPrefix}${pathKey}`);
+    keys.push(`${contentKeyPrefix}${contentBusId}`);
+  }
 
   if (state.info.unmappedPath) {
-    keys.push(await getPathKey({
+    const unmappedPathKey = await getPathKey({
       contentBusId,
       info: { path: state.info.unmappedPath },
-    }));
+    });
+    keys.push(unmappedPathKey);
+    if (partition === 'preview') {
+      // temporarily provide additional preview content key
+      // TODO: eventually provide either (prefixed) preview or (unprefixed) live content key
+      keys.push(`${contentKeyPrefix}${unmappedPathKey}`);
+    }
   }
 
   res.headers.set('x-surrogate-key', keys.join(' '));

package/src/steps/fetch-content.js

@@ -48,6 +48,13 @@ export default async function fetchContent(state, req, res) {
     } else {
       keys.push(await computeSurrogateKey(`${contentBusId}${info.path}`));
       keys.push(contentBusId);
+      const contentKeyPrefix = partition === 'preview' ? 'p_' : '';
+      if (partition === 'preview') {
+        // temporarily provide additional preview content keys
+        // TODO: eventually provide either (prefixed) preview or (unprefixed) live content keys
+        keys.push(`${contentKeyPrefix}${await computeSurrogateKey(`${contentBusId}${info.path}`)}`);
+        keys.push(`${contentKeyPrefix}${contentBusId}`);
+      }
     }
     res.headers.set('x-surrogate-key', keys.join(' '));
     res.error = 'moved';

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

@@ -42,11 +42,12 @@ export async function getPathKey(state) {
  */
 export default async function setXSurrogateKeyHeader(state, req, res) {
   const {
-    contentBusId, owner, repo, ref,
+    contentBusId, owner, repo, ref, partition,
   } = state;
 
   const isCode = state.content.sourceBus === 'code';
 
+  const contentKeyPrefix = partition === 'preview' ? 'p_' : '';
   const keys = [];
   const hash = await getPathKey(state);
   if (isCode) {
@@ -57,6 +58,13 @@ export default async function setXSurrogateKeyHeader(state, req, res) {
     keys.push(`${contentBusId}_metadata`);
     keys.push(`${ref}--${repo}--${owner}_head`);
     keys.push(contentBusId);
+    if (partition === 'preview') {
+      // temporarily provide additional preview content keys
+      // TODO: eventually provide either (prefixed) preview or (unprefixed) live content keys
+      keys.push(`${contentKeyPrefix}${hash}`);
+      keys.push(`${contentKeyPrefix}${contentBusId}_metadata`);
+      keys.push(`${contentKeyPrefix}${contentBusId}`);
+    }
   }
   // for folder-mapped resources, we also need to include the surrogate key of the mapped metadata
   if (state.mapped) {
@@ -67,6 +75,17 @@ export default async function setXSurrogateKeyHeader(state, req, res) {
         info: { path: state.info.unmappedPath },
       }));
     }
+    if (partition === 'preview') {
+      // temporarily provide additional preview content keys
+      // TODO: eventually provide either (prefixed) preview or (unprefixed) live content keys
+      keys.push(`${contentKeyPrefix}${hash}_metadata`);
+      if (state.info.unmappedPath) {
+        keys.push(`${contentKeyPrefix}${await getPathKey({
+          contentBusId,
+          info: { path: state.info.unmappedPath },
+        })}`);
+      }
+    }
   }
   res.headers.set('x-surrogate-key', keys.join(' '));
 }