metro-file-map 0.84.3 → 0.84.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metro-file-map",
-  "version": "0.84.3",
+  "version": "0.84.4",
   "description": "[Experimental] - 🚇 File crawling, watching and mapping for Metro",
   "main": "src/index.js",
   "exports": {

package/src/plugins/DependencyPlugin.d.ts

@@ -6,7 +6,7 @@
  *
  * @noformat
  * @oncall react_native
- * @generated SignedSource<<e07a9c061b0224fc44191d956461bd6f>>
+ * @generated SignedSource<<344b340710d6da24bcb609058e7ce8d6>>
  *
  * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
  * Original file: packages/metro-file-map/src/plugins/DependencyPlugin.js
@@ -15,38 +15,18 @@
  *   yarn run build-ts-defs (OSS) 
  */
 
-import type {
-  FileMapPlugin,
-  FileMapPluginInitOptions,
-  FileMapPluginWorker,
-  Path,
-} from '../flow-types';
+import type {Path} from '../flow-types';
+
+import FileDataPlugin from './FileDataPlugin';
 
 export type DependencyPluginOptions = Readonly<{
   /** Path to custom dependency extractor module */
   dependencyExtractor: null | undefined | string;
   /** Whether to compute dependencies (performance optimization) */
   computeDependencies: boolean;
-  rootDir: Path;
 }>;
-declare class DependencyPlugin
-  implements FileMapPlugin<null, ReadonlyArray<string> | null>
-{
-  readonly name: 'dependencies';
+declare class DependencyPlugin extends FileDataPlugin<ReadonlyArray<string> | null> {
   constructor(options: DependencyPluginOptions);
-  initialize(
-    initOptions: FileMapPluginInitOptions<null, ReadonlyArray<string> | null>,
-  ): Promise<void>;
-  getSerializableSnapshot(): null;
-  onChanged(): void;
-  assertValid(): void;
-  getCacheKey(): string;
-  getWorker(): FileMapPluginWorker;
-  /**
-   * Get the list of dependencies for a given file.
-   * @param mixedPath Absolute or project-relative path to the file
-   * @returns Array of dependency module names, or null if the file doesn't exist
-   */
   getDependencies(mixedPath: Path): null | undefined | ReadonlyArray<string>;
 }
 export default DependencyPlugin;

package/src/plugins/DependencyPlugin.js

@@ -4,70 +4,50 @@ Object.defineProperty(exports, "__esModule", {
   value: true,
 });
 exports.default = void 0;
-class DependencyPlugin {
-  name = "dependencies";
-  #dependencyExtractor;
-  #computeDependencies;
-  #getDependencies;
-  #rootDir;
+var _workerExclusionList = _interopRequireDefault(
+  require("../workerExclusionList"),
+);
+var _FileDataPlugin = _interopRequireDefault(require("./FileDataPlugin"));
+function _interopRequireDefault(e) {
+  return e && e.__esModule ? e : { default: e };
+}
+class DependencyPlugin extends _FileDataPlugin.default {
   constructor(options) {
-    this.#dependencyExtractor = options.dependencyExtractor;
-    this.#computeDependencies = options.computeDependencies;
-    this.#rootDir = options.rootDir;
-  }
-  async initialize(initOptions) {
-    const { files } = initOptions;
-    this.#getDependencies = (mixedPath) => {
-      const result = files.lookup(mixedPath);
-      if (result.exists && result.type === "f") {
-        return result.pluginData ?? [];
-      }
-      return null;
-    };
-  }
-  getSerializableSnapshot() {
-    return null;
-  }
-  onChanged() {}
-  assertValid() {}
-  getCacheKey() {
-    if (this.#dependencyExtractor != null) {
-      const extractor = require(this.#dependencyExtractor);
-      return JSON.stringify({
-        extractorKey: extractor.getCacheKey?.() ?? null,
-        extractorPath: this.#dependencyExtractor,
-      });
+    const { dependencyExtractor, computeDependencies } = options;
+    let cacheKey;
+    if (dependencyExtractor != null) {
+      const extractor = require(dependencyExtractor);
+      cacheKey = extractor.getCacheKey?.() ?? dependencyExtractor;
+    } else {
+      cacheKey = "default-dependency-extractor";
     }
-    return "default-dependency-extractor";
-  }
-  getWorker() {
-    const excludedExtensions = require("../workerExclusionList");
-    return {
+    super({
+      name: "dependencies",
+      cacheKey,
       worker: {
         modulePath: require.resolve("./dependencies/worker.js"),
         setupArgs: {
-          dependencyExtractor: this.#dependencyExtractor ?? null,
+          dependencyExtractor: dependencyExtractor ?? null,
         },
       },
       filter: ({ normalPath, isNodeModules }) => {
-        if (!this.#computeDependencies) {
+        if (!computeDependencies) {
           return false;
         }
         if (isNodeModules) {
           return false;
         }
         const ext = normalPath.substr(normalPath.lastIndexOf("."));
-        return !excludedExtensions.has(ext);
+        return !_workerExclusionList.default.has(ext);
       },
-    };
+    });
   }
   getDependencies(mixedPath) {
-    if (this.#getDependencies == null) {
-      throw new Error(
-        "DependencyPlugin has not been initialized before getDependencies",
-      );
+    const result = this.getFileSystem().lookup(mixedPath);
+    if (result.exists && result.type === "f") {
+      return result.pluginData ?? [];
     }
-    return this.#getDependencies(mixedPath);
+    return null;
   }
 }
 exports.default = DependencyPlugin;

package/src/plugins/DependencyPlugin.js.flow

@@ -9,121 +9,58 @@
  * @oncall react_native
  */
 
-import type {
-  FileMapPlugin,
-  FileMapPluginInitOptions,
-  FileMapPluginWorker,
-  Path,
-} from '../flow-types';
+import type {Path} from '../flow-types';
+
+import excludedExtensions from '../workerExclusionList';
+import FileDataPlugin from './FileDataPlugin';
 
 export type DependencyPluginOptions = Readonly<{
   /** Path to custom dependency extractor module */
   dependencyExtractor: ?string,
   /** Whether to compute dependencies (performance optimization) */
   computeDependencies: boolean,
-  rootDir: Path,
 }>;
 
-export default class DependencyPlugin
-  implements FileMapPlugin<null, ReadonlyArray<string> | null>
-{
-  +name: 'dependencies' = 'dependencies';
-
-  #dependencyExtractor: ?string;
-  #computeDependencies: boolean;
-  #getDependencies: Path => ?ReadonlyArray<string>;
-  #rootDir: Path;
-
+export default class DependencyPlugin extends FileDataPlugin<ReadonlyArray<string> | null> {
   constructor(options: DependencyPluginOptions) {
-    this.#dependencyExtractor = options.dependencyExtractor;
-    this.#computeDependencies = options.computeDependencies;
-    this.#rootDir = options.rootDir;
-  }
-
-  async initialize(
-    initOptions: FileMapPluginInitOptions<null, ReadonlyArray<string> | null>,
-  ): Promise<void> {
-    const {files} = initOptions;
-    // Create closure to access dependencies from file metadata plugin data
-    this.#getDependencies = (mixedPath: Path) => {
-      const result = files.lookup(mixedPath);
-      if (result.exists && result.type === 'f') {
-        // Backwards compatibility: distinguish an extant file that we've not
-        // run the worker on (probably because it fails the extension filter)
-        // from a missing file. Non-source files are expected to have empty
-        // dependencies.
-        return result.pluginData ?? [];
-      }
-      return null;
-    };
-  }
-
-  getSerializableSnapshot(): null {
-    // Dependencies stored in plugin data, no separate serialization needed
-    return null;
-  }
+    const {dependencyExtractor, computeDependencies} = options;
 
-  onChanged(): void {
-    // No-op: Worker already populated plugin data
-    // Plugin data is write-only from worker
-  }
-
-  assertValid(): void {
-    // No validation needed
-  }
-
-  getCacheKey(): string {
-    if (this.#dependencyExtractor != null) {
-      // Dynamic require to get extractor's cache key
+    let cacheKey: string;
+    if (dependencyExtractor != null) {
       // $FlowFixMe[unsupported-syntax] - dynamic require
-      const extractor = require(this.#dependencyExtractor);
-      return JSON.stringify({
-        extractorKey: extractor.getCacheKey?.() ?? null,
-        extractorPath: this.#dependencyExtractor,
-      });
+      const extractor = require(dependencyExtractor);
+      cacheKey = extractor.getCacheKey?.() ?? dependencyExtractor;
+    } else {
+      cacheKey = 'default-dependency-extractor';
     }
-    return 'default-dependency-extractor';
-  }
 
-  getWorker(): FileMapPluginWorker {
-    const excludedExtensions = require('../workerExclusionList');
-
-    return {
+    super({
+      name: 'dependencies',
+      cacheKey,
       worker: {
         modulePath: require.resolve('./dependencies/worker.js'),
         setupArgs: {
-          dependencyExtractor: this.#dependencyExtractor ?? null,
+          dependencyExtractor: dependencyExtractor ?? null,
         },
       },
       filter: ({normalPath, isNodeModules}) => {
-        // Respect computeDependencies flag
-        if (!this.#computeDependencies) {
+        if (!computeDependencies) {
           return false;
         }
-
-        // Never process node_modules
         if (isNodeModules) {
           return false;
         }
-
-        // Skip excluded extensions
         const ext = normalPath.substr(normalPath.lastIndexOf('.'));
         return !excludedExtensions.has(ext);
       },
-    };
+    });
   }
 
-  /**
-   * Get the list of dependencies for a given file.
-   * @param mixedPath Absolute or project-relative path to the file
-   * @returns Array of dependency module names, or null if the file doesn't exist
-   */
   getDependencies(mixedPath: Path): ?ReadonlyArray<string> {
-    if (this.#getDependencies == null) {
-      throw new Error(
-        'DependencyPlugin has not been initialized before getDependencies',
-      );
+    const result = this.getFileSystem().lookup(mixedPath);
+    if (result.exists && result.type === 'f') {
+      return result.pluginData ?? [];
     }
-    return this.#getDependencies(mixedPath);
+    return null;
   }
 }

package/src/plugins/FileDataPlugin.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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<<8833f226ec9fa3a4c96370862ca4d59f>>
+ *
+ * This file was translated from Flow by scripts/generateTypeScriptDefinitions.js
+ * Original file: packages/metro-file-map/src/plugins/FileDataPlugin.js
+ * To regenerate, run:
+ *   js1 build metro-ts-defs (internal) OR
+ *   yarn run build-ts-defs (OSS) 
+ */
+
+import type {
+  FileMapPlugin,
+  FileMapPluginInitOptions,
+  FileMapPluginWorker,
+  ReadonlyFileSystemChanges,
+  V8Serializable,
+} from '../flow-types';
+
+export type FileDataPluginOptions = Readonly<
+  Omit<FileMapPluginWorker, keyof {name: string; cacheKey: string}> & {
+    name: string;
+    cacheKey: string;
+  }
+>;
+/**
+ * Base class for FileMap plugins that store per-file data via a worker and
+ * have no separate serializable state. Provides default no-op implementations
+ * of lifecycle methods that subclasses can override as needed.
+ */
+declare class FileDataPlugin<
+  PerFileData extends void | V8Serializable = void | V8Serializable,
+> implements FileMapPlugin<null, PerFileData>
+{
+  readonly name: string;
+  constructor($$PARAM_0$$: FileDataPluginOptions);
+  initialize(
+    initOptions: FileMapPluginInitOptions<null, PerFileData>,
+  ): Promise<void>;
+  getFileSystem(): FileMapPluginInitOptions<null, PerFileData>['files'];
+  onChanged(
+    _changes: ReadonlyFileSystemChanges<null | undefined | PerFileData>,
+  ): void;
+  assertValid(): void;
+  getSerializableSnapshot(): null;
+  getCacheKey(): string;
+  getWorker(): FileMapPluginWorker;
+}
+export default FileDataPlugin;

package/src/plugins/FileDataPlugin.js

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.default = void 0;
+class FileDataPlugin {
+  #worker;
+  #cacheKey;
+  #files;
+  constructor({ name, worker, filter, cacheKey }) {
+    this.name = name;
+    this.#worker = {
+      worker,
+      filter,
+    };
+    this.#cacheKey = cacheKey;
+  }
+  async initialize(initOptions) {
+    this.#files = initOptions.files;
+  }
+  getFileSystem() {
+    const files = this.#files;
+    if (files == null) {
+      throw new Error(`${this.name} plugin has not been initialized`);
+    }
+    return files;
+  }
+  onChanged(_changes) {}
+  assertValid() {}
+  getSerializableSnapshot() {
+    return null;
+  }
+  getCacheKey() {
+    return this.#cacheKey;
+  }
+  getWorker() {
+    return this.#worker;
+  }
+}
+exports.default = FileDataPlugin;

package/src/plugins/FileDataPlugin.js.flow

@@ -0,0 +1,76 @@
+/**
+ * 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
+ */
+
+import type {
+  FileMapPlugin,
+  FileMapPluginInitOptions,
+  FileMapPluginWorker,
+  ReadonlyFileSystemChanges,
+  V8Serializable,
+} from '../flow-types';
+
+export type FileDataPluginOptions = Readonly<{
+  ...FileMapPluginWorker,
+  name: string,
+  cacheKey: string,
+}>;
+
+/**
+ * Base class for FileMap plugins that store per-file data via a worker and
+ * have no separate serializable state. Provides default no-op implementations
+ * of lifecycle methods that subclasses can override as needed.
+ */
+export default class FileDataPlugin<
+  -PerFileData extends void | V8Serializable = void | V8Serializable,
+> implements FileMapPlugin<null, PerFileData>
+{
+  +name: string;
+
+  #worker: FileMapPluginWorker;
+  #cacheKey: string;
+  #files: ?FileMapPluginInitOptions<null, PerFileData>['files'];
+
+  constructor({name, worker, filter, cacheKey}: FileDataPluginOptions) {
+    this.name = name;
+    this.#worker = {worker, filter};
+    this.#cacheKey = cacheKey;
+  }
+
+  async initialize(
+    initOptions: FileMapPluginInitOptions<null, PerFileData>,
+  ): Promise<void> {
+    this.#files = initOptions.files;
+  }
+
+  getFileSystem(): FileMapPluginInitOptions<null, PerFileData>['files'] {
+    const files = this.#files;
+    if (files == null) {
+      throw new Error(`${this.name} plugin has not been initialized`);
+    }
+    return files;
+  }
+
+  onChanged(_changes: ReadonlyFileSystemChanges<?PerFileData>): void {}
+
+  assertValid(): void {}
+
+  getSerializableSnapshot(): null {
+    return null;
+  }
+
+  getCacheKey(): string {
+    return this.#cacheKey;
+  }
+
+  getWorker(): FileMapPluginWorker {
+    return this.#worker;
+  }
+}