@adobe/helix-html-pipeline 3.10.1 → 3.11.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.11.0](https://github.com/adobe/helix-html-pipeline/compare/v3.10.2...v3.11.0) (2023-04-24)
+
+
+### Features
+
+* load metadata from mapped path ([#298](https://github.com/adobe/helix-html-pipeline/issues/298)) ([a1fc7b0](https://github.com/adobe/helix-html-pipeline/commit/a1fc7b0b9b2d795d3aa3f6c8e15713ad1862ee77))
+
+## [3.10.2](https://github.com/adobe/helix-html-pipeline/compare/v3.10.1...v3.10.2) (2023-04-11)
+
+
+### Bug Fixes
+
+* use correct header for contentbusid ([#294](https://github.com/adobe/helix-html-pipeline/issues/294)) ([1c070f9](https://github.com/adobe/helix-html-pipeline/commit/1c070f905667d414f76226958461b3dcd18a2c1c))
+
 ## [3.10.1](https://github.com/adobe/helix-html-pipeline/compare/v3.10.0...v3.10.1) (2023-04-11)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "3.10.1",
+  "version": "3.11.0",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -50,7 +50,7 @@
     "hast-util-to-html": "8.0.4",
     "hast-util-to-string": "2.0.0",
     "hastscript": "7.2.0",
-    "jose": "4.13.1",
+    "jose": "4.14.1",
     "mdast-util-gfm-footnote": "1.0.2",
     "mdast-util-gfm-strikethrough": "1.0.3",
     "mdast-util-gfm-table": "1.0.7",
@@ -83,7 +83,7 @@
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "10.0.3",
     "c8": "7.13.0",
-    "eslint": "8.38.0",
+    "eslint": "8.39.0",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.27.5",

package/src/html-pipe.js

@@ -37,6 +37,7 @@ import { PipelineStatusError } from './PipelineStatusError.js';
 import { PipelineResponse } from './PipelineResponse.js';
 import { validatePathInfo } from './utils/path.js';
 import { initAuthRoute } from './utils/auth.js';
+import fetchMappedMetadata from './steps/fetch-mapped-metadata.js';
 
 /**
  * Runs the default pipeline and returns the response.
@@ -88,6 +89,7 @@ export async function htmlPipe(state, req) {
     await Promise.all([
       fetchConfigAll(state, req, res),
       fetchContent(state, req, res),
+      fetchMappedMetadata(state),
     ]);
 
     await requireProject(state, req, res);

package/src/steps/extract-metadata.js

@@ -158,6 +158,7 @@ export default function extractMetaData(state, req) {
   // with local metadata from document
   const metaConfig = Object.assign(
     state.metadata.getModifiers(state.info.unmappedPath || state.info.path),
+    state.mappedMetadata.getModifiers(state.info.path),
     getLocalMetadata(hast),
   );
 

package/src/steps/fetch-config-all.js

@@ -35,12 +35,12 @@ async function fetchMetadata(state, req, res) {
     try {
       json = JSON.parse(ret.body);
     } catch (e) {
-      throw new PipelineStatusError(400, `failed parsing of /metadata.json: ${e.message}`);
+      throw new PipelineStatusError(500, `failed parsing of /metadata.json: ${e.message}`);
     }
 
     const { data } = json.default ?? json;
     if (!Array.isArray(data)) {
-      throw new PipelineStatusError(400, 'failed loading of /metadata.json: data must be an array');
+      throw new PipelineStatusError(500, 'failed loading of /metadata.json: data must be an array');
     }
 
     state.metadata = Modifiers.fromModifierSheet(

package/src/steps/fetch-config.js

@@ -48,7 +48,7 @@ export default async function fetchConfig(state, req, res) {
   }
 
   // set contentbusid from header if missing in config
-  const cbid = ret.headers.get('x-contentbus-id');
+  const cbid = ret.headers.get('x-amz-meta-x-contentbus-id');
   if (!config.content && cbid) {
     config.content = {
       data: {

package/src/steps/fetch-mapped-metadata.js

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2021 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { PipelineStatusError } from '../PipelineStatusError.js';
+import { Modifiers } from '../utils/modifiers.js';
+
+/**
+ * Loads metadata for a mapped path and puts it into `state.mappedMetadata`. If path is not
+ * mapped or there is no `metadata.json` at that path, puts an `EMPTY` Modifiers object into
+ * `state.mappedMetadata`.
+ *
+ * @type PipelineStep
+ * @param {PipelineState} state
+ * @returns {Promise<void>}
+ */
+export default async function fetchMappedMetadata(state) {
+  state.mappedMetadata = Modifiers.EMPTY;
+  if (!state.mapped) {
+    return;
+  }
+  const { contentBusId, partition } = state;
+  const metadataPath = `${state.info.path}/metadata.json`;
+  const key = `${contentBusId}/${partition}${metadataPath}`;
+  const ret = await state.s3Loader.getObject('helix-content-bus', key);
+  if (ret.status === 200) {
+    let json;
+    try {
+      json = JSON.parse(ret.body);
+    } catch (e) {
+      throw new PipelineStatusError(500, `failed parsing of ${metadataPath}: ${e.message}`);
+    }
+
+    const { data } = json.default ?? json;
+    if (!Array.isArray(data)) {
+      throw new PipelineStatusError(500, `failed loading of ${metadataPath}: data must be an array`);
+    }
+
+    state.mappedMetadata = Modifiers.fromModifierSheet(
+      data,
+    );
+    return;
+  }
+  if (ret.status !== 404) {
+    throw new PipelineStatusError(502, `failed to load ${metadataPath}: ${ret.status}`);
+  }
+}

package/src/steps/folder-mapping.js

@@ -55,6 +55,7 @@ export default function folderMapping(state) {
       state.info.resourcePath = mapped;
       state.log.info(`mapped ${path} to ${state.info.resourcePath} (code-bus)`);
     } else {
+      state.mapped = true;
       state.log.info(`mapped ${path} to ${state.info.path} (content-bus)`);
     }
   }

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

@@ -37,10 +37,15 @@ export default async function setXSurrogateKeyHeader(state, req, res) {
   } else if (path.endsWith('.plain.html')) {
     path = path.substring(0, path.length - '.plain.html'.length);
   }
-  keys.push(await computeSurrogateKey(`${contentBusId}${path}`));
+  const hash = await computeSurrogateKey(`${contentBusId}${path}`);
+  keys.push(hash);
 
   keys.push(`${contentBusId}_metadata`);
   keys.push(`${ref}--${repo}--${owner}_head`);
 
+  if (state.mapped) {
+    keys.push(`${hash}_metadata`);
+  }
+
   res.headers.set('x-surrogate-key', keys.join(' '));
 }