@adobe/helix-html-pipeline 3.11.17 → 3.11.19

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [3.11.19](https://github.com/adobe/helix-html-pipeline/compare/v3.11.18...v3.11.19) (2023-07-11)
+
+
+### Bug Fixes
+
+* **deps:** use gfm from markdown-support ([3b27b20](https://github.com/adobe/helix-html-pipeline/commit/3b27b20fbe76eaeb6c1a8089a02440f43d614783))
+
+## [3.11.18](https://github.com/adobe/helix-html-pipeline/compare/v3.11.17...v3.11.18) (2023-07-04)
+
+
+### Bug Fixes
+
+* ensure contentBusId is loaded properly ([#342](https://github.com/adobe/helix-html-pipeline/issues/342)) ([80e4552](https://github.com/adobe/helix-html-pipeline/commit/80e4552223124ba73cef41829f40bd64ade392c9))
+
 ## [3.11.17](https://github.com/adobe/helix-html-pipeline/compare/v3.11.16...v3.11.17) (2023-06-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "3.11.17",
+  "version": "3.11.19",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -41,7 +41,7 @@
   "dependencies": {
     "@adobe/helix-markdown-support": "6.1.3",
     "@adobe/helix-shared-utils": "3.0.0",
-    "@adobe/mdast-util-gridtables": "1.0.9",
+    "@adobe/mdast-util-gridtables": "2.0.0",
     "@adobe/remark-gridtables": "1.0.4",
     "cookie": "0.5.0",
     "github-slugger": "2.0.0",
@@ -51,30 +51,20 @@
     "hast-util-to-string": "2.0.0",
     "hastscript": "7.2.0",
     "jose": "4.14.4",
-    "mdast-util-gfm-footnote": "1.0.2",
-    "mdast-util-gfm-strikethrough": "1.0.3",
-    "mdast-util-gfm-table": "1.0.7",
-    "mdast-util-gfm-task-list-item": "1.0.2",
     "mdast-util-to-hast": "12.3.0",
-    "mdast-util-to-string": "3.2.0",
-    "micromark-extension-gfm-footnote": "1.1.2",
-    "micromark-extension-gfm-strikethrough": "1.0.7",
-    "micromark-extension-gfm-table": "1.0.7",
-    "micromark-extension-gfm-tagfilter": "1.0.2",
-    "micromark-extension-gfm-task-list-item": "1.0.5",
-    "micromark-util-combine-extensions": "1.1.0",
+    "mdast-util-to-string": "4.0.0",
     "mime": "3.0.0",
     "rehype-format": "4.0.1",
     "rehype-parse": "8.0.4",
     "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",
-    "unist-util-remove-position": "4.0.2",
-    "unist-util-select": "4.0.3",
-    "unist-util-visit": "4.1.2",
-    "unist-util-visit-parents": "5.1.3"
+    "unist-util-map": "4.0.0",
+    "unist-util-remove": "4.0.0",
+    "unist-util-remove-position": "5.0.0",
+    "unist-util-select": "5.0.0",
+    "unist-util-visit": "5.0.0",
+    "unist-util-visit-parents": "6.0.1"
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "2.0.2",
@@ -83,7 +73,7 @@
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "10.0.4",
     "c8": "8.0.0",
-    "eslint": "8.43.0",
+    "eslint": "8.44.0",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.27.5",
@@ -92,11 +82,10 @@
     "js-yaml": "4.1.0",
     "jsdom": "22.1.0",
     "junit-report-builder": "3.0.1",
-    "lint-staged": "13.2.2",
+    "lint-staged": "13.2.3",
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
-    "remark-gfm": "3.0.1",
-    "semantic-release": "21.0.5"
+    "semantic-release": "21.0.7"
   },
   "lint-staged": {
     "*.js": "eslint",

package/src/PipelineState.d.ts

@@ -46,7 +46,6 @@ declare interface PipelineOptions {
   ref: string;
   partition: string;
   path: string;
-  contentBusId: string;
   timer: PipelineTimer;
   env: object;
 }

package/src/PipelineState.js

@@ -29,8 +29,6 @@ export class PipelineState {
       env: opts.env,
       info: getPathInfo(opts.path),
       content: new PipelineContent(),
-      // todo: compute content-bus id from fstab
-      contentBusId: opts.contentBusId,
       owner: opts.owner,
       repo: opts.repo,
       ref: opts.ref,

package/src/json-pipe.js

@@ -98,7 +98,6 @@ async function computeSurrogateKeys(path, contentBusId) {
 export async function jsonPipe(state, req) {
   const { log } = state;
   state.type = 'json';
-  const { contentBusId } = state;
   const { extension } = state.info;
   const { searchParams } = req.url;
   const params = Object.fromEntries(searchParams.entries());
@@ -174,7 +173,7 @@ export async function jsonPipe(state, req) {
     });
 
     // set surrogate keys
-    const keys = await computeSurrogateKeys(state.info.path, contentBusId);
+    const keys = await computeSurrogateKeys(state.info.path, state.contentBusId);
     res.headers.set('x-surrogate-key', keys.join(' '));
 
     await setCustomResponseHeaders(state, req, res);
@@ -191,7 +190,7 @@ export async function jsonPipe(state, req) {
       await setCustomResponseHeaders(state, req, res);
     }
     if (res.status === 404) {
-      const keys = await computeSurrogateKeys(state.info.path, contentBusId);
+      const keys = await computeSurrogateKeys(state.info.path, state.contentBusId);
       res.headers.set('x-surrogate-key', keys.join(' '));
     }
     return res;

package/src/options-pipe.js

@@ -9,9 +9,12 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
 import { PipelineResponse } from './PipelineResponse.js';
 import fetchConfigAll from './steps/fetch-config-all.js';
 import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
+import fetchConfig from './steps/fetch-config.js';
+import { PipelineStatusError } from './PipelineStatusError.js';
 
 /**
  * Handles options requests
@@ -20,18 +23,39 @@ import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
  * @returns {Response} a response
  */
 export async function optionsPipe(state, request) {
-  // todo: improve
-  const response = new PipelineResponse('', {
-    status: 204,
-    headers: {
-      // Set preflight cache duration
-      'access-control-max-age': '86400',
-      // Allow content type header
-      'access-control-allow-headers': 'content-type',
-    },
-  });
-  await fetchConfigAll(state, request, response);
-  await setCustomResponseHeaders(state, request, response);
+  try {
+    await fetchConfig(state, request);
+    if (!state.contentBusId) {
+      return new PipelineResponse('', {
+        status: 400,
+        headers: {
+          'x-error': 'contentBusId missing',
+        },
+      });
+    }
 
-  return response;
+    // todo: improve
+    const res = new PipelineResponse('', {
+      status: 204,
+      headers: {
+        // Set preflight cache duration
+        'access-control-max-age': '86400',
+        // Allow content type header
+        'access-control-allow-headers': 'content-type',
+      },
+    });
+    await fetchConfigAll(state, request, res);
+    await setCustomResponseHeaders(state, request, res);
+
+    return res;
+  } catch (e) {
+    const res = new PipelineResponse('', {
+      status: e instanceof PipelineStatusError ? e.code : 500,
+    });
+    const level = res.status >= 500 ? 'error' : 'info';
+    state.log[level](`pipeline status: ${res.status} ${e.message}`);
+    res.headers.set('x-error', cleanupHeaderValue(e.message));
+    res.headers.set('cache-control', 'no-store, private, must-revalidate');
+    return res;
+  }
 }

package/src/steps/parse-markdown.js

@@ -12,10 +12,9 @@
 import { unified } from 'unified';
 import remarkParse from 'remark-parse';
 import { removePosition } from 'unist-util-remove-position';
-import { dereference } from '@adobe/helix-markdown-support';
+import { dereference, remarkGfmNoLink } from '@adobe/helix-markdown-support';
 import { remarkMatter } from '@adobe/helix-markdown-support/matter';
 import remarkGridTable from '@adobe/remark-gridtables';
-import remarkGfm from '../utils/remark-gfm-nolink.js';
 
 export class FrontmatterParsingError extends Error {
 }
@@ -32,7 +31,7 @@ export default function parseMarkdown(state) {
   const converted = content.data.replace(/(\r\n|\n|\r)/gm, '\n');
   content.mdast = unified()
     .use(remarkParse)
-    .use(remarkGfm)
+    .use(remarkGfmNoLink)
     .use(remarkMatter, {
       errorHandler: (e) => {
         log.warn(new FrontmatterParsingError(e));
@@ -41,6 +40,6 @@ export default function parseMarkdown(state) {
     .use(remarkGridTable)
     .parse(converted);
 
-  removePosition(content.mdast, true);
+  removePosition(content.mdast, { force: true });
   dereference(content.mdast);
 }

package/src/utils/mdast-util-gfm-nolink.js

@@ -1,93 +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.
- */
-
-/*
-copied from
-https://github.com/micromark/micromark-extension-gfm/blob/7bc6b6f3baf941f877d7b2111e9257b21b13b37e/index.js
-
-(The MIT License)
-
-Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-/**
- * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
- * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
- *
- * @typedef {import('mdast-util-gfm-table').Options} Options
- */
-
-// import {
-//   gfmAutolinkLiteralFromMarkdown,
-//   gfmAutolinkLiteralToMarkdown
-// } from 'mdast-util-gfm-autolink-literal'
-import {
-  gfmFootnoteFromMarkdown,
-  gfmFootnoteToMarkdown,
-} from 'mdast-util-gfm-footnote';
-import {
-  gfmStrikethroughFromMarkdown,
-  gfmStrikethroughToMarkdown,
-} from 'mdast-util-gfm-strikethrough';
-import { gfmTableFromMarkdown, gfmTableToMarkdown } from 'mdast-util-gfm-table';
-import {
-  gfmTaskListItemFromMarkdown,
-  gfmTaskListItemToMarkdown,
-} from 'mdast-util-gfm-task-list-item';
-
-/**
- * @returns {Array.<FromMarkdownExtension>}
- */
-export function gfmFromMarkdown() {
-  return [
-    gfmFootnoteFromMarkdown(),
-    gfmStrikethroughFromMarkdown,
-    gfmTableFromMarkdown,
-    // gfmAutolinkLiteralFromMarkdown,
-    gfmTaskListItemFromMarkdown,
-  ];
-}
-
-/**
- * @param {Options} [options]
- * @returns {ToMarkdownExtension}
- */
-export function gfmToMarkdown(options) {
-  return {
-    extensions: [
-      // gfmAutolinkLiteralToMarkdown,
-      gfmFootnoteToMarkdown(),
-      gfmStrikethroughToMarkdown,
-      gfmTableToMarkdown(options),
-      gfmTaskListItemToMarkdown,
-    ],
-  };
-}

package/src/utils/remark-gfm-nolink.js

@@ -1,128 +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.
- */
-
-/*
-copied from
-https://github.com/syntax-tree/mdast-util-gfm/blob/544cc04ef9980fe152090bf68338444b1ed0e7a4/index.js
-
-(The MIT License)
-
-Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
-/* eslint-disable no-unused-vars */
-
-/**
- * @typedef {import('micromark-util-types').Extension} Extension
- * @typedef {import('micromark-util-types').HtmlExtension} HtmlExtension
- * @typedef {import('micromark-extension-gfm-strikethrough').Options} Options
- * @typedef {import('micromark-extension-gfm-footnote').HtmlOptions} HtmlOptions
- */
-
-import {
-  combineExtensions,
-} from 'micromark-util-combine-extensions';
-// import {
-//   gfmAutolinkLiteral,
-//   gfmAutolinkLiteralHtml
-// } from 'micromark-extension-gfm-autolink-literal'
-import { gfmFootnote, gfmFootnoteHtml } from 'micromark-extension-gfm-footnote';
-import {
-  gfmStrikethrough,
-  gfmStrikethroughHtml,
-} from 'micromark-extension-gfm-strikethrough';
-import { gfmTable, gfmTableHtml } from 'micromark-extension-gfm-table';
-import { gfmTagfilterHtml } from 'micromark-extension-gfm-tagfilter';
-import {
-  gfmTaskListItem,
-  gfmTaskListItemHtml,
-} from 'micromark-extension-gfm-task-list-item';
-import { gfmFromMarkdown, gfmToMarkdown } from './mdast-util-gfm-nolink.js';
-
-/**
- * Support GFM or markdown on github.com.
- *
- * @param {Options} [options]
- * @returns {Extension}
- */
-export function gfm(options) {
-  return combineExtensions([
-    // gfmAutolinkLiteral,
-    gfmFootnote(),
-    gfmStrikethrough(options),
-    gfmTable,
-    gfmTaskListItem,
-  ]);
-}
-
-/**
- * Support to compile GFM to HTML.
- *
- * @param {HtmlOptions} [options]
- * @returns {HtmlExtension}
- */
-// export function gfmHtml(options) {
-//   return combineHtmlExtensions([
-//     // gfmAutolinkLiteralHtml,
-//     gfmFootnoteHtml(options),
-//     gfmStrikethroughHtml,
-//     gfmTableHtml,
-//     gfmTagfilterHtml,
-//     gfmTaskListItemHtml,
-//   ]);
-// }
-
-/**
- * Plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists).
- *
- * @type {import('unified').Plugin<[Options?]|void[], Root>}
- */
-export default function remarkGfm(options = {}) {
-  const data = this.data();
-
-  /**
-   * @param {string} field
-   * @param {unknown} value
-   */
-  function add(field, value) {
-    const list = /** @type {unknown[]} */ (
-      // Other extensions
-      /* c8 ignore next 2 */
-      data[field] ? data[field] : (data[field] = [])
-    );
-
-    list.push(value);
-  }
-
-  add('micromarkExtensions', gfm(options));
-  add('fromMarkdownExtensions', gfmFromMarkdown());
-  add('toMarkdownExtensions', gfmToMarkdown(options));
-}