@adobe/helix-html-pipeline 4.0.0 → 4.0.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [4.0.1](https://github.com/adobe/helix-html-pipeline/compare/v4.0.0...v4.0.1) (2023-07-18)
+
+
+### Bug Fixes
+
+* ignore urns, hrefs, code blocks for rewrite-icons ([d61e23a](https://github.com/adobe/helix-html-pipeline/commit/d61e23a6a64ea764b935dd6a4d396c409d00bcb9)), closes [#348](https://github.com/adobe/helix-html-pipeline/issues/348)
+
 # [4.0.0](https://github.com/adobe/helix-html-pipeline/compare/v3.11.20...v4.0.0) (2023-07-11)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -39,7 +39,7 @@
     "node": ">=16.x"
   },
   "dependencies": {
-    "@adobe/helix-markdown-support": "6.1.3",
+    "@adobe/helix-markdown-support": "6.2.1",
     "@adobe/helix-shared-utils": "3.0.0",
     "@adobe/mdast-util-gridtables": "2.0.1",
     "@adobe/remark-gridtables": "1.0.4",
@@ -73,7 +73,7 @@
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "10.0.4",
     "c8": "8.0.0",
-    "eslint": "8.44.0",
+    "eslint": "8.45.0",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.27.5",

package/src/forms-pipe.js

@@ -15,6 +15,7 @@ import fetchConfigAll from './steps/fetch-config-all.js';
 import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
 import { authenticate } from './steps/authenticate.js';
 import fetchConfig from './steps/fetch-config.js';
+import validateCaptcha from './steps/validate-captcha.js';
 
 function error(log, msg, status, response) {
   log.error(msg);
@@ -126,12 +127,6 @@ export async function formsPipe(state, req) {
     return error(log, 'POST to URL with extension not allowed', 405, res);
   }
 
-  // head workbook in content bus
-  const resourceFetchResponse = await s3Loader.headObject('helix-content-bus', `${contentBusId}/${partition}${resourcePath}`);
-  if (resourceFetchResponse.status !== 200) {
-    return resourceFetchResponse;
-  }
-
   let body;
   try {
     body = await extractBodyData(req);
@@ -139,6 +134,19 @@ export async function formsPipe(state, req) {
     return error(log, err.message, 400, res);
   }
 
+  // verify captcha if needed
+  try {
+    await validateCaptcha(state, body);
+  } catch (e) {
+    return error(log, e.message, e.code, res);
+  }
+
+  // head workbook in content bus
+  const resourceFetchResponse = await s3Loader.headObject('helix-content-bus', `${contentBusId}/${partition}${resourcePath}`);
+  if (resourceFetchResponse.status !== 200) {
+    return resourceFetchResponse;
+  }
+
   const sheets = resourceFetchResponse.headers.get('x-amz-meta-x-sheet-names');
   if (!sheets) {
     return error(log, `Target workbook at ${resourcePath} missing x-sheet-names header.`, 403, res);

package/src/steps/rewrite-icons.js

@@ -11,9 +11,9 @@
  */
 /* eslint-disable no-param-reassign */
 import { h } from 'hastscript';
-import { CONTINUE, visit } from 'unist-util-visit';
+import { CONTINUE, SKIP, visit } from 'unist-util-visit';
 
-const REGEXP_ICON = /:(#?[a-z_-]+[a-z\d]*):/gi;
+const REGEXP_ICON = /(?<!(?:https?|urn)[^\s]*):(#?[a-z_-]+[a-z\d]*):/gi;
 
 /**
  * Create a <span> icon element:
@@ -44,9 +44,13 @@ function createIcon(value) {
 export default function rewrite({ content }) {
   const { hast } = content;
   visit(hast, (node, idx, parent) => {
+    if (node.tagName === 'code') {
+      return SKIP;
+    }
     if (node.type !== 'text') {
       return CONTINUE;
     }
+
     const text = node.value;
     let lastIdx = 0;
     for (const match of text.matchAll(REGEXP_ICON)) {

package/src/steps/validate-captcha.js

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2023 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';
+
+async function validateGoogleCaptchaV2(body, fetch, secretKey) {
+  const captchaToken = body.data?.['g-recaptcha-response']
+    || body.data?.find((x) => (x.name === 'g-recaptcha-response'))?.value;
+
+  if (!captchaToken) {
+    throw new PipelineStatusError(400, 'Captcha token missing from request body');
+  }
+
+  const response = await fetch('https://www.google.com/recaptcha/api/siteverify', {
+    method: 'POST',
+    body: new URLSearchParams({ secret: secretKey, response: captchaToken }),
+  });
+  if (!response.ok) {
+    throw new PipelineStatusError(500, `Captcha validation request returned ${response.status}`);
+  }
+  const responseData = await response.json();
+  if (!responseData.success) {
+    throw new PipelineStatusError(400, 'Captcha validation failed');
+  }
+}
+
+const SUPPORTED_CAPTCHA_TYPES = {
+  'reCaptcha v2': validateGoogleCaptchaV2,
+};
+
+/**
+ *
+ * @param {PipelineState} state Pipeline options
+ * @param {Object} body Request body
+ * @returns {void}
+ */
+export default async function validateCaptcha(state, body) {
+  const { fetch, config } = state;
+  const { captcha } = config;
+
+  // If captcha type is not configured, do nothing
+  if (!captcha?.type) {
+    return;
+  }
+
+  // Check captcha type is correctly configured
+  const validator = SUPPORTED_CAPTCHA_TYPES[captcha.type];
+  if (!validator) {
+    throw new PipelineStatusError(500, `The captcha type ${captcha.type} is not supported.`);
+  }
+  if (!captcha.secret) {
+    throw new PipelineStatusError(500, 'Captcha secret key is not configured.');
+  }
+
+  // Perform validation
+  await validator(body, fetch, captcha.secret);
+}