metro 0.84.1 → 0.84.3

package/src/node-haste/DependencyGraph/ModuleResolution.js.flow

@@ -35,28 +35,7 @@ import util from 'util';
 
 export type DirExistsFn = (filePath: string) => boolean;
 
-export type Packageish = interface {
-  path: string,
-  read(): PackageJson,
-};
-
-export type Moduleish = interface {
-  +path: string,
-};
-
-export type PackageishCache<TPackage> = interface {
-  getPackage(
-    name: string,
-    platform?: string,
-    supportsNativePlatform?: boolean,
-  ): TPackage,
-  getPackageOf(absolutePath: string): ?{
-    pkg: TPackage,
-    packageRelativePath: string,
-  },
-};
-
-type Options<TPackage> = Readonly<{
+type Options = Readonly<{
   assetExts: ReadonlySet<string>,
   dirExists: DirExistsFn,
   disableHierarchicalLookup: boolean,
@@ -67,7 +46,8 @@ type Options<TPackage> = Readonly<{
   getHasteModulePath: (name: string, platform: ?string) => ?string,
   getHastePackagePath: (name: string, platform: ?string) => ?string,
   mainFields: ReadonlyArray<string>,
-  packageCache: PackageishCache<TPackage>,
+  getPackage: (packageJsonPath: string) => ?PackageJson,
+  getPackageForModule: (absolutePath: string) => ?PackageForModule,
   nodeModulesPaths: ReadonlyArray<string>,
   preferNativePlatform: boolean,
   projectRoot: string,
@@ -83,14 +63,14 @@ type Options<TPackage> = Readonly<{
   unstable_incrementalResolution: boolean,
 }>;
 
-export class ModuleResolver<TPackage: Packageish> {
-  _options: Options<TPackage>;
+export class ModuleResolver {
+  _options: Options;
   // A module representing the project root, used as the origin when resolving `emptyModulePath`.
   _projectRootFakeModulePath: string;
   // An empty module, the result of resolving `emptyModulePath` from the project root.
   _cachedEmptyModule: ?BundlerResolution;
 
-  constructor(options: Options<TPackage>) {
+  constructor(options: Options) {
     this._options = options;
     const {projectRoot} = this._options;
     this._projectRootFakeModulePath = path.join(projectRoot, '_');
@@ -132,6 +112,8 @@ export class ModuleResolver<TPackage: Packageish> {
       doesFileExist,
       extraNodeModules,
       fileSystemLookup,
+      getPackage,
+      getPackageForModule,
       mainFields,
       nodeModulesPaths,
       preferNativePlatform,
@@ -156,9 +138,8 @@ export class ModuleResolver<TPackage: Packageish> {
             doesFileExist,
             extraNodeModules,
             fileSystemLookup,
-            getPackage: this._getPackage,
-            getPackageForModule: (absoluteModulePath: string) =>
-              this._getPackageForModule(absoluteModulePath),
+            getPackage,
+            getPackageForModule,
             isESMImport: dependency.data.isESMImport,
             mainFields,
             nodeModulesPaths,
@@ -240,36 +221,6 @@ export class ModuleResolver<TPackage: Packageish> {
     }
   }
 
-  _getPackage = (packageJsonPath: string): ?PackageJson => {
-    try {
-      return this._options.packageCache.getPackage(packageJsonPath).read();
-    } catch (e) {
-      // Do nothing. The standard module cache does not trigger any error, but
-      // the ModuleGraph one does, if the module does not exist.
-    }
-
-    return null;
-  };
-
-  _getPackageForModule = (absolutePath: string): ?PackageForModule => {
-    let result;
-
-    try {
-      result = this._options.packageCache.getPackageOf(absolutePath);
-    } catch (e) {
-      // Do nothing. The standard module cache does not trigger any error, but
-      // the ModuleGraph one does, if the module does not exist.
-    }
-
-    return result != null
-      ? {
-          packageJson: result.pkg.read(),
-          packageRelativePath: result.packageRelativePath,
-          rootPath: path.dirname(result.pkg.path),
-        }
-      : null;
-  };
-
   /**
    * TODO: Return Resolution instead of coercing to BundlerResolution here
    */

package/src/node-haste/DependencyGraph/createFileMap.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<c008adad2ea747972e2f301a6375b447>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/node-haste/DependencyGraph/createFileMap.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {ConfigT} from 'metro-config';
+import type {HasteMap} from 'metro-file-map';
+
+import MetroFileMap, {DependencyPlugin} from 'metro-file-map';
+
+declare function createFileMap(
+  config: ConfigT,
+  options?: Readonly<{
+    extractDependencies?: boolean;
+    watch?: boolean;
+    throwOnModuleCollision?: boolean;
+    cacheFilePrefix?: string;
+  }>,
+): {
+  fileMap: MetroFileMap;
+  hasteMap: HasteMap;
+  dependencyPlugin: null | undefined | DependencyPlugin;
+};
+export default createFileMap;

package/src/node-haste/DependencyGraph/createFileMap.js

@@ -71,7 +71,7 @@ function createFileMap(config, options) {
   const { enabled: autoSaveEnabled, ...autoSaveOpts } =
     config.watcher.unstable_autoSaveCache ?? {};
   const autoSave = watch && autoSaveEnabled ? autoSaveOpts : false;
-  const plugins = [];
+  const plugins = [...(config.unstable_fileMapPlugins ?? [])];
   let dependencyPlugin = null;
   if (
     config.resolver.dependencyExtractor != null &&

package/src/node-haste/DependencyGraph/createFileMap.js.flow

@@ -10,7 +10,7 @@
  */
 
 import type {ConfigT} from 'metro-config';
-import type {HasteMap} from 'metro-file-map';
+import type {HasteMap, InputFileMapPlugin} from 'metro-file-map';
 
 import ci from 'ci-info';
 import MetroFileMap, {
@@ -75,7 +75,9 @@ export default function createFileMap(
     config.watcher.unstable_autoSaveCache ?? {};
   const autoSave = watch && autoSaveEnabled ? autoSaveOpts : false;
 
-  const plugins: Array<DependencyPlugin | HastePlugin> = [];
+  const plugins: Array<InputFileMapPlugin> = [
+    ...(config.unstable_fileMapPlugins ?? []),
+  ];
 
   let dependencyPlugin = null;
   // Add DependencyPlugin if dependencies should be extracted

package/src/node-haste/DependencyGraph.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<13f1483d2a732241f8d9eae463399b0e>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/node-haste/DependencyGraph.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {
+  BundlerResolution,
+  TransformResultDependency,
+} from '../DeltaBundler/types';
+import type {ResolverInputOptions} from '../shared/types';
+import type {ConfigT} from 'metro-config';
+import type {
+  ChangeEvent,
+  FileSystem,
+  HasteMap,
+  HealthCheckResult,
+  WatcherStatus,
+  default as MetroFileMap,
+} from 'metro-file-map';
+
+import {ModuleResolver} from './DependencyGraph/ModuleResolution';
+import EventEmitter from 'events';
+
+declare class DependencyGraph extends EventEmitter {
+  _config: ConfigT;
+  _haste: MetroFileMap;
+  _fileSystem: FileSystem;
+  _hasteMap: HasteMap;
+  _moduleResolver: ModuleResolver;
+  _resolutionCache: Map<
+    string | symbol,
+    Map<
+      string | symbol,
+      Map<string | symbol, Map<string | symbol, BundlerResolution>>
+    >
+  >;
+  _initializedPromise: Promise<void>;
+  constructor(
+    config: ConfigT,
+    options?: {
+      readonly hasReducedPerformance?: boolean;
+      readonly watch?: boolean;
+    },
+  );
+  _onWatcherHealthCheck(result: HealthCheckResult): void;
+  _onWatcherStatus(status: WatcherStatus): void;
+  ready(): Promise<void>;
+  _onHasteChange($$PARAM_0$$: ChangeEvent): void;
+  _createModuleResolver(): void;
+  _getClosestPackage(
+    absoluteModulePath: string,
+  ): null | undefined | {packageJsonPath: string; packageRelativePath: string};
+  getAllFiles(): Array<string>;
+  /**
+   * Used when watcher.unstable_lazySha1 is true
+   */
+  getOrComputeSha1(
+    mixedPath: string,
+  ): Promise<{content?: Buffer; sha1: string}>;
+  getWatcher(): EventEmitter;
+  end(): void;
+  /** Given a search context, return a list of file paths matching the query. */
+  matchFilesWithContext(
+    from: string,
+    context: Readonly<{recursive: boolean; filter: RegExp}>,
+  ): Iterable<string>;
+  resolveDependency(
+    originModulePath: string,
+    dependency: TransformResultDependency,
+    platform: string | null,
+    resolverOptions: ResolverInputOptions,
+    $$PARAM_4$$?: {assumeFlatNodeModules: boolean},
+  ): BundlerResolution;
+  doesFileExist: (filePath: string) => boolean;
+  getHasteName(filePath: string): string;
+  getDependencies(filePath: string): Array<string>;
+}
+export default DependencyGraph;

package/src/node-haste/DependencyGraph.js

@@ -71,7 +71,10 @@ class DependencyGraph extends _events.default {
         this._onWatcherHealthCheck(result),
       );
       this._resolutionCache = new Map();
-      this.#packageCache = this._createPackageCache();
+      this.#packageCache = new _PackageCache.PackageCache({
+        getClosestPackage: (absoluteModulePath) =>
+          this._getClosestPackage(absoluteModulePath),
+      });
       this._createModuleResolver();
     });
   }
@@ -90,10 +93,14 @@ class DependencyGraph extends _events.default {
   async ready() {
     await this._initializedPromise;
   }
-  _onHasteChange({ eventsQueue }) {
+  _onHasteChange({ changes, rootDir }) {
     this._resolutionCache = new Map();
-    eventsQueue.forEach(({ filePath }) =>
-      this.#packageCache.invalidate(filePath),
+    [
+      ...changes.addedFiles,
+      ...changes.modifiedFiles,
+      ...changes.removedFiles,
+    ].forEach(([canonicalPath]) =>
+      this.#packageCache.invalidate(_path.default.join(rootDir, canonicalPath)),
     );
     this._createModuleResolver();
     this.emit("change");
@@ -130,9 +137,19 @@ class DependencyGraph extends _events.default {
         this._hasteMap.getModule(name, platform, true),
       getHastePackagePath: (name, platform) =>
         this._hasteMap.getPackage(name, platform, true),
+      getPackage: (packageJsonPath) => {
+        try {
+          return (
+            this.#packageCache.getPackage(packageJsonPath).packageJson ?? null
+          );
+        } catch {
+          return null;
+        }
+      },
+      getPackageForModule: (absolutePath) =>
+        this.#packageCache.getPackageForModule(absolutePath),
       mainFields: this._config.resolver.resolverMainFields,
       nodeModulesPaths: this._config.resolver.nodeModulesPaths,
-      packageCache: this.#packageCache,
       preferNativePlatform: true,
       projectRoot: this._config.projectRoot,
       reporter: this._config.reporter,
@@ -176,12 +193,6 @@ class DependencyGraph extends _events.default {
         }
       : null;
   }
-  _createPackageCache() {
-    return new _PackageCache.PackageCache({
-      getClosestPackage: (absolutePath) =>
-        this._getClosestPackage(absolutePath),
-    });
-  }
   getAllFiles() {
     return (0, _nullthrows.default)(this._fileSystem).getAllFiles();
   }

package/src/node-haste/DependencyGraph.js.flow

@@ -14,7 +14,6 @@ import type {
   TransformResultDependency,
 } from '../DeltaBundler/types';
 import type {ResolverInputOptions} from '../shared/types';
-import type Package from './Package';
 import type {ConfigT} from 'metro-config';
 import type {
   ChangeEvent,
@@ -66,7 +65,7 @@ export default class DependencyGraph extends EventEmitter {
   #packageCache: PackageCache;
   _hasteMap: HasteMap;
   #dependencyPlugin: ?DependencyPlugin;
-  _moduleResolver: ModuleResolver<Package>;
+  _moduleResolver: ModuleResolver;
   _resolutionCache: Map<
     // Custom resolver options
     string | symbol,
@@ -131,7 +130,10 @@ export default class DependencyGraph extends EventEmitter {
         this._onWatcherHealthCheck(result),
       );
       this._resolutionCache = new Map();
-      this.#packageCache = this._createPackageCache();
+      this.#packageCache = new PackageCache({
+        getClosestPackage: absoluteModulePath =>
+          this._getClosestPackage(absoluteModulePath),
+      });
       this._createModuleResolver();
     });
   }
@@ -150,10 +152,14 @@ export default class DependencyGraph extends EventEmitter {
     await this._initializedPromise;
   }
 
-  _onHasteChange({eventsQueue}: ChangeEvent) {
+  _onHasteChange({changes, rootDir}: ChangeEvent) {
     this._resolutionCache = new Map();
-    eventsQueue.forEach(({filePath}) =>
-      this.#packageCache.invalidate(filePath),
+    [
+      ...changes.addedFiles,
+      ...changes.modifiedFiles,
+      ...changes.removedFiles,
+    ].forEach(([canonicalPath]) =>
+      this.#packageCache.invalidate(path.join(rootDir, canonicalPath)),
     );
     this._createModuleResolver();
     this.emit('change');
@@ -190,9 +196,20 @@ export default class DependencyGraph extends EventEmitter {
         this._hasteMap.getModule(name, platform, true),
       getHastePackagePath: (name, platform) =>
         this._hasteMap.getPackage(name, platform, true),
+      getPackage: (packageJsonPath: string) => {
+        try {
+          return (
+            this.#packageCache.getPackage(packageJsonPath).packageJson ?? null
+          );
+        } catch {
+          // Non-existence or malformed JSON, we treat both as non-existent
+          return null;
+        }
+      },
+      getPackageForModule: (absolutePath: string) =>
+        this.#packageCache.getPackageForModule(absolutePath),
       mainFields: this._config.resolver.resolverMainFields,
       nodeModulesPaths: this._config.resolver.nodeModulesPaths,
-      packageCache: this.#packageCache,
       preferNativePlatform: true,
       projectRoot: this._config.projectRoot,
       reporter: this._config.reporter,
@@ -241,12 +258,6 @@ export default class DependencyGraph extends EventEmitter {
       : null;
   }
 
-  _createPackageCache(): PackageCache {
-    return new PackageCache({
-      getClosestPackage: absolutePath => this._getClosestPackage(absolutePath),
-    });
-  }
-
   getAllFiles(): Array<string> {
     return nullthrows(this._fileSystem).getAllFiles();
   }

package/src/node-haste/PackageCache.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<768dba0958b531c8edd43c2df24e25f6>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/node-haste/PackageCache.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {PackageJson} from 'metro-resolver/private/types';
+
+type GetClosestPackageFn = (
+  absoluteFilePath: string,
+) => null | undefined | {packageJsonPath: string; packageRelativePath: string};
+type PackageForModule = Readonly<{
+  packageJson: PackageJson;
+  rootPath: string;
+  packageRelativePath: string;
+}>;
+export declare class PackageCache {
+  constructor(options: {getClosestPackage: GetClosestPackageFn});
+  getPackage(
+    filePath: string,
+  ): Readonly<{rootPath: string; packageJson: PackageJson}>;
+  getPackageForModule(
+    absoluteModulePath: string,
+  ): null | undefined | PackageForModule;
+  invalidate(filePath: string): void;
+}

package/src/node-haste/PackageCache.js

@@ -4,78 +4,89 @@ Object.defineProperty(exports, "__esModule", {
   value: true,
 });
 exports.PackageCache = void 0;
-var _Package = _interopRequireDefault(require("./Package"));
-function _interopRequireDefault(e) {
-  return e && e.__esModule ? e : { default: e };
-}
+var _fs = require("fs");
+var _path = require("path");
 class PackageCache {
+  #getClosestPackage;
+  #packageCache;
+  #resultByModulePath;
+  #modulePathsByPackagePath;
+  #modulePathsWithNoPackage;
   constructor(options) {
-    this._getClosestPackage = options.getClosestPackage;
-    this._packageCache = Object.create(null);
-    this._packagePathAndSubpathByModulePath = Object.create(null);
-    this._modulePathsByPackagePath = Object.create(null);
+    this.#getClosestPackage = options.getClosestPackage;
+    this.#packageCache = new Map();
+    this.#resultByModulePath = new Map();
+    this.#modulePathsByPackagePath = new Map();
+    this.#modulePathsWithNoPackage = new Set();
   }
   getPackage(filePath) {
-    if (!this._packageCache[filePath]) {
-      this._packageCache[filePath] = new _Package.default({
-        file: filePath,
-      });
+    let cached = this.#packageCache.get(filePath);
+    if (cached == null) {
+      cached = {
+        rootPath: (0, _path.dirname)(filePath),
+        packageJson: JSON.parse((0, _fs.readFileSync)(filePath, "utf8")),
+      };
+      this.#packageCache.set(filePath, cached);
     }
-    return this._packageCache[filePath];
+    return cached;
   }
-  getPackageOf(absoluteModulePath) {
-    let packagePathAndSubpath =
-      this._packagePathAndSubpathByModulePath[absoluteModulePath];
-    if (
-      packagePathAndSubpath &&
-      this._packageCache[packagePathAndSubpath.packageJsonPath]
-    ) {
-      return {
-        pkg: this._packageCache[packagePathAndSubpath.packageJsonPath],
-        packageRelativePath: packagePathAndSubpath.packageRelativePath,
-      };
+  getPackageForModule(absoluteModulePath) {
+    const cached = this.#resultByModulePath.get(absoluteModulePath);
+    if (cached !== undefined) {
+      return cached;
     }
-    packagePathAndSubpath = this._getClosestPackage(absoluteModulePath);
-    if (!packagePathAndSubpath) {
+    const closest = this.#getClosestPackage(absoluteModulePath);
+    if (closest == null) {
+      this.#resultByModulePath.set(absoluteModulePath, null);
+      this.#modulePathsWithNoPackage.add(absoluteModulePath);
       return null;
     }
-    const packagePath = packagePathAndSubpath.packageJsonPath;
-    this._packagePathAndSubpathByModulePath[absoluteModulePath] =
-      packagePathAndSubpath;
-    const modulePaths =
-      this._modulePathsByPackagePath[packagePath] ?? new Set();
+    const packagePath = closest.packageJsonPath;
+    let modulePaths = this.#modulePathsByPackagePath.get(packagePath);
+    if (modulePaths == null) {
+      modulePaths = new Set();
+      this.#modulePathsByPackagePath.set(packagePath, modulePaths);
+    }
     modulePaths.add(absoluteModulePath);
-    this._modulePathsByPackagePath[packagePath] = modulePaths;
-    return {
-      pkg: this.getPackage(packagePath),
-      packageRelativePath: packagePathAndSubpath.packageRelativePath,
+    const pkg = this.getPackage(packagePath);
+    if (pkg == null) {
+      return null;
+    }
+    const result = {
+      packageJson: pkg.packageJson,
+      packageRelativePath: closest.packageRelativePath,
+      rootPath: pkg.rootPath,
     };
+    this.#resultByModulePath.set(absoluteModulePath, result);
+    return result;
   }
   invalidate(filePath) {
-    if (this._packageCache[filePath]) {
-      this._packageCache[filePath].invalidate();
-      delete this._packageCache[filePath];
-    }
-    const packagePathAndSubpath =
-      this._packagePathAndSubpathByModulePath[filePath];
-    if (packagePathAndSubpath) {
-      const packagePath = packagePathAndSubpath.packageJsonPath;
-      delete this._packagePathAndSubpathByModulePath[filePath];
-      const modulePaths = this._modulePathsByPackagePath[packagePath];
-      if (modulePaths) {
-        modulePaths.delete(filePath);
-        if (modulePaths.size === 0) {
-          delete this._modulePathsByPackagePath[packagePath];
+    this.#packageCache.delete(filePath);
+    const cachedResult = this.#resultByModulePath.get(filePath);
+    this.#resultByModulePath.delete(filePath);
+    this.#modulePathsWithNoPackage.delete(filePath);
+    if (cachedResult != null) {
+      const packagePath = cachedResult.rootPath + _path.sep + "package.json";
+      const modules = this.#modulePathsByPackagePath.get(packagePath);
+      if (modules != null) {
+        modules.delete(filePath);
+        if (modules.size === 0) {
+          this.#modulePathsByPackagePath.delete(packagePath);
         }
       }
     }
-    if (this._modulePathsByPackagePath[filePath]) {
-      const modulePaths = this._modulePathsByPackagePath[filePath];
+    const modulePaths = this.#modulePathsByPackagePath.get(filePath);
+    if (modulePaths != null) {
       for (const modulePath of modulePaths) {
-        delete this._packagePathAndSubpathByModulePath[modulePath];
+        this.#resultByModulePath.delete(modulePath);
+      }
+      this.#modulePathsByPackagePath.delete(filePath);
+    }
+    if (filePath.endsWith(_path.sep + "package.json")) {
+      for (const modulePath of this.#modulePathsWithNoPackage) {
+        this.#resultByModulePath.delete(modulePath);
       }
-      modulePaths.clear();
-      delete this._modulePathsByPackagePath[filePath];
+      this.#modulePathsWithNoPackage.clear();
     }
   }
 }