metro-file-map 0.71.2 → 0.72.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metro-file-map",
-  "version": "0.71.2",
+  "version": "0.72.1",
   "description": "[Experimental] - 🚇 File crawling, watching and mapping for Metro",
   "main": "src/index.js",
   "repository": {
@@ -13,6 +13,7 @@
   },
   "license": "MIT",
   "dependencies": {
+    "abort-controller": "^3.0.0",
     "anymatch": "^3.0.3",
     "debug": "^2.2.0",
     "fb-watchman": "^2.0.0",

package/src/HasteFS.js

@@ -9,6 +9,8 @@ var _constants = _interopRequireDefault(require("./constants"));
 
 var fastPath = _interopRequireWildcard(require("./lib/fast_path"));
 
+var path = _interopRequireWildcard(require("path"));
+
 var _jestUtil = require("jest-util");
 
 function _getRequireWildcardCache(nodeInterop) {
@@ -66,7 +68,6 @@ function _interopRequireDefault(obj) {
  * @format
  *
  */
-// $FlowFixMe[untyped-import] - jest-util
 class HasteFS {
   constructor({ rootDir, files }) {
     this._rootDir = rootDir;
@@ -141,6 +142,42 @@ class HasteFS {
 
     return files;
   }
+  /**
+   * Given a search context, return a list of file paths matching the query.
+   * The query matches against normalized paths which start with `./`,
+   * for example: `a/b.js` -> `./a/b.js`
+   */
+
+  matchFilesWithContext(root, context) {
+    const files = [];
+    const prefix = "./";
+
+    for (const file of this.getAbsoluteFileIterator()) {
+      const filePath = fastPath.relative(root, file);
+      const isUnderRoot = filePath && !filePath.startsWith(".."); // Ignore everything outside of the provided `root`.
+
+      if (!isUnderRoot) {
+        continue;
+      } // Prevent searching in child directories during a non-recursive search.
+
+      if (!context.recursive && filePath.includes(path.sep)) {
+        continue;
+      }
+
+      if (
+        context.filter.test(
+          // NOTE(EvanBacon): Ensure files start with `./` for matching purposes
+          // this ensures packages work across Metro and Webpack (ex: Storybook for React DOM / React Native).
+          // `a/b.js` -> `./a/b.js`
+          prefix + filePath.replace(/\\/g, "/")
+        )
+      ) {
+        files.push(file);
+      }
+    }
+
+    return files;
+  }
 
   matchFilesWithGlob(globs, root) {
     const files = new Set();

package/src/HasteFS.js.flow

@@ -8,16 +8,13 @@
  * @flow strict-local
  */
 
-import type {FileData, Path} from './flow-types';
+import type {FileData, FileMetaData, Glob, Path} from './flow-types';
 
 import H from './constants';
 import * as fastPath from './lib/fast_path';
-// $FlowFixMe[untyped-import] - jest-util
+import * as path from 'path';
 import {globsToMatcher, replacePathSepForGlob} from 'jest-util';
 
-// $FlowFixMe[unclear-type] - Check TS Config.Glob
-type Glob = any;
-
 export default class HasteFS {
   +_rootDir: Path;
   +_files: FileData;
@@ -84,6 +81,52 @@ export default class HasteFS {
     return files;
   }
 
+  /**
+   * Given a search context, return a list of file paths matching the query.
+   * The query matches against normalized paths which start with `./`,
+   * for example: `a/b.js` -> `./a/b.js`
+   */
+  matchFilesWithContext(
+    root: Path,
+    context: $ReadOnly<{
+      /* Should search for files recursively. */
+      recursive: boolean,
+      /* Filter relative paths against a pattern. */
+      filter: RegExp,
+    }>,
+  ): Array<Path> {
+    const files = [];
+    const prefix = './';
+
+    for (const file of this.getAbsoluteFileIterator()) {
+      const filePath = fastPath.relative(root, file);
+
+      const isUnderRoot = filePath && !filePath.startsWith('..');
+      // Ignore everything outside of the provided `root`.
+      if (!isUnderRoot) {
+        continue;
+      }
+
+      // Prevent searching in child directories during a non-recursive search.
+      if (!context.recursive && filePath.includes(path.sep)) {
+        continue;
+      }
+
+      if (
+        context.filter.test(
+          // NOTE(EvanBacon): Ensure files start with `./` for matching purposes
+          // this ensures packages work across Metro and Webpack (ex: Storybook for React DOM / React Native).
+          // `a/b.js` -> `./a/b.js`
+          prefix + filePath.replace(/\\/g, '/'),
+        )
+      ) {
+        files.push(file);
+      }
+    }
+
+    return files;
+  }
+
   matchFilesWithGlob(globs: $ReadOnlyArray<Glob>, root: ?Path): Set<Path> {
     const files = new Set<string>();
     const matcher = globsToMatcher(globs);
@@ -97,7 +140,7 @@ export default class HasteFS {
     return files;
   }
 
-  _getFileData(file: Path) {
+  _getFileData(file: Path): void | FileMetaData {
     const relativePath = fastPath.relative(this._rootDir, file);
     return this._files.get(relativePath);
   }

package/src/ModuleMap.js.flow

@@ -184,7 +184,7 @@ export default class ModuleMap implements IModuleMap<SerializableModuleMap> {
     platform: string,
     supportsNativePlatform: boolean,
     relativePathSet: ?DuplicatesSet,
-  ) {
+  ): void {
     if (relativePathSet == null) {
       return;
     }

package/src/cache/DiskCacheManager.js

@@ -30,7 +30,6 @@ function _interopRequireDefault(obj) {
  *
  * @format
  */
-// $FlowFixMe[missing-export] - serialize and deserialize missing typedefs
 const DEFAULT_PREFIX = "metro-file-map";
 const DEFAULT_DIRECTORY = (0, _os.tmpdir)();
 

package/src/cache/DiskCacheManager.js.flow

@@ -19,7 +19,6 @@ import rootRelativeCacheKeys from '../lib/rootRelativeCacheKeys';
 import {readFileSync, writeFileSync} from 'graceful-fs';
 import {tmpdir} from 'os';
 import path from 'path';
-// $FlowFixMe[missing-export] - serialize and deserialize missing typedefs
 import {deserialize, serialize} from 'v8';
 
 type DiskCacheConfig = {

package/src/crawlers/watchman.js

@@ -91,8 +91,12 @@ async function capabilityCheck(client, caps) {
       // @ts-expect-error: incorrectly typed
       caps,
       (error, response) => {
-        if (error) {
-          reject(error);
+        if (error != null || response == null) {
+          reject(
+            error !== null && error !== void 0
+              ? error
+              : new Error("capabilityCheck: Response missing")
+          );
         } else {
           resolve(response);
         }
@@ -102,6 +106,8 @@ async function capabilityCheck(client, caps) {
 }
 
 module.exports = async function watchmanCrawl(options) {
+  var _options$abortSignal;
+
   const fields = ["name", "exists", "mtime_ms", "size"];
   const { data, extensions, ignore, rootDir, roots, perfLogger } = options;
   const clocks = data.clocks;
@@ -109,6 +115,10 @@ module.exports = async function watchmanCrawl(options) {
     ? void 0
     : perfLogger.point("watchmanCrawl_start");
   const client = new watchman.Client();
+  (_options$abortSignal = options.abortSignal) === null ||
+  _options$abortSignal === void 0
+    ? void 0
+    : _options$abortSignal.addEventListener("abort", () => client.end());
   perfLogger === null || perfLogger === void 0
     ? void 0
     : perfLogger.point("watchmanCrawl/negotiateCapabilities_start"); // https://facebook.github.io/watchman/docs/capabilities.html
@@ -273,7 +283,7 @@ module.exports = async function watchmanCrawl(options) {
            * directories. Therefore `glob` < `suffix`.
            */
 
-          let queryGenerator = undefined;
+          let queryGenerator;
 
           if (since != null) {
             // Use the `since` generator and filter by both path and extension.
@@ -346,6 +356,7 @@ module.exports = async function watchmanCrawl(options) {
   const changedFiles = new Map();
   let results;
   let isFresh = false;
+  let queryError;
 
   try {
     const watchmanRoots = await getWatchmanRoots(roots);
@@ -359,15 +370,56 @@ module.exports = async function watchmanCrawl(options) {
     }
 
     results = watchmanFileResults.results;
-  } finally {
-    client.end();
+  } catch (e) {
+    queryError = e;
   }
 
-  if (clientError) {
+  client.end();
+
+  if (results == null) {
+    var _ref, _queryError;
+
+    if (clientError) {
+      var _clientError$message;
+
+      perfLogger === null || perfLogger === void 0
+        ? void 0
+        : perfLogger.annotate({
+            string: {
+              "watchmanCrawl/client_error":
+                (_clientError$message = clientError.message) !== null &&
+                _clientError$message !== void 0
+                  ? _clientError$message
+                  : "[message missing]",
+            },
+          });
+    }
+
+    if (queryError) {
+      var _queryError$message;
+
+      perfLogger === null || perfLogger === void 0
+        ? void 0
+        : perfLogger.annotate({
+            string: {
+              "watchmanCrawl/query_error":
+                (_queryError$message = queryError.message) !== null &&
+                _queryError$message !== void 0
+                  ? _queryError$message
+                  : "[message missing]",
+            },
+          });
+    }
+
     perfLogger === null || perfLogger === void 0
       ? void 0
       : perfLogger.point("watchmanCrawl_end");
-    throw clientError;
+    throw (_ref =
+      (_queryError = queryError) !== null && _queryError !== void 0
+        ? _queryError
+        : clientError) !== null && _ref !== void 0
+      ? _ref
+      : new Error("Watchman file results missing");
   }
 
   perfLogger === null || perfLogger === void 0

package/src/crawlers/watchman.js.flow

@@ -91,8 +91,8 @@ async function capabilityCheck(
       // @ts-expect-error: incorrectly typed
       caps,
       (error, response) => {
-        if (error) {
-          reject(error);
+        if (error != null || response == null) {
+          reject(error ?? new Error('capabilityCheck: Response missing'));
         } else {
           resolve(response);
         }
@@ -114,6 +114,7 @@ module.exports = async function watchmanCrawl(
 
   perfLogger?.point('watchmanCrawl_start');
   const client = new watchman.Client();
+  options.abortSignal?.addEventListener('abort', () => client.end());
 
   perfLogger?.point('watchmanCrawl/negotiateCapabilities_start');
   // https://facebook.github.io/watchman/docs/capabilities.html
@@ -268,11 +269,7 @@ module.exports = async function watchmanCrawl(
            * repo but Haste map projects are focused on a handful of
            * directories. Therefore `glob` < `suffix`.
            */
-          let queryGenerator: ?(
-            | $TEMPORARY$string<'glob'>
-            | $TEMPORARY$string<'since'>
-            | $TEMPORARY$string<'suffix'>
-          ) = undefined;
+          let queryGenerator: ?string;
           if (since != null) {
             // Use the `since` generator and filter by both path and extension.
             query.since = since;
@@ -339,6 +336,7 @@ module.exports = async function watchmanCrawl(
   const changedFiles = new Map();
   let results: Map<string, WatchmanQueryResponse>;
   let isFresh = false;
+  let queryError: ?Error;
   try {
     const watchmanRoots = await getWatchmanRoots(roots);
     const watchmanFileResults = await queryWatchmanForDirs(watchmanRoots);
@@ -352,13 +350,32 @@ module.exports = async function watchmanCrawl(
     }
 
     results = watchmanFileResults.results;
-  } finally {
-    client.end();
+  } catch (e) {
+    queryError = e;
   }
-
-  if (clientError) {
+  client.end();
+
+  if (results == null) {
+    if (clientError) {
+      perfLogger?.annotate({
+        string: {
+          'watchmanCrawl/client_error':
+            clientError.message ?? '[message missing]',
+        },
+      });
+    }
+    if (queryError) {
+      perfLogger?.annotate({
+        string: {
+          'watchmanCrawl/query_error':
+            queryError.message ?? '[message missing]',
+        },
+      });
+    }
     perfLogger?.point('watchmanCrawl_end');
-    throw clientError;
+    throw (
+      queryError ?? clientError ?? new Error('Watchman file results missing')
+    );
   }
 
   perfLogger?.point('watchmanCrawl/processResults_start');

package/src/flow-types.js.flow

@@ -61,6 +61,7 @@ export type ChangeEvent = {
 export type Console = typeof global.console;
 
 export type CrawlerOptions = {
+  abortSignal: ?AbortSignal,
   computeSha1: boolean,
   enableSymlinks: boolean,
   data: InternalData,
@@ -125,6 +126,8 @@ export type FileMetaData = [
   /* sha1 */ ?string,
 ];
 
+export type Glob = string;
+
 export interface IModuleMap<S = SerializableModuleMap> {
   getModule(
     name: string,

package/src/index.js

@@ -72,6 +72,8 @@ var _jestWorker = require("jest-worker");
 
 var path = _interopRequireWildcard(require("path"));
 
+var _abortController = _interopRequireDefault(require("abort-controller"));
+
 function _getRequireWildcardCache(nodeInterop) {
   if (typeof WeakMap !== "function") return null;
   var cacheBabelInterop = new WeakMap();
@@ -131,6 +133,7 @@ function _interopRequireDefault(obj) {
 // $FlowFixMe[untyped-import] - WatchmanWatcher
 // $FlowFixMe[untyped-import] - jest-regex-util
 // $FlowFixMe[untyped-import] - jest-worker
+// $FlowFixMe[untyped-import] - this is a polyfill
 const nodeCrawl = require("./crawlers/node");
 
 const watchmanCrawl = require("./crawlers/watchman");
@@ -141,7 +144,7 @@ exports.DuplicateHasteCandidatesError = DuplicateHasteCandidatesError;
 // This should be bumped whenever a code change to `metro-file-map` itself
 // would cause a change to the cache data structure and/or content (for a given
 // filesystem state and build parameters).
-const CACHE_BREAKER = "1";
+const CACHE_BREAKER = "2";
 const CHANGE_INTERVAL = 30;
 const MAX_WAIT_TIME = 240000;
 const NODE_MODULES = path.sep + "node_modules" + path.sep;
@@ -341,6 +344,7 @@ class HasteMap extends _events.default {
     _this$_options$perfLo === void 0
       ? void 0
       : _this$_options$perfLo.point("constructor_end");
+    this._crawlerAbortController = new _abortController.default();
   }
 
   static getCacheFilePath(cacheDirectory, cacheFilePrefix, buildParameters) {
@@ -889,6 +893,7 @@ class HasteMap extends _events.default {
     const crawl =
       canUseWatchman && this._options.useWatchman ? watchmanCrawl : nodeCrawl;
     const crawlerOptions = {
+      abortSignal: this._crawlerAbortController.signal,
       computeSha1: options.computeSha1,
       data: hasteMap,
       enableSymlinks: options.enableSymlinks,
@@ -983,7 +988,12 @@ class HasteMap extends _events.default {
     const createWatcher = (root) => {
       const watcher = new WatcherImpl(root, {
         dot: true,
-        glob: extensions.map((extension) => "**/*." + extension),
+        glob: [
+          // Ensure we always include package.json files, which are crucial for
+          /// module resolution.
+          "**/package.json",
+          ...extensions.map((extension) => "**/*." + extension),
+        ],
         ignored: ignorePattern,
         watchmanDeferStates: this._options.watchmanDeferStates,
       });
@@ -1255,6 +1265,8 @@ class HasteMap extends _events.default {
 
     await Promise.all(this._watchers.map((watcher) => watcher.close()));
     this._watchers = [];
+
+    this._crawlerAbortController.abort();
   }
   /**
    * Helpers

package/src/index.js.flow

@@ -56,6 +56,8 @@ import {escapePathForRegex} from 'jest-regex-util';
 // $FlowFixMe[untyped-import] - jest-worker
 import {Worker} from 'jest-worker';
 import * as path from 'path';
+// $FlowFixMe[untyped-import] - this is a polyfill
+import AbortController from 'abort-controller';
 
 const nodeCrawl = require('./crawlers/node');
 const watchmanCrawl = require('./crawlers/watchman');
@@ -133,7 +135,7 @@ export type {
 // This should be bumped whenever a code change to `metro-file-map` itself
 // would cause a change to the cache data structure and/or content (for a given
 // filesystem state and build parameters).
-const CACHE_BREAKER = '1';
+const CACHE_BREAKER = '2';
 
 const CHANGE_INTERVAL = 30;
 const MAX_WAIT_TIME = 240000;
@@ -237,6 +239,7 @@ export default class HasteMap extends EventEmitter {
   _watchers: Array<Watcher>;
   _worker: ?WorkerInterface;
   _cacheManager: CacheManager;
+  _crawlerAbortController: typeof AbortController;
 
   static create(options: InputOptions): HasteMap {
     return new HasteMap(options);
@@ -320,6 +323,7 @@ export default class HasteMap extends EventEmitter {
     this._watchers = [];
     this._worker = null;
     this._options.perfLogger?.point('constructor_end');
+    this._crawlerAbortController = new AbortController();
   }
 
   static getCacheFilePath(
@@ -774,13 +778,21 @@ export default class HasteMap extends EventEmitter {
     return this._worker;
   }
 
-  _crawl(hasteMap: InternalData) {
+  _crawl(hasteMap: InternalData): Promise<?(
+    | Promise<{
+        changedFiles?: FileData,
+        hasteMap: InternalData,
+        removedFiles: FileData,
+      }>
+    | {changedFiles?: FileData, hasteMap: InternalData, removedFiles: FileData}
+  )> {
     this._options.perfLogger?.point('crawl_start');
     const options = this._options;
-    const ignore = filePath => this._ignore(filePath);
+    const ignore = (filePath: string) => this._ignore(filePath);
     const crawl =
       canUseWatchman && this._options.useWatchman ? watchmanCrawl : nodeCrawl;
     const crawlerOptions: CrawlerOptions = {
+      abortSignal: this._crawlerAbortController.signal,
       computeSha1: options.computeSha1,
       data: hasteMap,
       enableSymlinks: options.enableSymlinks,
@@ -862,7 +874,12 @@ export default class HasteMap extends EventEmitter {
     const createWatcher = (root: Path): Promise<Watcher> => {
       const watcher = new WatcherImpl(root, {
         dot: true,
-        glob: extensions.map(extension => '**/*.' + extension),
+        glob: [
+          // Ensure we always include package.json files, which are crucial for
+          /// module resolution.
+          '**/package.json',
+          ...extensions.map(extension => '**/*.' + extension),
+        ],
         ignored: ignorePattern,
         watchmanDeferStates: this._options.watchmanDeferStates,
       });
@@ -1118,6 +1135,7 @@ export default class HasteMap extends EventEmitter {
     await Promise.all(this._watchers.map(watcher => watcher.close()));
 
     this._watchers = [];
+    this._crawlerAbortController.abort();
   }
 
   /**

package/src/watchers/FSEventsWatcher.js.flow

@@ -61,7 +61,8 @@ export default class FSEventsWatcher extends EventEmitter {
 
   static _normalizeProxy(
     callback: (normalizedPath: string, stats: fs.Stats) => void,
-  ) {
+    // $FlowFixMe[cannot-resolve-name]
+  ): (filepath: string, stats: Stats) => void {
     return (filepath: string, stats: fs.Stats): void =>
       callback(path.normalize(filepath), stats);
   }
@@ -149,7 +150,7 @@ export default class FSEventsWatcher extends EventEmitter {
     }
   }
 
-  _isFileIncluded(relativePath: string) {
+  _isFileIncluded(relativePath: string): boolean {
     if (this.doIgnore(relativePath)) {
       return false;
     }