@jsenv/snapshot 2.2.2 → 2.2.4

package/package.json

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

package/src/function_snapshot.js

@@ -1,20 +1,36 @@
-import { readEntryStatSync, readFileSync } from "@jsenv/filesystem";
+import {
+  readEntryStatSync,
+  readFileSync,
+  removeFileSync,
+  writeFileSync,
+} from "@jsenv/filesystem";
 import { urlToRelativeUrl } from "@jsenv/urls/src/url_to_relative_url.js";
-import { takeFileSnapshot } from "./filesystem_snapshot.js";
+import { takeDirectorySnapshot } from "./filesystem_snapshot.js";
 import { replaceFluctuatingValues } from "./replace_fluctuating_values.js";
 
 export const snapshotFunctionSideEffects = (
   fn,
   fnFileUrl,
-  sideEffectFileRelativeUrl,
+  sideEffectDirectoryRelativeUrl,
   {
     rootDirectoryUrl = new URL("./", fnFileUrl),
     captureConsole = true,
     filesystemEffects,
+    filesystemEffectsInline,
+    restoreFilesystem,
   } = {},
 ) => {
-  const sideEffectFileUrl = new URL(sideEffectFileRelativeUrl, fnFileUrl);
-  const sideEffectFileSnapshot = takeFileSnapshot(sideEffectFileUrl);
+  const sideEffectDirectoryUrl = new URL(
+    sideEffectDirectoryRelativeUrl,
+    fnFileUrl,
+  );
+  const sideEffectDirectorySnapshot = takeDirectorySnapshot(
+    sideEffectDirectoryUrl,
+  );
+  const sideEffectFileUrl = new URL(
+    "./side_effect.txt",
+    sideEffectDirectoryUrl,
+  );
   const sideEffects = [];
   const finallyCallbackSet = new Set();
   const onError = (e) => {
@@ -33,10 +49,14 @@ export const snapshotFunctionSideEffects = (
     for (const finallyCallback of finallyCallbackSet) {
       finallyCallback();
     }
-    sideEffectFileSnapshot.update(
-      stringifySideEffects(sideEffects, { rootDirectoryUrl }),
+    writeFileSync(
+      sideEffectFileUrl,
+      stringifySideEffects(sideEffects, {
+        rootDirectoryUrl,
+        filesystemEffectsInline,
+      }),
     );
-    sideEffectFileSnapshot.compare();
+    sideEffectDirectorySnapshot.compare();
   };
   if (captureConsole) {
     const installConsoleSpy = (methodName) => {
@@ -57,9 +77,11 @@ export const snapshotFunctionSideEffects = (
     installConsoleSpy("log");
   }
   if (filesystemEffects) {
+    const fsSideEffectDirectoryUrl = new URL("./fs/", sideEffectDirectoryUrl);
     for (const filesystemEffect of filesystemEffects) {
       const from = new URL(filesystemEffect, fnFileUrl);
       const relativeUrl = urlToRelativeUrl(from, fnFileUrl);
+      const toUrl = new URL(relativeUrl, fsSideEffectDirectoryUrl);
       const atStartState = getFileState(from);
       const onFileSystemSideEffect = (fsSideEffect) => {
         const last = sideEffects.pop();
@@ -73,6 +95,9 @@ export const snapshotFunctionSideEffects = (
             type: `remove file "${relativeUrl}"`,
             value: atStartState.content,
           });
+          if (restoreFilesystem) {
+            writeFileSync(from, atStartState.content);
+          }
           return;
         }
         // we use same type because we don't want to differentiate between
@@ -84,10 +109,27 @@ export const snapshotFunctionSideEffects = (
           atStartState.content !== nowState.content ||
           atStartState.mtimeMs !== nowState.mtimeMs
         ) {
-          onFileSystemSideEffect({
-            type: `write file "${relativeUrl}"`,
-            value: nowState.content,
-          });
+          if (filesystemEffectsInline) {
+            onFileSystemSideEffect({
+              type: `write file "${relativeUrl}"`,
+              value: nowState.content,
+            });
+          } else {
+            writeFileSync(toUrl, nowState.content);
+            onFileSystemSideEffect({
+              type: `write file "${relativeUrl}" (see ./fs/${relativeUrl})`,
+              value: nowState.content,
+            });
+          }
+          if (restoreFilesystem) {
+            if (atStartState.found) {
+              if (atStartState.content !== nowState.content) {
+                writeFileSync(from, atStartState.content);
+              }
+            } else {
+              removeFileSync(from);
+            }
+          }
           return;
         }
         // file is exactly the same
@@ -123,7 +165,10 @@ export const snapshotFunctionSideEffects = (
   }
 };
 
-const stringifySideEffects = (sideEffects, { rootDirectoryUrl }) => {
+const stringifySideEffects = (
+  sideEffects,
+  { rootDirectoryUrl, filesystemEffectsInline },
+) => {
   let string = "";
   let index = 0;
   for (const sideEffect of sideEffects) {
@@ -131,12 +176,28 @@ const stringifySideEffects = (sideEffects, { rootDirectoryUrl }) => {
       string += "\n\n";
     }
     string += `${index + 1}. ${sideEffect.type}`;
-    string += "\n";
     let value = sideEffect.value;
-    if (sideEffect.type === "throw") {
+    if (sideEffect.type.startsWith("console.")) {
+      value = replaceFluctuatingValues(value, {
+        stringType: "console",
+        rootDirectoryUrl,
+      });
+      string += "\n";
+      string += value;
+    } else if (
+      sideEffect.type.startsWith("remove file") ||
+      sideEffect.type.startsWith("write file")
+    ) {
+      if (filesystemEffectsInline) {
+        string += "\n";
+        string += value;
+      }
+    } else if (sideEffect.type === "throw") {
       value = replaceFluctuatingValues(value.stack, {
         stringType: "error",
       });
+      string += "\n";
+      string += value;
     } else if (sideEffect.type === "return") {
       value =
         value === undefined
@@ -145,13 +206,12 @@ const stringifySideEffects = (sideEffects, { rootDirectoryUrl }) => {
               stringType: "json",
               rootDirectoryUrl,
             });
-    } else if (sideEffect.type.startsWith("console.")) {
-      value = replaceFluctuatingValues(value, {
-        stringType: "console",
-        rootDirectoryUrl,
-      });
+      string += "\n";
+      string += value;
+    } else {
+      string += "\n";
+      string += value;
     }
-    string += value;
     index++;
   }
   return string;