metro-file-map 0.71.0 → 0.71.3

package/package.json

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

package/src/cache/DiskCacheManager.js

@@ -0,0 +1,85 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.DiskCacheManager = void 0;
+
+var _rootRelativeCacheKeys = _interopRequireDefault(
+  require("../lib/rootRelativeCacheKeys")
+);
+
+var _gracefulFs = require("graceful-fs");
+
+var _os = require("os");
+
+var _path = _interopRequireDefault(require("path"));
+
+var _v = require("v8");
+
+function _interopRequireDefault(obj) {
+  return obj && obj.__esModule ? obj : { default: obj };
+}
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *
+ * @format
+ */
+// $FlowFixMe[missing-export] - serialize and deserialize missing typedefs
+const DEFAULT_PREFIX = "metro-file-map";
+const DEFAULT_DIRECTORY = (0, _os.tmpdir)();
+
+class DiskCacheManager {
+  constructor({ buildParameters, cacheDirectory, cacheFilePrefix }) {
+    this._cachePath = DiskCacheManager.getCacheFilePath(
+      buildParameters,
+      cacheFilePrefix,
+      cacheDirectory
+    );
+  }
+
+  static getCacheFilePath(buildParameters, cacheFilePrefix, cacheDirectory) {
+    const { rootDirHash, relativeConfigHash } = (0,
+    _rootRelativeCacheKeys.default)(buildParameters);
+    return _path.default.join(
+      cacheDirectory !== null && cacheDirectory !== void 0
+        ? cacheDirectory
+        : DEFAULT_DIRECTORY,
+      `${
+        cacheFilePrefix !== null && cacheFilePrefix !== void 0
+          ? cacheFilePrefix
+          : DEFAULT_PREFIX
+      }-${rootDirHash}-${relativeConfigHash}`
+    );
+  }
+
+  getCacheFilePath() {
+    return this._cachePath;
+  }
+
+  async read() {
+    try {
+      return (0, _v.deserialize)(
+        (0, _gracefulFs.readFileSync)(this._cachePath)
+      );
+    } catch {}
+
+    return null;
+  }
+
+  async write(dataSnapshot, { changed, removed }) {
+    if (changed.size > 0 || removed.size > 0) {
+      (0, _gracefulFs.writeFileSync)(
+        this._cachePath,
+        (0, _v.serialize)(dataSnapshot)
+      );
+    }
+  }
+}
+
+exports.DiskCacheManager = DiskCacheManager;

package/src/cache/DiskCacheManager.js.flow

@@ -0,0 +1,84 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+import type {
+  BuildParameters,
+  CacheManager,
+  FileData,
+  InternalData,
+} from '../flow-types';
+
+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 = {
+  buildParameters: BuildParameters,
+  cacheFilePrefix?: ?string,
+  cacheDirectory?: ?string,
+};
+
+const DEFAULT_PREFIX = 'metro-file-map';
+const DEFAULT_DIRECTORY = tmpdir();
+
+export class DiskCacheManager implements CacheManager {
+  _cachePath: string;
+
+  constructor({
+    buildParameters,
+    cacheDirectory,
+    cacheFilePrefix,
+  }: DiskCacheConfig) {
+    this._cachePath = DiskCacheManager.getCacheFilePath(
+      buildParameters,
+      cacheFilePrefix,
+      cacheDirectory,
+    );
+  }
+
+  static getCacheFilePath(
+    buildParameters: BuildParameters,
+    cacheFilePrefix?: ?string,
+    cacheDirectory?: ?string,
+  ): string {
+    const {rootDirHash, relativeConfigHash} =
+      rootRelativeCacheKeys(buildParameters);
+
+    return path.join(
+      cacheDirectory ?? DEFAULT_DIRECTORY,
+      `${
+        cacheFilePrefix ?? DEFAULT_PREFIX
+      }-${rootDirHash}-${relativeConfigHash}`,
+    );
+  }
+
+  getCacheFilePath(): string {
+    return this._cachePath;
+  }
+
+  async read(): Promise<?InternalData> {
+    try {
+      return deserialize(readFileSync(this._cachePath));
+    } catch {}
+    return null;
+  }
+
+  async write(
+    dataSnapshot: InternalData,
+    {changed, removed}: $ReadOnly<{changed: FileData, removed: FileData}>,
+  ): Promise<void> {
+    if (changed.size > 0 || removed.size > 0) {
+      writeFileSync(this._cachePath, serialize(dataSnapshot));
+    }
+  }
+}

package/src/crawlers/node.js

@@ -256,7 +256,7 @@ module.exports = async function nodeCrawl(options) {
   } = options;
   perfLogger === null || perfLogger === void 0
     ? void 0
-    : perfLogger.markerPoint("nodeCrawl_start");
+    : perfLogger.point("nodeCrawl_start");
   const useNativeFind = await hasNativeFindSupport(forceNodeFilesystemAPI);
   return new Promise((resolve) => {
     const callback = (list) => {
@@ -279,7 +279,7 @@ module.exports = async function nodeCrawl(options) {
       data.files = files;
       perfLogger === null || perfLogger === void 0
         ? void 0
-        : perfLogger.markerPoint("nodeCrawl_end");
+        : perfLogger.point("nodeCrawl_end");
       resolve({
         hasteMap: data,
         removedFiles,

package/src/crawlers/node.js.flow

@@ -12,7 +12,7 @@ import type {
   CrawlerOptions,
   FileData,
   IgnoreMatcher,
-  InternalHasteMap,
+  InternalData,
 } from '../flow-types';
 
 import H from '../constants';
@@ -206,7 +206,7 @@ function findNative(
 
 module.exports = async function nodeCrawl(options: CrawlerOptions): Promise<{
   removedFiles: FileData,
-  hasteMap: InternalHasteMap,
+  hasteMap: InternalData,
 }> {
   const {
     data,
@@ -218,7 +218,7 @@ module.exports = async function nodeCrawl(options: CrawlerOptions): Promise<{
     perfLogger,
     roots,
   } = options;
-  perfLogger?.markerPoint('nodeCrawl_start');
+  perfLogger?.point('nodeCrawl_start');
   const useNativeFind = await hasNativeFindSupport(forceNodeFilesystemAPI);
 
   return new Promise(resolve => {
@@ -239,7 +239,7 @@ module.exports = async function nodeCrawl(options: CrawlerOptions): Promise<{
       });
       data.files = files;
 
-      perfLogger?.markerPoint('nodeCrawl_end');
+      perfLogger?.point('nodeCrawl_end');
       resolve({
         hasteMap: data,
         removedFiles,

package/src/crawlers/watchman.js

@@ -102,16 +102,22 @@ 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;
   perfLogger === null || perfLogger === void 0
     ? void 0
-    : perfLogger.markerPoint("watchmanCrawl_start");
+    : 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.markerPoint("watchmanCrawl/negotiateCapabilities_start"); // https://facebook.github.io/watchman/docs/capabilities.html
+    : perfLogger.point("watchmanCrawl/negotiateCapabilities_start"); // https://facebook.github.io/watchman/docs/capabilities.html
   // Check adds about ~28ms
 
   const capabilities = await capabilityCheck(client, {
@@ -171,22 +177,22 @@ module.exports = async function watchmanCrawl(options) {
 
   perfLogger === null || perfLogger === void 0
     ? void 0
-    : perfLogger.markerPoint("watchmanCrawl/negotiateCapabilities_end");
+    : perfLogger.point("watchmanCrawl/negotiateCapabilities_end");
 
   async function getWatchmanRoots(roots) {
     perfLogger === null || perfLogger === void 0
       ? void 0
-      : perfLogger.markerPoint("watchmanCrawl/getWatchmanRoots_start");
+      : perfLogger.point("watchmanCrawl/getWatchmanRoots_start");
     const watchmanRoots = new Map();
     await Promise.all(
       roots.map(async (root, index) => {
         perfLogger === null || perfLogger === void 0
           ? void 0
-          : perfLogger.markerPoint(`watchmanCrawl/watchProject_${index}_start`);
+          : perfLogger.point(`watchmanCrawl/watchProject_${index}_start`);
         const response = await cmd("watch-project", root);
         perfLogger === null || perfLogger === void 0
           ? void 0
-          : perfLogger.markerPoint(`watchmanCrawl/watchProject_${index}_end`);
+          : perfLogger.point(`watchmanCrawl/watchProject_${index}_end`);
         const existing = watchmanRoots.get(response.watch); // A root can only be filtered if it was never seen with a
         // relative_path before.
 
@@ -209,14 +215,14 @@ module.exports = async function watchmanCrawl(options) {
     );
     perfLogger === null || perfLogger === void 0
       ? void 0
-      : perfLogger.markerPoint("watchmanCrawl/getWatchmanRoots_end");
+      : perfLogger.point("watchmanCrawl/getWatchmanRoots_end");
     return watchmanRoots;
   }
 
   async function queryWatchmanForDirs(rootProjectDirMappings) {
     perfLogger === null || perfLogger === void 0
       ? void 0
-      : perfLogger.markerPoint("watchmanCrawl/queryWatchmanForDirs_start");
+      : perfLogger.point("watchmanCrawl/queryWatchmanForDirs_start");
     const results = new Map();
     let isFresh = false;
     await Promise.all(
@@ -235,7 +241,7 @@ module.exports = async function watchmanCrawl(options) {
           const since = clocks.get(fastPath.relative(rootDir, root));
           perfLogger === null || perfLogger === void 0
             ? void 0
-            : perfLogger.markerAnnotate({
+            : perfLogger.annotate({
                 bool: {
                   [`watchmanCrawl/query_${index}_has_clock`]: since != null,
                 },
@@ -297,18 +303,18 @@ module.exports = async function watchmanCrawl(options) {
 
           perfLogger === null || perfLogger === void 0
             ? void 0
-            : perfLogger.markerAnnotate({
+            : perfLogger.annotate({
                 string: {
                   [`watchmanCrawl/query_${index}_generator`]: queryGenerator,
                 },
               });
           perfLogger === null || perfLogger === void 0
             ? void 0
-            : perfLogger.markerPoint(`watchmanCrawl/query_${index}_start`);
+            : perfLogger.point(`watchmanCrawl/query_${index}_start`);
           const response = await cmd("query", root, query);
           perfLogger === null || perfLogger === void 0
             ? void 0
-            : perfLogger.markerPoint(`watchmanCrawl/query_${index}_end`);
+            : perfLogger.point(`watchmanCrawl/query_${index}_end`);
 
           if ("warning" in response) {
             console.warn("watchman warning: ", response.warning);
@@ -334,7 +340,7 @@ module.exports = async function watchmanCrawl(options) {
     );
     perfLogger === null || perfLogger === void 0
       ? void 0
-      : perfLogger.markerPoint("watchmanCrawl/queryWatchmanForDirs_end");
+      : perfLogger.point("watchmanCrawl/queryWatchmanForDirs_end");
     return {
       isFresh,
       results,
@@ -366,13 +372,13 @@ module.exports = async function watchmanCrawl(options) {
   if (clientError) {
     perfLogger === null || perfLogger === void 0
       ? void 0
-      : perfLogger.markerPoint("watchmanCrawl_end");
+      : perfLogger.point("watchmanCrawl_end");
     throw clientError;
   }
 
   perfLogger === null || perfLogger === void 0
     ? void 0
-    : perfLogger.markerPoint("watchmanCrawl/processResults_start");
+    : perfLogger.point("watchmanCrawl/processResults_start");
 
   for (const [watchRoot, response] of results) {
     const fsRoot = (0, _normalizePathSep.default)(watchRoot);
@@ -460,10 +466,10 @@ module.exports = async function watchmanCrawl(options) {
   data.files = files;
   perfLogger === null || perfLogger === void 0
     ? void 0
-    : perfLogger.markerPoint("watchmanCrawl/processResults_end");
+    : perfLogger.point("watchmanCrawl/processResults_end");
   perfLogger === null || perfLogger === void 0
     ? void 0
-    : perfLogger.markerPoint("watchmanCrawl_end");
+    : perfLogger.point("watchmanCrawl_end");
 
   if (didLogWatchmanWaitMessage) {
     console.warn("Watchman query finished.");

package/src/crawlers/watchman.js.flow

@@ -12,7 +12,7 @@ import type {
   CrawlerOptions,
   FileData,
   FileMetaData,
-  InternalHasteMap,
+  InternalData,
   Path,
 } from '../flow-types';
 
@@ -106,16 +106,17 @@ module.exports = async function watchmanCrawl(
 ): Promise<{
   changedFiles?: FileData,
   removedFiles: FileData,
-  hasteMap: InternalHasteMap,
+  hasteMap: InternalData,
 }> {
   const fields = ['name', 'exists', 'mtime_ms', 'size'];
   const {data, extensions, ignore, rootDir, roots, perfLogger} = options;
   const clocks = data.clocks;
 
-  perfLogger?.markerPoint('watchmanCrawl_start');
+  perfLogger?.point('watchmanCrawl_start');
   const client = new watchman.Client();
+  options.abortSignal?.addEventListener('abort', () => client.end());
 
-  perfLogger?.markerPoint('watchmanCrawl/negotiateCapabilities_start');
+  perfLogger?.point('watchmanCrawl/negotiateCapabilities_start');
   // https://facebook.github.io/watchman/docs/capabilities.html
   // Check adds about ~28ms
   const capabilities = await capabilityCheck(client, {
@@ -172,21 +173,21 @@ module.exports = async function watchmanCrawl(
     }
   }
 
-  perfLogger?.markerPoint('watchmanCrawl/negotiateCapabilities_end');
+  perfLogger?.point('watchmanCrawl/negotiateCapabilities_end');
 
   async function getWatchmanRoots(
     roots: $ReadOnlyArray<Path>,
   ): Promise<WatchmanRoots> {
-    perfLogger?.markerPoint('watchmanCrawl/getWatchmanRoots_start');
+    perfLogger?.point('watchmanCrawl/getWatchmanRoots_start');
     const watchmanRoots = new Map();
     await Promise.all(
       roots.map(async (root, index) => {
-        perfLogger?.markerPoint(`watchmanCrawl/watchProject_${index}_start`);
+        perfLogger?.point(`watchmanCrawl/watchProject_${index}_start`);
         const response = await cmd<WatchmanWatchProjectResponse>(
           'watch-project',
           root,
         );
-        perfLogger?.markerPoint(`watchmanCrawl/watchProject_${index}_end`);
+        perfLogger?.point(`watchmanCrawl/watchProject_${index}_end`);
         const existing = watchmanRoots.get(response.watch);
         // A root can only be filtered if it was never seen with a
         // relative_path before.
@@ -207,12 +208,12 @@ module.exports = async function watchmanCrawl(
         }
       }),
     );
-    perfLogger?.markerPoint('watchmanCrawl/getWatchmanRoots_end');
+    perfLogger?.point('watchmanCrawl/getWatchmanRoots_end');
     return watchmanRoots;
   }
 
   async function queryWatchmanForDirs(rootProjectDirMappings: WatchmanRoots) {
-    perfLogger?.markerPoint('watchmanCrawl/queryWatchmanForDirs_start');
+    perfLogger?.point('watchmanCrawl/queryWatchmanForDirs_start');
     const results = new Map<string, WatchmanQueryResponse>();
     let isFresh = false;
     await Promise.all(
@@ -228,7 +229,7 @@ module.exports = async function watchmanCrawl(
           // system and import it, transforming the clock into a local clock.
           const since = clocks.get(fastPath.relative(rootDir, root));
 
-          perfLogger?.markerAnnotate({
+          perfLogger?.annotate({
             bool: {
               [`watchmanCrawl/query_${index}_has_clock`]: since != null,
             },
@@ -294,19 +295,19 @@ module.exports = async function watchmanCrawl(
             queryGenerator = 'suffix';
           }
 
-          perfLogger?.markerAnnotate({
+          perfLogger?.annotate({
             string: {
               [`watchmanCrawl/query_${index}_generator`]: queryGenerator,
             },
           });
 
-          perfLogger?.markerPoint(`watchmanCrawl/query_${index}_start`);
+          perfLogger?.point(`watchmanCrawl/query_${index}_start`);
           const response = await cmd<WatchmanQueryResponse>(
             'query',
             root,
             query,
           );
-          perfLogger?.markerPoint(`watchmanCrawl/query_${index}_end`);
+          perfLogger?.point(`watchmanCrawl/query_${index}_end`);
 
           if ('warning' in response) {
             console.warn('watchman warning: ', response.warning);
@@ -326,7 +327,7 @@ module.exports = async function watchmanCrawl(
       ),
     );
 
-    perfLogger?.markerPoint('watchmanCrawl/queryWatchmanForDirs_end');
+    perfLogger?.point('watchmanCrawl/queryWatchmanForDirs_end');
 
     return {
       isFresh,
@@ -357,11 +358,11 @@ module.exports = async function watchmanCrawl(
   }
 
   if (clientError) {
-    perfLogger?.markerPoint('watchmanCrawl_end');
+    perfLogger?.point('watchmanCrawl_end');
     throw clientError;
   }
 
-  perfLogger?.markerPoint('watchmanCrawl/processResults_start');
+  perfLogger?.point('watchmanCrawl/processResults_start');
 
   for (const [watchRoot, response] of results) {
     const fsRoot = normalizePathSep(watchRoot);
@@ -438,8 +439,8 @@ module.exports = async function watchmanCrawl(
 
   data.files = files;
 
-  perfLogger?.markerPoint('watchmanCrawl/processResults_end');
-  perfLogger?.markerPoint('watchmanCrawl_end');
+  perfLogger?.point('watchmanCrawl/processResults_end');
+  perfLogger?.point('watchmanCrawl_end');
   if (didLogWatchmanWaitMessage) {
     console.warn('Watchman query finished.');
   }

package/src/flow-types.js.flow

@@ -13,6 +13,44 @@
 import type HasteFS from './HasteFS';
 import type ModuleMap from './ModuleMap';
 import type {Stats} from 'graceful-fs';
+import type {PerfLogger} from 'metro-config';
+
+export type {PerfLogger};
+
+// These inputs affect the internal data collected for a given filesystem
+// state, and changes may invalidate a cache.
+export type BuildParameters = $ReadOnly<{
+  computeDependencies: boolean,
+  computeSha1: boolean,
+  enableSymlinks: boolean,
+  extensions: $ReadOnlyArray<string>,
+  forceNodeFilesystemAPI: boolean,
+  ignorePattern: RegExp,
+  mocksPattern: ?RegExp,
+  platforms: $ReadOnlyArray<string>,
+  retainAllFiles: boolean,
+  rootDir: string,
+  roots: $ReadOnlyArray<string>,
+  skipPackageJson: boolean,
+
+  // Module paths that should export a 'getCacheKey' method
+  dependencyExtractor: ?string,
+  hasteImplModulePath: ?string,
+
+  cacheBreaker: string,
+}>;
+
+export interface CacheManager {
+  read(): Promise<?InternalData>;
+  write(
+    dataSnapshot: InternalData,
+    delta: $ReadOnly<{changed: FileData, removed: FileData}>,
+  ): Promise<void>;
+}
+
+export type CacheManagerFactory = (
+  buildParameters: BuildParameters,
+) => CacheManager;
 
 export type ChangeEvent = {
   eventsQueue: EventsQueue,
@@ -23,9 +61,10 @@ export type ChangeEvent = {
 export type Console = typeof global.console;
 
 export type CrawlerOptions = {
+  abortSignal: ?AbortSignal,
   computeSha1: boolean,
   enableSymlinks: boolean,
-  data: InternalHasteMap,
+  data: InternalData,
   extensions: $ReadOnlyArray<string>,
   forceNodeFilesystemAPI: boolean,
   ignore: IgnoreMatcher,
@@ -46,20 +85,8 @@ export type EventsQueue = Array<{
 export type HasteMap = {
   hasteFS: HasteFS,
   moduleMap: ModuleMap,
-  __hasteMapForTest?: ?InternalHasteMap,
-};
-
-export type HasteMapStatic<S = SerializableModuleMap> = {
-  getCacheFilePath(
-    tmpdir: Path,
-    name: string,
-    ...extra: $ReadOnlyArray<string>
-  ): string,
-  getModuleMapFromJSON(json: S): IModuleMap<S>,
 };
 
-export type HasteRegExp = RegExp | ((str: string) => boolean);
-
 export type HType = {
   ID: 0,
   MTIME: 1,
@@ -80,7 +107,7 @@ export type HTypeValue = $Values<HType>;
 
 export type IgnoreMatcher = (item: string) => boolean;
 
-export type InternalHasteMap = {
+export type InternalData = {
   clocks: WatchmanClocks,
   duplicates: DuplicatesIndex,
   files: FileData,
@@ -131,22 +158,6 @@ export type ModuleMetaData = [/* path */ string, /* type */ number];
 
 export type Path = string;
 
-export interface PerfLogger {
-  markerPoint(name: string): void;
-  markerAnnotate(annotations: PerfAnnotations): void;
-}
-
-export type PerfAnnotations = $Shape<{
-  string: {[key: string]: string},
-  int: {[key: string]: number},
-  double: {[key: string]: number},
-  bool: {[key: string]: boolean},
-  string_array: {[key: string]: Array<string>},
-  int_array: {[key: string]: Array<number>},
-  double_array: {[key: string]: Array<number>},
-  bool_array: {[key: string]: Array<boolean>},
-}>;
-
 export type RawModuleMap = {
   rootDir: Path,
   duplicates: DuplicatesIndex,