@jsenv/snapshot 2.8.3 → 2.8.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.8.3",
+  "version": "2.8.4",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {

package/src/side_effects/filesystem/spy_filesystem_calls.js

@@ -9,7 +9,7 @@ import {
   writeFileSync,
 } from "@jsenv/filesystem";
 import { URL_META } from "@jsenv/url-meta";
-import { yieldAncestorUrls } from "@jsenv/urls";
+import { ensurePathnameTrailingSlash, yieldAncestorUrls } from "@jsenv/urls";
 import { readFileSync, statSync } from "node:fs";
 import { pathToFileURL } from "node:url";
 import {
@@ -101,7 +101,9 @@ export const spyFilesystemCalls = (
     _internalFs,
     "mkdir",
     (directoryPath, mode, recursive) => {
-      const directoryUrl = pathToFileURL(directoryPath);
+      const directoryUrl = ensurePathnameTrailingSlash(
+        pathToFileURL(directoryPath),
+      );
       const stateBefore = getDirectoryState(directoryPath);
       if (!stateBefore.found && recursive) {
         const ancestorNotFoundArray = [];
@@ -110,7 +112,9 @@ export const spyFilesystemCalls = (
           if (ancestorState.found) {
             break;
           }
-          ancestorNotFoundArray.unshift(ancestorUrl);
+          ancestorNotFoundArray.unshift(
+            ensurePathnameTrailingSlash(ancestorUrl),
+          );
         }
         return {
           return: (fd) => {
@@ -151,6 +155,13 @@ export const spyFilesystemCalls = (
     },
     { execute: METHOD_EXECUTION_NODE_CALLBACK },
   );
+  /*
+   * Relying on open/close to detect writes is done to be able to catch
+   * write done async, not sure how to distinguish open/close done to write
+   * from open/close done to read file stat
+   * open/close for file stat are excluded because we compare stateBefore/stateAfter
+   * but ideally we would early return by detecting open/close is not for write operations
+   */
   const closeHook = hookIntoMethod(
     _internalFs,
     "close",

package/src/side_effects/log/log_side_effects.js

@@ -4,7 +4,7 @@ import { groupLogSideEffects } from "./group_log_side_effects.js";
 
 const logSideEffectsOptionsDefault = {
   prevent: true,
-  group: false,
+  group: true,
 };
 
 export const logSideEffects = (logSideEffectsOptions) => {

package/src/side_effects/render_side_effects.js

@@ -50,6 +50,7 @@ export const renderSideEffects = (
       dedicatedFile: { line: 50, length: 5000 },
     }),
     errorStackHidden,
+    errorMessageTransform,
   } = {},
 ) => {
   const { rootDirectoryUrl, replaceFilesystemWellKnownValues } =
@@ -93,6 +94,7 @@ export const renderSideEffects = (
       getBigSizeEffect,
       replace,
       errorStackHidden,
+      errorMessageTransform,
       lastSideEffectNumber,
     });
   }
@@ -141,6 +143,7 @@ const renderOneSideEffect = (
     getBigSizeEffect,
     replace,
     errorStackHidden,
+    errorMessageTransform,
     lastSideEffectNumber,
   },
 ) => {
@@ -177,6 +180,7 @@ const renderOneSideEffect = (
       replace,
       rootDirectoryUrl,
       errorStackHidden,
+      errorMessageTransform,
     });
   }
   if (sideEffect.code === "source_code") {
@@ -213,6 +217,7 @@ const renderText = (
     replace,
     rootDirectoryUrl,
     errorStackHidden,
+    errorMessageTransform,
   },
 ) => {
   if (text && typeof text === "object") {
@@ -250,7 +255,10 @@ const renderText = (
           typeof jsValue.stack === "string")
       ) {
         // return renderMarkdownBlock(text.value.stack);
-        const exception = createException(jsValue, { rootDirectoryUrl });
+        const exception = createException(jsValue, {
+          rootDirectoryUrl,
+          errorMessageTransform,
+        });
         const exceptionText = errorStackHidden
           ? `${exception.name}: ${exception.message}`
           : exception.stack || exception.message || exception;

package/src/side_effects/snapshot_tests.js

@@ -30,6 +30,7 @@ export const snapshotTests = async (
     linkToSource = true,
     linkToEachSource,
     errorStackHidden,
+    errorMessageTransform,
     logEffects,
     filesystemEffects,
     throwWhenDiff = process.env.CI,
@@ -89,6 +90,15 @@ export const snapshotTests = async (
     markdown += generatedByLink;
   }
 
+  const outDirectoryRelativeUrl = outDirectoryPattern.replaceAll(
+    "[test_name]",
+    testName,
+  );
+  const outDirectoryUrl = new URL(outDirectoryRelativeUrl, testFileUrl);
+  const outDirectorySnapshot = takeDirectorySnapshot(outDirectoryUrl, {
+    "**/*": true,
+    "**/*.svg": "presence_only",
+  });
   for (const [scenario, { fn, callSite }] of activeTestMap) {
     markdown += "\n\n";
     markdown += `## ${scenario}`;
@@ -99,16 +109,6 @@ export const snapshotTests = async (
     });
     sideEffectsMap.set(scenario, sideEffects);
     const testScenario = asValidFilename(scenario);
-    let outDirectoryRelativeUrl = outDirectoryPattern
-      .replaceAll("[test_name]", testName)
-      .replaceAll("[test_scenario]", testScenario);
-    const outDirectoryUrl = new URL(outDirectoryRelativeUrl, testFileUrl);
-    const outDirectorySnapshot = takeDirectorySnapshot(outDirectoryUrl, {
-      pattern: {
-        "**/*": true,
-        "**/*.svg": "presence_only",
-      },
-    });
     const generateOutFileUrl = (filename) => {
       const outFileRelativeUrl = outFilePattern
         .replaceAll("[test_name]", testName)
@@ -127,8 +127,8 @@ export const snapshotTests = async (
       generatedBy: false,
       titleLevel: 3,
       errorStackHidden,
+      errorMessageTransform,
     });
-    outDirectorySnapshot.compare(throwWhenDiff);
     markdown += sideEffectsMarkdown;
   }
   const sideEffectFileSnapshot = takeFileSnapshot(sideEffectFileUrl);
@@ -136,6 +136,7 @@ export const snapshotTests = async (
     mockFluctuatingValues: false,
     throwWhenDiff,
   });
+  outDirectorySnapshot.compare(throwWhenDiff);
 
   return { dirUrlMap, sideEffectsMap };
 };