metro-file-map 0.81.0 → 0.81.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metro-file-map",
-  "version": "0.81.0",
+  "version": "0.81.1",
   "description": "[Experimental] - 🚇 File crawling, watching and mapping for Metro",
   "main": "src/index.js",
   "repository": {
@@ -13,7 +13,6 @@
   },
   "license": "MIT",
   "dependencies": {
-    "anymatch": "^3.0.3",
     "debug": "^2.2.0",
     "fb-watchman": "^2.0.0",
     "flow-enums-runtime": "^0.0.6",
@@ -21,16 +20,12 @@
     "invariant": "^2.2.4",
     "jest-worker": "^29.6.3",
     "micromatch": "^4.0.4",
-    "node-abort-controller": "^3.1.1",
     "nullthrows": "^1.1.1",
     "walker": "^1.0.7"
   },
   "devDependencies": {
     "slash": "^3.0.0"
   },
-  "optionalDependencies": {
-    "fsevents": "^2.3.2"
-  },
   "engines": {
     "node": ">=18.18"
   }

package/src/Watcher.js

@@ -7,10 +7,12 @@ exports.Watcher = void 0;
 var _node = _interopRequireDefault(require("./crawlers/node"));
 var _watchman = _interopRequireDefault(require("./crawlers/watchman"));
 var _common = require("./watchers/common");
-var _FSEventsWatcher = _interopRequireDefault(
-  require("./watchers/FSEventsWatcher")
+var _FallbackWatcher = _interopRequireDefault(
+  require("./watchers/FallbackWatcher")
+);
+var _NativeWatcher = _interopRequireDefault(
+  require("./watchers/NativeWatcher")
 );
-var _NodeWatcher = _interopRequireDefault(require("./watchers/NodeWatcher"));
 var _WatchmanWatcher = _interopRequireDefault(
   require("./watchers/WatchmanWatcher")
 );
@@ -60,8 +62,8 @@ class Watcher extends _events.default {
   async crawl() {
     this._options.perfLogger?.point("crawl_start");
     const options = this._options;
-    const ignore = (filePath) =>
-      options.ignore(filePath) ||
+    const ignoreForCrawl = (filePath) =>
+      options.ignoreForCrawl(filePath) ||
       path.basename(filePath).startsWith(this._options.healthCheckFilePrefix);
     const crawl = options.useWatchman ? _watchman.default : _node.default;
     let crawler = crawl === _watchman.default ? "watchman" : "node";
@@ -73,7 +75,7 @@ class Watcher extends _events.default {
       includeSymlinks: options.enableSymlinks,
       extensions: options.extensions,
       forceNodeFilesystemAPI: options.forceNodeFilesystemAPI,
-      ignore,
+      ignore: ignoreForCrawl,
       onStatus: (status) => {
         this.emit("status", status);
       },
@@ -123,17 +125,17 @@ class Watcher extends _events.default {
     }
   }
   async watch(onChange) {
-    const { extensions, ignorePattern, useWatchman } = this._options;
+    const { extensions, ignorePatternForWatch, useWatchman } = this._options;
     const WatcherImpl = useWatchman
       ? _WatchmanWatcher.default
-      : _FSEventsWatcher.default.isSupported()
-      ? _FSEventsWatcher.default
-      : _NodeWatcher.default;
-    let watcher = "node";
+      : _NativeWatcher.default.isSupported()
+      ? _NativeWatcher.default
+      : _FallbackWatcher.default;
+    let watcher = "fallback";
     if (WatcherImpl === _WatchmanWatcher.default) {
       watcher = "watchman";
-    } else if (WatcherImpl === _FSEventsWatcher.default) {
-      watcher = "fsevents";
+    } else if (WatcherImpl === _NativeWatcher.default) {
+      watcher = "native";
     }
     debug(`Using watcher: ${watcher}`);
     this._options.perfLogger?.annotate({
@@ -145,39 +147,38 @@ class Watcher extends _events.default {
     const createWatcherBackend = (root) => {
       const watcherOptions = {
         dot: true,
-        glob: [
+        globs: [
           "**/package.json",
           "**/" + this._options.healthCheckFilePrefix + "*",
           ...extensions.map((extension) => "**/*." + extension),
         ],
-        ignored: ignorePattern,
+        ignored: ignorePatternForWatch,
         watchmanDeferStates: this._options.watchmanDeferStates,
       };
       const watcher = new WatcherImpl(root, watcherOptions);
-      return new Promise((resolve, reject) => {
+      return new Promise(async (resolve, reject) => {
         const rejectTimeout = setTimeout(
           () => reject(new Error("Failed to start watch mode.")),
           MAX_WAIT_TIME
         );
-        watcher.once("ready", () => {
-          clearTimeout(rejectTimeout);
-          watcher.on("all", (type, filePath, root, metadata) => {
-            const basename = path.basename(filePath);
-            if (basename.startsWith(this._options.healthCheckFilePrefix)) {
-              if (type === _common.ADD_EVENT || type === _common.CHANGE_EVENT) {
-                debug(
-                  "Observed possible health check cookie: %s in %s",
-                  filePath,
-                  root
-                );
-                this._handleHealthCheckObservation(basename);
-              }
-              return;
+        watcher.onFileEvent((change) => {
+          const basename = path.basename(change.relativePath);
+          if (basename.startsWith(this._options.healthCheckFilePrefix)) {
+            if (change.event === _common.TOUCH_EVENT) {
+              debug(
+                "Observed possible health check cookie: %s in %s",
+                change.relativePath,
+                root
+              );
+              this._handleHealthCheckObservation(basename);
             }
-            onChange(type, filePath, root, metadata);
-          });
-          resolve(watcher);
+            return;
+          }
+          onChange(change);
         });
+        await watcher.startWatching();
+        clearTimeout(rejectTimeout);
+        resolve(watcher);
       });
     };
     this._backends = await Promise.all(
@@ -192,7 +193,7 @@ class Watcher extends _events.default {
     resolveHealthCheck();
   }
   async close() {
-    await Promise.all(this._backends.map((watcher) => watcher.close()));
+    await Promise.all(this._backends.map((watcher) => watcher.stopWatching()));
     this._activeWatcher = null;
   }
   async checkHealth(timeout) {

package/src/Watcher.js.flow

@@ -9,22 +9,22 @@
  */
 
 import type {
-  ChangeEventMetadata,
   Console,
   CrawlerOptions,
   FileData,
   Path,
   PerfLogger,
+  WatcherBackend,
+  WatcherBackendChangeEvent,
   WatchmanClocks,
 } from './flow-types';
 import type {WatcherOptions as WatcherBackendOptions} from './watchers/common';
-import type {AbortSignal} from 'node-abort-controller';
 
 import nodeCrawl from './crawlers/node';
 import watchmanCrawl from './crawlers/watchman';
-import {ADD_EVENT, CHANGE_EVENT} from './watchers/common';
-import FSEventsWatcher from './watchers/FSEventsWatcher';
-import NodeWatcher from './watchers/NodeWatcher';
+import {TOUCH_EVENT} from './watchers/common';
+import FallbackWatcher from './watchers/FallbackWatcher';
+import NativeWatcher from './watchers/NativeWatcher';
 import WatchmanWatcher from './watchers/WatchmanWatcher';
 import EventEmitter from 'events';
 import * as fs from 'fs';
@@ -50,8 +50,8 @@ type WatcherOptions = {
   extensions: $ReadOnlyArray<string>,
   forceNodeFilesystemAPI: boolean,
   healthCheckFilePrefix: string,
-  ignore: string => boolean,
-  ignorePattern: RegExp,
+  ignoreForCrawl: string => boolean,
+  ignorePatternForWatch: RegExp,
   previousState: CrawlerOptions['previousState'],
   perfLogger: ?PerfLogger,
   roots: $ReadOnlyArray<string>,
@@ -61,11 +61,6 @@ type WatcherOptions = {
   watchmanDeferStates: $ReadOnlyArray<string>,
 };
 
-interface WatcherBackend {
-  getPauseReason(): ?string;
-  close(): Promise<void>;
-}
-
 let nextInstanceId = 0;
 
 export type HealthCheckResult =
@@ -92,8 +87,8 @@ export class Watcher extends EventEmitter {
     this._options.perfLogger?.point('crawl_start');
 
     const options = this._options;
-    const ignore = (filePath: string) =>
-      options.ignore(filePath) ||
+    const ignoreForCrawl = (filePath: string) =>
+      options.ignoreForCrawl(filePath) ||
       path.basename(filePath).startsWith(this._options.healthCheckFilePrefix);
     const crawl = options.useWatchman ? watchmanCrawl : nodeCrawl;
     let crawler = crawl === watchmanCrawl ? 'watchman' : 'node';
@@ -107,7 +102,7 @@ export class Watcher extends EventEmitter {
       includeSymlinks: options.enableSymlinks,
       extensions: options.extensions,
       forceNodeFilesystemAPI: options.forceNodeFilesystemAPI,
-      ignore,
+      ignore: ignoreForCrawl,
       onStatus: status => {
         this.emit('status', status);
       },
@@ -163,28 +158,21 @@ export class Watcher extends EventEmitter {
     }
   }
 
-  async watch(
-    onChange: (
-      type: string,
-      filePath: string,
-      root: string,
-      metadata: ChangeEventMetadata,
-    ) => void,
-  ) {
-    const {extensions, ignorePattern, useWatchman} = this._options;
+  async watch(onChange: (change: WatcherBackendChangeEvent) => void) {
+    const {extensions, ignorePatternForWatch, useWatchman} = this._options;
 
-    // WatchmanWatcher > FSEventsWatcher > sane.NodeWatcher
+    // WatchmanWatcher > NativeWatcher > FallbackWatcher
     const WatcherImpl = useWatchman
       ? WatchmanWatcher
-      : FSEventsWatcher.isSupported()
-        ? FSEventsWatcher
-        : NodeWatcher;
+      : NativeWatcher.isSupported()
+        ? NativeWatcher
+        : FallbackWatcher;
 
-    let watcher = 'node';
+    let watcher = 'fallback';
     if (WatcherImpl === WatchmanWatcher) {
       watcher = 'watchman';
-    } else if (WatcherImpl === FSEventsWatcher) {
-      watcher = 'fsevents';
+    } else if (WatcherImpl === NativeWatcher) {
+      watcher = 'native';
     }
     debug(`Using watcher: ${watcher}`);
     this._options.perfLogger?.annotate({string: {watcher}});
@@ -193,7 +181,7 @@ export class Watcher extends EventEmitter {
     const createWatcherBackend = (root: Path): Promise<WatcherBackend> => {
       const watcherOptions: WatcherBackendOptions = {
         dot: true,
-        glob: [
+        globs: [
           // Ensure we always include package.json files, which are crucial for
           /// module resolution.
           '**/package.json',
@@ -201,44 +189,35 @@ export class Watcher extends EventEmitter {
           '**/' + this._options.healthCheckFilePrefix + '*',
           ...extensions.map(extension => '**/*.' + extension),
         ],
-        ignored: ignorePattern,
+        ignored: ignorePatternForWatch,
         watchmanDeferStates: this._options.watchmanDeferStates,
       };
-      const watcher = new WatcherImpl(root, watcherOptions);
+      const watcher: WatcherBackend = new WatcherImpl(root, watcherOptions);
 
-      return new Promise((resolve, reject) => {
+      return new Promise(async (resolve, reject) => {
         const rejectTimeout = setTimeout(
           () => reject(new Error('Failed to start watch mode.')),
           MAX_WAIT_TIME,
         );
 
-        watcher.once('ready', () => {
-          clearTimeout(rejectTimeout);
-          watcher.on(
-            'all',
-            (
-              type: string,
-              filePath: string,
-              root: string,
-              metadata: ChangeEventMetadata,
-            ) => {
-              const basename = path.basename(filePath);
-              if (basename.startsWith(this._options.healthCheckFilePrefix)) {
-                if (type === ADD_EVENT || type === CHANGE_EVENT) {
-                  debug(
-                    'Observed possible health check cookie: %s in %s',
-                    filePath,
-                    root,
-                  );
-                  this._handleHealthCheckObservation(basename);
-                }
-                return;
-              }
-              onChange(type, filePath, root, metadata);
-            },
-          );
-          resolve(watcher);
+        watcher.onFileEvent(change => {
+          const basename = path.basename(change.relativePath);
+          if (basename.startsWith(this._options.healthCheckFilePrefix)) {
+            if (change.event === TOUCH_EVENT) {
+              debug(
+                'Observed possible health check cookie: %s in %s',
+                change.relativePath,
+                root,
+              );
+              this._handleHealthCheckObservation(basename);
+            }
+            return;
+          }
+          onChange(change);
         });
+        await watcher.startWatching();
+        clearTimeout(rejectTimeout);
+        resolve(watcher);
       });
     };
 
@@ -256,7 +235,7 @@ export class Watcher extends EventEmitter {
   }
 
   async close() {
-    await Promise.all(this._backends.map(watcher => watcher.close()));
+    await Promise.all(this._backends.map(watcher => watcher.stopWatching()));
     this._activeWatcher = null;
   }
 

package/src/flow-types.d.ts

@@ -9,7 +9,6 @@
  */
 
 import type {PerfLogger, PerfLoggerFactory, RootPerfLogger} from 'metro-config';
-import type {AbortSignal} from 'node-abort-controller';
 
 export type {PerfLoggerFactory, PerfLogger};
 
@@ -43,7 +42,7 @@ export interface BuildResult {
 
 export interface CacheData {
   readonly clocks: WatchmanClocks;
-  readonly mocks: MockData;
+  readonly mocks: RawMockMap;
   readonly files: FileData;
 }
 
@@ -254,6 +253,13 @@ export type LookupResult =
       type: 'd' | 'f';
     };
 
+export type HasteConflict = {
+  id: string;
+  platform: string | null;
+  absolutePaths: Array<string>;
+  type: 'duplicate' | 'shadowing';
+};
+
 export interface HasteMap {
   getModule(
     name: string,
@@ -268,10 +274,14 @@ export interface HasteMap {
     _supportsNativePlatform: boolean | null,
   ): Path | null;
 
-  getRawHasteMap(): ReadOnlyRawHasteMap;
+  computeConflicts(): Array<HasteConflict>;
 }
 
-export type MockData = Map<string, Path>;
+export type RawMockMap = {
+  readonly mocks: Map<string, string>;
+  readonly duplicates: Map<string, Set<string>>;
+};
+
 export type HasteMapData = Map<string, HasteMapItem>;
 
 export interface HasteMapItem {
@@ -287,21 +297,6 @@ export interface MutableFileSystem extends FileSystem {
 
 export type Path = string;
 
-export interface RawHasteMap {
-  rootDir: Path;
-  duplicates: DuplicatesIndex;
-  map: HasteMapData;
-}
-
-export type ReadOnlyRawHasteMap = Readonly<{
-  rootDir: Path;
-  duplicates: ReadonlyMap<
-    string,
-    ReadonlyMap<string, ReadonlyMap<string, number>>
-  >;
-  map: ReadonlyMap<string, HasteMapItem>;
-}>;
-
 export type WatchmanClockSpec =
   | string
   | Readonly<{scm: Readonly<{'mergebase-with': string}>}>;
@@ -312,7 +307,6 @@ export type WorkerMessage = Readonly<{
   computeSha1: boolean;
   dependencyExtractor?: string | null;
   enableHastePackages: boolean;
-  readLink: boolean;
   rootDir: string;
   filePath: string;
   hasteImplModulePath?: string | null;
@@ -323,5 +317,4 @@ export type WorkerMetadata = Readonly<{
   id?: string | null;
   module?: HasteMapItemMetaData | null;
   sha1?: string | null;
-  symlinkTarget?: string | null;
 }>;

package/src/flow-types.js.flow

@@ -12,7 +12,6 @@
 'use strict';
 
 import type {PerfLogger, PerfLoggerFactory, RootPerfLogger} from 'metro-config';
-import type {AbortSignal} from 'node-abort-controller';
 
 export type {PerfLoggerFactory, PerfLogger};
 
@@ -43,12 +42,12 @@ export type BuildParameters = $ReadOnly<{
 export type BuildResult = {
   fileSystem: FileSystem,
   hasteMap: HasteMap,
-  mockMap: MockMap,
+  mockMap: ?MockMap,
 };
 
 export type CacheData = $ReadOnly<{
   clocks: WatchmanClocks,
-  mocks: RawMockMap,
+  mocks: ?RawMockMap,
   fileSystemData: mixed,
 }>;
 
@@ -125,7 +124,7 @@ export type DuplicatesIndex = Map<string, Map<string, DuplicatesSet>>;
 
 export type EventsQueue = Array<{
   filePath: Path,
-  metadata?: ?ChangeEventMetadata,
+  metadata: ChangeEventMetadata,
   type: string,
 }>;
 
@@ -272,6 +271,13 @@ export interface MockMap {
   getMockModule(name: string): ?Path;
 }
 
+export type HasteConflict = {
+  id: string,
+  platform: string | null,
+  absolutePaths: Array<string>,
+  type: 'duplicate' | 'shadowing',
+};
+
 export interface HasteMap {
   getModule(
     name: string,
@@ -286,7 +292,7 @@ export interface HasteMap {
     _supportsNativePlatform: ?boolean,
   ): ?Path;
 
-  getRawHasteMap(): ReadOnlyRawHasteMap;
+  computeConflicts(): Array<HasteConflict>;
 }
 
 export type HasteMapData = Map<string, HasteMapItem>;
@@ -305,22 +311,37 @@ export interface MutableFileSystem extends FileSystem {
 
 export type Path = string;
 
-export type RawMockMap = Map<string, Path>;
-
-export type RawHasteMap = {
-  duplicates: DuplicatesIndex,
-  map: HasteMapData,
-};
+export type RawMockMap = $ReadOnly<{
+  duplicates: Map<string, Set<string>>,
+  mocks: Map<string, Path>,
+}>;
 
-export type ReadOnlyRawHasteMap = $ReadOnly<{
-  duplicates: $ReadOnlyMap<
-    string,
-    $ReadOnlyMap<string, $ReadOnlyMap<string, number>>,
-  >,
-  map: $ReadOnlyMap<string, HasteMapItem>,
+export type ReadOnlyRawMockMap = $ReadOnly<{
+  duplicates: $ReadOnlyMap<string, $ReadOnlySet<string>>,
+  mocks: $ReadOnlyMap<string, Path>,
 }>;
 
-export type ReadOnlyRawMockMap = $ReadOnlyMap<string, Path>;
+export interface WatcherBackend {
+  getPauseReason(): ?string;
+  onError((error: Error) => void): () => void;
+  onFileEvent((event: WatcherBackendChangeEvent) => void): () => void;
+  startWatching(): Promise<void>;
+  stopWatching(): Promise<void>;
+}
+
+export type WatcherBackendChangeEvent =
+  | $ReadOnly<{
+      event: 'touch',
+      relativePath: string,
+      root: string,
+      metadata: ChangeEventMetadata,
+    }>
+  | $ReadOnly<{
+      event: 'delete',
+      relativePath: string,
+      root: string,
+      metadata?: void,
+    }>;
 
 export type WatchmanClockSpec =
   | string
@@ -332,7 +353,6 @@ export type WorkerMessage = $ReadOnly<{
   computeSha1: boolean,
   dependencyExtractor?: ?string,
   enableHastePackages: boolean,
-  readLink: boolean,
   rootDir: string,
   filePath: string,
   hasteImplModulePath?: ?string,
@@ -343,5 +363,4 @@ export type WorkerMetadata = $ReadOnly<{
   id?: ?string,
   module?: ?HasteMapItemMetaData,
   sha1?: ?string,
-  symlinkTarget?: ?string,
 }>;

package/src/index.d.ts

@@ -17,6 +17,7 @@ import type {
   Console,
   FileData,
   FileSystem,
+  HasteConflict,
   HasteMapData,
   HasteMapItem,
   PerfLoggerFactory,
@@ -90,4 +91,7 @@ export default class FileMap extends EventEmitter {
   read(): Promise<CacheData | null>;
 }
 
-export class DuplicateError extends Error {}
+export class HasteConflictsError extends Error {
+  constructor(conflicts: ReadonlyArray<HasteConflict>);
+  getDetailedMessage(pathsRelativeToRoot?: string): string;
+}