@adobe/helix-html-pipeline 5.4.4 → 5.5.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [5.5.0](https://github.com/adobe/helix-html-pipeline/compare/v5.4.5...v5.5.0) (2024-01-23)
+
+
+### Features
+
+* add pipeline for sitemap.xml ([#507](https://github.com/adobe/helix-html-pipeline/issues/507)) ([8256184](https://github.com/adobe/helix-html-pipeline/commit/825618471a50a0641d64de0b7bb0cb6a78578d52))
+
+## [5.4.5](https://github.com/adobe/helix-html-pipeline/compare/v5.4.4...v5.4.5) (2024-01-22)
+
+
+### Bug Fixes
+
+* **deps:** update external major ([#503](https://github.com/adobe/helix-html-pipeline/issues/503)) ([6c84eb2](https://github.com/adobe/helix-html-pipeline/commit/6c84eb258c731162935d502b34da01f1bdc12690))
+
 ## [5.4.4](https://github.com/adobe/helix-html-pipeline/compare/v5.4.3...v5.4.4) (2023-12-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "5.4.4",
+  "version": "5.5.0",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -52,9 +52,9 @@
     "hast-util-select": "6.0.2",
     "hast-util-to-html": "9.0.0",
     "hast-util-to-string": "3.0.0",
-    "hastscript": "8.0.0",
+    "hastscript": "9.0.0",
     "jose": "5.2.0",
-    "mdast-util-to-hast": "13.0.2",
+    "mdast-util-to-hast": "13.1.0",
     "mdast-util-to-string": "4.0.0",
     "mime": "4.0.1",
     "rehype-format": "5.0.0",
@@ -75,15 +75,15 @@
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "11.0.2",
-    "c8": "8.0.1",
+    "c8": "9.1.0",
     "eslint": "8.56.0",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.29.1",
-    "esmock": "2.6.0",
+    "esmock": "2.6.2",
     "husky": "8.0.3",
     "js-yaml": "4.1.0",
-    "jsdom": "23.0.1",
+    "jsdom": "24.0.0",
     "junit-report-builder": "3.1.0",
     "lint-staged": "15.2.0",
     "mocha": "10.2.0",

package/src/index.js

@@ -13,6 +13,7 @@ export * from './html-pipe.js';
 export * from './json-pipe.js';
 export * from './options-pipe.js';
 export * from './forms-pipe.js';
+export * from './sitemap-pipe.js';
 export * from './PipelineContent.js';
 export * from './PipelineRequest.js';
 export * from './PipelineResponse.js';

package/src/sitemap-pipe.js

@@ -0,0 +1,111 @@
+/*
+ * 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 { cleanupHeaderValue } from '@adobe/helix-shared-utils';
+import { authenticate, requireProject } from './steps/authenticate.js';
+import fetchConfig from './steps/fetch-config.js';
+import fetchContent from './steps/fetch-content.js';
+import fetchConfigAll from './steps/fetch-config-all.js';
+import renderCode from './steps/render-code.js';
+import setXSurrogateKeyHeader from './steps/set-x-surrogate-key-header.js';
+import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
+import { PipelineStatusError } from './PipelineStatusError.js';
+import { PipelineResponse } from './PipelineResponse.js';
+
+/**
+ * Serves or renders the sitemap xml. The sitemap is always served from the preview content-bus
+ * partition.
+ *
+ * todo: currently only serves an existing sitemap.xml from the contentbus.
+ *       generate sitemap on the fly based on the sitemap.json
+ *
+ * @param {PipelineState} state
+ * @param {PipelineRequest} req
+ * @returns {PipelineResponse}
+ */
+export async function sitemapPipe(state, req) {
+  const { log } = state;
+  state.type = 'sitemap';
+  // force loading from preview
+  state.partition = 'preview';
+
+  if (state.info?.path !== '/sitemap.xml') {
+    // this should not happen as it would mean that the caller used the wrong route. so we respond
+    // with a 500 to indicate that something is wrong.
+    return new PipelineResponse('', {
+      status: 500,
+      headers: {
+        'x-error': 'invalid route',
+      },
+    });
+  }
+
+  /** @type PipelineResponse */
+  const res = new PipelineResponse('', {
+    headers: {
+      'content-type': 'text/html; charset=utf-8',
+    },
+  });
+
+  // check if .auth request
+
+  try { // fetch config first, since we need to compute the content-bus-id from the fstab ...
+    state.timer?.update('config-fetch');
+    await fetchConfig(state, req, res);
+    if (!state.contentBusId) {
+      res.status = 400;
+      res.headers.set('x-error', 'contentBusId missing');
+      return res;
+    }
+
+    // fetch sitemap.xml
+
+    state.timer?.update('content-fetch');
+    await Promise.all([
+      fetchConfigAll(state, req, res),
+      fetchContent(state, req, res),
+    ]);
+
+    await requireProject(state, req, res);
+    if (res.error !== 401) {
+      await authenticate(state, req, res);
+    }
+
+    if (res.error) {
+      // if content loading produced an error, we're done.
+      const level = res.status >= 500 ? 'error' : 'info';
+      log[level](`pipeline status: ${res.status} ${res.error}`);
+      res.headers.set('x-error', cleanupHeaderValue(res.error));
+      if (res.status < 500) {
+        await setCustomResponseHeaders(state, req, res);
+      }
+      return res;
+    }
+
+    state.timer?.update('serialize');
+    await renderCode(state, req, res);
+    await setCustomResponseHeaders(state, req, res);
+    await setXSurrogateKeyHeader(state, req, res);
+  } catch (e) {
+    res.error = e.message;
+    if (e instanceof PipelineStatusError) {
+      res.status = e.code;
+    } else {
+      res.status = 500;
+    }
+
+    const level = res.status >= 500 ? 'error' : 'info';
+    log[level](`pipeline status: ${res.status} ${res.error}`, e);
+    res.headers.set('x-error', cleanupHeaderValue(res.error));
+  }
+
+  return res;
+}