@adobe/helix-html-pipeline 3.11.6 → 3.11.8

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [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)
+
+
+### Bug Fixes
+
+* folder mapping should only be applied if direct addressed resource is missing ([#307](https://github.com/adobe/helix-html-pipeline/issues/307)) ([cf9cfc0](https://github.com/adobe/helix-html-pipeline/commit/cf9cfc0f00aed7a8fd7a502d0b2c77e9aa6e710d))
+
 ## [3.11.6](https://github.com/adobe/helix-html-pipeline/compare/v3.11.5...v3.11.6) (2023-05-13)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "3.11.6",
+  "version": "3.11.8",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -66,8 +66,8 @@
     "mime": "3.0.0",
     "rehype-format": "4.0.1",
     "rehype-parse": "8.0.4",
-    "remark-parse": "10.0.1",
-    "strip-markdown": "5.0.0",
+    "remark-parse": "10.0.2",
+    "strip-markdown": "5.0.1",
     "unified": "10.1.2",
     "unist-util-map": "3.1.3",
     "unist-util-remove": "3.1.1",
@@ -83,11 +83,11 @@
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "10.0.3",
     "c8": "7.13.0",
-    "eslint": "8.40.0",
+    "eslint": "8.41.0",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.27.5",
-    "esmock": "2.2.2",
+    "esmock": "2.2.3",
     "husky": "8.0.3",
     "js-yaml": "4.1.0",
     "jsdom": "22.0.0",

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
@@ -82,13 +97,23 @@ export async function htmlPipe(state, req) {
     }
 
     // ...and apply the folder mapping
-    await folderMapping(state);
+    state.timer?.update('content-fetch');
+    let contentPromise = await fetchContent(state, req, res);
+    // ...but only if the current resource doesn't exist
+    if (res.status === 404) {
+      await folderMapping(state);
+      if (state.info.unmappedPath) {
+        contentPromise = fetchContentWith404Fallback(state, req, res);
+      } else {
+        contentPromise = fetch404(state, req, res);
+      }
+    }
 
     // load metadata and content in parallel
-    state.timer?.update('content-fetch');
+    state.timer?.update('metadata-fetch');
     await Promise.all([
       fetchConfigAll(state, req, res),
-      fetchContent(state, req, res),
+      contentPromise,
       fetchMappedMetadata(state),
     ]);
 

package/src/json-pipe.js

@@ -54,6 +54,8 @@ async function fetchJsonContent(state, req, res) {
     ret = await s3Loader.getObject('helix-code-bus', `${owner}/${repo}/${ref}${path}`);
   }
   if (ret.status === 200) {
+    res.status = 200;
+    delete res.error;
     state.content.data = ret.body;
 
     // store extra source location if present
@@ -117,7 +119,6 @@ export async function jsonPipe(state, req) {
         },
       });
     }
-    await folderMapping(state);
 
     /** @type PipelineResponse */
     const res = new PipelineResponse('', {
@@ -126,10 +127,20 @@ export async function jsonPipe(state, req) {
       },
     });
 
+    // apply the folder mapping if the current resource doesn't exist
     state.timer?.update('json-fetch');
+    let contentPromise = await fetchJsonContent(state, req, res);
+    if (res.status === 404) {
+      await folderMapping(state);
+      if (state.info.unmappedPath) {
+        contentPromise = fetchJsonContent(state, req, res);
+      }
+    }
+
+    state.timer?.update('json-metadata-fetch');
     await Promise.all([
       fetchConfigAll(state, req, res),
-      fetchJsonContent(state, req, res),
+      contentPromise,
     ]);
 
     await authenticate(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 { computeSurrogateKey } from '@adobe/helix-shared-utils';
+import { extractLastModified } from '../utils/last-modified.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 {
+    contentBusId, info, 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');
+    const pathKey = await computeSurrogateKey(`${contentBusId}${info.path}`);
+    res.headers.set('x-surrogate-key', `${pathKey} ${ref}--${repo}--${owner}_404`);
+  }
+}

package/src/steps/fetch-content.js

@@ -48,6 +48,8 @@ export default async function fetchContent(state, req, res) {
   }
 
   if (ret.status === 200) {
+    res.status = 200;
+    delete res.error;
     state.content.data = ret.body;
 
     // store extra source location if present
@@ -67,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`);
-    }
-  }
 }