metro 0.76.0 → 0.76.1

package/src/lib/getPrependedScripts.js

@@ -74,7 +74,6 @@ async function getPrependedScripts(
   ];
 }
 function _getPrelude({ dev, globalPrefix, requireCycleIgnorePatterns }) {
-  const { compile } = require("metro-hermes-compiler");
   const code = getPreludeCode({
     isDev: dev,
     globalPrefix,
@@ -95,14 +94,6 @@ function _getPrelude({ dev, globalPrefix, requireCycleIgnorePatterns }) {
           map: [],
         },
       },
-      {
-        type: "bytecode/script/virtual",
-        data: {
-          bytecode: compile(code, {
-            sourceURL: "__prelude__.virtual.js",
-          }).bytecode,
-        },
-      },
     ],
   };
 }

package/src/lib/getPrependedScripts.js.flow

@@ -95,8 +95,6 @@ function _getPrelude({
   requireCycleIgnorePatterns: $ReadOnlyArray<RegExp>,
   ...
 }): Module<> {
-  const {compile} = require('metro-hermes-compiler');
-
   const code = getPreludeCode({
     isDev: dev,
     globalPrefix,
@@ -118,13 +116,6 @@ function _getPrelude({
           map: [],
         },
       },
-      {
-        type: 'bytecode/script/virtual',
-        data: {
-          bytecode: compile(code, {sourceURL: '__prelude__.virtual.js'})
-            .bytecode,
-        },
-      },
     ],
   };
 }

package/src/lib/parseOptionsFromUrl.js

@@ -21,21 +21,13 @@ const getBoolean = (query, opt, defaultValue) =>
   query[opt] == null
     ? defaultValue
     : query[opt] === "true" || query[opt] === "1";
-const getNumber = (query, opt, defaultValue) => {
-  const number = parseInt(query[opt], 10);
-  return Number.isNaN(number) ? defaultValue : number;
-};
 const getBundleType = (bundleType) =>
   bundleType === "map" ? bundleType : "bundle";
 const getTransformProfile = (transformProfile) =>
   transformProfile === "hermes-stable" || transformProfile === "hermes-canary"
     ? transformProfile
     : "default";
-module.exports = function parseOptionsFromUrl(
-  requestUrl,
-  platforms,
-  bytecodeVersion
-) {
+module.exports = function parseOptionsFromUrl(requestUrl, platforms) {
   const parsedURL = nullthrows(url.parse(requestUrl, true)); // `true` to parse the query param as an object.
   const query = nullthrows(parsedURL.query);
   const pathname =
@@ -44,15 +36,8 @@ module.exports = function parseOptionsFromUrl(
   const platform =
     query.platform || parsePlatformFilePath(pathname, platforms).platform;
   const bundleType = getBundleType(path.extname(pathname).substr(1));
-  const runtimeBytecodeVersion = getNumber(
-    query,
-    "runtimeBytecodeVersion",
-    null
-  );
   return {
     bundleType,
-    runtimeBytecodeVersion:
-      bytecodeVersion === runtimeBytecodeVersion ? bytecodeVersion : null,
     customResolverOptions: parseCustomResolverOptions(parsedURL),
     customTransformOptions: parseCustomTransformOptions(parsedURL),
     dev: getBoolean(query, "dev", true),

package/src/lib/parseOptionsFromUrl.js.flow

@@ -30,15 +30,6 @@ const getBoolean = (
     ? defaultValue
     : query[opt] === 'true' || query[opt] === '1';
 
-const getNumber = (
-  query: $ReadOnly<{[opt: string]: string}>,
-  opt: string,
-  defaultValue: null,
-) => {
-  const number = parseInt(query[opt], 10);
-  return Number.isNaN(number) ? defaultValue : number;
-};
-
 const getBundleType = (bundleType: string): 'map' | 'bundle' =>
   bundleType === 'map' ? bundleType : 'bundle';
 
@@ -50,7 +41,6 @@ const getTransformProfile = (transformProfile: string): TransformProfile =>
 module.exports = function parseOptionsFromUrl(
   requestUrl: string,
   platforms: Set<string>,
-  bytecodeVersion: number,
 ): BundleOptions {
   const parsedURL = nullthrows(url.parse(requestUrl, true)); // `true` to parse the query param as an object.
   const query = nullthrows(parsedURL.query);
@@ -60,16 +50,9 @@ module.exports = function parseOptionsFromUrl(
   const platform =
     query.platform || parsePlatformFilePath(pathname, platforms).platform;
   const bundleType = getBundleType(path.extname(pathname).substr(1));
-  const runtimeBytecodeVersion = getNumber(
-    query,
-    'runtimeBytecodeVersion',
-    null,
-  );
 
   return {
     bundleType,
-    runtimeBytecodeVersion:
-      bytecodeVersion === runtimeBytecodeVersion ? bytecodeVersion : null,
     customResolverOptions: parseCustomResolverOptions(parsedURL),
     customTransformOptions: parseCustomTransformOptions(parsedURL),
     dev: getBoolean(query, 'dev', true),

package/src/lib/reporting.d.ts

@@ -0,0 +1,140 @@
+/**
+ * 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 {HealthCheckResult, WatcherStatus} from 'metro-file-map';
+
+export type GlobalCacheDisabledReason = 'too_many_errors' | 'too_many_misses';
+
+export interface BundleDetails {
+  bundleType: string;
+  dev: boolean;
+  entryFile: string;
+  minify: boolean;
+  platform?: string;
+  runtimeBytecodeVersion?: number;
+}
+
+/**
+ * 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';
+    }
+  | {
+      buildID: string;
+      bundleDetails: BundleDetails;
+      type: 'bundle_build_started';
+    }
+  | {
+      error: Error;
+      type: 'bundling_error';
+    }
+  | {
+      type: 'dep_graph_loading';
+      hasReducedPerformance: boolean;
+    }
+  | {type: 'dep_graph_loaded'}
+  | {
+      buildID: string;
+      type: 'bundle_transform_progressed';
+      transformedFileCount: number;
+      totalFileCount: number;
+    }
+  | {
+      type: 'global_cache_error';
+      error: Error;
+    }
+  | {
+      type: 'global_cache_disabled';
+      reason: GlobalCacheDisabledReason;
+    }
+  | {type: 'transform_cache_reset'}
+  | {
+      type: 'worker_stdout_chunk';
+      chunk: string;
+    }
+  | {
+      type: 'worker_stderr_chunk';
+      chunk: string;
+    }
+  | {
+      type: 'hmr_client_error';
+      error: Error;
+    }
+  | {
+      type: 'client_log';
+      level:
+        | 'trace'
+        | 'info'
+        | 'warn'
+        | 'log'
+        | 'group'
+        | 'groupCollapsed'
+        | 'groupEnd'
+        | 'debug';
+      data: unknown[];
+    }
+  | {
+      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
+ * write to the standard output, because a build would be:
+ *
+ *   1. ad-hoc, embedded into another tool, in which case we do not want to
+ *   pollute that tool's own output. The tool is free to present the
+ *   warnings/progress we generate any way they want, by specifing a custom
+ *   reporter.
+ *   2. run as a background process from another tool, in which case we want
+ *   to expose updates in a way that is easily machine-readable, for example
+ *   a JSON-stream. We don't want to pollute it with textual messages.
+ *
+ * We centralize terminal reporting into a single place because we want the
+ * output to be robust and consistent. The most common reporter is
+ * 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;
+}

package/src/lib/reporting.js.flow

@@ -26,7 +26,6 @@ export type BundleDetails = {
   entryFile: string,
   minify: boolean,
   platform: ?string,
-  runtimeBytecodeVersion: ?number,
   ...
 };
 

package/src/lib/splitBundleOptions.js

@@ -26,7 +26,6 @@ function splitBundleOptions(options) {
       hot: options.hot,
       minify: options.minify,
       platform: options.platform,
-      runtimeBytecodeVersion: options.runtimeBytecodeVersion,
       type: "module",
       unstable_transformProfile: options.unstable_transformProfile,
     },

package/src/lib/splitBundleOptions.js.flow

@@ -28,7 +28,6 @@ function splitBundleOptions(options: BundleOptions): SplitBundleOptions {
       hot: options.hot,
       minify: options.minify,
       platform: options.platform,
-      runtimeBytecodeVersion: options.runtimeBytecodeVersion,
       type: 'module',
       unstable_transformProfile: options.unstable_transformProfile,
     },

package/src/lib/transformHelpers.js

@@ -35,7 +35,6 @@ async function calcTransformerOptions(
     inlinePlatform: true,
     minify: options.minify,
     platform: options.platform,
-    runtimeBytecodeVersion: options.runtimeBytecodeVersion,
     unstable_transformProfile: options.unstable_transformProfile,
   };
 

package/src/lib/transformHelpers.js.flow

@@ -52,7 +52,6 @@ async function calcTransformerOptions(
     inlinePlatform: true,
     minify: options.minify,
     platform: options.platform,
-    runtimeBytecodeVersion: options.runtimeBytecodeVersion,
     unstable_transformProfile: options.unstable_transformProfile,
   };
 

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

@@ -116,7 +116,6 @@ function createHasteMap(config, options) {
     rootDir: config.projectRoot,
     roots: config.watchFolders,
     throwOnModuleCollision: options?.throwOnModuleCollision ?? true,
-    unstable_preferTreeFS: config.watcher.unstable_preferTreeFS,
     useWatchman: config.resolver.useWatchman,
     watch: options?.watch == null ? !ci.isCI : options.watch,
     watchmanDeferStates: config.watcher.watchman.deferStates,

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

@@ -90,7 +90,6 @@ function createHasteMap(
     rootDir: config.projectRoot,
     roots: config.watchFolders,
     throwOnModuleCollision: options?.throwOnModuleCollision ?? true,
-    unstable_preferTreeFS: config.watcher.unstable_preferTreeFS,
     useWatchman: config.resolver.useWatchman,
     watch: options?.watch == null ? !ci.isCI : options.watch,
     watchmanDeferStates: config.watcher.watchman.deferStates,

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

@@ -0,0 +1,59 @@
+/**
+ * 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 {EventEmitter} from 'events';
+import {ConfigT} from 'metro-config';
+import {ResolverInputOptions} from '../shared/types';
+import {BundlerResolution} from '../DeltaBundler/types';
+
+export default class DependencyGraph extends EventEmitter {
+  constructor(
+    config: ConfigT,
+    options?: Readonly<{
+      hasReducedPerformance?: boolean;
+      watch?: boolean;
+    }>,
+  );
+
+  ready(): Promise<void>;
+
+  /** @deprecated Use the constructor + `ready()` directly */
+  load(
+    config: ConfigT,
+    options?: Readonly<{hasReducedPerformance?: boolean; watch?: boolean}>,
+  ): Promise<DependencyGraph>;
+
+  getAllFiles(): string[];
+  getSha1(filename: string): 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[];
+
+  resolveDependency(
+    from: string,
+    to: string,
+    platform: string | null,
+    resolverOptions: ResolverInputOptions,
+    options: {assumeFlatNodeModules: boolean},
+  ): BundlerResolution;
+
+  getHasteName(filePath: string): string;
+  getDependencies(filePath: string): string[];
+}

package/src/node-haste/DependencyGraph.js

@@ -220,6 +220,7 @@ class DependencyGraph extends EventEmitter {
     return this._haste;
   }
   end() {
+    // $FlowFixMe[unused-promise]
     this._haste.end();
   }
 

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

@@ -279,6 +279,7 @@ class DependencyGraph extends EventEmitter {
   }
 
   end() {
+    // $FlowFixMe[unused-promise]
     this._haste.end();
   }
 

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

@@ -52,6 +52,7 @@ function saveAsAssets(bundle, options, log) {
         writeMagicFlagFile(modulesDir),
       ])
   );
+  // $FlowFixMe[unused-promise]
   writeUnbundle.then(() => log("Done writing unbundle output"));
   if (sourcemapOutput) {
     const sourceMap = buildSourcemapWithMetadata({

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

@@ -62,6 +62,7 @@ function saveAsAssets(
         writeMagicFlagFile(modulesDir),
       ]),
   );
+  // $FlowFixMe[unused-promise]
   writeUnbundle.then(() => log('Done writing unbundle output'));
 
   if (sourcemapOutput) {

package/src/shared/output/RamBundle/write-sourcemap.js

@@ -18,6 +18,7 @@ function writeSourcemap(fileName, contents, log) {
   }
   log("Writing sourcemap output to:", fileName);
   const writeMap = writeFile(fileName, contents, null);
+  // $FlowFixMe[unused-promise]
   writeMap.then(() => log("Done writing sourcemap output"));
   return writeMap;
 }

package/src/shared/output/RamBundle/write-sourcemap.js.flow

@@ -23,6 +23,7 @@ function writeSourcemap(
   }
   log('Writing sourcemap output to:', fileName);
   const writeMap = writeFile(fileName, contents, null);
+  // $FlowFixMe[unused-promise]
   writeMap.then(() => log('Done writing sourcemap output'));
   return writeMap;
 }

package/src/shared/output/bundle.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 {OutputOptions, RequestOptions} from '../../shared/types';
+import Server from '../../Server';
+
+export function build(
+  packagerClient: Server,
+  requestOptions: RequestOptions,
+): Promise<{
+  code: string;
+  map: string;
+}>;
+
+export function save(
+  bundle: {
+    code: string;
+    map: string;
+  },
+  options: OutputOptions,
+  log: (...args: string[]) => void,
+): Promise<unknown>;
+
+export const formatName: string;

package/src/shared/types.d.ts

@@ -0,0 +1,138 @@
+/**
+ * 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 {TransformProfile} from 'metro-babel-transformer';
+import type {CustomResolverOptions} from 'metro-resolver';
+
+import type {
+  MetroSourceMapSegmentTuple,
+  MixedSourceMap,
+} from 'metro-source-map';
+import type {
+  CustomTransformOptions,
+  MinifierOptions,
+} from 'metro-transform-worker';
+import type {
+  Options as DeltaBundlerOptions,
+  TransformInputOptions,
+} from '../DeltaBundler/types';
+
+export type BundleType =
+  | 'bundle'
+  | 'delta'
+  | 'meta'
+  | 'map'
+  | 'ram'
+  | 'cli'
+  | 'hmr'
+  | 'todo'
+  | 'graph';
+
+type MetroSourceMapOrMappings = MixedSourceMap | MetroSourceMapSegmentTuple[];
+
+export interface BundleOptions {
+  bundleType: BundleType;
+  readonly customResolverOptions: CustomResolverOptions;
+  customTransformOptions: CustomTransformOptions;
+  dev: boolean;
+  entryFile: string;
+  readonly excludeSource: boolean;
+  readonly hot: boolean;
+  readonly inlineSourceMap: boolean;
+  minify: boolean;
+  readonly modulesOnly: boolean;
+  onProgress?: (doneCont: number, totalCount: number) => unknown;
+  readonly platform?: string;
+  readonly runModule: boolean;
+  runtimeBytecodeVersion?: number;
+  readonly shallow: boolean;
+  sourceMapUrl?: string;
+  sourceUrl?: string;
+  createModuleIdFactory?: () => (path: string) => number;
+  readonly unstable_transformProfile: TransformProfile;
+}
+
+export interface ResolverInputOptions {
+  readonly customResolverOptions?: CustomResolverOptions;
+}
+
+export interface SerializerOptions {
+  readonly sourceMapUrl: string | null;
+  readonly sourceUrl: string | null;
+  readonly runModule: boolean;
+  readonly excludeSource: boolean;
+  readonly inlineSourceMap: boolean;
+  readonly modulesOnly: boolean;
+}
+
+export interface GraphOptions {
+  readonly shallow: boolean;
+}
+
+// Stricter representation of BundleOptions.
+export interface SplitBundleOptions {
+  readonly entryFile: string;
+  readonly resolverOptions: ResolverInputOptions;
+  readonly transformOptions: TransformInputOptions;
+  readonly serializerOptions: SerializerOptions;
+  readonly graphOptions: GraphOptions;
+  readonly onProgress: DeltaBundlerOptions['onProgress'];
+}
+
+export interface ModuleGroups {
+  groups: Map<number, Set<number>>;
+  modulesById: Map<number, ModuleTransportLike>;
+  modulesInGroups: Set<number>;
+}
+
+export interface ModuleTransportLike {
+  readonly code: string;
+  readonly id: number;
+  readonly map: MetroSourceMapOrMappings | null;
+  readonly name?: string;
+  readonly sourcePath: string;
+}
+
+export interface ModuleTransportLikeStrict {
+  readonly code: string;
+  readonly id: number;
+  readonly map: MetroSourceMapOrMappings | null;
+  readonly name?: string;
+  readonly sourcePath: string;
+}
+
+export interface RamModuleTransport extends ModuleTransportLikeStrict {
+  readonly source: string;
+  readonly type: string;
+}
+
+export interface OutputOptions {
+  bundleOutput: string;
+  bundleEncoding?: 'utf8' | 'utf16le' | 'ascii';
+  dev?: boolean;
+  indexedRamBundle?: boolean;
+  platform: string;
+  sourcemapOutput?: string;
+  sourcemapSourcesRoot?: string;
+  sourcemapUseAbsolutePath?: boolean;
+}
+
+export interface RequestOptions {
+  entryFile: string;
+  inlineSourceMap?: boolean;
+  sourceMapUrl?: string;
+  dev?: boolean;
+  minify: boolean;
+  platform: string;
+  createModuleIdFactory?: () => (path: string) => number;
+  onProgress?: (transformedFileCount: number, totalFileCount: number) => void;
+}
+
+export type {MinifierOptions};

package/src/shared/types.flow.js.flow

@@ -55,7 +55,6 @@ export type BundleOptions = {
   onProgress: ?(doneCont: number, totalCount: number) => mixed,
   +platform: ?string,
   +runModule: boolean,
-  runtimeBytecodeVersion: ?number,
   +shallow: boolean,
   sourceMapUrl: ?string,
   sourceUrl: ?string,
@@ -139,6 +138,8 @@ export type RequestOptions = {
   platform: string,
   createModuleIdFactory?: () => (path: string) => number,
   onProgress?: (transformedFileCount: number, totalFileCount: number) => void,
+  +customResolverOptions?: CustomResolverOptions,
+  +customTransformOptions?: CustomTransformOptions,
 };
 
 export type {MinifierOptions};

package/types/Asset.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
+ */
+
+export interface AssetDataWithoutFiles {
+  readonly __packager_asset: boolean;
+  readonly fileSystemLocation: string;
+  readonly hash: string;
+  readonly height?: number;
+  readonly httpServerLocation: string;
+  readonly name: string;
+  readonly scales: number[];
+  readonly type: string;
+  readonly width?: number;
+}
+
+export interface AssetData extends AssetDataWithoutFiles {
+  readonly files: string[];
+}