metro 0.76.0 → 0.76.1

package/src/commands/dependencies.js.flow

@@ -0,0 +1,128 @@
+/**
+ * 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.
+ *
+ * @flow
+ * @format
+ * @oncall react_native
+ */
+
+'use strict';
+
+import type {ConfigT} from 'metro-config';
+import typeof Yargs from 'yargs';
+import type {ModuleObject} from 'yargs';
+
+const {makeAsyncCommand} = require('../cli-utils');
+const Server = require('../Server');
+const fs = require('fs');
+const {loadConfig} = require('metro-config');
+const path = require('path');
+const {promisify} = require('util');
+
+type Args = $ReadOnly<{
+  entryFile: string,
+  output?: string,
+  platform?: string,
+  transformer?: string,
+  maxWorkers?: number,
+  dev: boolean,
+  verbose: boolean,
+}>;
+
+async function dependencies(args: Args, config: ConfigT) {
+  const rootModuleAbsolutePath = args.entryFile;
+  if (!fs.existsSync(rootModuleAbsolutePath)) {
+    return Promise.reject(
+      new Error(`File ${rootModuleAbsolutePath} does not exist`),
+    );
+  }
+
+  // $FlowFixMe[cannot-write]
+  config.cacheStores = [];
+
+  const relativePath = path.relative(
+    config.server.unstable_serverRoot ?? config.projectRoot,
+    rootModuleAbsolutePath,
+  );
+
+  const options = {
+    platform: args.platform,
+    entryFile: relativePath,
+    dev: args.dev,
+    minify: false,
+    generateSourceMaps: !args.dev,
+  };
+
+  const outStream =
+    args.output != null ? fs.createWriteStream(args.output) : process.stdout;
+
+  const server = new Server(config);
+  const deps = await server.getOrderedDependencyPaths(options);
+  deps.forEach(modulePath => {
+    // Temporary hack to disable listing dependencies not under this directory.
+    // Long term, we need either
+    // (a) JS code to not depend on anything outside this directory, or
+    // (b) Come up with a way to declare this dependency in Buck.
+    const isInsideProjectRoots =
+      config.watchFolders.filter(root => modulePath.startsWith(root)).length >
+      0;
+    if (isInsideProjectRoots) {
+      outStream.write(modulePath + '\n');
+    }
+  });
+
+  server.end();
+  return args.output != null
+    ? // $FlowFixMe[method-unbinding]
+      promisify(outStream.end).bind(outStream)()
+    : Promise.resolve();
+}
+
+module.exports = (): {...ModuleObject, handler: Function} => ({
+  command: 'get-dependencies [entryFile]',
+  desc: 'List all dependencies that will be bundled for a given entry point',
+  builder: (yargs: Yargs) => {
+    yargs.option('entry-file', {
+      type: 'string',
+      demandOption: true,
+      describe: 'Absolute path to the root JS file',
+    });
+    yargs.option('output', {
+      type: 'string',
+      describe:
+        'File name where to store the output, ex. /tmp/dependencies.txt',
+    });
+    yargs.option('platform', {
+      type: 'string',
+      describe: 'The platform extension used for selecting modules',
+    });
+    yargs.option('transformer', {
+      type: 'string',
+      describe: 'Specify a custom transformer to be used',
+    });
+    yargs.option('max-workers', {
+      type: 'number',
+      describe:
+        'Specifies the maximum number of workers the worker-pool ' +
+        'will spawn for transforming files. This defaults to the number of the ' +
+        'cores available on your machine.',
+    });
+    yargs.option('dev', {
+      type: 'boolean',
+      default: true,
+      describe: 'If false, skip all dev-only code path',
+    });
+    yargs.option('verbose', {
+      type: 'boolean',
+      default: false,
+      description: 'Enables logging',
+    });
+  },
+  handler: makeAsyncCommand(async (argv: Args) => {
+    const config = await loadConfig(argv);
+    await dependencies(argv, config);
+  }),
+});

package/src/commands/serve.js

@@ -94,12 +94,19 @@ module.exports = () => ({
 
       // Inline require() to avoid circular dependency with ../index
       const MetroApi = require("../index");
-
-      // $FlowExpectedError YargArguments and RunBuildOptions are used interchangeable but their types are not yet compatible
-      server = await MetroApi.runServer(config, argv);
+      const {
+        config: _config,
+        hmrEnabled: _hmrEnabled,
+        maxWorkers: _maxWorkers,
+        port: _port,
+        projectRoots: _projectRoots,
+        resetCache: _resetCache,
+        ...runServerOptions
+      } = argv;
+      server = await MetroApi.runServer(config, runServerOptions);
       restarting = false;
     }
-    const foundConfig = await resolveConfig(argv.config, argv.cwd);
+    const foundConfig = await resolveConfig(argv.config);
     if (foundConfig) {
       await watchFile(foundConfig.filepath, restart);
     } else {

package/src/commands/serve.js.flow

@@ -11,8 +11,6 @@
 
 'use strict';
 
-import type {RunServerOptions} from '../index';
-import type {YargArguments} from 'metro-config/src/configTypes.flow';
 import typeof Yargs from 'yargs';
 import type {ModuleObject} from 'yargs';
 
@@ -20,6 +18,20 @@ const {makeAsyncCommand, watchFile} = require('../cli-utils');
 const {loadConfig, resolveConfig} = require('metro-config');
 const {promisify} = require('util');
 
+type Args = $ReadOnly<{
+  projectRoots?: $ReadOnlyArray<string>,
+  host: string,
+  port: number,
+  maxWorkers?: number,
+  secure?: boolean,
+  secureKey?: string,
+  secureCert?: string,
+  secureServerOptions?: string,
+  hmrEnabled?: boolean,
+  config?: string,
+  resetCache?: boolean,
+}>;
+
 module.exports = (): {
   ...ModuleObject,
   handler: Function,
@@ -63,7 +75,7 @@ module.exports = (): {
     );
   },
 
-  handler: makeAsyncCommand(async (argv: YargArguments) => {
+  handler: makeAsyncCommand(async (argv: Args) => {
     let server = null;
     let restarting = false;
 
@@ -86,13 +98,21 @@ module.exports = (): {
       // Inline require() to avoid circular dependency with ../index
       const MetroApi = require('../index');
 
-      // $FlowExpectedError YargArguments and RunBuildOptions are used interchangeable but their types are not yet compatible
-      server = await MetroApi.runServer(config, (argv: RunServerOptions));
+      const {
+        config: _config,
+        hmrEnabled: _hmrEnabled,
+        maxWorkers: _maxWorkers,
+        port: _port,
+        projectRoots: _projectRoots,
+        resetCache: _resetCache,
+        ...runServerOptions
+      } = argv;
+      server = await MetroApi.runServer(config, runServerOptions);
 
       restarting = false;
     }
 
-    const foundConfig = await resolveConfig(argv.config, argv.cwd);
+    const foundConfig = await resolveConfig(argv.config);
 
     if (foundConfig) {
       await watchFile(foundConfig.filepath, restart);

package/src/index.d.ts

@@ -0,0 +1,151 @@
+/**
+ * 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 * from './Asset';
+export * from './DeltaBundler/types';
+export * from './ModuleGraph/worker/collectDependencies';
+export * from './Server';
+export * from './lib/reporting';
+
+import type {Server as HttpServer} from 'http';
+import type {Server as HttpsServer} from 'https';
+import type {
+  ConfigT,
+  InputConfigT,
+  loadConfig,
+  MetroConfig,
+  Middleware,
+} from 'metro-config';
+import type {CustomTransformOptions} from 'metro-babel-transformer';
+import type {ReadOnlyGraph} from './DeltaBundler/types';
+import type {Server} from 'ws';
+import Yargs = require('yargs');
+import type {default as MetroServer, ServerOptions} from './Server';
+import type {OutputOptions, RequestOptions} from './shared/types';
+
+export {HttpServer, HttpsServer};
+
+interface MetroMiddleWare {
+  attachHmrServer: (httpServer: HttpServer | HttpsServer) => void;
+  end: () => void;
+  metroServer: MetroServer;
+  middleware: Middleware;
+}
+
+export interface RunMetroOptions extends ServerOptions {
+  waitForBundler?: boolean;
+}
+
+export interface RunServerOptions {
+  hasReducedPerformance?: boolean;
+  host?: string;
+  onError?: (error: Error & {code?: string}) => void;
+  onReady?: (server: HttpServer | HttpsServer) => void;
+  runInspectorProxy?: boolean;
+  secureServerOptions?: Record<string, unknown>;
+
+  /** @deprecated since version 0.61 */
+  secure?: boolean;
+
+  /** @deprecated since version 0.61 */
+  secureCert?: string;
+
+  /** @deprecated since version 0.61 */
+  secureKey?: string;
+
+  waitForBundler?: boolean;
+  watch?: boolean;
+  websocketEndpoints?: {
+    [path: string]: Server;
+  };
+}
+
+export interface RunBuildOptions {
+  entry: string;
+  dev?: boolean;
+  out?: string;
+  onBegin?: () => void;
+  onComplete?: () => void;
+  onProgress?: (transformedFileCount: number, totalFileCount: number) => void;
+  minify?: boolean;
+  output?: {
+    build: (
+      server: MetroServer,
+      options: RequestOptions,
+    ) => Promise<{
+      code: string;
+      map: string;
+    }>;
+    save: (
+      entry: {
+        code: string;
+        map: string;
+      },
+      options: OutputOptions,
+      postSave: (...args: string[]) => void,
+    ) => Promise<unknown>;
+  };
+  platform?: string;
+  sourceMap?: boolean;
+  sourceMapUrl?: string;
+}
+
+interface BuildGraphOptions {
+  entries: ReadonlyArray<string>;
+  customTransformOptions?: CustomTransformOptions;
+  dev?: boolean;
+  minify?: boolean;
+  onProgress?: (transformedFileCount: number, totalFileCount: number) => void;
+  platform?: string;
+  type?: 'module' | 'script';
+}
+
+export {MetroConfig};
+
+export function runMetro(
+  config: InputConfigT,
+  options?: RunMetroOptions,
+): Promise<MetroServer>;
+
+export {loadConfig};
+
+export function createConnectMiddleWare(
+  config: ConfigT,
+  options?: RunMetroOptions,
+): Promise<MetroMiddleWare>;
+
+export function runServer(
+  config: ConfigT,
+  options: RunServerOptions,
+): Promise<HttpServer | HttpsServer>;
+
+export function runBuild(
+  config: ConfigT,
+  options: RunBuildOptions,
+): Promise<void>;
+
+export function buildGraph(
+  config: ConfigT,
+  options: BuildGraphOptions,
+): Promise<ReadOnlyGraph<void>>;
+
+type BuildCommandOptions = Record<string, unknown> | null;
+type ServeCommandOptions = Record<string, unknown> | null;
+
+interface AttachMetroCLIOptions {
+  build?: BuildCommandOptions;
+  serve?: ServeCommandOptions;
+  dependencies?: unknown;
+}
+
+export function attachMetroCli(
+  yargs: typeof Yargs,
+  options?: AttachMetroCLIOptions,
+): typeof Yargs;

package/src/index.flow.js

@@ -69,6 +69,7 @@ async function runMetro(config, options) {
 }
 exports.runMetro = runMetro;
 exports.loadConfig = loadConfig;
+exports.mergeConfig = mergeConfig;
 const createConnectMiddleware = async function (config, options) {
   const metroServer = await runMetro(config, options);
   let enhancedMiddleware = metroServer.processRequest;
@@ -179,7 +180,8 @@ exports.runServer = async (
       if (onReady) {
         onReady(httpServer);
       }
-      Object.assign(websocketEndpoints, {
+      websocketEndpoints = {
+        ...websocketEndpoints,
         ...(inspectorProxy
           ? {
               ...inspectorProxy.createWebSocketListeners(httpServer),
@@ -192,7 +194,7 @@ exports.runServer = async (
             config
           ),
         }),
-      });
+      };
       httpServer.on("upgrade", (request, socket, head) => {
         const { pathname } = parse(request.url);
         if (pathname != null && websocketEndpoints[pathname]) {
@@ -230,6 +232,8 @@ exports.runServer = async (
 exports.runBuild = async (
   config,
   {
+    customResolverOptions,
+    customTransformOptions,
     dev = false,
     entry,
     onBegin,
@@ -256,6 +260,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,6 +11,7 @@
 
 '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';
@@ -19,6 +20,7 @@ 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';
@@ -54,7 +56,7 @@ export type RunMetroOptions = {
   waitForBundler?: boolean,
 };
 
-export type RunServerOptions = {
+export type RunServerOptions = $ReadOnly<{
   hasReducedPerformance?: boolean,
   host?: string,
   onError?: (Error & {code?: string}) => void,
@@ -66,10 +68,10 @@ export type RunServerOptions = {
   secureKey?: string, // deprecated
   waitForBundler?: boolean,
   watch?: boolean,
-  websocketEndpoints?: {
+  websocketEndpoints?: $ReadOnly<{
     [path: string]: typeof ws.Server,
-  },
-};
+  }>,
+}>;
 
 type BuildGraphOptions = {
   entries: $ReadOnlyArray<string>,
@@ -112,11 +114,15 @@ export type RunBuildOptions = {
   platform?: string,
   sourceMap?: boolean,
   sourceMapUrl?: string,
+  customResolverOptions?: CustomResolverOptions,
+  customTransformOptions?: CustomTransformOptions,
 };
 
 type BuildCommandOptions = {} | null;
 type ServeCommandOptions = {} | null;
 
+export type {MetroConfig};
+
 async function getConfig(config: InputConfigT): Promise<ConfigT> {
   const defaultConfig = await getDefaultConfig(config.projectRoot);
   return mergeConfig(defaultConfig, config);
@@ -167,6 +173,7 @@ async function runMetro(
 
 exports.runMetro = runMetro;
 exports.loadConfig = loadConfig;
+exports.mergeConfig = mergeConfig;
 
 const createConnectMiddleware = async function (
   config: ConfigT,
@@ -291,7 +298,8 @@ exports.runServer = async (
           onReady(httpServer);
         }
 
-        Object.assign(websocketEndpoints, {
+        websocketEndpoints = {
+          ...websocketEndpoints,
           ...(inspectorProxy
             ? {...inspectorProxy.createWebSocketListeners(httpServer)}
             : {}),
@@ -302,7 +310,7 @@ exports.runServer = async (
               config,
             ),
           }),
-        });
+        };
 
         httpServer.on('upgrade', (request, socket, head) => {
           const {pathname} = parse(request.url);
@@ -346,6 +354,8 @@ exports.runServer = async (
 exports.runBuild = async (
   config: ConfigT,
   {
+    customResolverOptions,
+    customTransformOptions,
     dev = false,
     entry,
     onBegin,
@@ -377,6 +387,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,