metro 0.84.1 → 0.84.3

package/src/DeltaBundler/Transformer.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<15f603afc860c64c7acc5a6cfe2a6717>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/DeltaBundler/Transformer.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {TransformResult, TransformResultWithSource} from '../DeltaBundler';
+import type {TransformOptions} from './Worker';
+import type {ConfigT} from 'metro-config';
+
+import WorkerFarm from './WorkerFarm';
+import {Cache} from 'metro-cache';
+
+type GetOrComputeSha1Fn = (
+  $$PARAM_0$$: string,
+) => Promise<Readonly<{content?: Buffer; sha1: string}>>;
+declare class Transformer {
+  _config: ConfigT;
+  _cache: Cache<TransformResult>;
+  _baseHash: string;
+  _getSha1: GetOrComputeSha1Fn;
+  _workerFarm: WorkerFarm;
+  constructor(
+    config: ConfigT,
+    opts: Readonly<{getOrComputeSha1: GetOrComputeSha1Fn}>,
+  );
+  transformFile(
+    filePath: string,
+    transformerOptions: TransformOptions,
+    fileBuffer?: Buffer,
+  ): Promise<TransformResultWithSource>;
+  end(): Promise<void>;
+}
+export default Transformer;

package/src/DeltaBundler/Worker.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<36640ae81894592fbdc160fac081bdbf>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/DeltaBundler/Worker.flow.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {TransformResult} from './types';
+import type {LogEntry} from 'metro-core/private/Logger';
+import type {
+  JsTransformerConfig,
+  JsTransformOptions,
+} from 'metro-transform-worker';
+
+export type {JsTransformOptions as TransformOptions} from 'metro-transform-worker';
+export type TransformerConfig = {
+  transformerPath: string;
+  transformerConfig: JsTransformerConfig;
+};
+type Data = Readonly<{
+  result: TransformResult;
+  sha1: string;
+  transformFileStartLogEntry: LogEntry;
+  transformFileEndLogEntry: LogEntry;
+}>;
+export declare const transform: (
+  filename: string,
+  transformOptions: JsTransformOptions,
+  projectRoot: string,
+  transformerConfig: TransformerConfig,
+  fileBuffer?: Buffer,
+) => Promise<Data>;
+export declare type transform = typeof transform;
+export type Worker = {readonly transform: typeof transform};

package/src/DeltaBundler/WorkerFarm.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<bbd52f1dc5e4a9253455034b585115ac>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/DeltaBundler/WorkerFarm.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {TransformResult} from '../DeltaBundler';
+import type {TransformerConfig, TransformOptions, Worker} from './Worker';
+import type {ConfigT} from 'metro-config';
+import type {Readable} from 'stream';
+
+type WorkerInterface = Readonly<
+  Omit<
+    Worker,
+    keyof {
+      end(): void | Promise<void>;
+      getStdout(): Readable;
+      getStderr(): Readable;
+    }
+  > & {
+    end(): void | Promise<void>;
+    getStdout(): Readable;
+    getStderr(): Readable;
+  }
+>;
+type TransformerResult = Readonly<{result: TransformResult; sha1: string}>;
+declare class WorkerFarm {
+  _config: ConfigT;
+  _transformerConfig: TransformerConfig;
+  _worker: WorkerInterface | Worker;
+  constructor(config: ConfigT, transformerConfig: TransformerConfig);
+  kill(): Promise<void>;
+  transform(
+    filename: string,
+    options: TransformOptions,
+    fileBuffer?: Buffer,
+  ): Promise<TransformerResult>;
+  _makeFarm(
+    absoluteWorkerPath: string,
+    exposedMethods: ReadonlyArray<string>,
+    numWorkers: number,
+  ): WorkerInterface;
+  _computeWorkerKey(
+    method: string,
+    filename: string,
+  ): null | undefined | string;
+  _formatGenericError(
+    err: Readonly<{message: string; stack?: string}>,
+    filename: string,
+  ): TransformError;
+  _formatBabelError(
+    err: Readonly<{
+      message: string;
+      stack?: string;
+      type?: string;
+      codeFrame?: unknown;
+      loc: {line?: number; column?: number};
+    }>,
+    filename: string,
+  ): TransformError;
+}
+export default WorkerFarm;
+declare class TransformError extends SyntaxError {
+  type: string;
+  constructor(message: string);
+}

package/src/DeltaBundler/buildSubgraph.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.
+ *
+ * @noformat
+ * @generated SignedSource<<1e334cd36bb429700b82654f1ddab0a0>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/DeltaBundler/buildSubgraph.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {RequireContext} from '../lib/contextModule';
+import type {
+  ModuleData,
+  ResolvedDependency,
+  ResolveFn,
+  TransformFn,
+} from './types';
+
+type Parameters<T> = Readonly<{
+  resolve: ResolveFn;
+  transform: TransformFn<T>;
+  shouldTraverse: ($$PARAM_0$$: ResolvedDependency) => boolean;
+}>;
+export declare function buildSubgraph<T>(
+  entryPaths: ReadonlySet<string>,
+  resolvedContexts: ReadonlyMap<string, null | undefined | RequireContext>,
+  $$PARAM_2$$: Parameters<T>,
+): Promise<{
+  moduleData: Map<string, ModuleData<T>>;
+  errors: Map<string, Error>;
+}>;

package/src/DeltaBundler/getTransformCacheKey.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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<1a82c2238a94514c16e7bb93bf49d8c9>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/DeltaBundler/getTransformCacheKey.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {TransformerConfig} from './Worker';
+
+declare function getTransformCacheKey(opts: {
+  readonly cacheVersion: string;
+  readonly projectRoot: string;
+  readonly transformerConfig: TransformerConfig;
+}): string;
+export default getTransformCacheKey;

package/src/DeltaBundler/getTransformCacheKey.js

@@ -14,7 +14,9 @@ function getTransformCacheKey(opts) {
   const { transformerPath, transformerConfig } = opts.transformerConfig;
   const Transformer = require.call(null, transformerPath);
   const transformerKey = Transformer.getCacheKey
-    ? Transformer.getCacheKey(transformerConfig)
+    ? Transformer.getCacheKey(transformerConfig, {
+        projectRoot: opts.projectRoot,
+      })
     : "";
   return _crypto.default
     .createHash("sha1")

package/src/DeltaBundler/getTransformCacheKey.js.flow

@@ -19,7 +19,10 @@ import {getCacheKey} from 'metro-cache-key';
 const VERSION = require('../../package.json').version;
 
 type CacheKeyProvider = {
-  getCacheKey?: JsTransformerConfig => string,
+  getCacheKey?: (
+    config: JsTransformerConfig,
+    opts?: Readonly<{projectRoot: string}>,
+  ) => string,
 };
 
 export default function getTransformCacheKey(opts: {
@@ -32,7 +35,9 @@ export default function getTransformCacheKey(opts: {
   // eslint-disable-next-line no-useless-call
   const Transformer: CacheKeyProvider = require.call(null, transformerPath);
   const transformerKey = Transformer.getCacheKey
-    ? Transformer.getCacheKey(transformerConfig)
+    ? Transformer.getCacheKey(transformerConfig, {
+        projectRoot: opts.projectRoot,
+      })
     : '';
 
   return crypto

package/src/DeltaBundler/mergeDeltas.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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<46981e9bc1ef3945b99b147cbdf9ec5d>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/DeltaBundler/mergeDeltas.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {DeltaBundle} from 'metro-runtime/src/modules/types';
+
+declare function mergeDeltas(
+  delta1: DeltaBundle,
+  delta2: DeltaBundle,
+): DeltaBundle;
+export default mergeDeltas;

package/src/DeltaBundler/types.d.ts

@@ -0,0 +1,170 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<feddf9cb00d4a097d348531773c9f0bd>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/DeltaBundler/types.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {RequireContext} from '../lib/contextModule';
+import type {RequireContextParams} from '../ModuleGraph/worker/collectDependencies';
+import type {ReadonlySourceLocation} from '../shared/types';
+import type {Graph} from './Graph';
+import type {JsTransformOptions} from 'metro-transform-worker';
+
+import CountingSet from '../lib/CountingSet';
+
+export type MixedOutput = {readonly data: unknown; readonly type: string};
+export type AsyncDependencyType = 'async' | 'maybeSync' | 'prefetch' | 'weak';
+export type TransformResultDependency = Readonly<{
+  /**
+   * The literal name provided to a require or import call. For example 'foo' in
+   * case of `require('foo')`.
+   */
+  name: string;
+  /**
+   * Extra data returned by the dependency extractor.
+   */
+  data: Readonly<{
+    /**
+     * A locally unique key for this dependency within the current module.
+     */
+    key: string;
+    /**
+     * If not null, this dependency is due to a dynamic `import()` or `__prefetchImport()` call.
+     */
+    asyncType: AsyncDependencyType | null;
+    /**
+     * True if the dependency is declared with a static "import x from 'y'" or
+     * an import() call.
+     */
+    isESMImport: boolean;
+    /**
+     * The dependency is enclosed in a try/catch block.
+     */
+    isOptional?: boolean;
+    locs: ReadonlyArray<ReadonlySourceLocation>;
+    /** Context for requiring a collection of modules. */
+    contextParams?: RequireContextParams;
+  }>;
+}>;
+export type ResolvedDependency = Readonly<{
+  absolutePath: string;
+  data: TransformResultDependency;
+}>;
+export type Dependency =
+  | ResolvedDependency
+  | Readonly<{data: TransformResultDependency}>;
+export type Module<T = MixedOutput> = Readonly<{
+  dependencies: Map<string, Dependency>;
+  inverseDependencies: CountingSet<string>;
+  output: ReadonlyArray<T>;
+  path: string;
+  getSource: () => Buffer;
+  unstable_transformResultKey?: null | undefined | string;
+}>;
+export type ModuleData<T = MixedOutput> = Readonly<{
+  dependencies: ReadonlyMap<string, Dependency>;
+  resolvedContexts: ReadonlyMap<string, RequireContext>;
+  output: ReadonlyArray<T>;
+  getSource: () => Buffer;
+  unstable_transformResultKey?: null | undefined | string;
+}>;
+export type Dependencies<T = MixedOutput> = Map<string, Module<T>>;
+export type ReadOnlyDependencies<T = MixedOutput> = ReadonlyMap<
+  string,
+  Module<T>
+>;
+export type TransformInputOptions = Omit<
+  JsTransformOptions,
+  'inlinePlatform' | 'inlineRequires'
+>;
+export type GraphInputOptions = Readonly<{
+  entryPoints: ReadonlySet<string>;
+  transformOptions: TransformInputOptions;
+}>;
+export interface ReadOnlyGraph<T = MixedOutput> {
+  readonly entryPoints: ReadonlySet<string>;
+  readonly transformOptions: Readonly<TransformInputOptions>;
+  readonly dependencies: ReadOnlyDependencies<T>;
+}
+export type {Graph};
+export type TransformResult<T = MixedOutput> = Readonly<{
+  dependencies: ReadonlyArray<TransformResultDependency>;
+  output: ReadonlyArray<T>;
+  unstable_transformResultKey?: null | undefined | string;
+}>;
+export type TransformResultWithSource<T = MixedOutput> = Readonly<
+  Omit<TransformResult<T>, keyof {getSource: () => Buffer}> & {
+    getSource: () => Buffer;
+  }
+>;
+export type TransformFn<T = MixedOutput> = (
+  $$PARAM_0$$: string,
+  $$PARAM_1$$: null | undefined | RequireContext,
+) => Promise<TransformResultWithSource<T>>;
+export type ResolveFn = (
+  from: string,
+  dependency: TransformResultDependency,
+) => BundlerResolution;
+export type AllowOptionalDependenciesWithOptions = {
+  readonly exclude: Array<string>;
+};
+export type AllowOptionalDependencies =
+  | boolean
+  | AllowOptionalDependenciesWithOptions;
+export type BundlerResolution = Readonly<{
+  type: 'sourceFile';
+  filePath: string;
+}>;
+export type Options<T = MixedOutput> = Readonly<{
+  resolve: ResolveFn;
+  transform: TransformFn<T>;
+  transformOptions: TransformInputOptions;
+  onProgress:
+    | null
+    | undefined
+    | ((numProcessed: number, total: number) => unknown);
+  lazy: boolean;
+  unstable_allowRequireContext: boolean;
+  unstable_enablePackageExports: boolean;
+  unstable_incrementalResolution: boolean;
+  shallow: boolean;
+}>;
+export type DeltaResult<T = MixedOutput> = {
+  readonly added: Map<string, Module<T>>;
+  readonly modified: Map<string, Module<T>>;
+  readonly deleted: Set<string>;
+  readonly reset: boolean;
+};
+export type SerializerOptions = Readonly<{
+  asyncRequireModulePath: string;
+  createModuleId: ($$PARAM_0$$: string) => number;
+  dev: boolean;
+  getRunModuleStatement: (
+    moduleId: number | string,
+    globalPrefix: string,
+  ) => string;
+  globalPrefix: string;
+  includeAsyncPaths: boolean;
+  inlineSourceMap: null | undefined | boolean;
+  modulesOnly: boolean;
+  processModuleFilter: (module: Module) => boolean;
+  projectRoot: string;
+  runBeforeMainModule: ReadonlyArray<string>;
+  runModule: boolean;
+  serverRoot: string;
+  shouldAddToIgnoreList: ($$PARAM_0$$: Module) => boolean;
+  sourceMapUrl: null | undefined | string;
+  sourceUrl: null | undefined | string;
+  getSourceUrl: null | undefined | (($$PARAM_0$$: Module) => string);
+}>;

package/src/DeltaBundler.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @oncall react_native
+ * @generated SignedSource<<db564db653a99b07f3ad7585b2bed707>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/DeltaBundler.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {
+  DeltaResult,
+  Graph,
+  MixedOutput,
+  Options,
+  ReadOnlyGraph,
+} from './DeltaBundler/types';
+import type EventEmitter from 'events';
+
+import DeltaCalculator from './DeltaBundler/DeltaCalculator';
+
+export type {
+  DeltaResult,
+  Graph,
+  Dependencies,
+  MixedOutput,
+  Module,
+  ReadOnlyGraph,
+  TransformFn,
+  TransformResult,
+  TransformResultDependency,
+  TransformResultWithSource,
+} from './DeltaBundler/types';
+/**
+ * `DeltaBundler` uses the `DeltaTransformer` to build bundle deltas. This
+ * module handles all the transformer instances so it can support multiple
+ * concurrent clients requesting their own deltas. This is done through the
+ * `clientId` param (which maps a client to a specific delta transformer).
+ */
+declare class DeltaBundler<T = MixedOutput> {
+  _changeEventSource: EventEmitter;
+  _deltaCalculators: Map<Graph<T>, DeltaCalculator<T>>;
+  constructor(changeEventSource: EventEmitter);
+  end(): void;
+  getDependencies(
+    entryPoints: ReadonlyArray<string>,
+    options: Options<T>,
+  ): Promise<ReadOnlyGraph<T>['dependencies']>;
+  buildGraph(
+    entryPoints: ReadonlyArray<string>,
+    options: Options<T>,
+  ): Promise<Graph<T>>;
+  getDelta(
+    graph: Graph<T>,
+    $$PARAM_1$$: {reset: boolean; shallow: boolean},
+  ): Promise<DeltaResult<T>>;
+  listen(graph: Graph<T>, callback: () => Promise<void>): () => void;
+  endGraph(graph: Graph<T>): void;
+}
+export default DeltaBundler;

package/src/HmrServer.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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.
+ *
+ * @noformat
+ * @generated SignedSource<<ab4c245134631e14db114a9d49da79d1>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro/src/HmrServer.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {
+  RevisionId,
+  default as IncrementalBundler,
+} from './IncrementalBundler';
+import type {GraphOptions} from './shared/types';
+import type {ConfigT, RootPerfLogger} from 'metro-config';
+import type {
+  HmrErrorMessage,
+  HmrUpdateMessage,
+} from 'metro-runtime/src/modules/types';
+
+export type Client = {
+  optedIntoHMR: boolean;
+  revisionIds: Array<RevisionId>;
+  readonly sendFn: ($$PARAM_0$$: string) => void;
+};
+type ClientGroup = {
+  readonly clients: Set<Client>;
+  clientUrl: URL;
+  revisionId: RevisionId;
+  readonly unlisten: () => void;
+  readonly graphOptions: GraphOptions;
+};
+/**
+ * The HmrServer (Hot Module Reloading) implements a lightweight interface
+ * to communicate easily to the logic in the React Native repository (which
+ * is the one that handles the Web Socket connections).
+ *
+ * This interface allows the HmrServer to hook its own logic to WS clients
+ * getting connected, disconnected or having errors (through the
+ * `onClientConnect`, `onClientDisconnect` and `onClientError` methods).
+ */
+declare class HmrServer<TClient extends Client> {
+  _config: ConfigT;
+  _bundler: IncrementalBundler;
+  _createModuleId: (path: string) => number;
+  _clientGroups: Map<RevisionId, ClientGroup>;
+  constructor(
+    bundler: IncrementalBundler,
+    createModuleId: (path: string) => number,
+    config: ConfigT,
+  );
+  onClientConnect: (
+    requestUrl: string,
+    sendFn: (data: string) => void,
+  ) => Promise<Client>;
+  _registerEntryPoint(
+    client: Client,
+    originalRequestUrl: string,
+    sendFn: (data: string) => void,
+  ): Promise<void>;
+  onClientMessage: (
+    client: TClient,
+    message: string | Buffer | ArrayBuffer | Array<Buffer>,
+    sendFn: (data: string) => void,
+  ) => Promise<void>;
+  onClientError: (client: TClient, e: Error) => void;
+  onClientDisconnect: (client: TClient) => void;
+  _handleFileChange(
+    group: ClientGroup,
+    options: {isInitialUpdate: boolean},
+    changeEvent:
+      | null
+      | undefined
+      | {
+          readonly logger: null | undefined | RootPerfLogger;
+          readonly changeId?: string;
+        },
+  ): Promise<void>;
+  _prepareMessage(
+    group: ClientGroup,
+    options: {isInitialUpdate: boolean},
+    changeEvent:
+      | null
+      | undefined
+      | {
+          readonly logger: null | undefined | RootPerfLogger;
+          readonly changeId?: string;
+        },
+  ): Promise<HmrUpdateMessage | HmrErrorMessage>;
+}
+export default HmrServer;

package/src/HmrServer.js

@@ -214,6 +214,10 @@ class HmrServer {
         case "log-opt-in":
           client.optedIntoHMR = true;
           break;
+        case "heartbeat":
+          debug("Heartbeat received");
+          sendFn(String(message));
+          break;
         default:
           break;
       }
@@ -265,6 +269,9 @@ class HmrServer {
     send(sendFns, message);
     send(sendFns, {
       type: "update-done",
+      body: {
+        changeId: changeEvent?.changeId,
+      },
     });
     log({
       ...createActionEndEntry(processingHmrChange),