metro 0.83.3 → 0.83.5

package/src/lib/bundleProgressUtils.js.flow

@@ -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.
+ *
+ * @flow strict-local
+ * @format
+ * @oncall react_native
+ */
+
+/**
+ * Calculates a conservative progress ratio for bundle building.
+ *
+ * Because we know the `totalFileCount` is going to progressively increase
+ * starting with 1:
+ * - We use Math.max(totalFileCount, 10) to prevent the ratio from raising too
+ *   quickly when the total file count is low. (e.g 1/2 5/6)
+ * - We use Math.pow(ratio, 2) as a conservative measure of progress.
+ * - The ratio is capped at 0.999 to ensure we don't display 100% until done.
+ * - If previousRatio is provided, the ratio will not go backwards.
+ */
+export function calculateBundleProgressRatio(
+  transformedFileCount: number,
+  totalFileCount: number,
+  previousRatio?: number,
+): number {
+  const baseRatio = Math.pow(
+    transformedFileCount / Math.max(totalFileCount, 10),
+    2,
+  );
+  const ratio =
+    previousRatio != null ? Math.max(baseRatio, previousRatio) : baseRatio;
+  return Math.min(ratio, 0.999);
+}

package/src/lib/bundleToString.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 {Bundle, BundleMetadata} from 'metro-runtime/src/modules/types';
+/**
+ * Serializes a bundle into a plain JS bundle.
+ */
+declare function bundleToString(bundle: Bundle): {
+  readonly code: string;
+  readonly metadata: BundleMetadata;
+};
+export default bundleToString;

package/src/lib/contextModule.d.ts

@@ -8,15 +8,26 @@
  * @oncall react_native
  */
 
-import type {ContextMode} from '../ModuleGraph/worker/collectDependencies';
+import type {
+  ContextMode,
+  RequireContextParams,
+} 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;
+export type RequireContext = Readonly<{
+  recursive: boolean;
+  filter: RegExp;
   /** Mode for resolving dynamic dependencies. Defaults to `sync` */
-  readonly mode: ContextMode;
+  mode: ContextMode;
   /** Absolute path of the directory to search in */
-  readonly from: string;
-}
+  from: string;
+}>;
+/** Given a fully qualified require context, return a virtual file path that ensures uniqueness between paths with different contexts. */
+export declare function deriveAbsolutePathFromContext(
+  from: string,
+  context: RequireContextParams,
+): string;
+/** Match a file against a require context. */
+export declare function fileMatchesContext(
+  testPath: string,
+  context: RequireContext,
+): boolean;

package/src/lib/contextModule.js.flow

@@ -18,7 +18,7 @@ import crypto from 'crypto';
 import nullthrows from 'nullthrows';
 import path from 'path';
 
-export type RequireContext = $ReadOnly<{
+export type RequireContext = Readonly<{
   /* Should search for files recursively. Optional, default `true` when `require.context` is used */
   recursive: boolean,
   /* Filename filter pattern for use in `require.context`. Optional, default `.*` (any file) when `require.context` is used */

package/src/lib/contextModuleTemplates.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 {ContextMode} from '../ModuleGraph/worker/collectDependencies';
+/**
+ * Generate a context module as a virtual file string.
+ *
+ * @prop {ContextMode} mode indicates how the modules should be loaded.
+ * @prop {string} modulePath virtual file path for the virtual module. Example: `require.context('./src')` -> `'/path/to/project/src'`.
+ * @prop {string[]} files list of absolute file paths that must be exported from the context module. Example: `['/path/to/project/src/index.js']`.
+ *
+ * @returns a string representing a context module (virtual file contents).
+ */
+export declare function getContextModuleTemplate(
+  mode: ContextMode,
+  modulePath: string,
+  files: string[],
+): string;

package/src/lib/contextModuleTemplates.js

@@ -6,28 +6,32 @@ Object.defineProperty(exports, "__esModule", {
 exports.getContextModuleTemplate = getContextModuleTemplate;
 var os = _interopRequireWildcard(require("os"));
 var path = _interopRequireWildcard(require("path"));
-function _getRequireWildcardCache(e) {
-  if ("function" != typeof WeakMap) return null;
-  var r = new WeakMap(),
-    t = new WeakMap();
-  return (_getRequireWildcardCache = function (e) {
-    return e ? t : r;
-  })(e);
-}
-function _interopRequireWildcard(e, r) {
-  if (!r && e && e.__esModule) return e;
-  if (null === e || ("object" != typeof e && "function" != typeof e))
-    return { default: e };
-  var t = _getRequireWildcardCache(r);
-  if (t && t.has(e)) return t.get(e);
-  var n = { __proto__: null },
-    a = Object.defineProperty && Object.getOwnPropertyDescriptor;
-  for (var u in e)
-    if ("default" !== u && {}.hasOwnProperty.call(e, u)) {
-      var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
-      i && (i.get || i.set) ? Object.defineProperty(n, u, i) : (n[u] = e[u]);
+function _interopRequireWildcard(e, t) {
+  if ("function" == typeof WeakMap)
+    var r = new WeakMap(),
+      n = new WeakMap();
+  return (_interopRequireWildcard = function (e, t) {
+    if (!t && e && e.__esModule) return e;
+    var o,
+      i,
+      f = { __proto__: null, default: e };
+    if (null === e || ("object" != typeof e && "function" != typeof e))
+      return f;
+    if ((o = t ? n : r)) {
+      if (o.has(e)) return o.get(e);
+      o.set(e, f);
     }
-  return ((n.default = e), t && t.set(e, n), n);
+    for (const t in e)
+      "default" !== t &&
+        {}.hasOwnProperty.call(e, t) &&
+        ((i =
+          (o = Object.defineProperty) &&
+          Object.getOwnPropertyDescriptor(e, t)) &&
+        (i.get || i.set)
+          ? o(f, t, i)
+          : (f[t] = e[t]));
+    return f;
+  })(e, t);
 }
 function createFileMap(modulePath, files, processModule) {
   let mapString = "\n";

package/src/lib/countLines.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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
+ */
+
+declare function countLines(string: string): number;
+export default countLines;

package/src/lib/countLines.js

@@ -3,7 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true,
 });
-exports.default = void 0;
+exports.default = countLines;
 const newline = /\r\n?|\n|\u2028|\u2029/g;
-const countLines = (string) => (string.match(newline) || []).length + 1;
-var _default = (exports.default = countLines);
+function countLines(string) {
+  return (string.match(newline) || []).length + 1;
+}

package/src/lib/countLines.js.flow

@@ -11,7 +11,6 @@
 
 const newline = /\r\n?|\n|\u2028|\u2029/g;
 
-const countLines = (string: string): number =>
-  (string.match(newline) || []).length + 1;
-
-export default countLines;
+export default function countLines(string: string): number {
+  return (string.match(newline) || []).length + 1;
+}

package/src/lib/createWebsocketServer.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 ws from 'ws';
+
+type WebsocketServiceInterface<T> = {
+  readonly onClientConnect: (
+    url: string,
+    sendFn: (data: string) => void,
+  ) => Promise<null | undefined | T>;
+  readonly onClientDisconnect?: (client: T) => unknown;
+  readonly onClientError?: (client: T, e: Error) => unknown;
+  readonly onClientMessage?: (
+    client: T,
+    message: string | Buffer | ArrayBuffer | Array<Buffer>,
+    sendFn: (data: string) => void,
+  ) => unknown;
+};
+type HMROptions<TClient> = {
+  websocketServer: WebsocketServiceInterface<TClient>;
+};
+/**
+ * Returns a WebSocketServer to be attached to an existing HTTP instance. It forwards
+ * the received events on the given "websocketServer" parameter. It must be an
+ * object with the following fields:
+ *
+ *   - onClientConnect
+ *   - onClientError
+ *   - onClientMessage
+ *   - onClientDisconnect
+ */
+
+declare function createWebsocketServer<TClient>(
+  $$PARAM_0$$: HMROptions<TClient>,
+): ws.Server;
+export default createWebsocketServer;

package/src/lib/createWebsocketServer.js

@@ -4,10 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true,
 });
 exports.default = createWebsocketServer;
+var _timers = require("timers");
 var _ws = _interopRequireDefault(require("ws"));
 function _interopRequireDefault(e) {
   return e && e.__esModule ? e : { default: e };
 }
+const KEEP_ALIVE_INTERVAL_MS = 20000;
 function createWebsocketServer({ websocketServer }) {
   const wss = new _ws.default.Server({
     noServer: true,
@@ -15,9 +17,9 @@ function createWebsocketServer({ websocketServer }) {
   wss.on("connection", async (ws, req) => {
     let connected = true;
     const url = req.url;
-    const sendFn = (...args) => {
+    const sendFn = (data) => {
       if (connected) {
-        ws.send(...args);
+        ws.send(data);
       }
     };
     const client = await websocketServer.onClientConnect(url, sendFn);
@@ -25,10 +27,15 @@ function createWebsocketServer({ websocketServer }) {
       ws.close();
       return;
     }
+    const keepAliveInterval = (0, _timers.setInterval)(
+      () => ws.ping(),
+      KEEP_ALIVE_INTERVAL_MS,
+    ).unref();
     ws.on("error", (e) => {
       websocketServer.onClientError && websocketServer.onClientError(client, e);
     });
     ws.on("close", () => {
+      (0, _timers.clearInterval)(keepAliveInterval);
       websocketServer.onClientDisconnect &&
         websocketServer.onClientDisconnect(client);
       connected = false;

package/src/lib/createWebsocketServer.js.flow

@@ -4,11 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
+ * @flow strict
  * @format
  * @oncall react_native
  */
 
+import {clearInterval, setInterval} from 'timers';
 import ws from 'ws';
 
 type WebsocketServiceInterface<T> = interface {
@@ -16,13 +17,13 @@ type WebsocketServiceInterface<T> = interface {
     url: string,
     sendFn: (data: string) => void,
   ) => Promise<?T>,
-  +onClientDisconnect?: (client: T) => mixed,
-  +onClientError?: (client: T, e: ErrorEvent) => mixed,
+  +onClientDisconnect?: (client: T) => unknown,
+  +onClientError?: (client: T, e: Error) => unknown,
   +onClientMessage?: (
     client: T,
     message: string | Buffer | ArrayBuffer | Array<Buffer>,
     sendFn: (data: string) => void,
-  ) => mixed,
+  ) => unknown,
 };
 
 type HMROptions<TClient> = {
@@ -30,6 +31,8 @@ type HMROptions<TClient> = {
   ...
 };
 
+const KEEP_ALIVE_INTERVAL_MS = 20000;
+
 /**
  * Returns a WebSocketServer to be attached to an existing HTTP instance. It forwards
  * the received events on the given "websocketServer" parameter. It must be an
@@ -41,7 +44,7 @@ type HMROptions<TClient> = {
  *   - onClientDisconnect
  */
 
-export default function createWebsocketServer<TClient: Object>({
+export default function createWebsocketServer<TClient>({
   websocketServer,
 }: HMROptions<TClient>): ws.Server {
   const wss = new ws.Server({
@@ -52,10 +55,9 @@ export default function createWebsocketServer<TClient: Object>({
     let connected = true;
     const url = req.url;
 
-    const sendFn = (...args: Array<string>) => {
+    const sendFn = (data: string) => {
       if (connected) {
-        // $FlowFixMe[incompatible-type]
-        ws.send(...args);
+        ws.send(data);
       }
     };
 
@@ -66,12 +68,17 @@ export default function createWebsocketServer<TClient: Object>({
       return;
     }
 
+    const keepAliveInterval = setInterval(
+      () => ws.ping(),
+      KEEP_ALIVE_INTERVAL_MS,
+    ).unref();
+
     ws.on('error', e => {
-      // $FlowFixMe[incompatible-type]
       websocketServer.onClientError && websocketServer.onClientError(client, e);
     });
 
     ws.on('close', () => {
+      clearInterval(keepAliveInterval);
       websocketServer.onClientDisconnect &&
         websocketServer.onClientDisconnect(client);
       connected = false;

package/src/lib/debounceAsyncQueue.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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
+ */
+
+declare function debounceAsyncQueue<T>(
+  fn: () => Promise<T>,
+  delay: number,
+): () => Promise<T>;
+export default debounceAsyncQueue;

package/src/lib/debounceAsyncQueue.js.flow

@@ -33,7 +33,7 @@ export default function debounceAsyncQueue<T>(
   }
 
   return () =>
-    new Promise((resolve: T => void, reject: mixed => void) => {
+    new Promise((resolve: T => void, reject: unknown => void) => {
       callbacks.push(resolve);
 
       if (!executing) {

package/src/lib/formatBundlingError.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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
+ */
+
+import type {FormattedError} from 'metro-runtime/src/modules/types';
+
+export type CustomError = Error & {
+  readonly type?: string;
+  filename?: string;
+  lineNumber?: number;
+  errors?: Array<{
+    description: string;
+    filename: string;
+    lineNumber: number;
+  }>;
+};
+declare function formatBundlingError(error: CustomError): FormattedError;
+export default formatBundlingError;

package/src/lib/formatBundlingError.js.flow

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
  * @flow
+ * @format
  */
 
 import type {FormattedError} from 'metro-runtime/src/modules/types';

package/src/lib/getAppendScripts.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 type {Module} from '../DeltaBundler';
+
+type Options<T extends number | string> = Readonly<{
+  asyncRequireModulePath: string;
+  createModuleId: ($$PARAM_0$$: string) => T;
+  getRunModuleStatement: (moduleId: T, globalPrefix: string) => string;
+  globalPrefix: string;
+  inlineSourceMap: null | undefined | boolean;
+  runBeforeMainModule: ReadonlyArray<string>;
+  runModule: boolean;
+  shouldAddToIgnoreList: ($$PARAM_0$$: Module) => boolean;
+  sourceMapUrl: null | undefined | string;
+  sourceUrl: null | undefined | string;
+  getSourceUrl: null | undefined | (($$PARAM_0$$: Module) => string);
+}>;
+declare function getAppendScripts<T extends number | string>(
+  entryPoint: string,
+  modules: ReadonlyArray<Module>,
+  options: Options<T>,
+): ReadonlyArray<Module>;
+export default getAppendScripts;

package/src/lib/getAppendScripts.js.flow

@@ -18,13 +18,13 @@ import CountingSet from './CountingSet';
 import countLines from './countLines';
 import nullthrows from 'nullthrows';
 
-type Options<T: number | string> = $ReadOnly<{
+type Options<T: number | string> = Readonly<{
   asyncRequireModulePath: string,
   createModuleId: string => T,
   getRunModuleStatement: (moduleId: T, globalPrefix: string) => string,
   globalPrefix: string,
   inlineSourceMap: ?boolean,
-  runBeforeMainModule: $ReadOnlyArray<string>,
+  runBeforeMainModule: ReadonlyArray<string>,
   runModule: boolean,
   shouldAddToIgnoreList: (Module<>) => boolean,
   sourceMapUrl: ?string,
@@ -35,9 +35,9 @@ type Options<T: number | string> = $ReadOnly<{
 
 export default function getAppendScripts<T: number | string>(
   entryPoint: string,
-  modules: $ReadOnlyArray<Module<>>,
+  modules: ReadonlyArray<Module<>>,
   options: Options<T>,
-): $ReadOnlyArray<Module<>> {
+): ReadonlyArray<Module<>> {
   const output: Array<Module<>> = [];
 
   if (options.runModule) {

package/src/lib/getGraphId.d.ts

@@ -8,4 +8,18 @@
  * @oncall react_native
  */
 
-export type GraphId = string;
+import type {TransformInputOptions} from '../DeltaBundler/types';
+import type {ResolverInputOptions} from '../shared/types';
+
+export declare type GraphId = string;
+declare function getGraphId(
+  entryFile: string,
+  options: TransformInputOptions,
+  $$PARAM_2$$: Readonly<{
+    shallow: boolean;
+    lazy: boolean;
+    unstable_allowRequireContext: boolean;
+    resolverOptions: ResolverInputOptions;
+  }>,
+): GraphId;
+export default getGraphId;

package/src/lib/getGraphId.js.flow

@@ -24,7 +24,7 @@ export default function getGraphId(
     lazy,
     unstable_allowRequireContext,
     resolverOptions,
-  }: $ReadOnly<{
+  }: Readonly<{
     shallow: boolean,
     lazy: boolean,
     unstable_allowRequireContext: boolean,

package/src/lib/getPreludeCode.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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
+ */
+
+declare function getPreludeCode($$PARAM_0$$: {
+  readonly extraVars?: {[$$Key$$: string]: unknown};
+  readonly isDev: boolean;
+  readonly globalPrefix: string;
+  readonly requireCycleIgnorePatterns: ReadonlyArray<RegExp>;
+  readonly unstable_forceFullRefreshPatterns: ReadonlyArray<RegExp>;
+}): string;
+export default getPreludeCode;

package/src/lib/getPreludeCode.js

@@ -9,6 +9,7 @@ function getPreludeCode({
   isDev,
   globalPrefix,
   requireCycleIgnorePatterns,
+  unstable_forceFullRefreshPatterns,
 }) {
   const vars = [
     "__BUNDLE_START_TIME__=globalThis.nativePerformanceNow?nativePerformanceNow():Date.now()",
@@ -21,6 +22,9 @@ function getPreludeCode({
     vars.push(
       `${globalPrefix}__requireCycleIgnorePatterns=[${requireCycleIgnorePatterns.map((regex) => regex.toString()).join(",")}]`,
     );
+    vars.push(
+      `${globalPrefix}__unstable_forceFullRefreshPatterns=[${unstable_forceFullRefreshPatterns.map((regex) => regex.toString()).join(",")}]`,
+    );
   }
   return `var ${vars.join(",")};${processEnv(isDev ? "development" : "production")}`;
 }

package/src/lib/getPreludeCode.js.flow

@@ -14,11 +14,13 @@ export default function getPreludeCode({
   isDev,
   globalPrefix,
   requireCycleIgnorePatterns,
+  unstable_forceFullRefreshPatterns,
 }: {
-  +extraVars?: {[string]: mixed, ...},
+  +extraVars?: {[string]: unknown, ...},
   +isDev: boolean,
   +globalPrefix: string,
-  +requireCycleIgnorePatterns: $ReadOnlyArray<RegExp>,
+  +requireCycleIgnorePatterns: ReadonlyArray<RegExp>,
+  +unstable_forceFullRefreshPatterns: ReadonlyArray<RegExp>,
 }): string {
   const vars = [
     // Ensure these variable names match the ones referenced in metro-runtime
@@ -38,6 +40,11 @@ export default function getPreludeCode({
         .map(regex => regex.toString())
         .join(',')}]`,
     );
+    vars.push(
+      `${globalPrefix}__unstable_forceFullRefreshPatterns=[${unstable_forceFullRefreshPatterns
+        .map(regex => regex.toString())
+        .join(',')}]`,
+    );
   }
 
   return `var ${vars.join(',')};${processEnv(
@@ -47,7 +54,7 @@ export default function getPreludeCode({
 
 const excluded = new Set(['__BUNDLE_START_TIME__', '__DEV__', 'process']);
 
-function formatExtraVars(extraVars: ?{[string]: mixed, ...}): Array<string> {
+function formatExtraVars(extraVars: ?{[string]: unknown, ...}): Array<string> {
   const assignments = [];
 
   for (const key in extraVars) {

package/src/lib/getPrependedScripts.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 {Module, default as DeltaBundler} from '../DeltaBundler';
+import type {TransformInputOptions} from '../DeltaBundler/types';
+import type {ResolverInputOptions} from '../shared/types';
+import type {ConfigT} from 'metro-config';
+
+declare function getPrependedScripts(
+  config: ConfigT,
+  options: Omit<TransformInputOptions, 'type'>,
+  resolverOptions: ResolverInputOptions,
+  bundler: Bundler,
+  deltaBundler: DeltaBundler,
+): Promise<ReadonlyArray<Module>>;
+export default getPrependedScripts;