@jsenv/snapshot 2.8.5 → 2.8.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.8.5",
+  "version": "2.8.7",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "@jsenv/assert": "4.1.15",
-    "@jsenv/ast": "6.2.14",
+    "@jsenv/ast": "6.2.15",
     "@jsenv/exception": "1.0.2",
     "@jsenv/filesystem": "4.9.10",
     "@jsenv/terminal-recorder": "1.4.4",

package/src/filesystem_well_known_values.js

@@ -58,7 +58,6 @@ export const createWellKnown = (name, replacement = name) => {
 
 export const createReplaceFilesystemWellKnownValues = ({
   rootDirectoryUrl,
-  localhostUrl,
   // for unit tests
   isWindows = process.platform === "win32",
   ancestorPackagesDisabled,
@@ -127,32 +126,9 @@ export const createReplaceFilesystemWellKnownValues = ({
       }
     };
   };
-  const addWellKnownUrl = (url, replacement) => {
-    const wellKnownUrl = {
-      url,
-      replace: (string) => {
-        return string.replaceAll(url, replacement);
-      },
-    };
-    wellKownUrlArray.push(wellKnownUrl);
-    return () => {
-      const urlIndex = wellKownUrlArray.indexOf(wellKnownUrl);
-      if (urlIndex > -1) {
-        wellKownUrlArray.splice(urlIndex, 1);
-      }
-    };
-  };
   if (rootDirectoryUrl) {
     addWellKnownFileUrl(rootDirectoryUrl, WELL_KNOWN_ROOT);
   }
-  if (localhostUrl) {
-    addWellKnownUrl(
-      localhostUrl,
-      localhostUrl.startsWith("https")
-        ? "https://localhost"
-        : "http://localhost",
-    );
-  }
   /*
    * When running code inside a node project ancestor packages
    * should make things super predictible because

package/src/replace_fluctuating_values.js

@@ -21,13 +21,11 @@ export const replaceFluctuatingValues = (
   {
     stringType,
     rootDirectoryUrl,
-    localhostUrl,
     fileUrl,
     preserveAnsi,
     // for unit test
     replaceFilesystemWellKnownValues = createReplaceFilesystemWellKnownValues({
       rootDirectoryUrl,
-      localhostUrl,
     }),
   } = {},
 ) => {
@@ -191,6 +189,12 @@ const replaceInObject = (object, { replace }) => {
 };
 
 const replaceHttpUrls = (source) => {
+  source = source.replace(/(https?):\/\/localhost:\d+/, (match, protocol) => {
+    return `${protocol}://localhost`;
+  });
+  source = source.replace(/(https?):\/\/\[::1\]:\d+/, (match, protocol) => {
+    return `${protocol}://[::1]`;
+  });
   return source;
   // return source.replace(/(?:https?|ftp):\/\/\S+[\w/]/g, (match) => {
   //   const lastChar = match[match.length - 1];

package/src/side_effects/log/log_side_effects.js

@@ -5,6 +5,7 @@ import { groupLogSideEffects } from "./group_log_side_effects.js";
 const logSideEffectsOptionsDefault = {
   prevent: true,
   group: true,
+  ignore: false,
 };
 
 export const logSideEffects = (logSideEffectsOptions) => {
@@ -15,7 +16,7 @@ export const logSideEffects = (logSideEffectsOptions) => {
   return {
     name: "console",
     install: (addSideEffect, { addFinallyCallback }) => {
-      const { prevent, group } = logSideEffectsOptions;
+      const { prevent, group, ignore } = logSideEffectsOptions;
       if (group) {
         addFinallyCallback((sideEffects) => {
           groupLogSideEffects(sideEffects, {
@@ -60,6 +61,9 @@ export const logSideEffects = (logSideEffectsOptions) => {
         });
       }
       const addLogSideEffect = (type, message) => {
+        if (ignore) {
+          return;
+        }
         addSideEffect({
           code: type,
           type,

package/src/side_effects/snapshot_tests.js

@@ -12,6 +12,9 @@ import { renderSideEffects, renderSmallLink } from "./render_side_effects.js";
  * @param {Object} snapshotTestsOptions
  * @param {string|url} snapshotTestsOptions.outFilePattern
  * @param {string|url} snapshotTestsOptions.rootDirectoryUrl
+ * @param {Object} [snapshotTestsOptions.filesystemActions]
+ *        Control what to do when there is a file side effect
+ *        "compare", "compare_presence_only", "undo", "ignore"
  * @param {Object|boolean} [snapshotTestsOptions.filesystemEffects]
  * @param {boolean} [snapshotTestsOptions.filesystemEffects.textualFilesInline=false]
  *        Put textual files content in the markdown (instead of separate files).
@@ -43,6 +46,11 @@ export const snapshotTests = async (
     throwWhenDiff = process.env.CI,
   } = {},
 ) => {
+  filesystemActions = {
+    ...filesystemActions,
+    "**/*.svg": "presence_only",
+  };
+
   const sourceName = urlToBasename(sourceFileUrl, true);
   const sourceBasename = urlToBasename(sourceFileUrl);
   const sourceFilename = urlToFilename(sourceFileUrl);
@@ -56,10 +64,6 @@ export const snapshotTests = async (
     return outFileUrl;
   };
   const outDirectoryUrl = generateOutFileUrl("");
-  const outDirectorySnapshot = takeDirectorySnapshot(
-    outDirectoryUrl,
-    filesystemActions,
-  );
   const sideEffectMdFileUrl = generateOutFileUrl(`${sourceFilename}.md`);
 
   const dirUrlMap = new Map();
@@ -78,9 +82,28 @@ export const snapshotTests = async (
     }
     onlyTestMap.set(scenario, { fn, options, callSite: getCallerLocation(2) });
   };
-  fnRegisteringTest({ test });
+  const fnReturnValue = await fnRegisteringTest({ test });
 
-  const activeTestMap = onlyTestMap.size ? onlyTestMap : testMap;
+  let activeTestMap;
+  const toIgnoreActions = {};
+  if (onlyTestMap.size) {
+    activeTestMap = onlyTestMap;
+    for (const [scenario] of testMap) {
+      const testScenario = asValidFilename(scenario);
+      const generateScenarioOutFileUrl = (outfilename) => {
+        return generateOutFileUrl(`${testScenario}/${outfilename}`);
+      };
+      const scenarioOutDirectoryUrl = generateScenarioOutFileUrl("");
+      toIgnoreActions[scenarioOutDirectoryUrl] = "ignore";
+    }
+  } else {
+    activeTestMap = testMap;
+  }
+  // ignore tout ceux aui sont désactivé
+  const outDirectorySnapshot = takeDirectorySnapshot(outDirectoryUrl, {
+    ...filesystemActions,
+    ...toIgnoreActions,
+  });
   const captureSideEffects = createCaptureSideEffects({
     sourceFileUrl,
     rootDirectoryUrl,
@@ -107,7 +130,6 @@ export const snapshotTests = async (
     markdown += "\n\n";
     markdown += generatedByLink;
   }
-
   const scenarioDirs = [];
   for (const [scenario, { fn, callSite }] of activeTestMap) {
     markdown += "\n\n";
@@ -135,6 +157,9 @@ export const snapshotTests = async (
     });
     markdown += sideEffectsMarkdown;
   }
+  if (typeof fnReturnValue === "function") {
+    await fnReturnValue();
+  }
   // if (sideEffectFilePattern === "./side_effects/[filename]/[filename].md") {
   //   const scenarioParentDirUrl = new URL("./", sideEffectFileUrl);
   //   const dirContent = readDirectorySync(scenarioParentDirUrl);