@jsenv/snapshot 2.6.11 → 2.7.1

package/package.json

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

package/src/replace_fluctuating_values.js

@@ -21,7 +21,7 @@ export const replaceFluctuatingValues = (
     stringType,
     rootDirectoryUrl,
     fileUrl,
-    removeAnsi = true,
+    preserveAnsi,
     // for unit test
     replaceFilesystemWellKnownValues = createReplaceFilesystemWellKnownValues({
       rootDirectoryUrl,
@@ -51,7 +51,7 @@ export const replaceFluctuatingValues = (
     if (stringType === "filesystem") {
       return replaceFilesystemWellKnownValues(value);
     }
-    if (removeAnsi) {
+    if (!preserveAnsi) {
       value = stripAnsi(value);
     }
     value = replaceFilesystemWellKnownValues(value, {

package/src/side_effects/filesystem/spy_filesystem_calls.js

@@ -37,6 +37,10 @@ export const spyFilesystemCalls = (
   const fileDescriptorPathMap = new Map();
   const fileRestoreMap = new Map();
   const onWriteFileDone = (fileUrl, stateBefore, stateAfter) => {
+    if (!stateAfter.found) {
+      // seems to be possible somehow
+      return;
+    }
     // we use same type because we don't want to differentiate between
     // - writing file for the 1st time
     // - updating file content

package/src/side_effects/hook_into_method.js

@@ -29,6 +29,9 @@ export const hookIntoMethod = (
     const callHooks = (hookCallbackSet, ...args) => {
       hookExecuting = true;
       for (const hookCallback of hookCallbackSet) {
+        if (!hookCallback.initCallback.installed) {
+          continue;
+        }
         hookCallback(...args);
       }
       hookExecuting = false;
@@ -62,15 +65,19 @@ export const hookIntoMethod = (
           allWantsToPreventOriginalCall = false;
         }
         if (hooks.returnPromise) {
+          hooks.returnPromise.initCallback = initCallback;
           returnPromiseCallbackSet.add(hooks.returnPromise);
         }
         if (hooks.return) {
+          hooks.return.initCallback = initCallback;
           returnCallbackSet.add(hooks.return);
         }
         if (hooks.catch) {
+          hooks.catch.initCallback = initCallback;
           catchCallbackSet.add(hooks.catch);
         }
         if (hooks.finally) {
+          hooks.finally.initCallback = initCallback;
           finallyCallbackSet.add(hooks.catch);
         }
       }
@@ -124,6 +131,7 @@ export const hookIntoMethod = (
     };
     object[method] = proxy;
   }
+  initCallback.installed = true;
   addInitCallback(initCallback);
   const hook = {
     disable: () => {
@@ -133,6 +141,7 @@ export const hookIntoMethod = (
       initCallback.disabled = false;
     },
     remove: () => {
+      initCallback.installed = false;
       removeInitCallback(initCallback);
     },
   };
@@ -220,7 +229,9 @@ export const METHOD_EXECUTION_NODE_CALLBACK = ({
         // useless because are a copy of the args
         // so the mutation we do above ( args[lastArgIndex] =)
         // cannot be important for the method being proxied
-        args[lastArgIndex] = lastArg;
+        if (args[lastArgIndex] === callbackProxy) {
+          args[lastArgIndex] = lastArg;
+        }
       };
     });
   }
@@ -230,7 +241,9 @@ export const METHOD_EXECUTION_NODE_CALLBACK = ({
       return installProxyAndCall(originalCallback, (callbackProxy) => {
         lastArg.context.callback = callbackProxy;
         return () => {
-          lastArg.context.callback = originalCallback;
+          if (lastArg.context.callback === callbackProxy) {
+            lastArg.context.callback = originalCallback;
+          }
         };
       });
     }
@@ -239,7 +252,9 @@ export const METHOD_EXECUTION_NODE_CALLBACK = ({
       return installProxyAndCall(originalCallback, (callbackProxy) => {
         lastArg.oncomplete = callbackProxy;
         return () => {
-          lastArg.oncomplete = originalCallback;
+          if (lastArg.oncomplete === callbackProxy) {
+            lastArg.oncomplete = originalCallback;
+          }
         };
       });
     }

package/src/side_effects/render_side_effects.js

@@ -246,6 +246,7 @@ const renderText = (
           typeof value.stack === "string")
       ) {
         onRenderError();
+        // return renderMarkdownBlock(text.value.stack);
         const exception = createException(text.value, { rootDirectoryUrl });
         const exceptionText = errorStackHidden
           ? `${exception.name}: ${exception.message}`
@@ -306,24 +307,36 @@ const renderPotentialAnsi = (
   string,
   { stringType, sideEffect, sideEffectFileUrl, generateOutFileUrl, replace },
 ) => {
+  const rawTextBlock = renderMarkdownBlock(
+    replace(string, { stringType }),
+    "console",
+  );
   // for assert we want ideally hummm
   // colored in details block?
   const includesAnsi = ansiRegex().test(string);
   if (!includesAnsi) {
-    return renderMarkdownBlock(replace(string, { stringType }), "console");
+    return rawTextBlock;
   }
   const svgFilename = `${sideEffect.code}${sideEffect.counter ? `_${sideEffect.counter}` : ""}.svg`;
   const svgFileUrl = generateOutFileUrl(svgFilename);
-  let svgFileContent = renderTerminalSvg(string, {
-    head: false,
-    paddingTop: 10,
-    paddingBottom: 10,
-  });
+  let svgFileContent = renderTerminalSvg(
+    replace(string, { stringType: "console", preserveAnsi: true }),
+    {
+      head: false,
+      paddingTop: 10,
+      paddingBottom: 10,
+    },
+  );
   svgFileContent = replace(svgFileContent, { fileUrl: svgFileUrl });
   writeFileSync(svgFileUrl, svgFileContent);
   const svgFileRelativeUrl = urlToRelativeUrl(svgFileUrl, sideEffectFileUrl);
-  return `![img](${svgFileRelativeUrl})`;
-  // we will write a svg file
+  let md = `![img](${svgFileRelativeUrl})`;
+  md += "\n\n";
+  md += renderMarkdownDetails(`${rawTextBlock}`, {
+    summary: "see without style",
+  });
+  md += "\n";
+  return md;
 };
 
 export const renderFileContent = (text, { sideEffect, replace }) => {

package/src/side_effects/snapshot_side_effects.js

@@ -11,21 +11,21 @@ export const snapshotSideEffects = (
   fn,
   {
     sideEffectFileUrl,
-    sideEffectFilePattern = "./output/[basename].md",
-    outDirectoryPattern = "./output/[basename]/",
-    outFilePattern = "./output/[basename]/[filename]",
+    outDirectoryPattern = "./side_effects/",
+    sideEffectFilePattern = "./side_effects/[basename].md",
+    outFilePattern = "./side_effects/[name]/[filename]",
     generateOutFileUrl,
     outDirectoryUrl,
     errorStackHidden,
     ...captureOptions
   } = {},
 ) => {
-  const basename = urlToBasename(sourceFileUrl, true);
+  const name = urlToBasename(sourceFileUrl, true);
+  const basename = urlToBasename(sourceFileUrl);
   if (sideEffectFileUrl === undefined) {
-    const sideEffectFileRelativeUrl = sideEffectFilePattern.replaceAll(
-      "[basename]",
-      basename,
-    );
+    const sideEffectFileRelativeUrl = sideEffectFilePattern
+      .replaceAll("[basename]", basename)
+      .replaceAll("[name]", name);
     sideEffectFileUrl = new URL(sideEffectFileRelativeUrl, sourceFileUrl);
   } else {
     sideEffectFileUrl = new URL(sideEffectFileUrl, sourceFileUrl);
@@ -42,6 +42,7 @@ export const snapshotSideEffects = (
   if (generateOutFileUrl === undefined) {
     generateOutFileUrl = (filename) => {
       const outRelativeUrl = outFilePattern
+        .replaceAll("[name]", name)
         .replaceAll("[basename]", basename)
         .replaceAll("[filename]", filename);
       const outFileUrl = new URL(outRelativeUrl, new URL("./", sourceFileUrl))

package/src/side_effects/snapshot_tests.js

@@ -1,4 +1,4 @@
-import { urlToBasename, urlToFilename, urlToRelativeUrl } from "@jsenv/urls";
+import { urlToBasename, urlToRelativeUrl } from "@jsenv/urls";
 import {
   takeDirectorySnapshot,
   takeFileSnapshot,
@@ -22,9 +22,9 @@ export const snapshotTests = async (
   {
     testName = urlToBasename(testFileUrl, true),
     sideEffectFileUrl,
-    sideEffectFilePattern = "./output/[test_name]/[test_name].md",
-    outDirectoryPattern = "./output/[test_name]/",
-    outFilePattern = "./output/[test_name]/[test_scenario]_[filename]",
+    outDirectoryPattern = "./side_effects/",
+    sideEffectFilePattern = "./side_effects/[test_basename].md",
+    outFilePattern = "./side_effects/[test_name]/[test_scenario]/[filename]",
     rootDirectoryUrl,
     generatedBy = true,
     linkToSource = true,
@@ -35,11 +35,11 @@ export const snapshotTests = async (
     throwWhenDiff = process.env.CI,
   } = {},
 ) => {
+  const testBasename = urlToBasename(testFileUrl);
   if (sideEffectFileUrl === undefined) {
-    const sideEffectFileRelativeUrl = sideEffectFilePattern.replaceAll(
-      "[test_name]",
-      testName,
-    );
+    const sideEffectFileRelativeUrl = sideEffectFilePattern
+      .replaceAll("[test_name]", testName)
+      .replaceAll("[test_basename]", testBasename);
     sideEffectFileUrl = new URL(sideEffectFileRelativeUrl, testFileUrl);
   } else {
     sideEffectFileUrl = new URL(sideEffectFileUrl, testFileUrl);
@@ -62,7 +62,7 @@ export const snapshotTests = async (
     filesystemEffects,
   });
   let markdown = "";
-  markdown += `# ${urlToFilename(sideEffectFileUrl)}`;
+  markdown += `# ${testName}`;
   if (generatedBy) {
     let generatedByLink = renderSmallLink(
       {
@@ -103,6 +103,7 @@ export const snapshotTests = async (
     const generateOutFileUrl = (filename) => {
       const outFileRelativeUrl = outFilePattern
         .replaceAll("[test_name]", testName)
+        .replaceAll("[test_basename]", testBasename)
         .replaceAll("[test_scenario]", testScenario)
         .replaceAll("[filename]", filename);
       const outFileUrl = new URL(outFileRelativeUrl, testFileUrl).href;