metro 0.83.4 → 0.83.5

package/src/lib/BatchProcessor.js

@@ -7,11 +7,7 @@ exports.default = void 0;
 var _invariant = _interopRequireDefault(require("invariant"));
 var _timers = require("timers");
 function _interopRequireDefault(e) {
-  return e && e.__esModule
-    ? e
-    : {
-        default: e,
-      };
+  return e && e.__esModule ? e : { default: e };
 }
 class BatchProcessor {
   constructor(options, processBatch) {

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;
+  readonly size: number;
+  count(item: T): number;
+  forEach<ThisT>(
+    callbackFn: (
+      this: ThisT,
+      value: T,
+      key: T,
+      set: ReadOnlyCountingSet<T>,
+    ) => unknown,
+    thisArg: ThisT,
+  ): void;
+}
+/**
+ * A Set that only deletes a given item when the number of delete(item) calls
+ * matches the number of add(item) calls. Iteration and `size` are in terms of
+ * *unique* items.
+ */
+declare class CountingSet<T> implements ReadOnlyCountingSet<T> {
+  constructor(items?: Iterable<T>);
+  has(item: T): boolean;
+  add(item: T): void;
+  delete(item: T): void;
+  keys(): Iterator<T>;
+  values(): Iterator<T>;
+  entries(): Iterator<[T, T]>;
+  [Symbol.iterator](): Iterator<T>;
+  get size(): number;
+  count(item: T): number;
+  clear(): void;
+  forEach<ThisT>(
+    callbackFn: (this: ThisT, value: T, key: T, set: CountingSet<T>) => unknown,
+    thisArg: ThisT,
+  ): void;
+  toJSON(): unknown;
+}
+export default CountingSet;

package/src/lib/JsonReporter.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 {Writable} from 'stream';
+
+export type SerializedError = {
+  message: string;
+  stack: string;
+  errors?: ReadonlyArray<SerializedError>;
+  cause?: SerializedError;
+};
+export type SerializedEvent<
+  TEvent extends {readonly [$$Key$$: string]: unknown},
+> = TEvent extends {error: Error}
+  ? Omit<Omit<TEvent, 'error'>, keyof {error: SerializedError}> & {
+      error: SerializedError;
+    }
+  : TEvent;
+declare class JsonReporter<
+  TEvent extends {readonly [$$Key$$: string]: unknown},
+> {
+  _stream: Writable;
+  constructor(stream: Writable);
+  /**
+   * There is a special case for errors because they have non-enumerable fields.
+   * (Perhaps we should switch in favor of plain object?)
+   */
+  update(event: TEvent): void;
+}
+export default JsonReporter;

package/src/lib/RamBundleParser.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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
+ */
+
+/**
+ * Implementation of a RAM bundle parser in JS.
+ *
+ * It receives a Buffer as an input and implements two main methods, which are
+ * able to run in constant time no matter the size of the bundle:
+ *
+ * getStartupCode(): returns the runtime and the startup code of the bundle.
+ * getModule(): returns the code for the specified module.
+ */
+declare class RamBundleParser {
+  _buffer: Buffer;
+  _numModules: number;
+  _startupCodeLength: number;
+  _startOffset: number;
+  constructor(buffer: Buffer);
+  _readPosition(pos: number): number;
+  getStartupCode(): string;
+  getModule(id: number): string;
+}
+export default RamBundleParser;

package/src/lib/RamBundleParser.js

@@ -8,11 +8,7 @@ var _magicNumber = _interopRequireDefault(
   require("../shared/output/RamBundle/magic-number"),
 );
 function _interopRequireDefault(e) {
-  return e && e.__esModule
-    ? e
-    : {
-        default: e,
-      };
+  return e && e.__esModule ? e : { default: e };
 }
 const SIZEOF_UINT32 = 4;
 const HEADER_SIZE = 3;

package/src/lib/TerminalReporter.d.ts

@@ -0,0 +1,118 @@
+/**
+ * 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 {BundleDetails, ReportableEvent} from './reporting';
+import type {Terminal} from 'metro-core';
+import type {HealthCheckResult, WatcherStatus} from 'metro-file-map';
+
+type BundleProgress = {
+  bundleDetails: BundleDetails;
+  transformedFileCount: number;
+  totalFileCount: number;
+  ratio: number;
+  isPrefetch?: boolean;
+};
+export type TerminalReportableEvent =
+  | ReportableEvent
+  | {
+      buildID: string;
+      type: 'bundle_transform_progressed_throttled';
+      transformedFileCount: number;
+      totalFileCount: number;
+    }
+  | {
+      type: 'unstable_server_log';
+      level: 'info' | 'warn' | 'error';
+      data: string | Array<unknown>;
+    }
+  | {type: 'unstable_server_menu_updated'; message: string}
+  | {type: 'unstable_server_menu_cleared'};
+type BuildPhase = 'in_progress' | 'done' | 'failed';
+interface SnippetError extends Error {
+  code?: string;
+  filename?: string;
+  snippet?: string;
+}
+/**
+ * We try to print useful information to the terminal for interactive builds.
+ * This implements the `Reporter` interface from the './reporting' module.
+ */
+declare class TerminalReporter {
+  /**
+   * The bundle builds for which we are actively maintaining the status on the
+   * terminal, ie. showing a progress bar. There can be several bundles being
+   * built at the same time.
+   */
+  _activeBundles: Map<string, BundleProgress>;
+  _interactionStatus: null | undefined | string;
+  _scheduleUpdateBundleProgress: {
+    (data: {
+      buildID: string;
+      transformedFileCount: number;
+      totalFileCount: number;
+    }): void;
+    cancel(): void;
+  };
+  _prevHealthCheckResult: null | undefined | HealthCheckResult;
+  readonly terminal: Terminal;
+  constructor(terminal: Terminal);
+  /**
+   * Construct a message that represents the progress of a
+   * single bundle build, for example:
+   *
+   *     BUNDLE path/to/bundle.js ▓▓▓▓▓░░░░░░░░░░░ 36.6% (4790/7922)
+   */
+  _getBundleStatusMessage(
+    $$PARAM_0$$: BundleProgress,
+    phase: BuildPhase,
+  ): string;
+  _logBundleBuildDone(buildID: string): void;
+  _logBundleBuildFailed(buildID: string): void;
+  _logInitializing(port: number, hasReducedPerformance: boolean): void;
+  _logInitializingFailed(port: number, error: SnippetError): void;
+  /**
+   * This function is only concerned with logging and should not do state
+   * or terminal status updates.
+   */
+  _log(event: TerminalReportableEvent): void;
+  /**
+   * We do not want to log the whole stacktrace for bundling error, because
+   * these are operational errors, not programming errors, and the stacktrace
+   * is not actionable to end users.
+   */
+  _logBundlingError(error: SnippetError): void;
+  _logWorkerChunk(origin: 'stdout' | 'stderr', chunk: string): void;
+  _updateBundleProgress($$PARAM_0$$: {
+    buildID: string;
+    transformedFileCount: number;
+    totalFileCount: number;
+  }): void;
+  /**
+   * This function is exclusively concerned with updating the internal state.
+   * No logging or status updates should be done at this point.
+   */
+  _updateState(event: TerminalReportableEvent): void;
+  /**
+   * Return a status message that is always consistent with the current state
+   * of the application. Having this single function ensures we don't have
+   * different callsites overriding each other status messages.
+   */
+  _getStatusMessage(): string;
+  _logHmrClientError(e: Error): void;
+  _logWarning(message: string): void;
+  _logWatcherHealthCheckResult(result: HealthCheckResult): void;
+  _logWatcherStatus(status: WatcherStatus): void;
+  /**
+   * Single entry point for reporting events. That allows us to implement the
+   * corresponding JSON reporter easily and have a consistent reporting.
+   */
+  update(event: TerminalReportableEvent): void;
+}
+export default TerminalReporter;

package/src/lib/TerminalReporter.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true,
 });
 exports.default = void 0;
+var _bundleProgressUtils = require("./bundleProgressUtils");
 var _logToConsole = _interopRequireDefault(require("./logToConsole"));
 var reporting = _interopRequireWildcard(require("./reporting"));
 var _chalk = _interopRequireDefault(require("chalk"));
@@ -18,10 +19,7 @@ function _interopRequireWildcard(e, t) {
     if (!t && e && e.__esModule) return e;
     var o,
       i,
-      f = {
-        __proto__: null,
-        default: e,
-      };
+      f = { __proto__: null, default: e };
     if (null === e || ("object" != typeof e && "function" != typeof e))
       return f;
     if ((o = t ? n : r)) {
@@ -41,11 +39,7 @@ function _interopRequireWildcard(e, t) {
   })(e, t);
 }
 function _interopRequireDefault(e) {
-  return e && e.__esModule
-    ? e
-    : {
-        default: e,
-      };
+  return e && e.__esModule ? e : { default: e };
 }
 const DARK_BLOCK_CHAR = "\u2593";
 const LIGHT_BLOCK_CHAR = "\u2591";
@@ -85,7 +79,7 @@ class TerminalReporter {
           _chalk.default.bgWhite.white(
             LIGHT_BLOCK_CHAR.repeat(MAX_PROGRESS_BAR_CHAR_WIDTH - filledBar),
           ) +
-          _chalk.default.bold(` ${(100 * ratio).toFixed(1)}% `) +
+          _chalk.default.bold(` ${Math.floor(100 * ratio)}% `) +
           _chalk.default.dim(`(${transformedFileCount}/${totalFileCount})`)
         : "";
     return (
@@ -294,12 +288,10 @@ class TerminalReporter {
     if (currentProgress == null) {
       return;
     }
-    const ratio = Math.min(
-      Math.max(
-        Math.pow(transformedFileCount / Math.max(totalFileCount, 10), 2),
-        currentProgress.ratio,
-      ),
-      0.999,
+    const ratio = (0, _bundleProgressUtils.calculateBundleProgressRatio)(
+      transformedFileCount,
+      totalFileCount,
+      currentProgress.ratio,
     );
     Object.assign(currentProgress, {
       ratio,

package/src/lib/TerminalReporter.js.flow

@@ -13,6 +13,7 @@ import type {BundleDetails, ReportableEvent} from './reporting';
 import type {Terminal} from 'metro-core';
 import type {HealthCheckResult, WatcherStatus} from 'metro-file-map';
 
+import {calculateBundleProgressRatio} from './bundleProgressUtils';
 import logToConsole from './logToConsole';
 import * as reporting from './reporting';
 import chalk from 'chalk';
@@ -132,7 +133,7 @@ export default class TerminalReporter {
           chalk.bgWhite.white(
             LIGHT_BLOCK_CHAR.repeat(MAX_PROGRESS_BAR_CHAR_WIDTH - filledBar),
           ) +
-          chalk.bold(` ${(100 * ratio).toFixed(1)}% `) +
+          chalk.bold(` ${Math.floor(100 * ratio)}% `) +
           chalk.dim(`(${transformedFileCount}/${totalFileCount})`)
         : '';
 
@@ -352,14 +353,6 @@ export default class TerminalReporter {
     });
   }
 
-  /**
-   * Because we know the `totalFileCount` is going to progressively increase
-   * starting with 1:
-   * - We use Math.max(totalFileCount, 10) to prevent the ratio to raise too
-   *   quickly when the total file count is low. (e.g 1/2 5/6)
-   * - We prevent the ratio from going backwards.
-   * - Instead, we use Math.pow(ratio, 2) to as a conservative measure of progress.
-   */
   _updateBundleProgress({
     buildID,
     transformedFileCount,
@@ -375,12 +368,10 @@ export default class TerminalReporter {
       return;
     }
 
-    const ratio = Math.min(
-      Math.max(
-        Math.pow(transformedFileCount / Math.max(totalFileCount, 10), 2),
-        currentProgress.ratio,
-      ),
-      0.999, // make sure not to go above 99.9% to not get rounded to 100%,
+    const ratio = calculateBundleProgressRatio(
+      transformedFileCount,
+      totalFileCount,
+      currentProgress.ratio,
     );
 
     // $FlowFixMe[unsafe-object-assign]

package/src/lib/bundleProgressUtils.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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
+ */
+
+/**
+ * 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 declare function calculateBundleProgressRatio(
+  transformedFileCount: number,
+  totalFileCount: number,
+  previousRatio?: number,
+): number;

package/src/lib/bundleProgressUtils.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.calculateBundleProgressRatio = calculateBundleProgressRatio;
+function calculateBundleProgressRatio(
+  transformedFileCount,
+  totalFileCount,
+  previousRatio,
+) {
+  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/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

@@ -0,0 +1,33 @@
+/**
+ * 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,
+  RequireContextParams,
+} from '../ModuleGraph/worker/collectDependencies';
+
+export type RequireContext = Readonly<{
+  recursive: boolean;
+  filter: RegExp;
+  /** Mode for resolving dynamic dependencies. Defaults to `sync` */
+  mode: ContextMode;
+  /** Absolute path of the directory to search in */
+  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

@@ -9,11 +9,7 @@ var _crypto = _interopRequireDefault(require("crypto"));
 var _nullthrows = _interopRequireDefault(require("nullthrows"));
 var _path = _interopRequireDefault(require("path"));
 function _interopRequireDefault(e) {
-  return e && e.__esModule
-    ? e
-    : {
-        default: e,
-      };
+  return e && e.__esModule ? e : { default: e };
 }
 function toHash(value) {
   return _crypto.default.createHash("sha1").update(value).digest("hex");

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

@@ -14,10 +14,7 @@ function _interopRequireWildcard(e, t) {
     if (!t && e && e.__esModule) return e;
     var o,
       i,
-      f = {
-        __proto__: null,
-        default: e,
-      };
+      f = { __proto__: null, default: e };
     if (null === e || ("object" != typeof e && "function" != typeof e))
       return f;
     if ((o = t ? n : r)) {

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/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

@@ -7,11 +7,7 @@ exports.default = createWebsocketServer;
 var _timers = require("timers");
 var _ws = _interopRequireDefault(require("ws"));
 function _interopRequireDefault(e) {
-  return e && e.__esModule
-    ? e
-    : {
-        default: e,
-      };
+  return e && e.__esModule ? e : { default: e };
 }
 const KEEP_ALIVE_INTERVAL_MS = 20000;
 function createWebsocketServer({ websocketServer }) {

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/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;