@jsenv/snapshot 2.0.1 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -35,6 +35,7 @@
   },
   "dependencies": {
     "@jsenv/assert": "4.1.4",
+    "@jsenv/ast": "6.2.4",
     "@jsenv/filesystem": "4.8.1",
     "@jsenv/urls": "2.3.0",
     "@jsenv/utils": "2.1.1",

package/src/filesystem_snapshot.js

@@ -38,6 +38,7 @@ export const takeFileSnapshot = (fileUrl) => {
     ) => {
       if (mockFluctuatingValues) {
         content = replaceFluctuatingValues(content, {
+          fileUrl,
           cwdPath: rootDirectoryUrl
             ? fileURLToPath(rootDirectoryUrl)
             : undefined,

package/src/replace_fluctuating_values.js

@@ -4,42 +4,98 @@
 import stripAnsi from "strip-ansi";
 import { pathToFileURL, fileURLToPath } from "node:url";
 import { escapeRegexpSpecialChars } from "@jsenv/utils/src/string/escape_regexp_special_chars.js";
+import {
+  parseSvgString,
+  parseHtml,
+  setHtmlNodeText,
+  visitHtmlNodes,
+  getHtmlNodeText,
+  getHtmlNodeAttributes,
+  setHtmlNodeAttributes,
+  stringifyHtmlAst,
+} from "@jsenv/ast";
+import { urlToExtension } from "@jsenv/urls";
 
 export const replaceFluctuatingValues = (
   string,
   {
+    fileUrl,
     removeAnsi = true,
     rootDirectoryUrl = pathToFileURL(process.cwd()),
     // for unit tests
-    rootDirectoryPath = fileURLToPath(rootDirectoryUrl),
+    rootDirectoryPath,
     isWindows = process.platform === "win32",
   } = {},
 ) => {
-  if (removeAnsi) {
-    string = stripAnsi(string);
-  }
   rootDirectoryUrl = String(rootDirectoryUrl);
   if (rootDirectoryUrl[rootDirectoryUrl.length - 1] === "/") {
     rootDirectoryUrl = rootDirectoryUrl.slice(0, -1);
   }
-  string = string.replaceAll(rootDirectoryUrl, "file:///cwd()");
-  if (isWindows) {
-    const windowPathRegex = new RegExp(
-      `${escapeRegexpSpecialChars(rootDirectoryPath)}(((?:\\\\(?:[\\w !#()-]+|[.]{1,2})+)*)(?:\\\\)?)`,
-      "gm",
-    );
-    string = string.replaceAll(windowPathRegex, (match, afterCwd) => {
-      return `cwd()${afterCwd.replaceAll("\\", "/")}`;
-    });
-  } else {
-    string = string.replaceAll(rootDirectoryPath, "cwd()");
+  if (rootDirectoryPath === undefined) {
+    rootDirectoryPath = fileURLToPath(rootDirectoryUrl);
   }
-  string = replaceHttpUrls(string);
-  return string;
+  const replaceFileUrls = (value) => {
+    return value.replaceAll(rootDirectoryUrl, "file:///cwd()");
+  };
+  const replaceFilePaths = isWindows
+    ? (value) => {
+        const windowPathRegex = new RegExp(
+          `${escapeRegexpSpecialChars(rootDirectoryPath)}(((?:\\\\(?:[\\w !#()-]+|[.]{1,2})+)*)(?:\\\\)?)`,
+          "gm",
+        );
+        return value.replaceAll(windowPathRegex, (match, afterCwd) => {
+          return `cwd()${afterCwd.replaceAll("\\", "/")}`;
+        });
+      }
+    : (value) => {
+        return value.replaceAll(rootDirectoryPath, "cwd()");
+      };
+  const replaceThings = (value) => {
+    if (removeAnsi) {
+      value = stripAnsi(value);
+    }
+    value = replaceFileUrls(value);
+    value = replaceFilePaths(value);
+    value = replaceHttpUrls(value);
+    return value;
+  };
+
+  if (fileUrl) {
+    const extension = urlToExtension(fileUrl);
+    if (extension === ".svg" || extension === ".html") {
+      // do parse html
+      const htmlAst =
+        extension === ".svg"
+          ? parseSvgString(string)
+          : parseHtml({
+              html: string,
+              storeOriginalPositions: false,
+            });
+      // for each attribute value
+      // and each text node content
+      visitHtmlNodes(htmlAst, {
+        "*": (node) => {
+          const htmlNodeText = getHtmlNodeText(node);
+          if (htmlNodeText) {
+            setHtmlNodeText(node, replaceThings(htmlNodeText));
+          }
+          const attributes = getHtmlNodeAttributes(node);
+          if (attributes) {
+            for (const name of Object.keys(attributes)) {
+              attributes[name] = replaceThings(attributes[name]);
+            }
+            setHtmlNodeAttributes(node, attributes);
+          }
+        },
+      });
+      return stringifyHtmlAst(htmlAst);
+    }
+  }
+  return replaceThings(string);
 };
 
 const replaceHttpUrls = (source) => {
-  return source.replace(/(?:https?|ftp):\/\/\S+/g, (match) => {
+  return source.replace(/(?:https?|ftp):\/\/\S+[\w/]/g, (match) => {
     const lastChar = match[match.length - 1];
     // hotfix because our url regex sucks a bit
     const endsWithSeparationChar = lastChar === ")" || lastChar === ":";
@@ -48,10 +104,14 @@ const replaceHttpUrls = (source) => {
     }
     try {
       const urlObject = new URL(match);
+      if (urlObject.hostname === "www.w3.org") {
+        return match;
+      }
       if (urlObject.port) {
         urlObject.port = 9999;
       }
-      return urlObject.href;
+      const url = urlObject.href;
+      return url;
     } catch (e) {
       return match;
     }