@adobe/helix-html-pipeline 1.0.0 → 1.0.3

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [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)
+
+
+### Bug Fixes
+
+* include static s3 loader ([0a89e2f](https://github.com/adobe/helix-html-pipeline/commit/0a89e2fda5d6a8ab3e67724fd0b436c8b1aa6e58))
+
 # 1.0.0 (2022-03-07)
 
 

package/package.json

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

package/src/html-pipe.js

@@ -33,6 +33,7 @@ import splitSections from './steps/split-sections.js';
 import tohtml from './steps/stringify-response.js';
 import { PipelineStatusError } from './PipelineStatusError.js';
 import { PipelineResponse } from './PipelineResponse.js';
+import { validatePathInfo } from './utils/path.js';
 
 /**
  * Runs the default pipeline and returns the response.
@@ -43,6 +44,15 @@ import { PipelineResponse } from './PipelineResponse.js';
 export async function htmlPipe(state, req) {
   const { log } = state;
 
+  if (!validatePathInfo(state.info)) {
+    return new PipelineResponse('', {
+      status: 404,
+      headers: {
+        'x-error': 'invalid path',
+      },
+    });
+  }
+
   /** @type PipelineResponse */
   const res = new PipelineResponse();
 

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

@@ -26,7 +26,7 @@ export default async function fetchContent(state, req, res) {
 
   const isCode = state.content.sourceBus === 'code';
   const key = isCode
-    ? `${owner}/${repo}/${ref}/${info.resourcePath}`
+    ? `${owner}/${repo}/${ref}${info.resourcePath}`
     : `${contentBusId}/${partition}${info.resourcePath}`;
   const bucketId = isCode ? 'helix-code-bus' : 'helix-content-bus';
 
@@ -55,12 +55,12 @@ export default async function fetchContent(state, req, res) {
     // (https://github.com/adobe/helix-pipeline-service/issues/290)
     if (state.info.originalFilename === 'index') {
       res.status = 404;
-      res.error = `request to ${info.path} not allowed (no-index).`;
+      res.error = `request to ${info.resourcePath} not allowed (no-index).`;
     }
   } else {
     // keep 404, but propagate others as 502
     res.status = ret.status === 404 ? 404 : 502;
-    res.error = `failed to load ${info.path} from ${state.content.sourceBus}-bus: ${ret.status}`;
+    res.error = `failed to load ${info.resourcePath} from ${state.content.sourceBus}-bus: ${ret.status}`;
   }
 
   if (res.status === 404) {
@@ -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/folder-mapping.js

@@ -53,9 +53,9 @@ export default function folderMapping(state) {
       // special case: use code-bus
       state.content.sourceBus = 'code';
       state.info.resourcePath = mapped;
-      state.log.info(`mapped ${path} to ${state.info.resourcePath} (${state.content.sourceBus}-bus)`);
+      state.log.info(`mapped ${path} to ${state.info.resourcePath} (code-bus)`);
     } else {
-      state.log.info(`mapped ${path} to ${state.info.path} (${state.content.sourceBus}-bus)`);
+      state.log.info(`mapped ${path} to ${state.info.path} (content-bus)`);
     }
   }
 }

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',
+];

package/test/StaticS3Loader.js

@@ -0,0 +1,45 @@
+/*
+ * 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.
+ */
+/**
+ * @implements S3Loader
+ */
+export class StaticS3Loader {
+  constructor() {
+    this.buckets = {};
+  }
+
+  reply(bucketId, key, response) {
+    let bucket = this.buckets[bucketId];
+    if (!bucket) {
+      bucket = {};
+      this.buckets[bucketId] = bucket;
+    }
+    bucket[key] = response;
+    return this;
+  }
+
+  async getObject(bucketId, key) {
+    const bucket = this.buckets[bucketId];
+    const response = bucket?.[key] ?? {
+      status: 404,
+      body: '',
+      headers: new Map(),
+    };
+    // eslint-disable-next-line no-console
+    console.log(`StaticS3Loader: loading ${bucketId}/${key} -> ${response.status}`);
+    return response;
+  }
+
+  async headObject(bucketId, key) {
+    return this.getObject(bucketId, key);
+  }
+}

package/.eslintrc.cjs

@@ -1,33 +0,0 @@
-/*
- * 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.
- */
-
-module.exports = {
-  root: true,
-  extends: '@adobe/helix',
-  env: {
-    node: true,
-    es6: true,
-  },
-  parserOptions: {
-    sourceType: 'module',
-    ecmaVersion: 2020,
-  },
-  rules: {
-    'import/extensions': [2, 'ignorePackages'],
-    'import/prefer-default-export': 0,
-    'no-param-reassign': ['error', { props: false }],
-  },
-  globals: {
-    __rootdir: true,
-    __testdir: true,
-  },
-};

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx lint-staged

package/.mocha-multi.json

@@ -1,6 +0,0 @@
-{
-    "reporterEnabled": "spec,xunit",
-    "xunitReporterOptions": {
-        "output": "junit/test-results.xml"
-    }
-}

package/.nycrc.json

@@ -1,10 +0,0 @@
-{
-  "reporter": [
-    "lcov",
-    "text"
-  ],
-  "check-coverage": true,
-  "lines": 100,
-  "branches": 100,
-  "statements": 100
-}

package/.releaserc.cjs

@@ -1,16 +0,0 @@
-module.exports = {
-  plugins: [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    ["@semantic-release/changelog", {
-      "changelogFile": "CHANGELOG.md",
-    }],
-    "@semantic-release/npm",
-    ["@semantic-release/git", {
-      "assets": ["package.json", "CHANGELOG.md"],
-      "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-    }],
-    ["@semantic-release/github", {}]
-  ],
-  branches: ['main'],
-};