@jsenv/snapshot 2.7.5 → 2.8.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.7.5",
+  "version": "2.8.1",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "@jsenv/assert": "4.1.14",
-    "@jsenv/ast": "6.2.13",
+    "@jsenv/ast": "6.2.14",
     "@jsenv/exception": "1.0.1",
     "@jsenv/filesystem": "4.9.9",
     "@jsenv/terminal-recorder": "1.4.3",

package/src/filesystem_well_known_values.js

@@ -58,6 +58,7 @@ export const createWellKnown = (name, replacement = name) => {
 
 export const createReplaceFilesystemWellKnownValues = ({
   rootDirectoryUrl,
+  localhostUrl,
   // for unit tests
   isWindows = process.platform === "win32",
   ancestorPackagesDisabled,
@@ -126,9 +127,32 @@ export const createReplaceFilesystemWellKnownValues = ({
       }
     };
   };
+  const addWellKnownUrl = (url, replacement) => {
+    const wellKnownUrl = {
+      url,
+      replace: (string) => {
+        return string.replaceAll(url, replacement);
+      },
+    };
+    wellKownUrlArray.push(wellKnownUrl);
+    return () => {
+      const urlIndex = wellKownUrlArray.indexOf(wellKnownUrl);
+      if (urlIndex > -1) {
+        wellKownUrlArray.splice(urlIndex, 1);
+      }
+    };
+  };
   if (rootDirectoryUrl) {
     addWellKnownFileUrl(rootDirectoryUrl, WELL_KNOWN_ROOT);
   }
+  if (localhostUrl) {
+    addWellKnownUrl(
+      localhostUrl,
+      localhostUrl.startsWith("https")
+        ? "https://localhost"
+        : "http://localhost",
+    );
+  }
   /*
    * When running code inside a node project ancestor packages
    * should make things super predictible because
@@ -203,23 +227,17 @@ export const createReplaceFilesystemWellKnownValues = ({
 
   const replaceFileUrls = (string, { willBeWrittenOnFilesystem }) => {
     for (const wellKownUrl of wellKownUrlArray) {
-      const replaceResult = wellKownUrl.replace(string, {
+      string = wellKownUrl.replace(string, {
         willBeWrittenOnFilesystem,
       });
-      if (replaceResult !== string) {
-        return replaceResult;
-      }
     }
     return string;
   };
   const replaceFilePaths = (string, { willBeWrittenOnFilesystem }) => {
     for (const wellKownPath of wellKnownPathArray) {
-      const replaceResult = wellKownPath.replace(string, {
+      string = wellKownPath.replace(string, {
         willBeWrittenOnFilesystem,
       });
-      if (replaceResult !== string) {
-        return replaceResult;
-      }
     }
     return string;
   };

package/src/replace_fluctuating_values.js

@@ -12,119 +12,205 @@ import {
   visitHtmlNodes,
 } from "@jsenv/ast";
 import { urlToExtension } from "@jsenv/urls";
+import { CONTENT_TYPE } from "@jsenv/utils/src/content_type/content_type.js";
 import stripAnsi from "strip-ansi";
 import { createReplaceFilesystemWellKnownValues } from "./filesystem_well_known_values.js";
 
 export const replaceFluctuatingValues = (
-  string,
+  value,
   {
     stringType,
     rootDirectoryUrl,
+    localhostUrl,
     fileUrl,
     preserveAnsi,
     // for unit test
     replaceFilesystemWellKnownValues = createReplaceFilesystemWellKnownValues({
       rootDirectoryUrl,
+      localhostUrl,
     }),
   } = {},
 ) => {
-  if (fileUrl && stringType === undefined) {
-    const extension = urlToExtension(fileUrl);
-    if (extension === ".html") {
-      stringType = "html";
-    } else if (extension === ".svg") {
-      stringType = "svg";
+  if (fileUrl) {
+    const contentType = CONTENT_TYPE.fromUrlExtension(fileUrl);
+    if (Buffer.isBuffer(value) && CONTENT_TYPE.isTextual(contentType)) {
+      value = String(value);
+    }
+    if (stringType === undefined) {
+      const extension = urlToExtension(fileUrl);
+      if (extension === ".html") {
+        stringType = "html";
+      } else if (extension === ".svg") {
+        stringType = "svg";
+      } else if (extension === ".json" || CONTENT_TYPE.isJson(contentType)) {
+        stringType = "json";
+      }
     }
   }
-  const replaceDurations = (value) => {
+  const replaceDurations = (string) => {
     // https://stackoverflow.com/a/59202307/24573072
-    value = value.replace(
+    string = string.replace(
       /(?<!\d|\.)\d+(?:\.\d+)?(\s*)(seconds|second|s)\b/g,
       (match, space, unit) => {
         if (unit === "seconds") unit = "second";
         return `<X>${space}${unit}`;
       },
     );
-    return value;
+    return string;
   };
-  const replaceSizes = (value) => {
+  const replaceSizes = (string) => {
     // the size of files might slighly differ from an OS to an other
     // we round the floats to make them predictable
     // (happens for HTML files where one char is added on linux)
-    value = value.replace(
-      /(?<!\d|\.)(\d+(?:\.\d+)?)(\s*)(B|kB|MB)\b/g,
-      (match, size, space, unit) => {
-        return `${Math.round(parseFloat(size))}${space}${unit}`;
-      },
-    );
-    return value;
+    // string = string.replace(
+    //   /(?<!\d|\.)(\d+(?:\.\d+)?)(\s*)(B|kB|MB)\b/g,
+    //   (match, size, space, unit) => {
+    //     return `${Math.round(parseFloat(size))}${space}${unit}`;
+    //   },
+    // );
+    return string;
   };
-  const replaceThings = (value) => {
+  const replaceThings = (string) => {
     if (stringType === "filesystem") {
-      return replaceFilesystemWellKnownValues(value);
+      return replaceFilesystemWellKnownValues(string);
     }
     if (!preserveAnsi) {
-      value = stripAnsi(value);
+      string = stripAnsi(string);
     }
-    value = replaceFilesystemWellKnownValues(value, {
+    string = replaceFilesystemWellKnownValues(string, {
       willBeWrittenOnFilesystem: false,
     });
-    value = replaceHttpUrls(value);
-    value = replaceDurations(value);
-    value = replaceSizes(value);
-    return value;
+    string = replaceHttpUrls(string);
+    string = replaceDurations(string);
+    string = replaceSizes(string);
+    return string;
   };
-  if (stringType === "html" || stringType === "svg") {
-    // do parse html
-    const htmlAst =
-      stringType === "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]);
+  if (value === null) {
+    return null;
+  }
+  if (typeof value === "string") {
+    if (stringType === "json") {
+      const jsValue = JSON.parse(value);
+      const replaced = replaceInObject(jsValue, { replace: replaceThings });
+      return JSON.stringify(replaced, null, "  ");
+    }
+    if (stringType === "html" || stringType === "svg") {
+      // do parse html
+      const htmlAst =
+        stringType === "svg"
+          ? parseSvgString(value)
+          : parseHtml({
+              html: value,
+              storeOriginalPositions: false,
+            });
+      // for each attribute value
+      // and each text node content
+      visitHtmlNodes(htmlAst, {
+        "*": (node) => {
+          const htmlNodeText = getHtmlNodeText(node);
+          if (htmlNodeText) {
+            setHtmlNodeText(node, replaceThings(htmlNodeText));
           }
-          setHtmlNodeAttributes(node, attributes);
-        }
-      },
-    });
-    return stringifyHtmlAst(htmlAst);
+          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(value);
   }
-  return replaceThings(string);
+  if (typeof value === "object") {
+    if (Buffer.isBuffer(value)) {
+      return value;
+    }
+    const jsValueReplaced = replaceInObject(value, { replace: replaceThings });
+    return JSON.stringify(jsValueReplaced, null, "  ");
+  }
+  return value;
 };
 
-const replaceHttpUrls = (source) => {
-  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 === ":";
-    if (endsWithSeparationChar) {
-      match = match.slice(0, -1);
+const replaceInObject = (object, { replace }) => {
+  const deepCopy = (
+    value,
+    { shouldReplaceStrings, shouldReplaceNumbers } = {},
+  ) => {
+    if (value === null) {
+      return null;
     }
-    try {
-      const urlObject = new URL(match);
-      if (urlObject.hostname === "www.w3.org") {
-        return match;
+    if (Array.isArray(value)) {
+      const copy = [];
+      let i = 0;
+      while (i < value.length) {
+        copy[i] = deepCopy(value[i], {
+          shouldReplaceStrings,
+          shouldReplaceNumbers,
+        });
+        i++;
       }
-      if (urlObject.port) {
-        urlObject.port = 9999;
+      return copy;
+    }
+    if (typeof value === "object") {
+      const copy = {};
+      const keysToVisit = Object.keys(value);
+      for (const keyToVisit of keysToVisit) {
+        const nestedValue = value[keyToVisit];
+        copy[keyToVisit] = deepCopy(nestedValue, {
+          shouldReplaceStrings: shouldReplaceStrings || keyToVisit === "os",
+          shouldReplaceNumbers:
+            shouldReplaceNumbers ||
+            keyToVisit === "timings" ||
+            keyToVisit === "performance" ||
+            keyToVisit === "memoryUsage" ||
+            keyToVisit === "cpuUsage" ||
+            keyToVisit === "os",
+        });
       }
-      const url = urlObject.href;
-      return url;
-    } catch (e) {
-      return match;
+      return copy;
     }
-  });
+    if (typeof value === "string") {
+      if (shouldReplaceStrings) {
+        return "<X>";
+      }
+      return replace(value);
+    }
+    if (typeof value === "number") {
+      if (shouldReplaceNumbers) {
+        return "<X>";
+      }
+      return value;
+    }
+    return value;
+  };
+  const copy = deepCopy(object);
+  return copy;
+};
+
+const replaceHttpUrls = (source) => {
+  return source;
+  // 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 === ":";
+  //   if (endsWithSeparationChar) {
+  //     match = match.slice(0, -1);
+  //   }
+  //   try {
+  //     const urlObject = new URL(match);
+  //     if (urlObject.hostname === "www.w3.org") {
+  //       return match;
+  //     }
+  //     if (urlObject.port) {
+  //       urlObject.port = 9999;
+  //     }
+  //     const url = urlObject.href;
+  //     return url;
+  //   } catch (e) {
+  //     return match;
+  //   }
+  // });
 };

package/src/side_effects/render_side_effects.js

@@ -160,6 +160,16 @@ const renderOneSideEffect = (
     lastSideEffectNumber,
   });
   if (text) {
+    if (
+      sideEffect.number === 1 &&
+      lastSideEffectNumber === 1 &&
+      (sideEffect.code === "return" ||
+        sideEffect.code === "throw" ||
+        sideEffect.code === "resolve" ||
+        sideEffect.code === "reject")
+    ) {
+      label = null;
+    }
     text = renderText(text, {
       sideEffect,
       sideEffectFileUrl,
@@ -167,11 +177,6 @@ const renderOneSideEffect = (
       replace,
       rootDirectoryUrl,
       errorStackHidden,
-      onRenderError: () => {
-        if (sideEffect.number === 1 && lastSideEffectNumber === 1) {
-          label = null;
-        }
-      },
     });
   }
   if (sideEffect.code === "source_code") {
@@ -208,7 +213,6 @@ const renderText = (
     replace,
     rootDirectoryUrl,
     errorStackHidden,
-    onRenderError = () => {},
   },
 ) => {
   if (text && typeof text === "object") {
@@ -233,21 +237,20 @@ const renderText = (
       return sourceMd;
     }
     if (text.type === "js_value") {
-      const value = text.value;
-      if (value === undefined) {
+      const jsValue = text.value;
+      if (jsValue === undefined) {
         return renderMarkdownBlock("undefined", "js");
       }
       if (
-        value instanceof Error ||
-        (value &&
-          value.constructor &&
-          value.constructor.name.includes("Error") &&
-          value.stack &&
-          typeof value.stack === "string")
+        jsValue instanceof Error ||
+        (jsValue &&
+          jsValue.constructor &&
+          jsValue.constructor.name.includes("Error") &&
+          jsValue.stack &&
+          typeof jsValue.stack === "string")
       ) {
-        onRenderError();
         // return renderMarkdownBlock(text.value.stack);
-        const exception = createException(text.value, { rootDirectoryUrl });
+        const exception = createException(jsValue, { rootDirectoryUrl });
         const exceptionText = errorStackHidden
           ? `${exception.name}: ${exception.message}`
           : exception.stack || exception.message || exception;
@@ -259,14 +262,7 @@ const renderText = (
           replace,
         });
       }
-
-      return renderMarkdownBlock(
-        replace(
-          typeof value === "string" ? value : JSON.stringify(value, null, "  "),
-          { stringType: "json" },
-        ),
-        "js",
-      );
+      return renderMarkdownBlock(replace(jsValue), "js");
     }
     if (text.type === "console") {
       return renderConsole(text.value, {
@@ -279,7 +275,6 @@ const renderText = (
     if (text.type === "file_content") {
       return renderFileContent(text, {
         sideEffect,
-        sideEffectFileUrl,
         replace,
       });
     }
@@ -341,16 +336,18 @@ const renderPotentialAnsi = (
 
 export const renderFileContent = (text, { sideEffect, replace }) => {
   const { url, buffer, outDirectoryReason } = sideEffect.value;
+  const { value } = text;
+  let content = value;
   if (outDirectoryReason) {
-    const { value, outRelativeUrl, urlInsideOutDirectory } = text;
-    writeFileSync(urlInsideOutDirectory, buffer);
+    const { outRelativeUrl, urlInsideOutDirectory } = text;
+    writeFileSync(urlInsideOutDirectory, replace(buffer, { fileUrl: url }));
     let md = "";
     if (
       outDirectoryReason === "lot_of_chars" ||
       outDirectoryReason === "lot_of_lines"
     ) {
       md += "\n";
-      md += renderMarkdownBlock(escapeMarkdownBlockContent(replace(value)));
+      md += renderMarkdownBlock(escapeMarkdownBlockContent(replace(content)));
       const fileLink = renderLinkMarkdown(
         {
           text: outRelativeUrl,
@@ -371,13 +368,14 @@ export const renderFileContent = (text, { sideEffect, replace }) => {
     );
     return md;
   }
-  const { value } = text;
-  let content = value;
-  const extension = urlToExtension(url).slice(1);
-  if (extension === "md") {
+  const extension = urlToExtension(url);
+  if (extension === ".md") {
     content = escapeMarkdownBlockContent(content);
   }
-  return renderMarkdownBlock(replace(content, { fileUrl: url }), extension);
+  return renderMarkdownBlock(
+    replace(content, { fileUrl: url }),
+    extension.slice(1),
+  );
 };
 
 const escapeMarkdownBlockContent = (content) => {