@adobe/helix-html-pipeline 5.0.12 → 5.1.1

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [5.1.1](https://github.com/adobe/helix-html-pipeline/compare/v5.1.0...v5.1.1) (2023-11-09)
+
+
+### Bug Fixes
+
+* append .plain.html in redirects if needed ([#452](https://github.com/adobe/helix-html-pipeline/issues/452)) ([d3035a1](https://github.com/adobe/helix-html-pipeline/commit/d3035a1f593b0ac39fd9bd2ce68c8bcb83fe06b4)), closes [#451](https://github.com/adobe/helix-html-pipeline/issues/451)
+* increase test time ([336bda0](https://github.com/adobe/helix-html-pipeline/commit/336bda099dae3a3faea26c71984693a2cd3a998f))
+
+# [5.1.0](https://github.com/adobe/helix-html-pipeline/compare/v5.0.12...v5.1.0) (2023-11-06)
+
+
+### Bug Fixes
+
+* **options:** use request.url.pathname ([0086a2d](https://github.com/adobe/helix-html-pipeline/commit/0086a2dd4d9b8dc6b8845dab6e7bf0f63132fbdc))
+
+
+### Features
+
+* **domainkeys:** support arrays of domainkeys in config ([f90b3b6](https://github.com/adobe/helix-html-pipeline/commit/f90b3b6a6b67804cf8b6e24e950769cdf70313be))
+* **options:** add support for domainkey challenges ([8153afc](https://github.com/adobe/helix-html-pipeline/commit/8153afc8fa49cfca20763c982cadb36f30382525))
+
 ## [5.0.12](https://github.com/adobe/helix-html-pipeline/compare/v5.0.11...v5.0.12) (2023-10-31)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "5.0.12",
+  "version": "5.1.1",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -53,7 +53,7 @@
     "hast-util-to-html": "9.0.0",
     "hast-util-to-string": "3.0.0",
     "hastscript": "8.0.0",
-    "jose": "5.0.1",
+    "jose": "5.1.0",
     "mdast-util-to-hast": "13.0.2",
     "mdast-util-to-string": "4.0.0",
     "mime": "3.0.0",
@@ -74,13 +74,13 @@
     "@markedjs/html-differ": "4.0.2",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/npm": "11.0.0",
+    "@semantic-release/npm": "11.0.1",
     "c8": "8.0.1",
-    "eslint": "8.52.0",
+    "eslint": "8.53.0",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.29.0",
-    "esmock": "2.5.8",
+    "esmock": "2.5.9",
     "husky": "8.0.3",
     "js-yaml": "4.1.0",
     "jsdom": "22.1.0",
@@ -89,7 +89,7 @@
     "mocha": "10.2.0",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.4.1",
-    "semantic-release": "22.0.5"
+    "semantic-release": "22.0.7"
   },
   "lint-staged": {
     "*.js": "eslint",

package/src/options-pipe.js

@@ -10,12 +10,70 @@
  * governing permissions and limitations under the License.
  */
 import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
+import { createHash } from 'crypto';
 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';
+import { getOriginalHost } from './steps/utils.js';
 
+/**
+ * Hashes the domain and domainkey
+ * @param {string} domain the domain
+ * @param {string|string[]} domainkeys the domainkey or domainkeys
+ * @returns {string} the hash
+ */
+function hashMe(domain, domainkeys) {
+  return (Array.isArray(domainkeys) ? domainkeys : [domainkeys]).map((dk) => {
+    const hash = createHash('sha256');
+    hash.update(domain);
+    hash.update(dk);
+    return hash.digest('hex');
+  }).join(' ');
+}
+
+/**
+ * If the request is a _rum-challenge request, then set the x-rum-challenge header
+ * A rum-challenge request is an OPTIONS request to any path ending with _rum-challenge
+ * and will return a 204 response with the x-rum-challenge header set to the hash of
+ * the x-forwarded-host and the domainkey. If no domainkey has been set in .helix/config
+ * then the `slack` channel will be used instead.
+ * @param {object} state current pipeline state
+ * @param {Request} request HTTP request
+ * @param {Response} response HTTP response
+ * @returns {void}
+ */
+function setDomainkeyHeader(state, request, response) {
+  // nope out if path does not end with _rum-challenge
+  if (!request.url.pathname.endsWith('/_rum-challenge')) {
+    return;
+  }
+  // get x-forwarded-host
+  const originalHost = getOriginalHost(request.headers);
+  // get liveHost
+  const { host } = state.config;
+
+  if (originalHost !== host) {
+    // these have to match
+    state.log.debug(`x-forwarded-host: ${originalHost} does not match prod host: ${host}`);
+    return;
+  }
+  // get domainkey from config
+  const { domainkey } = state.config;
+  // get slack channel from config
+  const { slack } = state.config;
+  let hash;
+  if (typeof domainkey === 'string' || Array.isArray(domainkey)) {
+    hash = hashMe(originalHost, domainkey);
+  } else if (typeof slack === 'string' || Array.isArray(slack)) {
+    hash = hashMe(originalHost, slack);
+  }
+
+  if (hash) {
+    response.headers.set('x-rum-challenge', hash);
+  }
+}
 /**
  * Handles options requests
  * @param {PipelineState} state pipeline options
@@ -46,6 +104,7 @@ export async function optionsPipe(state, request) {
     });
     await fetchConfigAll(state, request, res);
     await setCustomResponseHeaders(state, request, res);
+    setDomainkeyHeader(state, request, res);
 
     return res;
   } catch (e) {

package/src/steps/fetch-content.js

@@ -37,10 +37,13 @@ export default async function fetchContent(state, req, res) {
   const ret = await state.s3Loader.getObject(bucketId, key);
 
   // check for redirect
-  const redirectLocation = ret.headers.get('x-amz-meta-redirect-location');
+  let redirectLocation = ret.headers.get('x-amz-meta-redirect-location');
   if (redirectLocation) {
     res.status = 301;
     res.body = '';
+    if (redirectLocation.startsWith('/') && state.info.selector === 'plain') {
+      redirectLocation += '.plain.html';
+    }
     res.headers.set('location', redirectLocation);
     res.headers.set('x-surrogate-key', await computeSurrogateKey(`${contentBusId}${info.path}`));
     res.error = 'moved';