metro 0.83.3 → 0.83.5

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

@@ -8,55 +8,79 @@
  * @oncall react_native
  */
 
-import {
+import type {
   BundlerResolution,
   TransformResultDependency,
 } from '../DeltaBundler/types';
-import {ResolverInputOptions} from '../shared/types';
-import {EventEmitter} from 'events';
-import {ConfigT} from 'metro-config';
+import type {ResolverInputOptions} from '../shared/types';
+import type Package from './Package';
+import type {ConfigT} from 'metro-config';
+import type {
+  ChangeEvent,
+  FileSystem,
+  HasteMap,
+  HealthCheckResult,
+  WatcherStatus,
+  default as MetroFileMap,
+} from 'metro-file-map';
 
-export default class DependencyGraph extends EventEmitter {
+import {ModuleResolver} from './DependencyGraph/ModuleResolution';
+import {PackageCache} from './PackageCache';
+import EventEmitter from 'events';
+
+declare class DependencyGraph extends EventEmitter {
+  _config: ConfigT;
+  _haste: MetroFileMap;
+  _fileSystem: FileSystem;
+  _hasteMap: HasteMap;
+  _moduleResolver: ModuleResolver<Package>;
+  _resolutionCache: Map<
+    string | symbol,
+    Map<
+      string | symbol,
+      Map<string | symbol, Map<string | symbol, BundlerResolution>>
+    >
+  >;
+  _initializedPromise: Promise<void>;
   constructor(
     config: ConfigT,
-    options?: Readonly<{
-      hasReducedPerformance?: boolean;
-      watch?: boolean;
-    }>,
+    options?: {
+      readonly hasReducedPerformance?: boolean;
+      readonly watch?: boolean;
+    },
   );
-
+  _onWatcherHealthCheck(result: HealthCheckResult): void;
+  _onWatcherStatus(status: WatcherStatus): void;
   ready(): Promise<void>;
-
-  /** @deprecated Use the constructor + `ready()` directly */
-  load(
-    config: ConfigT,
-    options?: Readonly<{hasReducedPerformance?: boolean; watch?: boolean}>,
-  ): Promise<DependencyGraph>;
-
-  getAllFiles(): string[];
-  getOrComputeSha1(filename: string): Promise<{sha1: string; content?: Buffer}>;
+  _onHasteChange($$PARAM_0$$: ChangeEvent): void;
+  _createModuleResolver(): void;
+  _getClosestPackage(
+    absoluteModulePath: string,
+  ): null | undefined | {packageJsonPath: string; packageRelativePath: string};
+  _createPackageCache(): PackageCache;
+  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<{
-      /* Should search for files recursively. */
-      recursive: boolean;
-      /* Filter relative paths against a pattern. */
-      filter: RegExp;
-    }>,
-  ): string[];
-
+    context: Readonly<{recursive: boolean; filter: RegExp}>,
+  ): Iterable<string>;
   resolveDependency(
-    from: string,
-    to: TransformResultDependency,
+    originModulePath: string,
+    dependency: TransformResultDependency,
     platform: string | null,
     resolverOptions: ResolverInputOptions,
-    options: {assumeFlatNodeModules: boolean},
+    $$PARAM_4$$?: {assumeFlatNodeModules: boolean},
   ): BundlerResolution;
-
+  doesFileExist: (filePath: string) => boolean;
   getHasteName(filePath: string): string;
-  getDependencies(filePath: string): string[];
+  getDependencies(filePath: string): Array<string>;
 }
+export default DependencyGraph;

package/src/node-haste/DependencyGraph.js

@@ -34,6 +34,7 @@ function getOrCreateMap(map, field) {
 }
 class DependencyGraph extends _events.default {
   #packageCache;
+  #dependencyPlugin;
   constructor(config, options) {
     super();
     this._config = config;
@@ -45,32 +46,34 @@ class DependencyGraph extends _events.default {
       type: "dep_graph_loading",
       hasReducedPerformance: !!hasReducedPerformance,
     });
-    const fileMap = (0, _createFileMap.default)(config, {
-      throwOnModuleCollision: false,
-      watch,
-    });
+    const { fileMap, hasteMap, dependencyPlugin } = (0, _createFileMap.default)(
+      config,
+      {
+        throwOnModuleCollision: false,
+        watch,
+      },
+    );
     fileMap.setMaxListeners(1000);
     this._haste = fileMap;
     this._haste.on("status", (status) => this._onWatcherStatus(status));
-    this._initializedPromise = fileMap
-      .build()
-      .then(({ fileSystem, hasteMap }) => {
-        log(createActionEndEntry(initializingMetroLogEntry));
-        config.reporter.update({
-          type: "dep_graph_loaded",
-        });
-        this._fileSystem = fileSystem;
-        this._hasteMap = hasteMap;
-        this._haste.on("change", (changeEvent) =>
-          this._onHasteChange(changeEvent),
-        );
-        this._haste.on("healthCheck", (result) =>
-          this._onWatcherHealthCheck(result),
-        );
-        this._resolutionCache = new Map();
-        this.#packageCache = this._createPackageCache();
-        this._createModuleResolver();
+    this._initializedPromise = fileMap.build().then(({ fileSystem }) => {
+      log(createActionEndEntry(initializingMetroLogEntry));
+      config.reporter.update({
+        type: "dep_graph_loaded",
       });
+      this._fileSystem = fileSystem;
+      this._hasteMap = hasteMap;
+      this.#dependencyPlugin = dependencyPlugin;
+      this._haste.on("change", (changeEvent) =>
+        this._onHasteChange(changeEvent),
+      );
+      this._haste.on("healthCheck", (result) =>
+        this._onWatcherHealthCheck(result),
+      );
+      this._resolutionCache = new Map();
+      this.#packageCache = this._createPackageCache();
+      this._createModuleResolver();
+    });
   }
   _onWatcherHealthCheck(result) {
     this._config.reporter.update({
@@ -87,11 +90,6 @@ class DependencyGraph extends _events.default {
   async ready() {
     await this._initializedPromise;
   }
-  static async load(config, options) {
-    const self = new DependencyGraph(config, options);
-    await self.ready();
-    return self;
-  }
   _onHasteChange({ eventsQueue }) {
     this._resolutionCache = new Map();
     eventsQueue.forEach(({ filePath }) =>
@@ -124,7 +122,7 @@ class DependencyGraph extends _events.default {
       },
       disableHierarchicalLookup:
         this._config.resolver.disableHierarchicalLookup,
-      doesFileExist: this._doesFileExist,
+      doesFileExist: this.doesFileExist,
       emptyModulePath: this._config.resolver.emptyModulePath,
       extraNodeModules: this._config.resolver.extraNodeModules,
       fileSystemLookup,
@@ -157,6 +155,8 @@ class DependencyGraph extends _events.default {
         this._config.resolver.unstable_conditionsByPlatform,
       unstable_enablePackageExports:
         this._config.resolver.unstable_enablePackageExports,
+      unstable_incrementalResolution:
+        this._config.resolver.unstable_incrementalResolution,
     });
   }
   _getClosestPackage(absoluteModulePath) {
@@ -276,18 +276,27 @@ class DependencyGraph extends _events.default {
     mapByPlatform.set(platformKey, resolution);
     return resolution;
   }
-  _doesFileExist = (filePath) => {
+  doesFileExist = (filePath) => {
     return this._fileSystem.exists(filePath);
   };
   getHasteName(filePath) {
-    const hasteName = this._fileSystem.getModuleName(filePath);
+    const hasteName = this._hasteMap.getModuleNameByPath(filePath);
     if (hasteName) {
       return hasteName;
     }
     return _path.default.relative(this._config.projectRoot, filePath);
   }
   getDependencies(filePath) {
-    return (0, _nullthrows.default)(this._fileSystem.getDependencies(filePath));
+    if (!this.#dependencyPlugin) {
+      throw new Error(
+        "getDependencies called but extractDependencies is false",
+      );
+    }
+    return Array.from(
+      (0, _nullthrows.default)(
+        this.#dependencyPlugin.getDependencies(filePath),
+      ),
+    );
   }
 }
 exports.default = DependencyGraph;

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

@@ -16,12 +16,14 @@ import type {
 import type {ResolverInputOptions} from '../shared/types';
 import type Package from './Package';
 import type {ConfigT} from 'metro-config';
-import type MetroFileMap, {
+import type {
   ChangeEvent,
+  DependencyPlugin,
   FileSystem,
   HasteMap,
   HealthCheckResult,
   WatcherStatus,
+  default as MetroFileMap,
 } from 'metro-file-map';
 import type {FileSystemLookup} from 'metro-resolver';
 
@@ -63,6 +65,7 @@ export default class DependencyGraph extends EventEmitter {
   _fileSystem: FileSystem;
   #packageCache: PackageCache;
   _hasteMap: HasteMap;
+  #dependencyPlugin: ?DependencyPlugin;
   _moduleResolver: ModuleResolver<Package>;
   _resolutionCache: Map<
     // Custom resolver options
@@ -103,7 +106,7 @@ export default class DependencyGraph extends EventEmitter {
       type: 'dep_graph_loading',
       hasReducedPerformance: !!hasReducedPerformance,
     });
-    const fileMap = createFileMap(config, {
+    const {fileMap, hasteMap, dependencyPlugin} = createFileMap(config, {
       throwOnModuleCollision: false,
       watch,
     });
@@ -115,25 +118,22 @@ export default class DependencyGraph extends EventEmitter {
     this._haste = fileMap;
     this._haste.on('status', status => this._onWatcherStatus(status));
 
-    this._initializedPromise = fileMap
-      .build()
-      .then(({fileSystem, hasteMap}) => {
-        log(createActionEndEntry(initializingMetroLogEntry));
-        config.reporter.update({type: 'dep_graph_loaded'});
-
-        this._fileSystem = fileSystem;
-        this._hasteMap = hasteMap;
-
-        this._haste.on('change', changeEvent =>
-          this._onHasteChange(changeEvent),
-        );
-        this._haste.on('healthCheck', result =>
-          this._onWatcherHealthCheck(result),
-        );
-        this._resolutionCache = new Map();
-        this.#packageCache = this._createPackageCache();
-        this._createModuleResolver();
-      });
+    this._initializedPromise = fileMap.build().then(({fileSystem}) => {
+      log(createActionEndEntry(initializingMetroLogEntry));
+      config.reporter.update({type: 'dep_graph_loaded'});
+
+      this._fileSystem = fileSystem;
+      this._hasteMap = hasteMap;
+      this.#dependencyPlugin = dependencyPlugin;
+
+      this._haste.on('change', changeEvent => this._onHasteChange(changeEvent));
+      this._haste.on('healthCheck', result =>
+        this._onWatcherHealthCheck(result),
+      );
+      this._resolutionCache = new Map();
+      this.#packageCache = this._createPackageCache();
+      this._createModuleResolver();
+    });
   }
 
   _onWatcherHealthCheck(result: HealthCheckResult) {
@@ -150,17 +150,6 @@ export default class DependencyGraph extends EventEmitter {
     await this._initializedPromise;
   }
 
-  // Creates the dependency graph and waits for it to become ready.
-  // @deprecated Use the constructor + ready() directly.
-  static async load(
-    config: ConfigT,
-    options?: {+hasReducedPerformance?: boolean, +watch?: boolean},
-  ): Promise<DependencyGraph> {
-    const self = new DependencyGraph(config, options);
-    await self.ready();
-    return self;
-  }
-
   _onHasteChange({eventsQueue}: ChangeEvent) {
     this._resolutionCache = new Map();
     eventsQueue.forEach(({filePath}) =>
@@ -193,7 +182,7 @@ export default class DependencyGraph extends EventEmitter {
       },
       disableHierarchicalLookup:
         this._config.resolver.disableHierarchicalLookup,
-      doesFileExist: this._doesFileExist,
+      doesFileExist: this.doesFileExist,
       emptyModulePath: this._config.resolver.emptyModulePath,
       extraNodeModules: this._config.resolver.extraNodeModules,
       fileSystemLookup,
@@ -227,6 +216,8 @@ export default class DependencyGraph extends EventEmitter {
         this._config.resolver.unstable_conditionsByPlatform,
       unstable_enablePackageExports:
         this._config.resolver.unstable_enablePackageExports,
+      unstable_incrementalResolution:
+        this._config.resolver.unstable_incrementalResolution,
     });
   }
 
@@ -290,7 +281,7 @@ export default class DependencyGraph extends EventEmitter {
   /** Given a search context, return a list of file paths matching the query. */
   matchFilesWithContext(
     from: string,
-    context: $ReadOnly<{
+    context: Readonly<{
       /* Should search for files recursively. */
       recursive: boolean,
       /* Filter relative paths against a pattern. */
@@ -376,12 +367,12 @@ export default class DependencyGraph extends EventEmitter {
     return resolution;
   }
 
-  _doesFileExist = (filePath: string): boolean => {
+  doesFileExist = (filePath: string): boolean => {
     return this._fileSystem.exists(filePath);
   };
 
   getHasteName(filePath: string): string {
-    const hasteName = this._fileSystem.getModuleName(filePath);
+    const hasteName = this._hasteMap.getModuleNameByPath(filePath);
 
     if (hasteName) {
       return hasteName;
@@ -391,6 +382,13 @@ export default class DependencyGraph extends EventEmitter {
   }
 
   getDependencies(filePath: string): Array<string> {
-    return nullthrows(this._fileSystem.getDependencies(filePath));
+    if (!this.#dependencyPlugin) {
+      throw new Error(
+        'getDependencies called but extractDependencies is false',
+      );
+    }
+    return Array.from(
+      nullthrows(this.#dependencyPlugin.getDependencies(filePath)),
+    );
   }
 }

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

@@ -0,0 +1,21 @@
+/**
+ * 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
+ * @oncall react_native
+ */
+
+import type {PackageJson} from 'metro-resolver/private/types';
+
+declare class Package {
+  path: string;
+  _root: string;
+  _content: null | undefined | PackageJson;
+  constructor($$PARAM_0$$: {file: string});
+  invalidate(): void;
+  read(): PackageJson;
+}
+export default Package;

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

@@ -0,0 +1,34 @@
+/**
+ * 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
+ * @oncall react_native
+ */
+
+import Package from './Package';
+
+type GetClosestPackageFn = (
+  absoluteFilePath: string,
+) => null | undefined | {packageJsonPath: string; packageRelativePath: string};
+export declare class PackageCache {
+  _getClosestPackage: GetClosestPackageFn;
+  _packageCache: {[filePath: string]: Package};
+  _packagePathAndSubpathByModulePath: {
+    [filePath: string]:
+      | null
+      | undefined
+      | {packageJsonPath: string; packageRelativePath: string};
+  };
+  _modulePathsByPackagePath: {
+    [filePath: string]: Set<string>;
+  };
+  constructor(options: {getClosestPackage: GetClosestPackageFn});
+  getPackage(filePath: string): Package;
+  getPackageOf(
+    absoluteModulePath: string,
+  ): null | undefined | {pkg: Package; packageRelativePath: string};
+  invalidate(filePath: string): void;
+}

package/src/node-haste/lib/AssetPaths.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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
+ * @oncall react_native
+ */
+
+export type AssetPath = {
+  assetName: string;
+  name: string;
+  platform: null | undefined | string;
+  resolution: number;
+  type: string;
+};
+/**
+ * Return `null` if the `filePath` doesn't have a valid extension, required
+ * to describe the type of an asset.
+ */
+export declare function tryParse(
+  filePath: string,
+  platforms: ReadonlySet<string>,
+): null | undefined | AssetPath;
+export declare function parse(
+  filePath: string,
+  platforms: ReadonlySet<string>,
+): AssetPath;

package/src/node-haste/lib/AssetPaths.js

@@ -23,14 +23,14 @@ function parseBaseName(baseName) {
     const resolution = parseFloat(match[3]);
     if (!Number.isNaN(resolution)) {
       return {
-        rootName,
         resolution,
+        rootName,
       };
     }
   }
   return {
-    rootName,
     resolution: 1,
+    rootName,
   };
 }
 function tryParse(filePath, platforms) {

package/src/node-haste/lib/AssetPaths.js.flow

@@ -35,10 +35,10 @@ function parseBaseName(baseName: string): {
   if (match[3] != null) {
     const resolution = parseFloat(match[3]);
     if (!Number.isNaN(resolution)) {
-      return {rootName, resolution};
+      return {resolution, rootName};
     }
   }
-  return {rootName, resolution: 1};
+  return {resolution: 1, rootName};
 }
 
 /**
@@ -47,7 +47,7 @@ function parseBaseName(baseName: string): {
  */
 export function tryParse(
   filePath: string,
-  platforms: $ReadOnlySet<string>,
+  platforms: ReadonlySet<string>,
 ): ?AssetPath {
   const result = parsePlatformFilePath(filePath, platforms);
   const {dirPath, baseName, platform, extension} = result;
@@ -66,7 +66,7 @@ export function tryParse(
 
 export function parse(
   filePath: string,
-  platforms: $ReadOnlySet<string>,
+  platforms: ReadonlySet<string>,
 ): AssetPath {
   const result = tryParse(filePath, platforms);
   if (result == null) {

package/src/node-haste/lib/parsePlatformFilePath.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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
+ * @oncall react_native
+ */
+
+type PlatformFilePathParts = {
+  dirPath: string;
+  baseName: string;
+  platform: null | undefined | string;
+  extension: null | undefined | string;
+};
+/**
+ * Extract the components of a file path that can have a platform specifier: Ex.
+ * `index.ios.js` is specific to the `ios` platform and has the extension `js`.
+ */
+declare function parsePlatformFilePath(
+  filePath: string,
+  platforms: ReadonlySet<string>,
+): PlatformFilePathParts;
+export default parsePlatformFilePath;

package/src/node-haste/lib/parsePlatformFilePath.js

@@ -15,27 +15,27 @@ function parsePlatformFilePath(filePath, platforms) {
   const match = fileName.match(PATH_RE);
   if (!match) {
     return {
-      dirPath,
       baseName: fileName,
-      platform: null,
+      dirPath,
       extension: null,
+      platform: null,
     };
   }
   const extension = match[4] || null;
   const platform = match[3] || null;
   if (platform == null || platforms.has(platform)) {
     return {
-      dirPath,
       baseName: match[1],
-      platform,
+      dirPath,
       extension,
+      platform,
     };
   }
   const baseName = `${match[1]}.${platform}`;
   return {
-    dirPath,
     baseName,
-    platform: null,
+    dirPath,
     extension,
+    platform: null,
   };
 }

package/src/node-haste/lib/parsePlatformFilePath.js.flow

@@ -26,19 +26,19 @@ const PATH_RE = /^(.+?)(\.([^.]+))?\.([^.]+)$/;
  */
 export default function parsePlatformFilePath(
   filePath: string,
-  platforms: $ReadOnlySet<string>,
+  platforms: ReadonlySet<string>,
 ): PlatformFilePathParts {
   const dirPath = path.dirname(filePath);
   const fileName = path.basename(filePath);
   const match = fileName.match(PATH_RE);
   if (!match) {
-    return {dirPath, baseName: fileName, platform: null, extension: null};
+    return {baseName: fileName, dirPath, extension: null, platform: null};
   }
   const extension = match[4] || null;
   const platform = match[3] || null;
   if (platform == null || platforms.has(platform)) {
-    return {dirPath, baseName: match[1], platform, extension};
+    return {baseName: match[1], dirPath, extension, platform};
   }
   const baseName = `${match[1]}.${platform}`;
-  return {dirPath, baseName, platform: null, extension};
+  return {baseName, dirPath, extension, platform: null};
 }

package/src/shared/output/RamBundle/as-assets.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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
+ * @oncall react_native
+ */
+
+import type {RamBundleInfo} from '../../../DeltaBundler/Serializers/getRamBundleInfo';
+import type {OutputOptions} from '../../types';
+/**
+ * Saves all JS modules of an app as single files
+ * The startup code (prelude, polyfills etc.) are written to the file
+ * designated by the `bundleOuput` option.
+ * All other modules go into a 'js-modules' folder that in the same parent
+ * directory as the startup file.
+ */
+declare function saveAsAssets(
+  bundle: RamBundleInfo,
+  options: OutputOptions,
+  log: (...args: Array<string>) => void,
+): Promise<unknown>;
+export default saveAsAssets;

package/src/shared/output/RamBundle/as-assets.js.flow

@@ -37,7 +37,7 @@ export default function saveAsAssets(
   bundle: RamBundleInfo,
   options: OutputOptions,
   log: (...args: Array<string>) => void,
-): Promise<mixed> {
+): Promise<unknown> {
   const {
     bundleOutput,
     bundleEncoding: encoding,
@@ -100,24 +100,24 @@ function writeModuleFile(
   module: ModuleTransportLike,
   modulesDir: string,
   encoding: void | 'ascii' | 'utf16le' | 'utf8',
-): Promise<mixed> {
+): Promise<unknown> {
   const {code, id} = module;
   return writeFile(path.join(modulesDir, id + '.js'), code, encoding);
 }
 
 function writeModules(
-  modules: $ReadOnlyArray<ModuleTransportLike>,
+  modules: ReadonlyArray<ModuleTransportLike>,
   modulesDir: string,
   encoding: void | 'ascii' | 'utf16le' | 'utf8',
-): Promise<Array<mixed>> {
+): Promise<Array<unknown>> {
   const writeFiles = modules.map(
-    (module: ModuleTransportLike): Promise<mixed> =>
+    (module: ModuleTransportLike): Promise<unknown> =>
       writeModuleFile(module, modulesDir, encoding),
   );
   return Promise.all(writeFiles);
 }
 
-function writeMagicFlagFile(outputDir: string): Promise<mixed> {
+function writeMagicFlagFile(outputDir: string): Promise<unknown> {
   const buffer = Buffer.alloc(4);
   buffer.writeUInt32LE(MAGIC_RAM_BUNDLE_NUMBER, 0);
   return writeFile(path.join(outputDir, MAGIC_RAM_BUNDLE_FILENAME), buffer);