@jsenv/filesystem 4.2.6 → 4.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/filesystem",
-  "version": "4.2.6",
+  "version": "4.3.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -16,6 +16,9 @@
     "url": "https://twitter.com/damienmaillard"
   },
   "type": "module",
+  "engines": {
+    "node": ">=19.1.0"
+  },
   "exports": {
     ".": {
       "import": "./src/main.js"

package/src/internal/createWatcher.js

@@ -16,7 +16,9 @@ export const createWatcher = (sourcePath, options) => {
           if (e.code === "ENOENT") {
             return;
           }
-          console.error(`error while fixing windows eperm: ${e.stack}`);
+          console.error(
+            `error while trying to get rid of windows EPERM: ${e.stack}`,
+          );
           throw error;
         }
       } else {

package/src/registerDirectoryLifecycle.js

@@ -8,9 +8,7 @@ import { guardTooFastSecondCallPerFile } from "./internal/guard_second_call.js";
 import { createWatcher } from "./internal/createWatcher.js";
 import { trackResources } from "./internal/track_resources.js";
 
-const isLinux = process.platform === "linux";
-// linux does not support recursive option
-const fsWatchSupportsRecursive = !isLinux;
+const fsWatchSupportsRecursive = process.platform !== "linux";
 
 export const registerDirectoryLifecycle = (
   source,
@@ -93,8 +91,8 @@ export const registerDirectoryLifecycle = (
     try {
       const relativeUrl = urlToRelativeUrl(url, source);
       const previousInfo = infoMap.get(relativeUrl);
-      const stats = statSync(new URL(url));
-      const type = statsToType(stats);
+      const stat = statSync(new URL(url));
+      const type = statsToType(stat);
       const patternValue = previousInfo
         ? previousInfo.patternValue
         : getWatchPatternValue({ url, type });
@@ -103,13 +101,15 @@ export const registerDirectoryLifecycle = (
         url,
         relativeUrl,
         type,
-        atimeMs: stats.atimeMs,
-        mtimeMs: stats.mtimeMs,
+        stat,
         patternValue,
       };
     } catch (e) {
       if (e.code === "ENOENT") {
-        return null;
+        return {
+          type: null,
+          stat: null,
+        };
       }
       throw e;
     }
@@ -182,7 +182,7 @@ export const registerDirectoryLifecycle = (
   const handleChange = (relativeUrl) => {
     const entryUrl = new URL(relativeUrl, sourceUrl).href;
     const entryInfo = readEntryInfo(entryUrl);
-    if (!entryInfo) {
+    if (entryInfo.type === null) {
       const previousEntryInfo = infoMap.get(relativeUrl);
       if (!previousEntryInfo) {
         // on MacOS it's possible to receive a "rename" event for
@@ -242,7 +242,7 @@ export const registerDirectoryLifecycle = (
       readdirSync(new URL(directoryUrl)).forEach((entryName) => {
         const childEntryUrl = new URL(entryName, directoryUrl).href;
         const childEntryInfo = readEntryInfo(childEntryUrl);
-        if (childEntryInfo && childEntryInfo.patternValue) {
+        if (childEntryInfo.type !== null && childEntryInfo.patternValue) {
           handleEntryFound(childEntryInfo, { notify });
         }
       });
@@ -271,7 +271,7 @@ export const registerDirectoryLifecycle = (
         relativeUrl: entryInfo.relativeUrl,
         type: entryInfo.type,
         patternValue: entryInfo.patternValue,
-        mtime: entryInfo.mtimeMs,
+        mtime: entryInfo.stat.mtimeMs,
       });
     }
   };
@@ -282,19 +282,19 @@ export const registerDirectoryLifecycle = (
         relativeUrl: entryInfo.relativeUrl,
         type: entryInfo.type,
         patternValue: entryInfo.patternValue,
-        mtime: entryInfo.mtimeMs,
+        mtime: entryInfo.stat.mtimeMs,
       });
     }
   };
   const handleEntryUpdated = (entryInfo) => {
     infoMap.set(entryInfo.relativeUrl, entryInfo);
-    if (updated && entryInfo.patternValue) {
+    if (updated && entryInfo.patternValue && shouldCallUpdated(entryInfo)) {
       updated({
         relativeUrl: entryInfo.relativeUrl,
         type: entryInfo.type,
         patternValue: entryInfo.patternValue,
-        mtime: entryInfo.mtimeMs,
-        previousMtime: entryInfo.previousInfo.mtimeMs,
+        mtime: entryInfo.stat.mtimeMs,
+        previousMtime: entryInfo.previousInfo.stat.mtimeMs,
       });
     }
   };
@@ -302,7 +302,7 @@ export const registerDirectoryLifecycle = (
   readdirSync(new URL(sourceUrl)).forEach((entry) => {
     const entryUrl = new URL(entry, sourceUrl).href;
     const entryInfo = readEntryInfo(entryUrl);
-    if (entryInfo && entryInfo.patternValue) {
+    if (entryInfo.type !== null && entryInfo.patternValue) {
       handleEntryFound(entryInfo, {
         notify: notifyExistent,
       });
@@ -336,6 +336,20 @@ ${relativeUrls.join("\n")}`,
   return tracker.cleanup;
 };
 
+const shouldCallUpdated = (entryInfo) => {
+  const { stat, previousInfo } = entryInfo;
+  if (!stat.atimeMs) {
+    return true;
+  }
+  if (stat.atimeMs < stat.mtimeMs) {
+    return true;
+  }
+  if (stat.mtimeMs > previousInfo.stat.mtimeMs) {
+    return true;
+  }
+  return false;
+};
+
 const undefinedOrFunction = (value) => {
   return typeof value === "undefined" || typeof value === "function";
 };

package/src/registerFileLifecycle.js

@@ -47,7 +47,7 @@ export const registerFileLifecycle = (
 
   const tracker = trackResources();
 
-  const handleFileFound = ({ existent }) => {
+  const handleFileFound = ({ stat, existent }) => {
     const fileMutationStopWatching = watchFileMutation(sourceUrl, {
       updated,
       removed: () => {
@@ -58,6 +58,7 @@ export const registerFileLifecycle = (
         }
       },
       keepProcessAlive,
+      stat,
     });
     const fileMutationStopTracking = tracker.registerCleanupCallback(
       fileMutationStopWatching,
@@ -77,9 +78,9 @@ export const registerFileLifecycle = (
   const watchFileAdded = () => {
     const fileCreationStopWatching = watchFileCreation(
       sourceUrl,
-      () => {
+      (stat) => {
         fileCreationgStopTracking();
-        handleFileFound({ existent: false });
+        handleFileFound({ stat, existent: false });
       },
       keepProcessAlive,
     );
@@ -88,8 +89,8 @@ export const registerFileLifecycle = (
     );
   };
 
-  const sourceType = entryToTypeOrNull(sourceUrl);
-  if (sourceType === null) {
+  const { type, stat } = readFileInfo(sourceUrl);
+  if (type === null) {
     if (added) {
       watchFileAdded();
     } else {
@@ -97,8 +98,8 @@ export const registerFileLifecycle = (
         `${urlToFileSystemPath(sourceUrl)} must lead to a file, found nothing`,
       );
     }
-  } else if (sourceType === "file") {
-    handleFileFound({ existent: true });
+  } else if (type === "file") {
+    handleFileFound({ stat, existent: true });
   } else {
     throw new Error(
       `${urlToFileSystemPath(
@@ -110,13 +111,19 @@ export const registerFileLifecycle = (
   return tracker.cleanup;
 };
 
-const entryToTypeOrNull = (url) => {
+const readFileInfo = (url) => {
   try {
-    const stats = statSync(new URL(url));
-    return statsToType(stats);
+    const stat = statSync(new URL(url));
+    return {
+      type: statsToType(stat),
+      stat,
+    };
   } catch (e) {
     if (e.code === "ENOENT") {
-      return null;
+      return {
+        type: null,
+        stat: null,
+      };
     }
     throw e;
   }
@@ -135,14 +142,15 @@ const watchFileCreation = (source, callback, keepProcessAlive) => {
   directoryWatcher.on("change", (eventType, filename) => {
     if (filename && filename !== sourceFilename) return;
 
-    const type = entryToTypeOrNull(source);
+    const { type, stat } = readFileInfo(source);
     // ignore if something else with that name gets created
     // we are only interested into files
-    if (type !== "file") return;
-
+    if (type !== "file") {
+      return;
+    }
     directoryWatcher.close();
     directoryWatcher = undefined;
-    callback();
+    callback(stat);
   });
 
   return () => {
@@ -154,26 +162,28 @@ const watchFileCreation = (source, callback, keepProcessAlive) => {
 
 const watchFileMutation = (
   sourceUrl,
-  { updated, removed, keepProcessAlive },
+  { updated, removed, keepProcessAlive, stat },
 ) => {
+  let prevStat = stat;
   let watcher = createWatcher(urlToFileSystemPath(sourceUrl), {
     persistent: keepProcessAlive,
   });
 
   watcher.on("change", () => {
-    const sourceType = entryToTypeOrNull(sourceUrl);
+    const { type, stat } = readFileInfo(sourceUrl);
 
-    if (sourceType === null) {
+    if (type === null) {
       watcher.close();
       watcher = undefined;
       if (removed) {
         removed();
       }
-    } else if (sourceType === "file") {
-      if (updated) {
+    } else if (type === "file") {
+      if (updated && shouldCallUpdated(stat, prevStat)) {
         updated();
       }
     }
+    prevStat = stat;
   });
 
   return () => {
@@ -182,3 +192,16 @@ const watchFileMutation = (
     }
   };
 };
+
+const shouldCallUpdated = (stat, prevStat) => {
+  if (!stat.atimeMs) {
+    return true;
+  }
+  if (stat.atimeMs < stat.mtimeMs) {
+    return true;
+  }
+  if (stat.mtimeMs > prevStat.mtimeMs) {
+    return true;
+  }
+  return false;
+};