metro-file-map 0.76.6 → 0.76.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metro-file-map",
-  "version": "0.76.6",
+  "version": "0.76.8",
   "description": "[Experimental] - 🚇 File crawling, watching and mapping for Metro",
   "main": "src/index.js",
   "repository": {

package/src/flow-types.js.flow

@@ -146,7 +146,7 @@ export type FileData = Map<Path, FileMetaData>;
 
 export type FileMetaData = [
   /* id */ string,
-  /* mtime */ number,
+  /* mtime */ ?number,
   /* size */ number,
   /* visited */ 0 | 1,
   /* dependencies */ string,
@@ -156,7 +156,7 @@ export type FileMetaData = [
 
 export type FileStats = $ReadOnly<{
   fileType: 'f' | 'l',
-  modifiedTime: number,
+  modifiedTime: ?number,
 }>;
 
 export interface FileSystem {

package/src/index.js

@@ -867,11 +867,14 @@ class HasteMap extends _events.default {
       const relativeFilePath = fastPath.relative(rootDir, absoluteFilePath);
       const linkStats = fileSystem.linkStats(relativeFilePath);
 
-      // The file has been accessed, not modified
+      // The file has been accessed, not modified. If the modified time is
+      // null, then it is assumed that the watcher does not have capabilities
+      // to detect modified time, and change processing proceeds.
       if (
         type === "change" &&
         linkStats != null &&
         metadata &&
+        metadata.modifiedTime != null &&
         linkStats.modifiedTime === metadata.modifiedTime
       ) {
         return;
@@ -891,6 +894,8 @@ class HasteMap extends _events.default {
                 ((!event.metadata && !metadata) ||
                   (event.metadata &&
                     metadata &&
+                    event.metadata.modifiedTime != null &&
+                    metadata.modifiedTime != null &&
                     event.metadata.modifiedTime === metadata.modifiedTime))
             )
           ) {
@@ -915,9 +920,7 @@ class HasteMap extends _events.default {
           // parse it and update the haste map.
           if (type === "add" || type === "change") {
             (0, _invariant.default)(
-              metadata != null &&
-                metadata.modifiedTime != null &&
-                metadata.size != null,
+              metadata != null && metadata.size != null,
               "since the file exists or changed, it should have metadata"
             );
             const fileMetadata = [

package/src/index.js.flow

@@ -962,11 +962,14 @@ export default class HasteMap extends EventEmitter {
       const relativeFilePath = fastPath.relative(rootDir, absoluteFilePath);
       const linkStats = fileSystem.linkStats(relativeFilePath);
 
-      // The file has been accessed, not modified
+      // The file has been accessed, not modified. If the modified time is
+      // null, then it is assumed that the watcher does not have capabilities
+      // to detect modified time, and change processing proceeds.
       if (
         type === 'change' &&
         linkStats != null &&
         metadata &&
+        metadata.modifiedTime != null &&
         linkStats.modifiedTime === metadata.modifiedTime
       ) {
         return;
@@ -987,6 +990,8 @@ export default class HasteMap extends EventEmitter {
                 ((!event.metadata && !metadata) ||
                   (event.metadata &&
                     metadata &&
+                    event.metadata.modifiedTime != null &&
+                    metadata.modifiedTime != null &&
                     event.metadata.modifiedTime === metadata.modifiedTime)),
             )
           ) {
@@ -1013,9 +1018,7 @@ export default class HasteMap extends EventEmitter {
           // parse it and update the haste map.
           if (type === 'add' || type === 'change') {
             invariant(
-              metadata != null &&
-                metadata.modifiedTime != null &&
-                metadata.size != null,
+              metadata != null && metadata.size != null,
               'since the file exists or changed, it should have metadata',
             );
             const fileMetadata: FileMetaData = [

package/src/lib/TreeFS.js

@@ -122,10 +122,6 @@ class TreeFS {
     }
     const fileType = fileMetadata[_constants.default.SYMLINK] === 0 ? "f" : "l";
     const modifiedTime = fileMetadata[_constants.default.MTIME];
-    (0, _invariant.default)(
-      typeof modifiedTime === "number",
-      "File in TreeFS missing modified time"
-    );
     return {
       fileType,
       modifiedTime,

package/src/lib/TreeFS.js.flow

@@ -98,10 +98,6 @@ export default class TreeFS implements MutableFileSystem {
     }
     const fileType = fileMetadata[H.SYMLINK] === 0 ? 'f' : 'l';
     const modifiedTime = fileMetadata[H.MTIME];
-    invariant(
-      typeof modifiedTime === 'number',
-      'File in TreeFS missing modified time',
-    );
     return {
       fileType,
       modifiedTime,

package/src/watchers/NodeWatcher.js

@@ -310,7 +310,7 @@ module.exports = class NodeWatcher extends EventEmitter {
         }
       }
     } catch (error) {
-      if (error?.code !== "ENOENT") {
+      if (!isIgnorableFileError(error)) {
         this.emit("error", error);
         return;
       }
@@ -368,7 +368,11 @@ module.exports = class NodeWatcher extends EventEmitter {
 function isIgnorableFileError(error) {
   return (
     error.code === "ENOENT" ||
-    // Workaround Windows EPERM on watched folder deletion.
+    // Workaround Windows EPERM on watched folder deletion, and when
+    // reading locked files (pending further writes or pending deletion).
+    // In such cases, we'll receive a subsequent event when the file is
+    // deleted or ready to read.
+    // https://github.com/facebook/metro/issues/1001
     // https://github.com/nodejs/node-v0.x-archive/issues/4337
     (error.code === "EPERM" && platform === "win32")
   );

package/src/watchers/NodeWatcher.js.flow

@@ -340,7 +340,7 @@ module.exports = class NodeWatcher extends EventEmitter {
         }
       }
     } catch (error) {
-      if (error?.code !== 'ENOENT') {
+      if (!isIgnorableFileError(error)) {
         this.emit('error', error);
         return;
       }
@@ -403,7 +403,11 @@ module.exports = class NodeWatcher extends EventEmitter {
 function isIgnorableFileError(error: Error | {code: string}) {
   return (
     error.code === 'ENOENT' ||
-    // Workaround Windows EPERM on watched folder deletion.
+    // Workaround Windows EPERM on watched folder deletion, and when
+    // reading locked files (pending further writes or pending deletion).
+    // In such cases, we'll receive a subsequent event when the file is
+    // deleted or ready to read.
+    // https://github.com/facebook/metro/issues/1001
     // https://github.com/nodejs/node-v0.x-archive/issues/4337
     (error.code === 'EPERM' && platform === 'win32')
   );

package/src/watchers/WatchmanWatcher.js

@@ -286,8 +286,9 @@ class WatchmanWatcher extends _events.default {
         // Change event on dirs are mostly useless.
         !(type === "d" && eventType === CHANGE_EVENT)
       ) {
+        const mtime = Number(mtime_ms);
         self._emitEvent(eventType, relativePath, self.root, {
-          modifiedTime: Number(mtime_ms),
+          modifiedTime: mtime !== 0 ? mtime : null,
           size,
           type,
         });

package/src/watchers/WatchmanWatcher.js.flow

@@ -289,8 +289,9 @@ export default class WatchmanWatcher extends EventEmitter {
         // Change event on dirs are mostly useless.
         !(type === 'd' && eventType === CHANGE_EVENT)
       ) {
+        const mtime = Number(mtime_ms);
         self._emitEvent(eventType, relativePath, self.root, {
-          modifiedTime: Number(mtime_ms),
+          modifiedTime: mtime !== 0 ? mtime : null,
           size,
           type,
         });