@adobe/helix-html-pipeline 1.8.14 → 1.9.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.9.0](https://github.com/adobe/helix-html-pipeline/compare/v1.8.15...v1.9.0) (2023-01-13)
+
+
+### Features
+
+* add contentbusId/path as surrogate key ([87b1ad6](https://github.com/adobe/helix-html-pipeline/commit/87b1ad6bc5890eb2e743b59d3726a962226a8e6d))
+
+## [1.8.15](https://github.com/adobe/helix-html-pipeline/compare/v1.8.14...v1.8.15) (2023-01-07)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#228](https://github.com/adobe/helix-html-pipeline/issues/228)) ([761b4ec](https://github.com/adobe/helix-html-pipeline/commit/761b4ec70764f02bbc393e507c8fccc62e8bc5a9))
+
 ## [1.8.14](https://github.com/adobe/helix-html-pipeline/compare/v1.8.13...v1.8.14) (2022-12-10)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "1.8.14",
+  "version": "1.9.0",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -35,15 +35,15 @@
     "@adobe/remark-gridtables": "1.0.0",
     "github-slugger": "2.0.0",
     "hast-util-raw": "7.2.3",
-    "hast-util-select": "5.0.2",
+    "hast-util-select": "5.0.3",
     "hast-util-to-html": "8.0.3",
     "hast-util-to-string": "2.0.0",
-    "hastscript": "7.1.0",
+    "hastscript": "7.2.0",
     "mdast-util-gfm-footnote": "1.0.1",
     "mdast-util-gfm-strikethrough": "1.0.2",
     "mdast-util-gfm-table": "1.0.6",
     "mdast-util-gfm-task-list-item": "1.0.1",
-    "mdast-util-to-hast": "12.2.4",
+    "mdast-util-to-hast": "12.2.5",
     "mdast-util-to-string": "3.1.0",
     "micromark-extension-gfm-footnote": "1.0.4",
     "micromark-extension-gfm-strikethrough": "1.0.4",
@@ -61,7 +61,7 @@
     "unist-util-map": "3.1.2",
     "unist-util-remove": "3.1.0",
     "unist-util-remove-position": "4.0.1",
-    "unist-util-select": "4.0.1",
+    "unist-util-select": "4.0.2",
     "unist-util-visit": "4.1.1"
   },
   "devDependencies": {
@@ -71,17 +71,17 @@
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "9.0.1",
     "c8": "7.12.0",
-    "eslint": "8.29.0",
+    "eslint": "8.31.0",
     "eslint-import-resolver-exports": "1.0.0-beta.3",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.26.0",
     "esmock": "2.1.0",
-    "husky": "8.0.2",
+    "husky": "8.0.3",
     "js-yaml": "4.1.0",
-    "jsdom": "20.0.3",
+    "jsdom": "21.0.0",
     "junit-report-builder": "3.0.1",
     "lint-staged": "13.1.0",
-    "mocha": "10.1.0",
+    "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
     "remark-gfm": "3.0.1",
     "semantic-release": "19.0.5"

package/src/json-pipe.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
+import { cleanupHeaderValue, computeSurrogateKey } from '@adobe/helix-shared-utils';
 import fetchMetadata from './steps/fetch-metadata.js';
 import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
 import { PipelineResponse } from './PipelineResponse.js';
@@ -111,8 +111,11 @@ export async function jsonPipe(state, req) {
     // set last-modified
     updateLastModified(state, response, extractLastModified(dataResponse.headers));
 
-    // set surrogate key
-    response.headers.set('x-surrogate-key', `${contentBusId}${path}`.replace(/\//g, '_'));
+    // set surrogate keys
+    const keys = [];
+    keys.push(`${contentBusId}${path}`.replace(/\//g, '_')); // TODO: remove
+    keys.push(await computeSurrogateKey(`${contentBusId}${path}`));
+    response.headers.set('x-surrogate-key', keys.join(' '));
 
     // Load metadata from metadata.json
     await fetchMetadata(state, req, response);

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

@@ -20,13 +20,25 @@ import { computeSurrogateKey } from '@adobe/helix-shared-utils';
  */
 export default async function setXSurrogateKeyHeader(state, req, res) {
   const {
-    content, contentBusId, owner, repo, ref,
+    content, contentBusId, owner, repo, ref, info,
   } = state;
 
+  let { path } = info;
+
   const keys = [];
   if (content.sourceLocation) {
     keys.push(await computeSurrogateKey(content.sourceLocation));
   }
+
+  // surrogate key for path
+  // strip [index].plain.html
+  if (path.endsWith('index.plain.html')) {
+    path = path.substring(0, path.length - 'index.plain.html'.length);
+  } else if (path.endsWith('.plain.html')) {
+    path = path.substring(0, path.length - '.plain.html'.length);
+  }
+  keys.push(await computeSurrogateKey(`${contentBusId}${path}`));
+
   keys.push(`${contentBusId}_metadata`);
   keys.push(`${ref}--${repo}--${owner}_head`);