@jsenv/snapshot 2.13.9 → 2.14.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.13.9",
+  "version": "2.14.1",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -31,14 +31,14 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@jsenv/assert": "4.4.4",
-    "@jsenv/ast": "6.6.6",
+    "@jsenv/assert": "4.4.5",
+    "@jsenv/ast": "6.6.7",
     "@jsenv/exception": "1.1.7",
-    "@jsenv/humanize": "1.3.1",
-    "@jsenv/filesystem": "4.14.5",
-    "@jsenv/terminal-recorder": "1.5.8",
-    "@jsenv/urls": "2.7.0",
-    "@jsenv/utils": "2.2.1",
+    "@jsenv/humanize": "1.4.0",
+    "@jsenv/filesystem": "4.14.6",
+    "@jsenv/terminal-recorder": "1.5.10",
+    "@jsenv/urls": "2.7.1",
+    "@jsenv/utils": "2.3.0",
     "ansi-regex": "6.1.0",
     "pixelmatch": "7.1.0",
     "prettier": "3.5.3",

package/src/main.js

@@ -5,6 +5,7 @@ export {
 export { createReplaceFilesystemWellKnownValues } from "./filesystem_well_known_values.js";
 export { getCallerLocation } from "./get_caller_location.js";
 export { replaceFluctuatingValues } from "./replace_fluctuating_values.js";
+export { captureLogsIntoFile } from "./side_effects/capture_logs_into_file.js";
 export { renderLogsGif } from "./side_effects/render_logs_gif.js";
 export { snapshotSideEffects } from "./side_effects/snapshot_side_effects.js";
 export { snapshotTests } from "./side_effects/snapshot_tests.js";

package/src/side_effects/capture_logs_into_file.js

@@ -0,0 +1,14 @@
+import { createCaptureSideEffects } from "./create_capture_side_effects.js";
+import { renderLogsSvg } from "./render_logs_svg.js";
+
+export const captureLogsIntoFile = async (fn, { svgFileUrl }) => {
+  const capture = createCaptureSideEffects({
+    executionEffects: false,
+    filesystemEffects: false,
+    logEffects: {
+      group: false,
+    },
+  });
+  const sideEffects = await capture(fn);
+  renderLogsSvg(sideEffects, svgFileUrl);
+};

package/src/side_effects/filesystem/spy_filesystem_calls.js

@@ -4,7 +4,7 @@
 // https://github.com/tschaub/mock-fs/issues/348
 
 import {
-  comparePathnames,
+  compareFileUrls,
   removeDirectorySync,
   removeFileSync,
   writeFileSync,
@@ -335,12 +335,7 @@ export const spyFilesystemCalls = (
       }
       fileRestoreMap.clear();
       const dirUrls = Array.from(dirRestoreMap.keys());
-      dirUrls.sort((left, right) => {
-        return comparePathnames(
-          new URL(left).pathname,
-          new URL(right).pathname,
-        );
-      });
+      dirUrls.sort(compareFileUrls);
       for (const dirUrl of dirUrls) {
         const restore = dirRestoreMap.get(dirUrl);
         restore();

package/src/side_effects/log/log_side_effects.js

@@ -71,7 +71,7 @@ export const logSideEffects = (logSideEffectsOptions) => {
               const logGroupSideEffect = {
                 code: "log_group",
                 type: `log_group`,
-                value: {},
+                value: {}, // TODO: the concatenation of the logs
                 render: {
                   md: (options) => {
                     const renderLogGroup = () => {

package/src/side_effects/render_logs_gif.js

@@ -2,7 +2,7 @@ import { writeFileSync } from "@jsenv/filesystem";
 import { startTerminalRecording } from "@jsenv/terminal-recorder";
 import { isLogSideEffect } from "./log/log_side_effects.js";
 
-export const renderLogsGif = async (sideEffects, gitFileUrl) => {
+export const renderLogsGif = async (sideEffects, gifFileUrl) => {
   const terminalRecorder = await startTerminalRecording({
     gif: true,
   });
@@ -15,5 +15,5 @@ export const renderLogsGif = async (sideEffects, gitFileUrl) => {
   }
   const result = await terminalRecorder.stop();
   const gif = await result.gif();
-  writeFileSync(new URL(gitFileUrl), gif);
+  writeFileSync(new URL(gifFileUrl), gif);
 };

package/src/side_effects/render_logs_svg.js

@@ -0,0 +1,27 @@
+import { writeFileSync } from "@jsenv/filesystem";
+import { startTerminalRecording } from "@jsenv/terminal-recorder";
+import { isLogSideEffect } from "./log/log_side_effects.js";
+
+export const renderLogsSvg = async (
+  sideEffects,
+  svgFileUrl,
+  svgOptions = {},
+) => {
+  const terminalRecorder = await startTerminalRecording({
+    svg: {
+      title: "Terminal",
+      width: "auto",
+      ...svgOptions,
+    },
+  });
+  for (const sideEffect of sideEffects) {
+    if (isLogSideEffect(sideEffect)) {
+      await terminalRecorder.write(`${sideEffect.value}\n`, {
+        delay: sideEffect.delay,
+      });
+    }
+  }
+  const result = await terminalRecorder.stop();
+  const svg = await result.svg();
+  writeFileSync(new URL(svgFileUrl), svg);
+};

package/src/side_effects/snapshot_tests.js

@@ -31,10 +31,17 @@ import { renderSideEffects, renderSmallLink } from "./render_side_effects.js";
  *        Urls of filesystem side effects will be relative to this base directory
  *        Default to the directory containing @sourceFileUrl
  */
+let preconfiguredOptions = null;
 export const snapshotTests = async (
   sourceFileUrl,
   fnRegisteringTest,
-  {
+  options = {},
+) => {
+  if (preconfiguredOptions) {
+    Object.assign(options, preconfiguredOptions);
+    preconfiguredOptions = null;
+  }
+  let {
     outFilePattern = "./_[source_filename]/[filename]",
     filesystemActions,
     rootDirectoryUrl,
@@ -43,11 +50,10 @@ export const snapshotTests = async (
     logEffects,
     filesystemEffects,
     throwWhenDiff = process.env.CI,
-  } = {},
-) => {
+  } = options;
   filesystemActions = {
     "**": "compare",
-    ...filesystemActions,
+    ...options.filesystemActions,
     "**/*.svg": "compare_presence_only",
   };
 
@@ -222,6 +228,17 @@ export const snapshotTests = async (
 
   return { dirUrlMap, sideEffectsMap };
 };
+// preConfigure is just so that when we update the snapshot test options
+// it does not influence too much the formatting
+// snapshotTests(import.meta.url, ({ test }) => { }, options)
+// becomes
+// snapshotTests.prefConfigure(options)
+// snapshotTests(import.meta.url, ({ test }) => { })
+// which are equivalent
+
+snapshotTests.prefConfigure = (options) => {
+  preconfiguredOptions = options;
+};
 
 // see https://github.com/parshap/node-sanitize-filename/blob/master/index.js
 const asValidFilename = (string) => {