@jsenv/snapshot 1.5.7 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "1.5.7",
+  "version": "2.0.0",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -39,9 +39,7 @@
     "@jsenv/urls": "2.2.11",
     "@jsenv/utils": "2.1.1",
     "pixelmatch": "6.0.0",
-    "prettier": "3.3.3"
-  },
-  "devDependencies": {
+    "prettier": "3.3.3",
     "strip-ansi": "7.1.0"
   }
 }

package/src/{file_snapshots.js → filesystem_snapshot.js}

@@ -1,4 +1,5 @@
 import { readdirSync, statSync, readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
 import { URL_META } from "@jsenv/url-meta";
 import {
   assertAndNormalizeDirectoryUrl,
@@ -19,18 +20,32 @@ import {
   ExtraFileAssertionError,
   FileContentAssertionError,
 } from "./errors.js";
+import { replaceFluctuatingValues } from "./replace_fluctuating_values.js";
 import { comparePngFiles } from "./compare_png_files.js";
 
 export const takeFileSnapshot = (fileUrl) => {
   fileUrl = assertAndNormalizeFileUrl(fileUrl);
   const fileSnapshot = createFileSnapshot(fileUrl);
   removeFileSync(fileUrl, { allowUseless: true });
+  const compare = (throwWhenDiff = process.env.CI) => {
+    fileSnapshot.compare(createFileSnapshot(fileUrl), { throwWhenDiff });
+  };
   return {
-    compare: (throwWhenDiff = process.env.CI) => {
-      fileSnapshot.compare(createFileSnapshot(fileUrl), { throwWhenDiff });
-    },
-    writeContent: (content) => {
+    compare,
+    update: (
+      content,
+      { mockFluctuatingValues = true, rootDirectoryUrl, throwWhenDiff } = {},
+    ) => {
+      if (mockFluctuatingValues) {
+        content = replaceFluctuatingValues(content, {
+          cwdPath: rootDirectoryUrl
+            ? fileURLToPath(rootDirectoryUrl)
+            : undefined,
+          cwdUrl: rootDirectoryUrl ? String(rootDirectoryUrl) : undefined,
+        });
+      }
       writeFileSync(fileUrl, content);
+      compare(throwWhenDiff);
     },
     restore: () => {
       if (fileSnapshot.empty) {

package/src/main.js

@@ -1 +1,5 @@
-export { takeDirectorySnapshot, takeFileSnapshot } from "./file_snapshots.js";
+export {
+  takeDirectorySnapshot,
+  takeFileSnapshot,
+} from "./filesystem_snapshot.js";
+export { replaceFluctuatingValues } from "./replace_fluctuating_values.js";

package/src/replace_fluctuating_values.js

@@ -0,0 +1,59 @@
+// - Find all things looking like urls and replace with stable values
+// - Find all things looking likes dates and replace with stable values
+
+import stripAnsi from "strip-ansi";
+import { pathToFileURL, fileURLToPath } from "node:url";
+import { escapeRegexpSpecialChars } from "@jsenv/utils/src/string/escape_regexp_special_chars.js";
+
+export const replaceFluctuatingValues = (
+  string,
+  {
+    removeAnsi = true,
+    rootDirectoryUrl = pathToFileURL(process.cwd()),
+    // for unit tests
+    rootDirectoryPath = fileURLToPath(rootDirectoryUrl),
+    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()");
+  }
+  string = replaceHttpUrls(string);
+  return string;
+};
+
+const replaceHttpUrls = (source) => {
+  return source.replace(/(?:https?|ftp):\/\/\S+/g, (match) => {
+    const lastChar = match[match.length - 1];
+    // hotfix because our url regex sucks a bit
+    const endsWithSeparationChar = lastChar === ")" || lastChar === ":";
+    if (endsWithSeparationChar) {
+      match = match.slice(0, -1);
+    }
+    try {
+      const urlObject = new URL(match);
+      if (urlObject.port) {
+        urlObject.port = 9999;
+      }
+      return urlObject.href;
+    } catch (e) {
+      return match;
+    }
+  });
+};