@jsenv/snapshot 2.7.0 → 2.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.7.0",
+  "version": "2.7.2",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -12,7 +12,6 @@
     "url": "https://github.com/jsenv/core",
     "directory": "packages/independent/snapshot"
   },
-  "bin": "./src/cli.mjs",
   "engines": {
     "node": ">=20.0.0"
   },
@@ -37,7 +36,7 @@
     "@jsenv/assert": "4.1.13",
     "@jsenv/ast": "6.2.12",
     "@jsenv/exception": "1.0.1",
-    "@jsenv/filesystem": "4.9.7",
+    "@jsenv/filesystem": "4.9.8",
     "@jsenv/terminal-recorder": "1.4.2",
     "@jsenv/urls": "2.5.1",
     "@jsenv/utils": "2.1.2",

package/src/side_effects/filesystem/spy_filesystem_calls.js

@@ -38,7 +38,7 @@ export const spyFilesystemCalls = (
   const fileRestoreMap = new Map();
   const onWriteFileDone = (fileUrl, stateBefore, stateAfter) => {
     if (!stateAfter.found) {
-      // not suppoed to happen but could apparently
+      // seems to be possible somehow
       return;
     }
     // we use same type because we don't want to differentiate between

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/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].md",
-    outDirectoryPattern = "./output/[test_name]/",
-    outFilePattern = "./output/[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;

package/src/cli.mjs

@@ -1,54 +0,0 @@
-#!/usr/bin/env node
-
-import { clearDirectorySync } from "@jsenv/filesystem";
-import { pathToFileURL } from "node:url";
-import { parseArgs } from "node:util";
-
-const options = {
-  help: {
-    type: "boolean",
-  },
-};
-const { values, positionals } = parseArgs({
-  options,
-  allowPositionals: true,
-});
-
-if (values.help || positionals.length === 0) {
-  console.log(`snapshot: Manage snapshot files generated during tests.
-
-Usage: npx @jsenv/snapshot clear [pattern]
-
-https://github.com/jsenv/core/tree/main/packages/independent/snapshot
-
-pattern: files matching this pattern will be removed; can use "*" and "**"
-`);
-  process.exit(0);
-}
-
-const commandHandlers = {
-  clear: (pattern) => {
-    const currentDirectoryPath = process.cwd();
-    const currentDirectoryUrl = pathToFileURL(`${currentDirectoryPath}/`);
-    console.log(`clear files matching ${pattern} in ${currentDirectoryPath}`);
-    clearDirectorySync(currentDirectoryUrl, pattern);
-  },
-};
-
-const [command] = positionals;
-const commandHandler = commandHandlers[command];
-
-if (!commandHandler) {
-  console.error(`Error: unknown command ${command}.`);
-  process.exit(1);
-}
-
-if (commandHandler.length) {
-  const args = positionals.slice(1);
-  if (args.length === 0) {
-    console.error(`Error: "${command}" command expect arguments.`);
-    process.exit(1);
-  }
-}
-
-await commandHandler(...positionals.slice(1));