@adobe/helix-html-pipeline 5.13.11 → 5.13.12

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [5.13.12](https://github.com/adobe/helix-html-pipeline/compare/v5.13.11...v5.13.12) (2024-12-04)
+
+
+### Bug Fixes
+
+* apply folder-mapped metadata also for existing resources ([#766](https://github.com/adobe/helix-html-pipeline/issues/766)) ([9574186](https://github.com/adobe/helix-html-pipeline/commit/95741861927afe291cd63ca4502e9c52d2e215fa)), closes [#758](https://github.com/adobe/helix-html-pipeline/issues/758)
+
 ## [5.13.11](https://github.com/adobe/helix-html-pipeline/compare/v5.13.10...v5.13.11) (2024-11-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "5.13.11",
+  "version": "5.13.12",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -89,7 +89,7 @@
     "jsdom": "25.0.1",
     "junit-report-builder": "5.1.1",
     "lint-staged": "15.2.10",
-    "mocha": "10.8.2",
+    "mocha": "11.0.1",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",
     "semantic-release": "24.2.0"

package/src/PipelineState.d.ts

@@ -133,5 +133,23 @@ declare class PipelineState {
    * this is initialized after the config is loaded.
    */
   liveHost?: string;
+
+  /**
+   * specifies if the content as folder mapped (note that it remains false for content that
+   * exists below a folder mapped path. in this case, the `mappedPath` would still be different
+   * from the `info.path`
+   */
+  mapped: boolean;
+
+  /**
+   * the mapped path (target) of a folder mapping. this is set irrespective of the existence of the
+   * resource, when the path is below a folder mapped path
+   */
+  mappedPath: string;
+
+  /**
+   * metadata from folder mapping
+   */
+  mappedMetadata: Modifiers
 }
 

package/src/html-pipe.js

@@ -20,7 +20,7 @@ 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';
+import { calculateFolderMapping, applyFolderMapping } from './steps/folder-mapping.js';
 import getMetadata from './steps/get-metadata.js';
 import html from './steps/make-html.js';
 import parseMarkdown from './steps/parse-markdown.js';
@@ -126,7 +126,7 @@ export async function htmlPipe(state, req) {
       state.content.sourceBus = 'code';
     }
 
-    // ...and apply the folder mapping
+    calculateFolderMapping(state);
     state.timer?.update('content-fetch');
     let contentPromise = await fetchContent(state, req, res);
     if (res.status === 404) {
@@ -135,7 +135,7 @@ export async function htmlPipe(state, req) {
         contentPromise = fetchContentRedirectWith404Fallback(state, req, res);
       } else {
         // ...apply folder mapping if the current resource doesn't exist
-        await folderMapping(state);
+        applyFolderMapping(state);
         if (state.info.unmappedPath) {
           contentPromise = fetchContentWith404Fallback(state, req, res);
         } else {

package/src/steps/extract-metadata.js

@@ -168,7 +168,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.unmappedPath),
+    state.mappedMetadata.getModifiers(state.info.unmappedPath || state.info.path),
   );
 
   // prune empty values and explicit "" strings from sheet based metadata

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

@@ -24,11 +24,12 @@ import { Modifiers } from '../utils/modifiers.js';
  */
 export default async function fetchMappedMetadata(state) {
   state.mappedMetadata = Modifiers.EMPTY;
-  if (!state.mapped) {
+  const { mappedPath } = state;
+  if (!mappedPath) {
     return;
   }
   const { contentBusId, partition } = state;
-  const metadataPath = `${state.info.path}/metadata.json`;
+  const metadataPath = `${mappedPath}/metadata.json`;
   const key = `${contentBusId}/${partition}${metadataPath}`;
   const ret = await state.s3Loader.getObject('helix-content-bus', key);
   if (ret.status === 200) {

package/src/steps/folder-mapping.js

@@ -33,26 +33,35 @@ export function mapPath(folders, path) {
 }
 
 /**
- * Checks the fstab for folder mapping entries and then re-adjusts the path infos if needed.
- * if the remapped resource is *not* extensionless, it will be declared as code-bus resource.
+ * Checks if the resource path is below a folder-mapped configuration and updates `state.mappedPath`
+ * accordingly.
  *
- * @type PipelineStep
- * @param {PipelineState} state
+ * @param state
  */
-export default function folderMapping(state) {
+export function calculateFolderMapping(state) {
   const folders = state.helixConfig?.fstab?.data.folders;
   if (!folders) {
     return;
   }
   const { path } = state.info;
-  const mapped = mapPath(folders, path);
-  if (mapped) {
-    state.info = getPathInfo(mapped);
+  state.mappedPath = mapPath(folders, path);
+}
+
+/**
+ * Applies folder mapping if the resource is mapped (i.e. if `state.mappedPath` is {@code true}.
+ *
+ * @type PipelineStep
+ * @param {PipelineState} state
+ */
+export function applyFolderMapping(state) {
+  const { info: { path }, mappedPath } = state;
+  if (mappedPath) {
+    state.info = getPathInfo(mappedPath);
     state.info.unmappedPath = path;
-    if (getExtension(mapped)) {
+    if (getExtension(mappedPath)) {
       // special case: use code-bus
       state.content.sourceBus = 'code';
-      state.info.resourcePath = mapped;
+      state.info.resourcePath = mappedPath;
       state.log.info(`mapped ${path} to ${state.info.resourcePath} (code-bus)`);
     } else {
       state.mapped = true;