metro 0.83.3 → 0.83.5

package/src/lib/reporting.d.ts

@@ -8,53 +8,39 @@
  * @oncall react_native
  */
 
+import type {Terminal} from 'metro-core';
 import type {HealthCheckResult, WatcherStatus} from 'metro-file-map';
+import type {CustomResolverOptions} from 'metro-resolver';
+import type {CustomTransformOptions} from 'metro-transform-worker';
 
-export interface BundleDetails {
+export type BundleDetails = {
   bundleType: string;
+  customResolverOptions: CustomResolverOptions;
+  customTransformOptions: CustomTransformOptions;
   dev: boolean;
   entryFile: string;
   minify: boolean;
-  platform?: string;
-  runtimeBytecodeVersion?: number;
-}
-
+  platform: null | undefined | string;
+};
 /**
  * A tagged union of all the actions that may happen and we may want to
  * report to the tool user.
  */
 export type ReportableEvent =
-  | {
-      port: number;
-      hasReducedPerformance: boolean;
-      type: 'initialize_started';
-    }
-  | {
-      type: 'initialize_failed';
-      port: number;
-      error: Error;
-    }
-  | {
-      buildID: string;
-      type: 'bundle_build_done';
-    }
-  | {
-      buildID: string;
-      type: 'bundle_build_failed';
-    }
+  | {port: number; hasReducedPerformance: boolean; type: 'initialize_started'}
+  | {type: 'initialize_failed'; port: number; error: Error}
+  | {type: 'initialize_done'; port: number}
+  | {buildID: string; type: 'bundle_build_done'}
+  | {buildID: string; type: 'bundle_build_failed'}
+  | {type: 'bundle_save_log'; message: string}
   | {
       buildID: string;
       bundleDetails: BundleDetails;
+      isPrefetch?: boolean;
       type: 'bundle_build_started';
     }
-  | {
-      error: Error;
-      type: 'bundling_error';
-    }
-  | {
-      type: 'dep_graph_loading';
-      hasReducedPerformance: boolean;
-    }
+  | {error: Error; type: 'bundling_error'}
+  | {type: 'dep_graph_loading'; hasReducedPerformance: boolean}
   | {type: 'dep_graph_loaded'}
   | {
       buildID: string;
@@ -62,27 +48,12 @@ export type ReportableEvent =
       transformedFileCount: number;
       totalFileCount: number;
     }
-  | {
-      type: 'cache_read_error';
-      error: Error;
-    }
-  | {
-      type: 'cache_write_error';
-      error: Error;
-    }
+  | {type: 'cache_read_error'; error: Error}
+  | {type: 'cache_write_error'; error: Error}
   | {type: 'transform_cache_reset'}
-  | {
-      type: 'worker_stdout_chunk';
-      chunk: string;
-    }
-  | {
-      type: 'worker_stderr_chunk';
-      chunk: string;
-    }
-  | {
-      type: 'hmr_client_error';
-      error: Error;
-    }
+  | {type: 'worker_stdout_chunk'; chunk: string}
+  | {type: 'worker_stderr_chunk'; chunk: string}
+  | {type: 'hmr_client_error'; error: Error}
   | {
       type: 'client_log';
       level:
@@ -94,33 +65,15 @@ export type ReportableEvent =
         | 'groupCollapsed'
         | 'groupEnd'
         | 'debug';
-      data: unknown[];
-    }
-  | {
-      type: 'server_listening';
-      port: number;
-      address: string;
-      family: string;
-    }
-  | {
-      type: 'transformer_load_started';
-    }
-  | {
-      type: 'transformer_load_done';
-    }
-  | {
-      type: 'transformer_load_failed';
-      error: Error;
-    }
-  | {
-      type: 'watcher_health_check_result';
-      result: HealthCheckResult;
-    }
-  | {
-      type: 'watcher_status';
-      status: WatcherStatus;
-    };
-
+      data: Array<unknown>;
+    }
+  | {type: 'resolver_warning'; message: string}
+  | {type: 'server_listening'; port: number; address: string; family: string}
+  | {type: 'transformer_load_started'}
+  | {type: 'transformer_load_done'}
+  | {type: 'transformer_load_failed'; error: Error}
+  | {type: 'watcher_health_check_result'; result: HealthCheckResult}
+  | {type: 'watcher_status'; status: WatcherStatus};
 /**
  * Code across the application takes a reporter as an option and calls the
  * update whenever one of the ReportableEvent happens. Code does not directly
@@ -139,6 +92,37 @@ export type ReportableEvent =
  * TerminalReporter, that should be the only place in the application should
  * access the `terminal` module (nor the `console`).
  */
-export interface Reporter {
-  update: (event: ReportableEvent) => void;
-}
+export type Reporter = {update(event: ReportableEvent): void};
+/**
+ * A standard way to log a warning to the terminal. This should not be called
+ * from some arbitrary Metro logic, only from the reporters. Instead of
+ * calling this, add a new type of ReportableEvent instead, and implement a
+ * proper handler in the reporter(s).
+ */
+export declare function logWarning(
+  terminal: Terminal,
+  format: string,
+  ...args: Array<unknown>
+): void;
+/**
+ * Similar to `logWarning`, but for messages that require the user to act.
+ */
+export declare function logError(
+  terminal: Terminal,
+  format: string,
+  ...args: Array<unknown>
+): void;
+/**
+ * Similar to `logWarning`, but for informational messages.
+ */
+export declare function logInfo(
+  terminal: Terminal,
+  format: string,
+  ...args: Array<unknown>
+): void;
+/**
+ * A reporter that does nothing. Errors and warnings will be swallowed, that
+ * is generally not what you want.
+ */
+export declare const nullReporter: {update(): void};
+export declare type nullReporter = typeof nullReporter;

package/src/lib/reporting.js.flow

@@ -126,7 +126,7 @@ export type ReportableEvent =
         | 'groupCollapsed'
         | 'groupEnd'
         | 'debug',
-      data: Array<mixed>,
+      data: Array<unknown>,
       ...
     }
   | {
@@ -187,7 +187,7 @@ export type Reporter = interface {update(event: ReportableEvent): void};
 export function logWarning(
   terminal: Terminal,
   format: string,
-  ...args: Array<mixed>
+  ...args: Array<unknown>
 ): void {
   const str = util.format(format, ...args);
   terminal.log('%s %s', chalk.yellow.inverse.bold(' WARN '), str);
@@ -199,7 +199,7 @@ export function logWarning(
 export function logError(
   terminal: Terminal,
   format: string,
-  ...args: Array<mixed>
+  ...args: Array<unknown>
 ): void {
   terminal.log(
     '%s %s',
@@ -221,7 +221,7 @@ export function logError(
 export function logInfo(
   terminal: Terminal,
   format: string,
-  ...args: Array<mixed>
+  ...args: Array<unknown>
 ): void {
   const str = util.format(format, ...args);
   terminal.log('%s %s', chalk.cyan.inverse.bold(' INFO '), str);

package/src/lib/splitBundleOptions.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 {BundleOptions, SplitBundleOptions} from '../shared/types';
+/**
+ * Splits a BundleOptions object into smaller, more manageable parts.
+ */
+declare function splitBundleOptions(options: BundleOptions): SplitBundleOptions;
+export default splitBundleOptions;

package/src/lib/transformHelpers.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 Bundler from '../Bundler';
+import type {TransformFn, default as DeltaBundler} from '../DeltaBundler';
+import type {
+  BundlerResolution,
+  TransformInputOptions,
+  TransformResultDependency,
+} from '../DeltaBundler/types';
+import type {ResolverInputOptions} from '../shared/types';
+import type {ConfigT} from 'metro-config';
+
+export declare function getTransformFn(
+  entryFiles: ReadonlyArray<string>,
+  bundler: Bundler,
+  deltaBundler: DeltaBundler,
+  config: ConfigT,
+  options: TransformInputOptions,
+  resolverOptions: ResolverInputOptions,
+): Promise<TransformFn>;
+export declare function getResolveDependencyFn(
+  bundler: Bundler,
+  platform: null | undefined | string,
+  resolverOptions: ResolverInputOptions,
+): Promise<
+  (from: string, dependency: TransformResultDependency) => BundlerResolution
+>;

package/src/lib/transformHelpers.js

@@ -31,8 +31,8 @@ async function calcTransformerOptions(
   const baseOptions = {
     customTransformOptions: options.customTransformOptions,
     dev: options.dev,
-    inlineRequires: false,
     inlinePlatform: true,
+    inlineRequires: false,
     minify: options.minify,
     platform: options.platform,
     unstable_transformProfile: options.unstable_transformProfile,
@@ -45,11 +45,14 @@ async function calcTransformerOptions(
   }
   const getDependencies = async (path) => {
     const dependencies = await deltaBundler.getDependencies([path], {
+      lazy: false,
+      onProgress: null,
       resolve: await getResolveDependencyFn(
         bundler,
         options.platform,
         resolverOptions,
       ),
+      shallow: false,
       transform: await getTransformFn(
         [path],
         bundler,
@@ -62,13 +65,12 @@ async function calcTransformerOptions(
         resolverOptions,
       ),
       transformOptions: options,
-      onProgress: null,
-      lazy: false,
       unstable_allowRequireContext:
         config.transformer.unstable_allowRequireContext,
       unstable_enablePackageExports:
         config.resolver.unstable_enablePackageExports,
-      shallow: false,
+      unstable_incrementalResolution:
+        config.resolver.unstable_incrementalResolution,
     });
     return Array.from(dependencies.keys());
   };
@@ -83,15 +85,15 @@ async function calcTransformerOptions(
   );
   return {
     ...baseOptions,
-    inlineRequires: transform?.inlineRequires || false,
     experimentalImportSupport: transform?.experimentalImportSupport || false,
+    inlineRequires: transform?.inlineRequires || false,
+    nonInlinedRequires:
+      transform?.nonInlinedRequires || baseIgnoredInlineRequires,
+    type: "module",
     unstable_memoizeInlineRequires:
       transform?.unstable_memoizeInlineRequires || false,
     unstable_nonMemoizedInlineRequires:
       transform?.unstable_nonMemoizedInlineRequires || [],
-    nonInlinedRequires:
-      transform?.nonInlinedRequires || baseIgnoredInlineRequires,
-    type: "module",
   };
 }
 function removeInlineRequiresBlockListFromOptions(path, inlineRequires) {
@@ -138,11 +140,11 @@ async function getTransformFn(
       modulePath,
       {
         ...transformOptions,
-        type: getType(transformOptions.type, modulePath, assetExts),
         inlineRequires: removeInlineRequiresBlockListFromOptions(
           modulePath,
           inlineRequires,
         ),
+        type: getType(transformOptions.type, modulePath, assetExts),
       },
       templateBuffer,
     );

package/src/lib/transformHelpers.js.flow

@@ -10,7 +10,7 @@
  */
 
 import type Bundler from '../Bundler';
-import type DeltaBundler, {TransformFn} from '../DeltaBundler';
+import type {TransformFn, default as DeltaBundler} from '../DeltaBundler';
 import type {
   BundlerResolution,
   TransformInputOptions,
@@ -26,10 +26,10 @@ import {getContextModuleTemplate} from './contextModuleTemplates';
 import isAssetFile from 'metro-resolver/private/utils/isAssetFile';
 
 type InlineRequiresRaw =
-  | $ReadOnly<{blockList: $ReadOnly<{[string]: true, ...}>, ...}>
+  | Readonly<{blockList: Readonly<{[string]: true, ...}>, ...}>
   | boolean;
 
-type TransformOptionsWithRawInlines = $ReadOnly<{
+type TransformOptionsWithRawInlines = Readonly<{
   ...TransformOptions,
   inlineRequires: InlineRequiresRaw,
 }>;
@@ -44,7 +44,7 @@ const baseIgnoredInlineRequires = [
 ];
 
 async function calcTransformerOptions(
-  entryFiles: $ReadOnlyArray<string>,
+  entryFiles: ReadonlyArray<string>,
   bundler: Bundler,
   deltaBundler: DeltaBundler<>,
   config: ConfigT,
@@ -54,8 +54,8 @@ async function calcTransformerOptions(
   const baseOptions = {
     customTransformOptions: options.customTransformOptions,
     dev: options.dev,
-    inlineRequires: false,
     inlinePlatform: true,
+    inlineRequires: false,
     minify: options.minify,
     platform: options.platform,
     unstable_transformProfile: options.unstable_transformProfile,
@@ -73,11 +73,14 @@ async function calcTransformerOptions(
 
   const getDependencies = async (path: string) => {
     const dependencies = await deltaBundler.getDependencies([path], {
+      lazy: false,
+      onProgress: null,
       resolve: await getResolveDependencyFn(
         bundler,
         options.platform,
         resolverOptions,
       ),
+      shallow: false,
       transform: await getTransformFn(
         [path],
         bundler,
@@ -90,13 +93,12 @@ async function calcTransformerOptions(
         resolverOptions,
       ),
       transformOptions: options,
-      onProgress: null,
-      lazy: false,
       unstable_allowRequireContext:
         config.transformer.unstable_allowRequireContext,
       unstable_enablePackageExports:
         config.resolver.unstable_enablePackageExports,
-      shallow: false,
+      unstable_incrementalResolution:
+        config.resolver.unstable_incrementalResolution,
     });
 
     return Array.from(dependencies.keys());
@@ -110,15 +112,15 @@ async function calcTransformerOptions(
 
   return {
     ...baseOptions,
-    inlineRequires: transform?.inlineRequires || false,
     experimentalImportSupport: transform?.experimentalImportSupport || false,
+    inlineRequires: transform?.inlineRequires || false,
+    nonInlinedRequires:
+      transform?.nonInlinedRequires || baseIgnoredInlineRequires,
+    type: 'module',
     unstable_memoizeInlineRequires:
       transform?.unstable_memoizeInlineRequires || false,
     unstable_nonMemoizedInlineRequires:
       transform?.unstable_nonMemoizedInlineRequires || [],
-    nonInlinedRequires:
-      transform?.nonInlinedRequires || baseIgnoredInlineRequires,
-    type: 'module',
   };
 }
 
@@ -134,7 +136,7 @@ function removeInlineRequiresBlockListFromOptions(
 }
 
 export async function getTransformFn(
-  entryFiles: $ReadOnlyArray<string>,
+  entryFiles: ReadonlyArray<string>,
   bundler: Bundler,
   deltaBundler: DeltaBundler<>,
   config: ConfigT,
@@ -181,11 +183,11 @@ export async function getTransformFn(
       modulePath,
       {
         ...transformOptions,
-        type: getType(transformOptions.type, modulePath, assetExts),
         inlineRequires: removeInlineRequiresBlockListFromOptions(
           modulePath,
           inlineRequires,
         ),
+        type: getType(transformOptions.type, modulePath, assetExts),
       },
       templateBuffer,
     );
@@ -195,7 +197,7 @@ export async function getTransformFn(
 function getType(
   type: string,
   filePath: string,
-  assetExts: $ReadOnlySet<string>,
+  assetExts: ReadonlySet<string>,
 ): Type {
   if (type === 'script') {
     return type;

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

@@ -0,0 +1,126 @@
+/**
+ * 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 {
+  BundlerResolution,
+  TransformResultDependency,
+} from '../../DeltaBundler/types';
+import type {Reporter} from '../../lib/reporting';
+import type {ResolverInputOptions} from '../../shared/types';
+import type {
+  CustomResolver,
+  DoesFileExist,
+  FileCandidates,
+  FileSystemLookup,
+  Resolution,
+  ResolveAsset,
+} from 'metro-resolver';
+import type {PackageForModule, PackageJson} from 'metro-resolver/private/types';
+
+export type DirExistsFn = (filePath: string) => boolean;
+export type Packageish = {path: string; read(): PackageJson};
+export type Moduleish = {readonly path: string};
+export type PackageishCache<TPackage> = {
+  getPackage(
+    name: string,
+    platform?: string,
+    supportsNativePlatform?: boolean,
+  ): TPackage;
+  getPackageOf(
+    absolutePath: string,
+  ): null | undefined | {pkg: TPackage; packageRelativePath: string};
+};
+type Options<TPackage> = Readonly<{
+  assetExts: ReadonlySet<string>;
+  dirExists: DirExistsFn;
+  disableHierarchicalLookup: boolean;
+  doesFileExist: DoesFileExist;
+  emptyModulePath: string;
+  extraNodeModules: null | undefined | object;
+  fileSystemLookup: FileSystemLookup;
+  getHasteModulePath: (
+    name: string,
+    platform: null | undefined | string,
+  ) => null | undefined | string;
+  getHastePackagePath: (
+    name: string,
+    platform: null | undefined | string,
+  ) => null | undefined | string;
+  mainFields: ReadonlyArray<string>;
+  packageCache: PackageishCache<TPackage>;
+  nodeModulesPaths: ReadonlyArray<string>;
+  preferNativePlatform: boolean;
+  projectRoot: string;
+  reporter: Reporter;
+  resolveAsset: ResolveAsset;
+  resolveRequest: null | undefined | CustomResolver;
+  sourceExts: ReadonlyArray<string>;
+  unstable_conditionNames: ReadonlyArray<string>;
+  unstable_conditionsByPlatform: Readonly<{
+    [platform: string]: ReadonlyArray<string>;
+  }>;
+  unstable_enablePackageExports: boolean;
+  unstable_incrementalResolution: boolean;
+}>;
+export declare class ModuleResolver<TPackage extends Packageish> {
+  _options: Options<TPackage>;
+  _projectRootFakeModulePath: string;
+  _cachedEmptyModule: null | undefined | BundlerResolution;
+  constructor(options: Options<TPackage>);
+  _getEmptyModule(): BundlerResolution;
+  resolveDependency(
+    originModulePath: string,
+    dependency: TransformResultDependency,
+    allowHaste: boolean,
+    platform: string | null,
+    resolverOptions: ResolverInputOptions,
+  ): BundlerResolution;
+  _getPackage: (packageJsonPath: string) => null | undefined | PackageJson;
+  _getPackageForModule: (
+    absolutePath: string,
+  ) => null | undefined | PackageForModule;
+  /**
+   * TODO: Return Resolution instead of coercing to BundlerResolution here
+   */
+  _getFileResolvedModule(resolution: Resolution): BundlerResolution;
+  _logWarning: (message: string) => void;
+  _removeRoot(candidates: FileCandidates): FileCandidates;
+}
+export declare class UnableToResolveError extends Error {
+  /**
+   * File path of the module that tried to require a module, ex. `/js/foo.js`.
+   */
+  originModulePath: string;
+  /**
+   * The name of the module that was required, no necessarily a path,
+   * ex. `./bar`, or `invariant`.
+   */
+  targetModuleName: string;
+  /**
+   * Original error that causes this error
+   */
+  cause: null | undefined | Error;
+  /**
+   * Fixed type field in common with other Metro build errors.
+   */
+  readonly type: 'UnableToResolveError';
+  constructor(
+    originModulePath: string,
+    targetModuleName: string,
+    message: string,
+    options?: Readonly<{
+      dependency?: null | undefined | TransformResultDependency;
+      cause?: Error;
+    }>,
+  );
+  buildCodeFrameMessage(
+    dependency: null | undefined | TransformResultDependency,
+  ): null | undefined | string;
+}