@adobe/helix-html-pipeline 1.3.0 → 1.3.3

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [1.3.3](https://github.com/adobe/helix-html-pipeline/compare/v1.3.2...v1.3.3) (2022-04-06)
+
+
+### Bug Fixes
+
+* correct last-modified handling for json ([#33](https://github.com/adobe/helix-html-pipeline/issues/33)) ([c9bb4fd](https://github.com/adobe/helix-html-pipeline/commit/c9bb4fd8e0974788cf0e963567db76685fcba231))
+
+## [1.3.2](https://github.com/adobe/helix-html-pipeline/compare/v1.3.1...v1.3.2) (2022-03-19)
+
+
+### Bug Fixes
+
+* expect spec-compliant URL ([d65428a](https://github.com/adobe/helix-html-pipeline/commit/d65428a2f0e68471f8eed785706766744a7f168b))
+
+## [1.3.1](https://github.com/adobe/helix-html-pipeline/compare/v1.3.0...v1.3.1) (2022-03-18)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-shared-utils to v2.0.6 ([#26](https://github.com/adobe/helix-html-pipeline/issues/26)) ([186c376](https://github.com/adobe/helix-html-pipeline/commit/186c376d0252b0c96ee461670cf45a711aa93f4f))
+* preserve formatting of script tags ([#25](https://github.com/adobe/helix-html-pipeline/issues/25)) ([7009f20](https://github.com/adobe/helix-html-pipeline/commit/7009f20d37190f5704b7f9363c59912b4272c0bf)), closes [#23](https://github.com/adobe/helix-html-pipeline/issues/23)
+
 # [1.3.0](https://github.com/adobe/helix-html-pipeline/compare/v1.2.1...v1.3.0) (2022-03-17)
 
 

package/README.md

@@ -3,8 +3,8 @@
 This package contains the common code for `helix-pipeline-service` and `helix-cloudflare-pipeline` for rendering the html response for helix3. it has the following design goals:
 
 - be platform neutral, i.e. not using node or browser specific modules or dependencies.
-- +/-0 runtime dependencies
-- offer extension interfaces where platform abstraction is required (e.g. reading from s3)
+- +/-0 runtime dependencies (eg. node [crypto](https://nodejs.org/api/crypto.html))
+- offer extension interfaces where platform abstraction is required (e.g. reading from S3, sending to SQS)
 
 ## Status
 [![codecov](https://img.shields.io/codecov/c/github/adobe/helix-html-pipeline.svg)](https://codecov.io/gh/adobe/helix-html-pipeline)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "1.3.0",
+  "version": "1.3.3",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@adobe/helix-markdown-support": "3.1.2",
-    "@adobe/helix-shared-utils": "2.0.5",
+    "@adobe/helix-shared-utils": "2.0.6",
     "github-slugger": "1.4.0",
     "hast-util-raw": "7.2.1",
     "hast-util-select": "5.0.1",
@@ -42,11 +42,11 @@
     "hastscript": "7.0.2",
     "mdast-util-gfm-footnote": "1.0.1",
     "mdast-util-gfm-strikethrough": "1.0.1",
-    "mdast-util-gfm-table": "1.0.3",
+    "mdast-util-gfm-table": "1.0.4",
     "mdast-util-gfm-task-list-item": "1.0.1",
     "mdast-util-to-hast": "12.1.1",
     "mdast-util-to-string": "3.1.0",
-    "micromark-extension-gfm-footnote": "1.0.3",
+    "micromark-extension-gfm-footnote": "1.0.4",
     "micromark-extension-gfm-strikethrough": "1.0.4",
     "micromark-extension-gfm-table": "1.0.5",
     "micromark-extension-gfm-tagfilter": "1.0.1",
@@ -54,12 +54,12 @@
     "micromark-util-combine-extensions": "1.0.0",
     "mime": "3.0.0",
     "rehype-format": "4.0.1",
-    "rehype-minify-whitespace": "5.0.0",
+    "rehype-minify-whitespace": "5.0.1",
     "rehype-parse": "8.0.4",
     "remark-parse": "10.0.1",
     "strip-markdown": "5.0.0",
     "unified": "10.1.2",
-    "unist-util-map": "3.0.0",
+    "unist-util-map": "3.0.1",
     "unist-util-remove": "3.1.0",
     "unist-util-remove-position": "4.0.1",
     "unist-util-select": "4.0.1",
@@ -76,16 +76,16 @@
     "codecov": "3.8.3",
     "commitizen": "4.2.4",
     "cz-conventional-changelog": "3.3.0",
-    "eslint": "8.11.0",
+    "eslint": "8.12.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.25.4",
-    "esmock": "1.7.4",
+    "esmock": "1.7.5",
     "husky": "7.0.4",
     "js-yaml": "4.1.0",
     "jsdoc-to-markdown": "7.1.1",
     "jsdom": "19.0.0",
     "junit-report-builder": "3.0.0",
-    "lint-staged": "12.3.5",
+    "lint-staged": "12.3.7",
     "mocha": "9.2.2",
     "mocha-multi-reporters": "1.5.1",
     "remark-gfm": "3.0.1",

package/src/PipelineState.d.ts

@@ -12,6 +12,12 @@
 import {PathInfo, S3Loader, FormsMessageDispatcher, PipelineTimer} from "./index";
 import {PipelineContent} from "./PipelineContent";
 
+declare enum PipelineType {
+  html = 'html',
+  json = 'json',
+  form = 'form',
+}
+
 declare interface PipelineOptions {
   log: Console;
   s3Loader: S3Loader;
@@ -70,5 +76,10 @@ declare class PipelineState {
    * optional timer that is used to measure the timing
    */
   timer?: PipelineTimer;
+
+  /**
+   * pipeline type. 'html', 'json', 'forms'
+   */
+  type: PipelineType;
 }
 

package/src/PipelineState.js

@@ -38,6 +38,7 @@ export class PipelineState {
       s3Loader: opts.s3Loader,
       messageDispatcher: opts.messageDispatcher,
       timer: opts.timer,
+      type: 'html',
     });
   }
 }

package/src/forms-pipe.js

@@ -88,6 +88,7 @@ export async function extractBodyData(request) {
  */
 export async function formsPipe(state, request) {
   const { log } = state;
+  state.type = 'form';
 
   // todo: improve
   const response = new PipelineResponse('', {

package/src/html-pipe.js

@@ -44,6 +44,7 @@ import { validatePathInfo } from './utils/path.js';
  */
 export async function htmlPipe(state, req) {
   const { log } = state;
+  state.type = 'html';
 
   if (!validatePathInfo(state.info)) {
     return new PipelineResponse('', {

package/src/json-pipe.js

@@ -13,6 +13,7 @@ import fetchMetadata from './steps/fetch-metadata.js';
 import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
 import { PipelineResponse } from './PipelineResponse.js';
 import jsonFilter from './utils/json-filter.js';
+import { updateLastModified } from './utils/last-modified.js';
 
 /**
  * Runs the default pipeline and returns the response.
@@ -22,6 +23,7 @@ import jsonFilter from './utils/json-filter.js';
  */
 export async function jsonPipe(state, req) {
   const { log } = state;
+  state.type = 'json';
   const {
     owner, repo, ref, contentBusId, partition, s3Loader,
   } = state;
@@ -70,11 +72,8 @@ export async function jsonPipe(state, req) {
     raw: limit === undefined && offset === undefined && sheet === undefined,
   });
 
-  // set last-modified (note, that it is not influenced by metadata or helix-config.json)
-  const lastModified = dataResponse.headers.get('last-modified');
-  if (lastModified) {
-    response.headers.set('last-modified', lastModified);
-  }
+  // set last-modified
+  updateLastModified(state, response, dataResponse.headers.get('last-modified'));
 
   // set surrogate key
   response.headers.set('x-surrogate-key', `${contentBusId}${path}`.replace(/\//g, '_'));

package/src/steps/fetch-metadata.js

@@ -39,8 +39,10 @@ export default async function fetchMetadata(state, req, res) {
     }
     state.metadata = data;
 
-    // also update last-modified
-    updateLastModified(state, res, extractLastModified(ret.headers));
+    if (state.type === 'html') {
+      // also update last-modified (only for html pipeline)
+      updateLastModified(state, res, extractLastModified(ret.headers));
+    }
     return;
   }
 

package/src/steps/stringify-response.js

@@ -12,6 +12,8 @@
 import { toHtml } from 'hast-util-to-html';
 // import rehypeFormat from 'rehype-format';
 import rehypeMinifyWhitespace from 'rehype-minify-whitespace';
+import { visit } from 'unist-util-visit';
+
 /**
  * Serializes the response document to HTML
  * @param {PipelineState} state
@@ -32,7 +34,25 @@ export default function stringify(state, req, res) {
   // TODO: for the next breaking release, pretty print the HTML with rehypeFormat.
   // TODO: but for backward compatibility, output all on 1 line.
   // rehypeFormat()(doc);
+
+  // due to a bug in rehype-minify-whitespace, script content is also minified to 1 line, which
+  // can result in errors https://github.com/rehypejs/rehype-minify/issues/44
+  // so we 'save' all text first and revert it afterwards
+  visit(doc, (node) => {
+    if (node.tagName === 'script' && node.children[0]?.type === 'text') {
+      node.children[0].savedValue = node.children[0].value;
+    }
+  });
+
   rehypeMinifyWhitespace()(doc);
+
+  visit(doc, (node) => {
+    if (node.tagName === 'script' && node.children[0]?.type === 'text') {
+      node.children[0].value = node.children[0].savedValue;
+      delete node.children[0].savedValue;
+    }
+  });
+
   res.body = toHtml(doc, {
     upperDoctype: true,
   });

package/src/steps/utils.js

@@ -125,8 +125,9 @@ export function optimizeImageURL(src, width, format = 'webply', optimize = 'medi
  * @returns {string} resolved url
  */
 export function resolveUrl(from, to) {
-  const resolvedUrl = new URL(to, new URL(from, 'resolve://'));
-  if (resolvedUrl.protocol === 'resolve:') {
+  const DUMMY_BASE = 'https://__dummmy__';
+  const resolvedUrl = new URL(to, new URL(from, DUMMY_BASE));
+  if (resolvedUrl.origin === DUMMY_BASE) {
     // `from` is a relative URL.
     const { pathname, search, hash } = resolvedUrl;
     return pathname + search + hash;