@adobe/helix-html-pipeline 1.0.1 → 1.0.4

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.0.4](https://github.com/adobe/helix-html-pipeline/compare/v1.0.3...v1.0.4) (2022-03-08)
+
+
+### Bug Fixes
+
+* no special headers init for PipelineResponse ([#9](https://github.com/adobe/helix-html-pipeline/issues/9)) ([7288677](https://github.com/adobe/helix-html-pipeline/commit/72886779f6ba0f8d07ea14757a8097034262e215))
+
+## [1.0.3](https://github.com/adobe/helix-html-pipeline/compare/v1.0.2...v1.0.3) (2022-03-08)
+
+
+### Bug Fixes
+
+* fix canonical url and 404.html response, clean up meta ([5f3e999](https://github.com/adobe/helix-html-pipeline/commit/5f3e999a6e305fb6ecf7d2fefe3a38274a135433))
+
+## [1.0.2](https://github.com/adobe/helix-html-pipeline/compare/v1.0.1...v1.0.2) (2022-03-08)
+
+
+### Bug Fixes
+
+* canonical url and 404.html response ([9f4e473](https://github.com/adobe/helix-html-pipeline/commit/9f4e47372d6aea1252f179ad661b0d2fb03429bd))
+
 ## [1.0.1](https://github.com/adobe/helix-html-pipeline/compare/v1.0.0...v1.0.1) (2022-03-07)
 
 

package/package.json

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

package/src/PipelineResponse.js

@@ -19,7 +19,7 @@ export class PipelineResponse {
    * Creates the pipeline response
    */
   constructor(body = undefined, init = {}) {
-    let headers = init.headers ?? new Map([['content-type', 'text/html; charset=utf-8']]);
+    let headers = init.headers ?? new Map();
     if (typeof headers.get !== 'function') {
       headers = new Map(Object.entries(init.headers));
     }

package/src/html-pipe.js

@@ -54,7 +54,11 @@ export async function htmlPipe(state, req) {
   }
 
   /** @type PipelineResponse */
-  const res = new PipelineResponse();
+  const res = new PipelineResponse('', {
+    headers: {
+      'content-type': 'text/html; charset=utf-8',
+    },
+  });
 
   try { // fetch config first, since we need to compute the content-bus-id from the fstab ...
     await fetchConfig(state, req, res);

package/src/index.js

@@ -16,3 +16,8 @@ export * from './PipelineRequest.js';
 export * from './PipelineResponse.js';
 export * from './PipelineState.js';
 export * from './PipelineStatusError.js';
+
+export { default as fetchMetadata } from './steps/fetch-metadata.js';
+export { default as fetchConfig } from './steps/fetch-config.js';
+export { default as setCustomResponseHeaders } from './steps/set-custom-response-headers.js';
+export { getOriginalHost } from './steps/utils.js';

package/src/steps/extract-metadata.js

@@ -11,17 +11,7 @@
  */
 import { resolve } from 'url';
 import { getAbsoluteUrl, makeCanonicalHtmlUrl, optimizeImageURL } from './utils.js';
-
-/**
- * Converts all non-valid characters to `-`.
- * @param {string} text input text
- * @returns {string} the meta name
- */
-function toMetaName(text) {
-  return text
-    .toLowerCase()
-    .replace(/[^0-9a-z:_]/gi, '-');
-}
+import { filterGlobalMetadata, toMetaName, ALLOWED_RESPONSE_HEADERS } from '../utils/metadata.js';
 
 /**
  * Cleans up comma-separated string lists and returns an array.
@@ -98,40 +88,6 @@ function readBlockConfig($block) {
   return config;
 }
 
-function applyMetaRule(target, obj) {
-  Object.keys(obj).forEach((key) => {
-    const metaKey = toMetaName(key);
-    if (metaKey !== 'url' && obj[key]) {
-      target[metaKey] = obj[key];
-    }
-  });
-}
-
-function globToRegExp(glob) {
-  const reString = glob
-    .replace(/\*\*/g, '_')
-    .replace(/\*/g, '[0-9a-z-.]*')
-    .replace(/_/g, '.*');
-  return new RegExp(`^${reString}$`);
-}
-
-export function filterGlobalMetadata(metaRules, path) {
-  const metaConfig = {};
-  metaRules.forEach((rule) => {
-    const glob = rule.url || rule.URL || rule.Url;
-    if (glob && typeof glob === 'string' && /[0-9a-z-/*]/.test(glob)) {
-      if (glob.indexOf('*') >= 0) {
-        if (globToRegExp(glob).test(path)) {
-          applyMetaRule(metaConfig, rule);
-        }
-      } else if (glob === path) {
-        applyMetaRule(metaConfig, rule);
-      }
-    }
-  });
-  return metaConfig;
-}
-
 /**
  * Looks for metadata in the document.
  * @param {HTMLDocument} document The document
@@ -196,11 +152,13 @@ export default function extractMetaData(state, req) {
   });
   if (Object.keys(metaConfig).length > 0) {
     // add rest to meta.custom
-    meta.custom = Object.keys(metaConfig).map((name) => ({
-      name,
-      value: metaConfig[name],
-      property: name.includes(':'),
-    }));
+    meta.custom = Object.entries(metaConfig)
+      .filter(([name]) => !ALLOWED_RESPONSE_HEADERS.includes(name))
+      .map(([name, value]) => ({
+        name,
+        value,
+        property: name.includes(':'),
+      }));
   }
 
   if (meta.keywords) {
@@ -233,7 +191,8 @@ export default function extractMetaData(state, req) {
     });
     meta.description = `${desc.slice(0, 25).join(' ')}${desc.length > 25 ? ' ...' : ''}`;
   }
-  meta.url = makeCanonicalHtmlUrl(getAbsoluteUrl(req.headers, req.url.href));
+  // use the req.url and not the state.info.path in case of folder mapping
+  meta.url = makeCanonicalHtmlUrl(getAbsoluteUrl(req.headers, req.url.pathname));
   if (!meta.canonical) {
     meta.canonical = meta.url;
   }

package/src/steps/fetch-content.js

@@ -74,7 +74,7 @@ export default async function fetchContent(state, req, res) {
       }
 
       // keep 404 response status
-      res.body = ret.body;
+      res.body = ret404.body;
       res.headers.set('last-modified', ret404.headers.get('last-modified'));
       res.headers.set('content-type', 'text/html; charset=utf-8');
       res.headers.set('x-surrogate-key', `${ref}--${repo}--${owner}_404`);

package/src/steps/set-custom-response-headers.js

@@ -10,18 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
-import { filterGlobalMetadata } from './extract-metadata.js';
-
-/**
- * Array of headers allowed in the metadata.json file.
- */
-const allowList = [
-  'content-security-policy',
-  'content-security-policy-report-only',
-  'access-control-allow-origin',
-  'access-control-allow-methods',
-  'link',
-];
+import { filterGlobalMetadata, ALLOWED_RESPONSE_HEADERS } from '../utils/metadata.js';
 
 /**
  * Decorates the pipeline response object with the headers defined in metadata.json.
@@ -34,7 +23,7 @@ const allowList = [
 export default function setCustomResponseHeaders(state, req, res) {
   const meta = filterGlobalMetadata(state.metadata, state.info.path);
   Object.entries(meta).forEach(([name, value]) => {
-    if (allowList.includes(name)) {
+    if (ALLOWED_RESPONSE_HEADERS.includes(name)) {
       res.headers.set(name, cleanupHeaderValue(value));
     }
   });

package/src/utils/metadata.js

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2022 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.
+ */
+/**
+ * Converts all non-valid characters to `-`.
+ * @param {string} text input text
+ * @returns {string} the meta name
+ */
+export function toMetaName(text) {
+  return text
+    .toLowerCase()
+    .replace(/[^0-9a-z:_]/gi, '-');
+}
+
+function applyMetaRule(target, obj) {
+  Object.keys(obj).forEach((key) => {
+    const metaKey = toMetaName(key);
+    if (metaKey !== 'url' && obj[key]) {
+      target[metaKey] = obj[key];
+    }
+  });
+}
+
+function globToRegExp(glob) {
+  const reString = glob
+    .replace(/\*\*/g, '_')
+    .replace(/\*/g, '[0-9a-z-.]*')
+    .replace(/_/g, '.*');
+  return new RegExp(`^${reString}$`);
+}
+
+export function filterGlobalMetadata(metaRules, path) {
+  const metaConfig = {};
+  metaRules.forEach((rule) => {
+    const glob = rule.url || rule.URL || rule.Url;
+    if (glob && typeof glob === 'string' && /[0-9a-z-/*]/.test(glob)) {
+      if (glob.indexOf('*') >= 0) {
+        if (globToRegExp(glob).test(path)) {
+          applyMetaRule(metaConfig, rule);
+        }
+      } else if (glob === path) {
+        applyMetaRule(metaConfig, rule);
+      }
+    }
+  });
+  return metaConfig;
+}
+
+/**
+ * Array of headers allowed in the metadata.json file.
+ */
+export const ALLOWED_RESPONSE_HEADERS = [
+  'content-security-policy',
+  'content-security-policy-report-only',
+  'access-control-allow-origin',
+  'access-control-allow-methods',
+  'link',
+];