metro 0.76.0 → 0.76.2

package/src/index.flow.js

@@ -23,11 +23,17 @@ const chalk = require("chalk");
 const fs = require("fs");
 const http = require("http");
 const https = require("https");
-const { getDefaultConfig, loadConfig, mergeConfig } = require("metro-config");
+const {
+  getDefaultConfig,
+  loadConfig,
+  mergeConfig,
+  resolveConfig,
+} = require("metro-config");
+const { Terminal } = require("metro-core");
 const { InspectorProxy } = require("metro-inspector-proxy");
 const net = require("net");
 const { parse } = require("url");
-const ws = require("ws");
+exports.Terminal = Terminal;
 async function getConfig(config) {
   const defaultConfig = await getDefaultConfig(config.projectRoot);
   return mergeConfig(defaultConfig, config);
@@ -69,6 +75,8 @@ async function runMetro(config, options) {
 }
 exports.runMetro = runMetro;
 exports.loadConfig = loadConfig;
+exports.mergeConfig = mergeConfig;
+exports.resolveConfig = resolveConfig;
 const createConnectMiddleware = async function (config, options) {
   const metroServer = await runMetro(config, options);
   let enhancedMiddleware = metroServer.processRequest;
@@ -179,7 +187,8 @@ exports.runServer = async (
       if (onReady) {
         onReady(httpServer);
       }
-      Object.assign(websocketEndpoints, {
+      websocketEndpoints = {
+        ...websocketEndpoints,
         ...(inspectorProxy
           ? {
               ...inspectorProxy.createWebSocketListeners(httpServer),
@@ -192,7 +201,7 @@ exports.runServer = async (
             config
           ),
         }),
-      });
+      };
       httpServer.on("upgrade", (request, socket, head) => {
         const { pathname } = parse(request.url);
         if (pathname != null && websocketEndpoints[pathname]) {
@@ -230,6 +239,8 @@ exports.runServer = async (
 exports.runBuild = async (
   config,
   {
+    customResolverOptions,
+    customTransformOptions,
     dev = false,
     entry,
     onBegin,
@@ -256,6 +267,8 @@ exports.runBuild = async (
       sourceMapUrl: sourceMap === false ? undefined : sourceMapUrl,
       createModuleIdFactory: config.serializer.createModuleIdFactory,
       onProgress,
+      customResolverOptions,
+      customTransformOptions,
     };
     if (onBegin) {
       onBegin();

package/src/index.flow.js.flow

@@ -11,17 +11,21 @@
 
 'use strict';
 
+import type {CustomResolverOptions} from 'metro-resolver';
 import type {ReadOnlyGraph} from './DeltaBundler';
 import type {ServerOptions} from './Server';
 import type {OutputOptions, RequestOptions} from './shared/types.flow.js';
-import type {Server as HttpServer} from 'http';
+import type EventEmitter from 'events';
+import type {IncomingMessage, Server as HttpServer} from 'http';
 import type {Server as HttpsServer} from 'https';
 import type {
   ConfigT,
   InputConfigT,
+  MetroConfig,
   Middleware,
 } from 'metro-config/src/configTypes.flow';
 import type {CustomTransformOptions} from 'metro-transform-worker';
+import type {Duplex} from 'stream';
 import typeof Yargs from 'yargs';
 
 const makeBuildCommand = require('./commands/build');
@@ -36,11 +40,16 @@ const chalk = require('chalk');
 const fs = require('fs');
 const http = require('http');
 const https = require('https');
-const {getDefaultConfig, loadConfig, mergeConfig} = require('metro-config');
+const {
+  getDefaultConfig,
+  loadConfig,
+  mergeConfig,
+  resolveConfig,
+} = require('metro-config');
+const {Terminal} = require('metro-core');
 const {InspectorProxy} = require('metro-inspector-proxy');
 const net = require('net');
 const {parse} = require('url');
-const ws = require('ws');
 
 type MetroMiddleWare = {
   attachHmrServer: (httpServer: HttpServer | HttpsServer) => void,
@@ -54,7 +63,16 @@ export type RunMetroOptions = {
   waitForBundler?: boolean,
 };
 
-export type RunServerOptions = {
+interface WebsocketServer extends EventEmitter {
+  handleUpgrade<T = WebsocketServer>(
+    request: IncomingMessage,
+    socket: Duplex,
+    upgradeHead: Buffer,
+    callback: (client: T, request: IncomingMessage) => void,
+  ): void;
+}
+
+export type RunServerOptions = $ReadOnly<{
   hasReducedPerformance?: boolean,
   host?: string,
   onError?: (Error & {code?: string}) => void,
@@ -66,10 +84,10 @@ export type RunServerOptions = {
   secureKey?: string, // deprecated
   waitForBundler?: boolean,
   watch?: boolean,
-  websocketEndpoints?: {
-    [path: string]: typeof ws.Server,
-  },
-};
+  websocketEndpoints?: $ReadOnly<{
+    [path: string]: WebsocketServer,
+  }>,
+}>;
 
 type BuildGraphOptions = {
   entries: $ReadOnlyArray<string>,
@@ -112,11 +130,17 @@ export type RunBuildOptions = {
   platform?: string,
   sourceMap?: boolean,
   sourceMapUrl?: string,
+  customResolverOptions?: CustomResolverOptions,
+  customTransformOptions?: CustomTransformOptions,
 };
 
 type BuildCommandOptions = {} | null;
 type ServeCommandOptions = {} | null;
 
+exports.Terminal = Terminal;
+
+export type {MetroConfig};
+
 async function getConfig(config: InputConfigT): Promise<ConfigT> {
   const defaultConfig = await getDefaultConfig(config.projectRoot);
   return mergeConfig(defaultConfig, config);
@@ -167,6 +191,8 @@ async function runMetro(
 
 exports.runMetro = runMetro;
 exports.loadConfig = loadConfig;
+exports.mergeConfig = mergeConfig;
+exports.resolveConfig = resolveConfig;
 
 const createConnectMiddleware = async function (
   config: ConfigT,
@@ -291,7 +317,8 @@ exports.runServer = async (
           onReady(httpServer);
         }
 
-        Object.assign(websocketEndpoints, {
+        websocketEndpoints = {
+          ...websocketEndpoints,
           ...(inspectorProxy
             ? {...inspectorProxy.createWebSocketListeners(httpServer)}
             : {}),
@@ -302,7 +329,7 @@ exports.runServer = async (
               config,
             ),
           }),
-        });
+        };
 
         httpServer.on('upgrade', (request, socket, head) => {
           const {pathname} = parse(request.url);
@@ -346,6 +373,8 @@ exports.runServer = async (
 exports.runBuild = async (
   config: ConfigT,
   {
+    customResolverOptions,
+    customTransformOptions,
     dev = false,
     entry,
     onBegin,
@@ -377,6 +406,8 @@ exports.runBuild = async (
       sourceMapUrl: sourceMap === false ? undefined : sourceMapUrl,
       createModuleIdFactory: config.serializer.createModuleIdFactory,
       onProgress,
+      customResolverOptions,
+      customTransformOptions,
     };
 
     if (onBegin) {

package/src/lib/CountingSet.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 ReadOnlyCountingSet<T> extends Iterable<T> {
+  has(item: T): boolean;
+  [Symbol.iterator](): Iterator<T>;
+  readonly size: number;
+  count(item: T): number;
+  forEach<ThisT>(
+    callbackFn: (
+      this: ThisT,
+      value: T,
+      key: T,
+      set: ReadOnlyCountingSet<T>,
+    ) => unknown,
+    thisArg: ThisT,
+  ): void;
+}
+
+export default class CountingSet<T> implements ReadOnlyCountingSet<T> {
+  constructor(items?: Iterable<T>);
+  get size(): number;
+  has(item: T): boolean;
+  add(item: T): void;
+  delete(item: T): void;
+  keys(): Iterator<T>;
+  values(): Iterator<T>;
+  [Symbol.iterator](): Iterator<T>;
+  count(item: T): number;
+  clear(): void;
+  forEach<ThisT>(
+    callbackFn: (
+      this: ThisT,
+      value: T,
+      key: T,
+      set: ReadOnlyCountingSet<T>,
+    ) => unknown,
+    thisArg: ThisT,
+  ): void;
+  toJSON(): unknown;
+}

package/src/lib/TerminalReporter.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 {ReportableEvent} from './reporting';
+import {Terminal} from 'metro-core';
+
+export type TerminalReportableEvent =
+  | ReportableEvent
+  | {
+      buildID: string;
+      type: 'bundle_transform_progressed_throttled';
+      transformedFileCount: number;
+      totalFileCount: number;
+    };
+
+export class TerminalReporter {
+  constructor(terminal: Terminal);
+  readonly terminal: Terminal;
+  update(event: TerminalReportableEvent): void;
+}

package/src/lib/TerminalReporter.js

@@ -53,7 +53,7 @@ class TerminalReporter {
    */
   _getBundleStatusMessage(
     {
-      bundleDetails: { entryFile, bundleType, runtimeBytecodeVersion },
+      bundleDetails: { entryFile, bundleType },
       transformedFileCount,
       totalFileCount,
       ratio,
@@ -61,9 +61,6 @@ class TerminalReporter {
     },
     phase
   ) {
-    if (runtimeBytecodeVersion) {
-      bundleType = "bytecodebundle";
-    }
     if (isPrefetch) {
       bundleType = "PREBUNDLE";
     }

package/src/lib/TerminalReporter.js.flow

@@ -101,7 +101,7 @@ class TerminalReporter {
    */
   _getBundleStatusMessage(
     {
-      bundleDetails: {entryFile, bundleType, runtimeBytecodeVersion},
+      bundleDetails: {entryFile, bundleType},
       transformedFileCount,
       totalFileCount,
       ratio,
@@ -109,10 +109,6 @@ class TerminalReporter {
     }: BundleProgress,
     phase: BuildPhase,
   ): string {
-    if (runtimeBytecodeVersion) {
-      bundleType = 'bytecodebundle';
-    }
-
     if (isPrefetch) {
       bundleType = 'PREBUNDLE';
     }

package/src/lib/contextModule.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 {ContextMode} from '../ModuleGraph/worker/collectDependencies';
+
+export interface RequireContext {
+  /* Should search for files recursively. Optional, default `true` when `require.context` is used */
+  readonly recursive: boolean;
+  /* Filename filter pattern for use in `require.context`. Optional, default `.*` (any file) when `require.context` is used */
+  readonly filter: RegExp;
+  /** Mode for resolving dynamic dependencies. Defaults to `sync` */
+  readonly mode: ContextMode;
+  /** Absolute path of the directory to search in */
+  readonly from: string;
+}

package/src/lib/getGraphId.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 GraphId = string;

package/src/lib/getGraphId.js

@@ -34,7 +34,6 @@ function getGraphId(
         minify: options.minify,
         unstable_disableES6Transforms: options.unstable_disableES6Transforms,
         platform: options.platform != null ? options.platform : null,
-        runtimeBytecodeVersion: options.runtimeBytecodeVersion,
         type: options.type,
         experimentalImportBundleSupport,
         unstable_allowRequireContext,

package/src/lib/getGraphId.js.flow

@@ -45,7 +45,6 @@ function getGraphId(
         minify: options.minify,
         unstable_disableES6Transforms: options.unstable_disableES6Transforms,
         platform: options.platform != null ? options.platform : null,
-        runtimeBytecodeVersion: options.runtimeBytecodeVersion,
         type: options.type,
         experimentalImportBundleSupport,
         unstable_allowRequireContext,

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,
   };