metro-file-map 0.84.2 → 0.84.4

package/src/plugins/MockPlugin.d.ts

@@ -6,7 +6,7 @@
  *
  * @noformat
  * @oncall react_native
- * @generated SignedSource<<81805d051693b746e75928fe6ed3dbca>>
+ * @generated SignedSource<<d9402d4670982b1e675e1edd9201cf75>>
  *
  * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
  * Original file: packages/metro-file-map/src/plugins/MockPlugin.js
@@ -16,13 +16,13 @@
  */
 
 import type {
-  FileMapDelta,
   FileMapPlugin,
   FileMapPluginInitOptions,
   FileMapPluginWorker,
   MockMap as IMockMap,
   Path,
   RawMockMap,
+  ReadonlyFileSystemChanges,
 } from '../flow-types';
 
 export declare const CACHE_VERSION: 2;
@@ -39,9 +39,7 @@ declare class MockPlugin implements FileMapPlugin<RawMockMap, void>, IMockMap {
   constructor($$PARAM_0$$: MockMapOptions);
   initialize($$PARAM_0$$: FileMapPluginInitOptions<RawMockMap>): Promise<void>;
   getMockModule(name: string): null | undefined | Path;
-  bulkUpdate(delta: FileMapDelta): void;
-  onNewOrModifiedFile(relativeFilePath: Path): void;
-  onRemovedFile(relativeFilePath: Path): void;
+  onChanged(delta: ReadonlyFileSystemChanges<null | undefined | void>): void;
   getSerializableSnapshot(): RawMockMap;
   assertValid(): void;
   getCacheKey(): string;

package/src/plugins/MockPlugin.js

@@ -51,15 +51,12 @@ class MockPlugin {
     if (pluginState != null && pluginState.version === this.#raw.version) {
       this.#raw = pluginState;
     } else {
-      this.bulkUpdate({
-        addedOrModified: [
-          ...files.fileIterator({
-            includeNodeModules: false,
-            includeSymlinks: false,
-          }),
-        ].map(({ canonicalPath }) => [canonicalPath, null]),
-        removed: [],
-      });
+      for (const { canonicalPath } of files.fileIterator({
+        includeNodeModules: false,
+        includeSymlinks: false,
+      })) {
+        this.#onFileAdded(canonicalPath);
+      }
     }
   }
   getMockModule(name) {
@@ -72,22 +69,22 @@ class MockPlugin {
       (0, _normalizePathSeparatorsToSystem.default)(mockPosixRelativePath),
     );
   }
-  bulkUpdate(delta) {
-    for (const [relativeFilePath] of delta.removed) {
-      this.onRemovedFile(relativeFilePath);
+  onChanged(delta) {
+    for (const [canonicalPath] of delta.removedFiles) {
+      this.#onFileRemoved(canonicalPath);
     }
-    for (const [relativeFilePath] of delta.addedOrModified) {
-      this.onNewOrModifiedFile(relativeFilePath);
+    for (const [canonicalPath] of delta.addedFiles) {
+      this.#onFileAdded(canonicalPath);
     }
   }
-  onNewOrModifiedFile(relativeFilePath) {
-    const absoluteFilePath = this.#pathUtils.normalToAbsolute(relativeFilePath);
+  #onFileAdded(canonicalPath) {
+    const absoluteFilePath = this.#pathUtils.normalToAbsolute(canonicalPath);
     if (!this.#mocksPattern.test(absoluteFilePath)) {
       return;
     }
     const mockName = (0, _getMockName.default)(absoluteFilePath);
     const posixRelativePath = (0, _normalizePathSeparatorsToPosix.default)(
-      relativeFilePath,
+      canonicalPath,
     );
     const existingMockPosixPath = this.#raw.mocks.get(mockName);
     if (existingMockPosixPath != null) {
@@ -104,8 +101,8 @@ class MockPlugin {
     }
     this.#raw.mocks.set(mockName, posixRelativePath);
   }
-  onRemovedFile(relativeFilePath) {
-    const absoluteFilePath = this.#pathUtils.normalToAbsolute(relativeFilePath);
+  #onFileRemoved(canonicalPath) {
+    const absoluteFilePath = this.#pathUtils.normalToAbsolute(canonicalPath);
     if (!this.#mocksPattern.test(absoluteFilePath)) {
       return;
     }
@@ -113,7 +110,7 @@ class MockPlugin {
     const duplicates = this.#raw.duplicates.get(mockName);
     if (duplicates != null) {
       const posixRelativePath = (0, _normalizePathSeparatorsToPosix.default)(
-        relativeFilePath,
+        canonicalPath,
       );
       duplicates.delete(posixRelativePath);
       if (duplicates.size === 1) {

package/src/plugins/MockPlugin.js.flow

@@ -10,13 +10,13 @@
  */
 
 import type {
-  FileMapDelta,
   FileMapPlugin,
   FileMapPluginInitOptions,
   FileMapPluginWorker,
   MockMap as IMockMap,
   Path,
   RawMockMap,
+  ReadonlyFileSystemChanges,
 } from '../flow-types';
 
 import normalizePathSeparatorsToPosix from '../lib/normalizePathSeparatorsToPosix';
@@ -79,15 +79,12 @@ export default class MockPlugin
       this.#raw = pluginState;
     } else {
       // Otherwise, traverse all files to rebuild
-      this.bulkUpdate({
-        addedOrModified: [
-          ...files.fileIterator({
-            includeNodeModules: false,
-            includeSymlinks: false,
-          }),
-        ].map(({canonicalPath}) => [canonicalPath, null]),
-        removed: [],
-      });
+      for (const {canonicalPath} of files.fileIterator({
+        includeNodeModules: false,
+        includeSymlinks: false,
+      })) {
+        this.#onFileAdded(canonicalPath);
+      }
     }
   }
 
@@ -102,24 +99,24 @@ export default class MockPlugin
     );
   }
 
-  bulkUpdate(delta: FileMapDelta<>): void {
+  onChanged(delta: ReadonlyFileSystemChanges<?void>): void {
     // Process removals first so that moves aren't treated as duplicates.
-    for (const [relativeFilePath] of delta.removed) {
-      this.onRemovedFile(relativeFilePath);
+    for (const [canonicalPath] of delta.removedFiles) {
+      this.#onFileRemoved(canonicalPath);
     }
-    for (const [relativeFilePath] of delta.addedOrModified) {
-      this.onNewOrModifiedFile(relativeFilePath);
+    for (const [canonicalPath] of delta.addedFiles) {
+      this.#onFileAdded(canonicalPath);
     }
   }
 
-  onNewOrModifiedFile(relativeFilePath: Path): void {
-    const absoluteFilePath = this.#pathUtils.normalToAbsolute(relativeFilePath);
+  #onFileAdded(canonicalPath: Path): void {
+    const absoluteFilePath = this.#pathUtils.normalToAbsolute(canonicalPath);
     if (!this.#mocksPattern.test(absoluteFilePath)) {
       return;
     }
 
     const mockName = getMockName(absoluteFilePath);
-    const posixRelativePath = normalizePathSeparatorsToPosix(relativeFilePath);
+    const posixRelativePath = normalizePathSeparatorsToPosix(canonicalPath);
 
     const existingMockPosixPath = this.#raw.mocks.get(mockName);
     if (existingMockPosixPath != null) {
@@ -141,16 +138,15 @@ export default class MockPlugin
     this.#raw.mocks.set(mockName, posixRelativePath);
   }
 
-  onRemovedFile(relativeFilePath: Path): void {
-    const absoluteFilePath = this.#pathUtils.normalToAbsolute(relativeFilePath);
+  #onFileRemoved(canonicalPath: Path): void {
+    const absoluteFilePath = this.#pathUtils.normalToAbsolute(canonicalPath);
     if (!this.#mocksPattern.test(absoluteFilePath)) {
       return;
     }
     const mockName = getMockName(absoluteFilePath);
     const duplicates = this.#raw.duplicates.get(mockName);
     if (duplicates != null) {
-      const posixRelativePath =
-        normalizePathSeparatorsToPosix(relativeFilePath);
+      const posixRelativePath = normalizePathSeparatorsToPosix(canonicalPath);
       duplicates.delete(posixRelativePath);
       if (duplicates.size === 1) {
         this.#raw.duplicates.delete(mockName);

package/src/watchers/FallbackWatcher.js

@@ -99,9 +99,19 @@ class FallbackWatcher extends _AbstractWatcher.AbstractWatcher {
     }
   }
   #unregisterDir(dirpath) {
-    if (this.#dirRegistry[dirpath]) {
-      delete this.#dirRegistry[dirpath];
+    const removedFiles = [];
+    for (const registeredDir of Object.keys(this.#dirRegistry)) {
+      if (
+        registeredDir === dirpath ||
+        registeredDir.startsWith(dirpath + _path.default.sep)
+      ) {
+        for (const filename of Object.keys(this.#dirRegistry[registeredDir])) {
+          removedFiles.push(_path.default.join(registeredDir, filename));
+        }
+        delete this.#dirRegistry[registeredDir];
+      }
     }
+    return removedFiles;
   }
   #registered(fullpath) {
     const dir = _path.default.dirname(fullpath);
@@ -294,7 +304,13 @@ class FallbackWatcher extends _AbstractWatcher.AbstractWatcher {
         return;
       }
       this.#unregister(fullPath);
-      this.#unregisterDir(fullPath);
+      const removedFiles = this.#unregisterDir(fullPath);
+      for (const removedFile of removedFiles) {
+        this.#emitEvent({
+          event: DELETE_EVENT,
+          relativePath: _path.default.relative(this.root, removedFile),
+        });
+      }
       if (registered) {
         this.#emitEvent({
           event: DELETE_EVENT,

package/src/watchers/FallbackWatcher.js.flow

@@ -124,12 +124,27 @@ export default class FallbackWatcher extends AbstractWatcher {
   }
 
   /**
-   * Removes a dir from the registry.
+   * Removes a dir from the registry, returning all files that were registered
+   * under it (recursively).
    */
-  #unregisterDir(dirpath: string): void {
-    if (this.#dirRegistry[dirpath]) {
-      delete this.#dirRegistry[dirpath];
+  #unregisterDir(dirpath: string): Array<string> {
+    const removedFiles: Array<string> = [];
+
+    // Find and remove all entries under this directory
+    for (const registeredDir of Object.keys(this.#dirRegistry)) {
+      if (
+        registeredDir === dirpath ||
+        registeredDir.startsWith(dirpath + path.sep)
+      ) {
+        // Collect all files in this directory
+        for (const filename of Object.keys(this.#dirRegistry[registeredDir])) {
+          removedFiles.push(path.join(registeredDir, filename));
+        }
+        delete this.#dirRegistry[registeredDir];
+      }
     }
+
+    return removedFiles;
   }
 
   /**
@@ -350,7 +365,15 @@ export default class FallbackWatcher extends AbstractWatcher {
         return;
       }
       this.#unregister(fullPath);
-      this.#unregisterDir(fullPath);
+      // When a directory is deleted, emit delete events for all files we
+      // knew about under that directory
+      const removedFiles = this.#unregisterDir(fullPath);
+      for (const removedFile of removedFiles) {
+        this.#emitEvent({
+          event: DELETE_EVENT,
+          relativePath: path.relative(this.root, removedFile),
+        });
+      }
       if (registered) {
         this.#emitEvent({event: DELETE_EVENT, relativePath});
       }

package/src/watchers/NativeWatcher.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @noformat
- * @generated SignedSource<<8239479487abff6df70ee54f9e05f352>>
+ * @generated SignedSource<<b68c5620efd3f5bec83279059d0d1b4e>>
  *
  * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
  * Original file: packages/metro-file-map/src/watchers/NativeWatcher.js
@@ -50,6 +50,6 @@ declare class NativeWatcher extends AbstractWatcher {
    * End watching.
    */
   stopWatching(): Promise<void>;
-  _handleEvent(relativePath: string): void;
+  _handleEvent(event: string, relativePath: string): void;
 }
 export default NativeWatcher;

package/src/watchers/NativeWatcher.js

@@ -39,6 +39,7 @@ function _interopRequireWildcard(e, t) {
 const debug = require("debug")("Metro:NativeWatcher");
 const TOUCH_EVENT = "touch";
 const DELETE_EVENT = "delete";
+const RECRAWL_EVENT = "recrawl";
 class NativeWatcher extends _AbstractWatcher.AbstractWatcher {
   #fsWatcher;
   static isSupported() {
@@ -57,8 +58,8 @@ class NativeWatcher extends _AbstractWatcher.AbstractWatcher {
         persistent: false,
         recursive: true,
       },
-      (_event, relativePath) => {
-        this._handleEvent(relativePath).catch((error) => {
+      (event, relativePath) => {
+        this._handleEvent(event, relativePath).catch((error) => {
           this.emitError(error);
         });
       },
@@ -71,13 +72,23 @@ class NativeWatcher extends _AbstractWatcher.AbstractWatcher {
       this.#fsWatcher.close();
     }
   }
-  async _handleEvent(relativePath) {
+  async _handleEvent(event, relativePath) {
     const absolutePath = path.resolve(this.root, relativePath);
     if (this.doIgnore(relativePath)) {
-      debug("Ignoring event on %s (root: %s)", relativePath, this.root);
+      debug(
+        'Ignoring event "%s" on %s (root: %s)',
+        event,
+        relativePath,
+        this.root,
+      );
       return;
     }
-    debug("Handling event on %s (root: %s)", relativePath, this.root);
+    debug(
+      'Handling event "%s" on %s (root: %s)',
+      event,
+      relativePath,
+      this.root,
+    );
     try {
       const stat = await _fs.promises.lstat(absolutePath);
       const type = (0, _common.typeFromStat)(stat);
@@ -89,6 +100,17 @@ class NativeWatcher extends _AbstractWatcher.AbstractWatcher {
       ) {
         return;
       }
+      if (type === "d" && event === "rename") {
+        debug(
+          "Directory rename detected on %s, requesting recrawl",
+          relativePath,
+        );
+        this.emitFileEvent({
+          event: RECRAWL_EVENT,
+          relativePath,
+        });
+        return;
+      }
       this.emitFileEvent({
         event: TOUCH_EVENT,
         relativePath,

package/src/watchers/NativeWatcher.js.flow

@@ -21,6 +21,7 @@ const debug = require('debug')('Metro:NativeWatcher');
 
 const TOUCH_EVENT = 'touch';
 const DELETE_EVENT = 'delete';
+const RECRAWL_EVENT = 'recrawl';
 
 /**
  * NativeWatcher uses Node's native fs.watch API with recursive: true.
@@ -74,9 +75,8 @@ export default class NativeWatcher extends AbstractWatcher {
         // ~instant on macOS or Windows.
         recursive: true,
       },
-      (_event, relativePath) => {
-        // _event is always 'rename' on macOS, so we don't use it.
-        this._handleEvent(relativePath).catch(error => {
+      (event, relativePath) => {
+        this._handleEvent(event, relativePath).catch(error => {
           this.emitError(error);
         });
       },
@@ -95,13 +95,23 @@ export default class NativeWatcher extends AbstractWatcher {
     }
   }
 
-  async _handleEvent(relativePath: string) {
+  async _handleEvent(event: string, relativePath: string) {
     const absolutePath = path.resolve(this.root, relativePath);
     if (this.doIgnore(relativePath)) {
-      debug('Ignoring event on %s (root: %s)', relativePath, this.root);
+      debug(
+        'Ignoring event "%s" on %s (root: %s)',
+        event,
+        relativePath,
+        this.root,
+      );
       return;
     }
-    debug('Handling event on %s (root: %s)', relativePath, this.root);
+    debug(
+      'Handling event "%s" on %s (root: %s)',
+      event,
+      relativePath,
+      this.root,
+    );
 
     try {
       const stat = await fsPromises.lstat(absolutePath);
@@ -116,6 +126,23 @@ export default class NativeWatcher extends AbstractWatcher {
         return;
       }
 
+      // For directory "rename" events, notify that we need a recrawl since we
+      // wont' receive events for unmodified files underneath a moved (or
+      // cloned) directory. Renames are fired by the OS on moves, clones, and
+      // creations. We ignore "change" events because they indiciate a change
+      // to directory metadata, rather than its path or existence.
+      if (type === 'd' && event === 'rename') {
+        debug(
+          'Directory rename detected on %s, requesting recrawl',
+          relativePath,
+        );
+        this.emitFileEvent({
+          event: RECRAWL_EVENT,
+          relativePath,
+        });
+        return;
+      }
+
       this.emitFileEvent({
         event: TOUCH_EVENT,
         relativePath,

package/src/watchers/common.d.ts

@@ -6,7 +6,7 @@
  *
  * @noformat
  * @oncall react_native
- * @generated SignedSource<<4f8f87abcb055b965a90e994a55ed177>>
+ * @generated SignedSource<<ebebfbca9d43e034fde8489e1d9f2dbb>>
  *
  * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
  * Original file: packages/metro-file-map/src/watchers/common.js
@@ -29,6 +29,8 @@ export declare const DELETE_EVENT: 'delete';
 export declare type DELETE_EVENT = typeof DELETE_EVENT;
 export declare const TOUCH_EVENT: 'touch';
 export declare type TOUCH_EVENT = typeof TOUCH_EVENT;
+export declare const RECRAWL_EVENT: 'recrawl';
+export declare type RECRAWL_EVENT = typeof RECRAWL_EVENT;
 export declare const ALL_EVENT: 'all';
 export declare type ALL_EVENT = typeof ALL_EVENT;
 export type WatcherOptions = Readonly<{

package/src/watchers/common.js

@@ -3,7 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true,
 });
-exports.TOUCH_EVENT = exports.DELETE_EVENT = exports.ALL_EVENT = void 0;
+exports.TOUCH_EVENT =
+  exports.RECRAWL_EVENT =
+  exports.DELETE_EVENT =
+  exports.ALL_EVENT =
+    void 0;
 exports.includedByGlob = includedByGlob;
 exports.posixPathMatchesPattern = void 0;
 exports.typeFromStat = typeFromStat;
@@ -14,6 +18,7 @@ function _interopRequireDefault(e) {
 }
 const DELETE_EVENT = (exports.DELETE_EVENT = "delete");
 const TOUCH_EVENT = (exports.TOUCH_EVENT = "touch");
+const RECRAWL_EVENT = (exports.RECRAWL_EVENT = "recrawl");
 const ALL_EVENT = (exports.ALL_EVENT = "all");
 function includedByGlob(type, globs, dot, relativePath) {
   if (globs.length === 0 || type !== "f") {

package/src/watchers/common.js.flow

@@ -26,6 +26,7 @@ import path from 'path';
  */
 export const DELETE_EVENT = 'delete';
 export const TOUCH_EVENT = 'touch';
+export const RECRAWL_EVENT = 'recrawl';
 export const ALL_EVENT = 'all';
 
 export type WatcherOptions = Readonly<{