@adobe/helix-html-pipeline 2.0.2 → 2.1.0

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+# [2.1.0](https://github.com/adobe/helix-html-pipeline/compare/v2.0.4...v2.1.0) (2022-06-02)
+
+
+### Features
+
+* use /.helix/config-all.json ([#72](https://github.com/adobe/helix-html-pipeline/issues/72)) ([712046c](https://github.com/adobe/helix-html-pipeline/commit/712046c31d51eecc392bb2f0aabfd0e227ed595c))
+
+## [2.0.4](https://github.com/adobe/helix-html-pipeline/compare/v2.0.3...v2.0.4) (2022-05-31)
+
+
+### Bug Fixes
+
+* fix glob matching for mapped pages ([c43e359](https://github.com/adobe/helix-html-pipeline/commit/c43e3590f9b564f988dfd35daeb5000e458dea71))
+* rename mappedPath to unmappedPath ([12e0066](https://github.com/adobe/helix-html-pipeline/commit/12e0066c8da51ffcb16f8ac7e78306fae1a1cd93))
+
+## [2.0.3](https://github.com/adobe/helix-html-pipeline/compare/v2.0.2...v2.0.3) (2022-05-30)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-markdown-support to v3.1.6 ([1dd999a](https://github.com/adobe/helix-html-pipeline/commit/1dd999a2c4ef3caf06a6b66dd7ff3e091166ea72))
+
 ## [2.0.2](https://github.com/adobe/helix-html-pipeline/compare/v2.0.1...v2.0.2) (2022-05-28)
 
 

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "type": "module",
   "scripts": {
-    "test": " c8 mocha",
+    "test": "c8 mocha",
     "lint": "eslint .",
     "docs": "npx jsdoc2md -c .jsdoc.json --files 'src/*.js'  > docs/API.md",
     "semantic-release": "semantic-release",
@@ -29,8 +29,11 @@
     "reporter-options": "configFile=.mocha-multi.json",
     "loader": "esmock"
   },
+  "engines": {
+    "node": ">=16.x"
+  },
   "dependencies": {
-    "@adobe/helix-markdown-support": "3.1.5",
+    "@adobe/helix-markdown-support": "3.1.6",
     "@adobe/helix-shared-utils": "2.0.10",
     "github-slugger": "1.4.0",
     "hast-util-raw": "7.2.1",

package/src/PipelineState.d.ts

@@ -11,6 +11,7 @@
  */
 import {PathInfo, S3Loader, FormsMessageDispatcher, PipelineTimer} from "./index";
 import {PipelineContent} from "./PipelineContent";
+import {Modifiers} from './utils/modifiers';
 
 declare enum PipelineType {
   html = 'html',
@@ -18,6 +19,12 @@ declare enum PipelineType {
   form = 'form',
 }
 
+declare interface HelixConfigAll {
+  host:string;
+  routes:RegExp[];
+  [string]:any;
+}
+
 declare interface PipelineOptions {
   log: Console;
   s3Loader: S3Loader;
@@ -68,9 +75,19 @@ declare class PipelineState {
   helixConfig?: object;
 
   /**
-   * metadata.json once loaded
+   * the /.helix/config.json in object form
+   */
+  config?: HelixConfigAll;
+
+  /**
+   * the metadata.json in modifier form.
+   */
+  metadata?: Modifiers;
+
+  /**
+   * the headers.json in modifier form.
    */
-  metadata?: object;
+  headers?: Modifiers;
 
   /**
    * optional timer that is used to measure the timing

package/src/PipelineState.js

@@ -12,6 +12,7 @@
 
 import { getPathInfo } from './utils/path.js';
 import { PipelineContent } from './PipelineContent.js';
+import { Modifiers } from './utils/modifiers.js';
 
 /**
  * State of the pipeline
@@ -34,7 +35,9 @@ export class PipelineState {
       ref: opts.ref,
       partition: opts.partition,
       helixConfig: undefined,
-      metadata: undefined,
+      metadata: Modifiers.EMPTY,
+      headers: Modifiers.EMPTY,
+      config: {},
       s3Loader: opts.s3Loader,
       messageDispatcher: opts.messageDispatcher,
       timer: opts.timer,

package/src/forms-pipe.js

@@ -11,9 +11,8 @@
  */
 import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
 import { PipelineResponse } from './PipelineResponse.js';
-import fetchMetadata from './steps/fetch-metadata.js';
+import fetchConfigAll from './steps/fetch-config-all.js';
 import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
-import { getOriginalHost } from './steps/utils.js';
 
 function error(log, msg, status, response) {
   log.error(msg);
@@ -96,7 +95,7 @@ export async function formsPipe(state, request) {
       'content-type': 'text/plain; charset=utf-8',
     },
   });
-  await fetchMetadata(state, request, response);
+  await fetchConfigAll(state, request, response);
   await setCustomResponseHeaders(state, request, response);
 
   const {
@@ -138,7 +137,7 @@ export async function formsPipe(state, request) {
 
   // Send message to SQS if workbook contains and incoming
   // sheet and the source location is not null
-  const host = getOriginalHost(request.headers);
+  const { host } = state.config;
 
   // Forms service expect owner and repo in the message body
   body.owner = owner;

package/src/html-pipe.js

@@ -16,7 +16,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 fetchMetadata from './steps/fetch-metadata.js';
+import fetchConfigAll from './steps/fetch-config-all.js';
 import fixSections from './steps/fix-sections.js';
 import folderMapping from './steps/folder-mapping.js';
 import getMetadata from './steps/get-metadata.js';
@@ -72,7 +72,7 @@ export async function htmlPipe(state, req) {
     // load metadata and content in parallel
     state.timer?.update('content-fetch');
     await Promise.all([
-      fetchMetadata(state, req, res),
+      fetchConfigAll(state, req, res),
       fetchContent(state, req, res),
     ]);
 

package/src/index.d.ts

@@ -65,6 +65,11 @@ declare interface PathInfo {
    * original extension as passed via request
    */
   originalExtension: string;
+
+  /**
+   * original path as passed before folder mapping
+   */
+  unmappedPath: string;
 }
 
 declare interface S3Loader {

package/src/index.js

@@ -18,8 +18,3 @@ 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/json-pipe.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import fetchMetadata from './steps/fetch-metadata.js';
+import fetchConfigAll from './steps/fetch-config-all.js';
 import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
 import { PipelineResponse } from './PipelineResponse.js';
 import jsonFilter from './utils/json-filter.js';
@@ -78,8 +78,8 @@ export async function jsonPipe(state, req) {
   // set surrogate key
   response.headers.set('x-surrogate-key', `${contentBusId}${path}`.replace(/\//g, '_'));
 
-  // Load metadata from metadata.json
-  await fetchMetadata(state, req, response);
+  // Load config-all and set response headers
+  await fetchConfigAll(state, req, response);
   await setCustomResponseHeaders(state, req, response);
 
   return response;

package/src/options-pipe.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import { PipelineResponse } from './PipelineResponse.js';
-import fetchMetadata from './steps/fetch-metadata.js';
+import fetchConfigAll from './steps/fetch-config-all.js';
 import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
 
 /**
@@ -30,7 +30,7 @@ export async function optionsPipe(state, request) {
       'access-control-allow-headers': 'content-type',
     },
   });
-  await fetchMetadata(state, request, response);
+  await fetchConfigAll(state, request, response);
   await setCustomResponseHeaders(state, request, response);
 
   return response;

package/src/steps/extract-metadata.js

@@ -16,7 +16,7 @@ import { visit, EXIT, CONTINUE } from 'unist-util-visit';
 import {
   getAbsoluteUrl, makeCanonicalHtmlUrl, optimizeImageURL, resolveUrl,
 } from './utils.js';
-import { filterGlobalMetadata, toMetaName, ALLOWED_RESPONSE_HEADERS } from '../utils/metadata.js';
+import { toMetaName } from '../utils/modifiers.js';
 import { childNodes } from '../utils/hast-utils.js';
 
 /**
@@ -157,11 +157,11 @@ export default function extractMetaData(state, req) {
   // extract global metadata from spreadsheet, and overlay
   // with local metadata from document
   const metaConfig = Object.assign(
-    filterGlobalMetadata(state.metadata, state.info.path),
+    state.metadata.getModifiers(state.info.unmappedPath || state.info.path),
     getLocalMetadata(hast),
   );
 
-  const IGNORED_CUSTOM_META = [...ALLOWED_RESPONSE_HEADERS, 'twitter:card'];
+  const IGNORED_CUSTOM_META = ['twitter:card'];
 
   // first process supported metadata properties
   [
@@ -215,7 +215,7 @@ export default function extractMetaData(state, req) {
   }
 
   // use the req.url and not the state.info.path in case of folder mapping
-  meta.url = makeCanonicalHtmlUrl(getAbsoluteUrl(req.headers, req.url.pathname));
+  meta.url = makeCanonicalHtmlUrl(getAbsoluteUrl(state, req.url.pathname));
   if (!meta.canonical) {
     meta.canonical = meta.url;
   }
@@ -231,7 +231,7 @@ export default function extractMetaData(state, req) {
   }
 
   meta.image = getAbsoluteUrl(
-    req.headers,
+    state,
     optimizeMetaImage(state.info.path, meta.image || content.image || '/default-meta-image.png'),
   );
 

package/src/steps/fetch-config-all.js

@@ -0,0 +1,132 @@
+/*
+ * 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.
+ */
+
+import { PipelineStatusError } from '../PipelineStatusError.js';
+import { extractLastModified, updateLastModified } from '../utils/last-modified.js';
+import { ALLOWED_RESPONSE_HEADERS, globToRegExp, Modifiers } from '../utils/modifiers.js';
+import { getOriginalHost } from './utils.js';
+
+/**
+ * Loads the metadata.json from the content-bus and stores it in `state.metadata` and
+ * `state.headers` in modifier form.
+ * this is to be backward compatible and can be removed in the future.
+ *
+ * @type PipelineStep
+ * @param {PipelineState} state
+ * @param {PipelineRequest} req
+ * @param {PipelineResponse} res
+ * @returns {Promise<void>}
+ */
+async function fetchMetadata(state, req, res) {
+  const { contentBusId, partition } = state;
+  const key = `${contentBusId}/${partition}/metadata.json`;
+  const ret = await state.s3Loader.getObject('helix-content-bus', key);
+  if (ret.status === 200) {
+    let json;
+    try {
+      json = JSON.parse(ret.body);
+    } catch (e) {
+      throw new PipelineStatusError(400, `failed parsing of /metadata.json: ${e.message}`);
+    }
+
+    const { data } = json.default ?? json;
+    if (!Array.isArray(data)) {
+      throw new PipelineStatusError(400, 'failed loading of /metadata.json: data must be an array');
+    }
+
+    state.metadata = Modifiers.fromModifierSheet(
+      data,
+      (name) => !ALLOWED_RESPONSE_HEADERS.includes(name),
+    );
+    state.headers = Modifiers.fromModifierSheet(
+      data,
+      (name) => ALLOWED_RESPONSE_HEADERS.includes(name),
+    );
+
+    if (state.type === 'html' && state.info.selector !== 'plain') {
+      // also update last-modified (only for extensionless html pipeline)
+      updateLastModified(state, res, extractLastModified(ret.headers));
+    }
+    return;
+  }
+
+  if (ret.status !== 404) {
+    throw new PipelineStatusError(502, `failed to load /metadata.json: ${ret.status}`);
+  }
+
+  // ignore 404
+}
+
+/**
+ * Computes the routes from the given config value.
+ * @param {string|string[]|undefined} value
+ * @return {RegExp[]} and array of regexps for route matching
+ */
+export function computeRoutes(value) {
+  if (!value) {
+    return [/.*/];
+  }
+  // eslint-disable-next-line no-param-reassign
+  return (Array.isArray(value) ? value : [value]).map((route) => {
+    if (route.indexOf('*') >= 0) {
+      return globToRegExp(route);
+    }
+    if (route.endsWith('/')) {
+      return new RegExp(`^${route}.*$`);
+    }
+    return new RegExp(`^${route}(/.*)?$`);
+  });
+}
+
+/**
+ * Loads the /.helix/config-all.json from the content-bus and stores it in the state. if no
+ * such config exists, it will load the metadata.json as fallback and separate out the
+ * `state.headers` and `state.metadata`.
+ *
+ * @type PipelineStep
+ * @param {PipelineState} state
+ * @param {PipelineRequest} req
+ * @param {PipelineResponse} res
+ * @returns {Promise<void>}
+ */
+export default async function fetchConfigAll(state, req, res) {
+  const { contentBusId, partition } = state;
+  const key = `${contentBusId}/${partition}/.helix/config-all.json`;
+  const ret = await state.s3Loader.getObject('helix-content-bus', key);
+  if (ret.status === 200) {
+    let json;
+    try {
+      json = JSON.parse(ret.body);
+    } catch (e) {
+      throw new PipelineStatusError(400, `failed parsing of /.helix/config-all.json: ${e.message}`);
+    }
+    state.config = json.config?.data || {};
+    state.metadata = new Modifiers(json.metadata?.data || {});
+    state.headers = new Modifiers(json.headers?.data || {});
+
+    if (state.type === 'html' && state.info.selector !== 'plain') {
+      // also update last-modified (only for extensionless html pipeline)
+      updateLastModified(state, res, extractLastModified(ret.headers));
+    }
+  } else if (ret.status !== 404) {
+    throw new PipelineStatusError(502, `failed to load /.helix/config-all.json: ${ret.status}`);
+  } else {
+    // fallback to old metadata loading
+    await fetchMetadata(state, req, res);
+  }
+
+  // compute host and routes
+  if (!state.config.host) {
+    state.config.host = state.config.cdn?.prod?.host || getOriginalHost(req.headers);
+  }
+  state.config.routes = computeRoutes(state.config.cdn?.prod?.route);
+}

package/src/steps/folder-mapping.js

@@ -48,6 +48,7 @@ export default function folderMapping(state) {
   const mapped = mapPath(folders, path);
   if (mapped) {
     state.info = getPathInfo(mapped);
+    state.info.unmappedPath = path;
     if (getExtension(mapped)) {
       // special case: use code-bus
       state.content.sourceBus = 'code';

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

@@ -10,7 +10,6 @@
  * governing permissions and limitations under the License.
  */
 import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
-import { filterGlobalMetadata, ALLOWED_RESPONSE_HEADERS } from '../utils/metadata.js';
 
 /**
  * Decorates the pipeline response object with the headers defined in metadata.json.
@@ -21,9 +20,9 @@ import { filterGlobalMetadata, ALLOWED_RESPONSE_HEADERS } from '../utils/metadat
  * @returns {Promise<void>}
  */
 export default function setCustomResponseHeaders(state, req, res) {
-  const meta = filterGlobalMetadata(state.metadata, state.info.path);
-  Object.entries(meta).forEach(([name, value]) => {
-    if (ALLOWED_RESPONSE_HEADERS.includes(name)) {
+  Object.entries(state.headers.getModifiers(state.info.path)).forEach(([name, value]) => {
+    // don't use `link` header for non-html pipeline
+    if (name !== 'link' || state.type === 'html') {
       res.headers.set(name, cleanupHeaderValue(value));
     }
   });

package/src/steps/utils.js

@@ -163,16 +163,29 @@ export function resolveUrl(from, to) {
 
 /**
  * Turns a relative into an absolute URL.
- * @param {object} headers The request headers
+ * @param {PipelineState} state the request state
  * @param {string} url The relative or absolute URL
  * @returns {string} The absolute URL or <code>null</code>
  *                   if <code>url</code> is not a string
  */
-export function getAbsoluteUrl(headers, url) {
+export function getAbsoluteUrl(state, url) {
   if (typeof url !== 'string') {
     return null;
   }
-  return resolveUrl(`https://${getOriginalHost(headers)}/`, url);
+  return resolveUrl(`https://${state.config.host}/`, url);
+}
+
+/**
+ * Checks if the given `str` matches any of the given regs or if `regs` is empty.
+ * @param {RegExp[]} regs
+ * @param {string} str
+ * @returns {boolean} {@code true} if `regs` is empty or if `str` matches any of them.
+ */
+function matchAny(regs, str) {
+  if (!regs || regs.length === 0) {
+    return true;
+  }
+  return regs.findIndex((r) => r.test(str)) >= 0;
 }
 
 /**
@@ -182,12 +195,14 @@ export function getAbsoluteUrl(headers, url) {
  * @returns {string|null}
  */
 export function rewriteUrl(state, url) {
-  if (!url) {
+  if (!url || !url.startsWith('https://')) {
     return url;
   }
+  const {
+    host, pathname, search, hash,
+  } = new URL(url);
 
   if (AZURE_BLOB_REGEXP.test(url)) {
-    const { pathname, hash } = new URL(url);
     const filename = pathname.split('/').pop();
     const [name, props] = hash.split('?');
     const extension = name.split('.').pop() || 'jpg';
@@ -196,29 +211,21 @@ export function rewriteUrl(state, url) {
   }
 
   if (MEDIA_BLOB_REGEXP.test(url)) {
-    const { pathname, hash } = new URL(url);
     return `.${pathname}${hash}`;
   }
 
   if (HELIX_URL_REGEXP.test(url)) {
-    const { pathname, hash, search } = new URL(url);
     if (hash && pathname === state.info?.path) {
       return hash;
     }
     return `${pathname}${search}${hash}`;
   }
 
-  // todo: read host from contentbus config
-  if (state.config?.host) {
-    const {
-      host, pathname, search, hash,
-    } = new URL(url);
-    if (host === state.config.host) {
-      if (hash && pathname === state.info?.path) {
-        return hash;
-      }
-      return `${pathname}${search}${hash}`;
+  if (host === state.config.host && matchAny(state.config.routes, pathname)) {
+    if (hash && pathname === state.info?.path) {
+      return hash;
     }
+    return `${pathname}${search}${hash}`;
   }
 
   return url;

package/src/utils/modifiers.js

@@ -0,0 +1,153 @@
+/*
+ * 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, '-');
+}
+
+export function globToRegExp(glob) {
+  const reString = glob
+    .replaceAll('**', '|')
+    .replaceAll('*', '[0-9a-z-.]*')
+    .replaceAll('|', '.*');
+  return new RegExp(`^${reString}$`);
+}
+
+/**
+ * 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',
+];
+
+/**
+ * Converts all keys in a row object to lowercase
+ * @param {Object} obj A row of data from a sheet
+ * @returns {Object} A row with all keys converted to lowercase
+ */
+function toLowerKeys(obj) {
+  return Object.keys(obj).reduce((prev, key) => {
+    prev[key.toLowerCase()] = obj[key];
+    return prev;
+  }, {});
+}
+
+/**
+ * The modifiers class help manage the metadata and headers modifiers.
+ */
+export class Modifiers {
+  /**
+   * Empty modifiers
+   * @type {Modifiers}
+   */
+  static EMPTY = new Modifiers({});
+
+  /**
+   * Parses a sheet that is in a modifier format into a list of key/value pairs
+   *
+   * @example
+   *
+   * | url   | key | value | Title   | Description    |
+   * |-------|-----|-------|---------|----------------|
+   * | "/*"  | "A" | "B"   | ""      | ""             |
+   * | "/*"  | "C" | "D"   | ""      | ""             |
+   * | "/f"  | ""  | ""    | "Hero"  | "Once upon..." |
+   *
+   * becomes:
+   *
+   * {
+   *   "/*": [
+   *     { "key": "A", "value": "B" },
+   *     { "key": "C", "value": "D" },
+   *   ],
+   *   "/f": [
+   *     { "key": "title", "value": "Hero" },
+   *     { "key": "description", "value": "Once upon..." },
+   *   ]
+   * }
+   *
+   *
+   * @param {object[]} sheet The sheet to parse
+   * @param {function} keyFilter filter to apply on keys
+   * @returns {object} An object containing an array of key/value pairs for every glob
+   */
+  static fromModifierSheet(sheet, keyFilter = () => true) {
+    const res = {};
+    for (let row of sheet) {
+      row = toLowerKeys(row);
+      const {
+        url, key, value, ...rest
+      } = row;
+      if (url) {
+        const put = (k, v) => {
+          if (keyFilter(k)) {
+            let entry = res[url];
+            if (!entry) {
+              entry = [];
+              res[url] = entry;
+            }
+            entry.push({ key: k, value: v });
+          }
+        };
+
+        // note that all values are strings, i.e. never another falsy value
+        if ('key' in row && 'value' in row && key && value) {
+          put(key, value);
+        } else {
+          Object.entries(rest).forEach(([k, v]) => {
+            if (k && v) {
+              put(k, v);
+            }
+          });
+        }
+      }
+    }
+    return new Modifiers(res);
+  }
+
+  constructor(config) {
+    this.modifiers = Object.entries(config).map(([url, mods]) => {
+      const pat = url.indexOf('*') >= 0 ? globToRegExp(url) : url;
+      return {
+        pat,
+        mods,
+      };
+    });
+  }
+
+  /**
+   * Returns the modifier object for the given path.
+   * @param {string} path
+   * @return {object} the modifier
+   */
+  getModifiers(path) {
+    const modifiers = {};
+    for (const { pat, mods } of this.modifiers) {
+      if (pat === path || (pat instanceof RegExp && pat.test(path))) {
+        for (const { key, value } of mods) {
+          modifiers[toMetaName(key)] = value;
+        }
+      }
+    }
+    return modifiers;
+  }
+}

package/src/utils/path.js

@@ -37,6 +37,7 @@ export function getPathInfo(path) {
     originalExtension: '',
     originalPath: path,
     originalFilename: segs.pop(),
+    unmappedPath: '',
   };
 
   // path         -> web path (no .html, no index)

package/src/steps/fetch-metadata.js

@@ -1,55 +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.
- */
-
-import { PipelineStatusError } from '../PipelineStatusError.js';
-import { extractLastModified, updateLastModified } from '../utils/last-modified.js';
-
-/**
- * Loads the metadata.json from the content-bus and stores it in `state.metadata`
- * @type PipelineStep
- * @param {PipelineState} state
- * @param {PipelineRequest} req
- * @param {PipelineResponse} res
- * @returns {Promise<void>}
- */
-export default async function fetchMetadata(state, req, res) {
-  const { contentBusId, partition } = state;
-  const key = `${contentBusId}/${partition}/metadata.json`;
-  const ret = await state.s3Loader.getObject('helix-content-bus', key);
-  if (ret.status === 200) {
-    let json;
-    try {
-      json = JSON.parse(ret.body);
-    } catch (e) {
-      throw new PipelineStatusError(400, `failed parsing of /metadata.json: ${e.message}`);
-    }
-
-    const { data } = json.default ?? json;
-    if (!Array.isArray(data)) {
-      throw new PipelineStatusError(400, 'failed loading of /metadata.json: data must be an array');
-    }
-    state.metadata = data;
-
-    if (state.type === 'html' && state.info.selector !== 'plain') {
-      // also update last-modified (only for extensionless html pipeline)
-      updateLastModified(state, res, extractLastModified(ret.headers));
-    }
-    return;
-  }
-
-  if (ret.status !== 404) {
-    throw new PipelineStatusError(502, `failed to load /metadata.json: ${ret.status}`);
-  }
-
-  // ignore 404
-  state.metadata = [];
-}

package/src/utils/metadata.js

@@ -1,66 +0,0 @@
-/*
- * 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',
-];