@adobe/helix-html-pipeline 3.11.7 → 3.11.9

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [3.11.9](https://github.com/adobe/helix-html-pipeline/compare/v3.11.8...v3.11.9) (2023-05-25)
+
+
+### Bug Fixes
+
+* properly set surrogate keys for 404 with .plain.html ([#321](https://github.com/adobe/helix-html-pipeline/issues/321)) ([c7a956a](https://github.com/adobe/helix-html-pipeline/commit/c7a956a1684e758b5c0cf343c68a8dba1f8bc226)), closes [#320](https://github.com/adobe/helix-html-pipeline/issues/320)
+
+## [3.11.8](https://github.com/adobe/helix-html-pipeline/compare/v3.11.7...v3.11.8) (2023-05-22)
+
+
+### Bug Fixes
+
+* don't load 404.html too early ([#318](https://github.com/adobe/helix-html-pipeline/issues/318)) ([6fa9f12](https://github.com/adobe/helix-html-pipeline/commit/6fa9f120eed6daca3f006062cb2f81f96708a5db))
+
 ## [3.11.7](https://github.com/adobe/helix-html-pipeline/compare/v3.11.6...v3.11.7) (2023-05-22)
 
 

package/package.json

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

package/src/html-pipe.js

@@ -17,6 +17,7 @@ import createPictures from './steps/create-pictures.js';
 import extractMetaData from './steps/extract-metadata.js';
 import fetchConfig from './steps/fetch-config.js';
 import fetchContent from './steps/fetch-content.js';
+import fetch404 from './steps/fetch-404.js';
 import fetchConfigAll from './steps/fetch-config-all.js';
 import fixSections from './steps/fix-sections.js';
 import folderMapping from './steps/folder-mapping.js';
@@ -39,6 +40,20 @@ import { validatePathInfo } from './utils/path.js';
 import { initAuthRoute } from './utils/auth.js';
 import fetchMappedMetadata from './steps/fetch-mapped-metadata.js';
 
+/**
+ * Fetches the content and if not found, fetches the 404.html
+ * @param state
+ * @param req
+ * @param res
+ * @returns {Promise<void>}
+ */
+async function fetchContentWith404Fallback(state, req, res) {
+  await fetchContent(state, req, res);
+  if (res.status === 404) {
+    await fetch404(state, req, res);
+  }
+}
+
 /**
  * Runs the default pipeline and returns the response.
  * @param {PipelineState} state
@@ -88,7 +103,9 @@ export async function htmlPipe(state, req) {
     if (res.status === 404) {
       await folderMapping(state);
       if (state.info.unmappedPath) {
-        contentPromise = fetchContent(state, req, res);
+        contentPromise = fetchContentWith404Fallback(state, req, res);
+      } else {
+        contentPromise = fetch404(state, req, res);
       }
     }
 

package/src/steps/fetch-404.js

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2023 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 { extractLastModified } from '../utils/last-modified.js';
+import { getPathKey } from './set-x-surrogate-key-header.js';
+
+/**
+ * Loads the 404.html from code-bus and stores it in `res.body`
+ * @type PipelineStep
+ * @param {PipelineState} state
+ * @param {PipelineRequest} req
+ * @param {PipelineResponse} res
+ * @returns {Promise<void>}
+ */
+export default async function fetch404(state, req, res) {
+  const { owner, repo, ref } = state;
+  const ret = await state.s3Loader.getObject('helix-code-bus', `${owner}/${repo}/${ref}/404.html`);
+  if (ret.status === 200) {
+    // override last-modified if source-last-modified is set
+    const lastModified = extractLastModified(ret.headers);
+    if (lastModified) {
+      ret.headers.set('last-modified', lastModified);
+    }
+
+    // keep 404 response status
+    res.body = ret.body;
+    res.headers.set('last-modified', ret.headers.get('last-modified'));
+    res.headers.set('content-type', 'text/html; charset=utf-8');
+  }
+
+  // set 404 keys in any case
+  const pathKey = await getPathKey(state);
+  res.headers.set('x-surrogate-key', `${pathKey} ${ref}--${repo}--${owner}_404`);
+}

package/src/steps/fetch-content.js

@@ -69,23 +69,4 @@ export default async function fetchContent(state, req, res) {
     res.status = ret.status === 404 ? 404 : 502;
     res.error = `failed to load ${info.resourcePath} from ${state.content.sourceBus}-bus: ${ret.status}`;
   }
-
-  if (res.status === 404) {
-    // try to load 404.html from code-bus
-    const ret404 = await state.s3Loader.getObject('helix-code-bus', `${owner}/${repo}/${ref}/404.html`);
-    if (ret404.status === 200) {
-      // override last-modified if source-last-modified is set
-      const lastModified = extractLastModified(ret404.headers);
-      if (lastModified) {
-        ret404.headers.set('last-modified', lastModified);
-      }
-
-      // keep 404 response status
-      res.body = ret404.body;
-      res.headers.set('last-modified', ret404.headers.get('last-modified'));
-      res.headers.set('content-type', 'text/html; charset=utf-8');
-      const pathKey = await computeSurrogateKey(`${contentBusId}${info.path}`);
-      res.headers.set('x-surrogate-key', `${pathKey} ${ref}--${repo}--${owner}_404`);
-    }
-  }
 }

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

@@ -11,6 +11,24 @@
  */
 import { computeSurrogateKey } from '@adobe/helix-shared-utils';
 
+/**
+ * Returns the surrogate key based on the contentBusId and the resource path
+ * @param state
+ * @returns {Promise<string>}
+ */
+export async function getPathKey(state) {
+  const { contentBusId, info } = state;
+  let { path } = info;
+  // 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);
+  }
+  return computeSurrogateKey(`${contentBusId}${path}`);
+}
+
 /**
  * @type PipelineStep
  * @param {PipelineState} state
@@ -20,26 +38,16 @@ import { computeSurrogateKey } from '@adobe/helix-shared-utils';
  */
 export default async function setXSurrogateKeyHeader(state, req, res) {
   const {
-    content, contentBusId, owner, repo, ref, info,
+    content, contentBusId, owner, repo, ref,
   } = 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);
-  }
-  const hash = await computeSurrogateKey(`${contentBusId}${path}`);
+  const hash = await getPathKey(state);
   keys.push(hash);
-
   keys.push(`${contentBusId}_metadata`);
   keys.push(`${ref}--${repo}--${owner}_head`);