@jsenv/snapshot 2.3.0 → 2.3.2

package/package.json

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

package/src/function_side_effects/function_side_effects_collector.js

@@ -1,17 +1,16 @@
 import { createException } from "@jsenv/exception";
 import { replaceFluctuatingValues } from "../replace_fluctuating_values.js";
+import { wrapIntoMarkdownBlock } from "./function_side_effects_renderer.js";
 
 const RETURN_PROMISE = {};
 
-let executing = false;
+let functionExecutingCount = 0;
+
 export const collectFunctionSideEffects = (
   fn,
   sideEffectDetectors,
   { rootDirectoryUrl },
 ) => {
-  if (executing) {
-    throw new Error("collectFunctionSideEffects already running");
-  }
   const sideEffects = [];
   const addSideEffect = (sideEffect) => {
     sideEffects.push(sideEffect);
@@ -23,14 +22,32 @@ export const collectFunctionSideEffects = (
       uninstall();
     });
   }
+  if (functionExecutingCount) {
+    // The reason for this warning:
+    // 1. fs side effect detectors is not yet fully compatible with that because
+    //    callback.oncomplete redefinition might be wrong for open, mkdir etc
+    //    (at least this is to be tested)
+    // 2. It's usually a sign code forgets to put await in front of
+    //    collectFunctionSideEffects or snapshotFunctionSideEffects
+    // 3. collectFunctionSideEffects is meant to collect a function side effect
+    //    during unit test. So in unit test the function being tested should be analyized
+    //    and should not in turn analyze an other one
+    console.warn(
+      `collectFunctionSideEffects called while other function(s) side effects are collected`,
+    );
+  }
+  functionExecutingCount++;
+
   const onCatch = (valueThrow) => {
     sideEffects.push({
       type: "throw",
       value: valueThrow,
       label: "throw",
-      text: renderValueThrownOrRejected(
-        createException(valueThrow, { rootDirectoryUrl }),
-        { rootDirectoryUrl },
+      text: wrapIntoMarkdownBlock(
+        renderValueThrownOrRejected(
+          createException(valueThrow, { rootDirectoryUrl }),
+          { rootDirectoryUrl },
+        ),
       ),
     });
   };
@@ -47,9 +64,12 @@ export const collectFunctionSideEffects = (
         type: "return",
         value: valueReturned,
         label: "return",
-        text: renderReturnValueOrResolveValue(valueReturned, {
-          rootDirectoryUrl,
-        }),
+        text: wrapIntoMarkdownBlock(
+          renderReturnValueOrResolveValue(valueReturned, {
+            rootDirectoryUrl,
+          }),
+          "js",
+        ),
       });
     }
   };
@@ -58,7 +78,10 @@ export const collectFunctionSideEffects = (
       type: "resolve",
       value,
       label: "resolve",
-      text: renderReturnValueOrResolveValue(value, { rootDirectoryUrl }),
+      text: wrapIntoMarkdownBlock(
+        renderReturnValueOrResolveValue(value, { rootDirectoryUrl }),
+        "js",
+      ),
     });
   };
   const onReject = (reason) => {
@@ -66,14 +89,16 @@ export const collectFunctionSideEffects = (
       type: "reject",
       value: reason,
       label: "reject",
-      text: renderValueThrownOrRejected(
-        createException(reason, { rootDirectoryUrl }),
-        { rootDirectoryUrl },
+      text: wrapIntoMarkdownBlock(
+        renderValueThrownOrRejected(
+          createException(reason, { rootDirectoryUrl }),
+          { rootDirectoryUrl },
+        ),
       ),
     });
   };
   const onFinally = () => {
-    executing = false;
+    functionExecutingCount--;
     for (const finallyCallback of finallyCallbackSet) {
       finallyCallback();
     }

package/src/function_side_effects/function_side_effects_renderer.js

@@ -16,3 +16,11 @@ export const renderSideEffects = (sideEffects) => {
   }
   return string;
 };
+
+export const wrapIntoMarkdownBlock = (value, blockName) => {
+  const start = "```";
+  const end = "```";
+  return `${start}${blockName}
+${value}
+${end}`;
+};

package/src/function_side_effects/function_side_effects_snapshot.js

@@ -1,18 +1,20 @@
 import { writeFileSync } from "@jsenv/filesystem";
 import {
   ensurePathnameTrailingSlash,
+  urlToExtension,
   urlToFilename,
   urlToRelativeUrl,
 } from "@jsenv/urls";
 import { takeDirectorySnapshot } from "../filesystem_snapshot.js";
 import { replaceFluctuatingValues } from "../replace_fluctuating_values.js";
 import { collectFunctionSideEffects } from "./function_side_effects_collector.js";
-import { renderSideEffects } from "./function_side_effects_renderer.js";
+import {
+  renderSideEffects,
+  wrapIntoMarkdownBlock,
+} from "./function_side_effects_renderer.js";
 import { spyConsoleCalls } from "./spy_console_calls.js";
 import { spyFilesystemCalls } from "./spy_filesystem_calls.js";
 
-let filesystemSideEffectInstalled;
-
 export const snapshotFunctionSideEffects = (
   fn,
   fnFileUrl,
@@ -34,7 +36,7 @@ export const snapshotFunctionSideEffects = (
   const sideEffectDirectorySnapshot = takeDirectorySnapshot(
     sideEffectDirectoryUrl,
   );
-  const sideEffectFilename = `${urlToFilename(sideEffectDirectoryUrl)}_side_effects.txt`;
+  const sideEffectFilename = `${urlToFilename(sideEffectDirectoryUrl)}_side_effects.md`;
   const sideEffectFileUrl = new URL(sideEffectFilename, sideEffectDirectoryUrl);
   const callbackSet = new Set();
   const sideEffectDetectors = [
@@ -46,10 +48,13 @@ export const snapshotFunctionSideEffects = (
             type: `console:${methodName}`,
             value: message,
             label: `console.${methodName}`,
-            text: replaceFluctuatingValues(message, {
-              stringType: "console",
-              rootDirectoryUrl,
-            }),
+            text: wrapIntoMarkdownBlock(
+              replaceFluctuatingValues(message, {
+                stringType: "console",
+                rootDirectoryUrl,
+              }),
+              "console",
+            ),
           });
         };
         const consoleSpy = spyConsoleCalls(
@@ -79,12 +84,6 @@ export const snapshotFunctionSideEffects = (
     {
       name: "filesystem",
       install: (addSideEffect) => {
-        if (filesystemSideEffectInstalled) {
-          throw new Error(
-            "cannot collect filesystem side effects concurrently (already collecting side effect for an other function)",
-          );
-        }
-        filesystemSideEffectInstalled = true;
         const fsSideEffectDirectoryUrl = ensurePathnameTrailingSlash(
           new URL(filesystemEffectsDirectory, sideEffectDirectoryUrl),
         );
@@ -112,7 +111,10 @@ export const snapshotFunctionSideEffects = (
                   type: "fs:write_file",
                   value: { relativeUrl, content },
                   label: `write file "${relativeUrl}"`,
-                  text: content,
+                  text: wrapIntoMarkdownBlock(
+                    content,
+                    urlToExtension(url).slice(1),
+                  ),
                 });
               }
             },
@@ -132,7 +134,6 @@ export const snapshotFunctionSideEffects = (
         );
         return () => {
           filesystemSpy.restore();
-          filesystemSideEffectInstalled = false;
         };
       },
     },