metro-file-map 0.83.3 → 0.84.0

package/src/watchers/WatchmanWatcher.js.flow

@@ -40,19 +40,20 @@ const SUB_PREFIX = 'metro-file-map';
  * Watches `dir`.
  */
 export default class WatchmanWatcher extends AbstractWatcher {
-  client: Client;
+  #client: Client;
   +subscriptionName: string;
-  watchProjectInfo: ?$ReadOnly<{
+  #watchProjectInfo: ?Readonly<{
     relativePath: string,
     root: string,
   }>;
-  +watchmanDeferStates: $ReadOnlyArray<string>;
+  +#watchmanDeferStates: ReadonlyArray<string>;
   #deferringStates: ?Set<string> = null;
 
-  constructor(dir: string, {watchmanDeferStates, ...opts}: WatcherOptions) {
-    super(dir, opts);
+  constructor(dir: string, opts: WatcherOptions) {
+    const {watchmanDeferStates, ...baseOpts} = opts;
+    super(dir, baseOpts);
 
-    this.watchmanDeferStates = watchmanDeferStates;
+    this.#watchmanDeferStates = watchmanDeferStates;
 
     // Use a unique subscription name per process per watched directory
     const watchKey = createHash('md5').update(this.root).digest('hex');
@@ -62,40 +63,40 @@ export default class WatchmanWatcher extends AbstractWatcher {
     this.subscriptionName = `${SUB_PREFIX}-${process.pid}-${readablePath}-${watchKey}`;
   }
 
-  async startWatching() {
-    await new Promise((resolve, reject) => this._init(resolve, reject));
+  async startWatching(): Promise<void> {
+    await new Promise((resolve, reject) => this.#init(resolve, reject));
   }
 
   /**
    * Run the watchman `watch` command on the root and subscribe to changes.
    */
-  _init(onReady: () => void, onError: (error: Error) => void) {
-    if (this.client) {
-      this.client.removeAllListeners();
+  #init(onReady: () => void, onError: (error: Error) => void) {
+    if (this.#client) {
+      this.#client.removeAllListeners();
     }
 
     const self = this;
-    this.client = new watchman.Client();
-    this.client.on('error', error => {
+    this.#client = new watchman.Client();
+    this.#client.on('error', error => {
       this.emitError(error);
     });
-    this.client.on('subscription', changeEvent =>
-      this._handleChangeEvent(changeEvent),
+    this.#client.on('subscription', changeEvent =>
+      this.#handleChangeEvent(changeEvent),
     );
-    this.client.on('end', () => {
+    this.#client.on('end', () => {
       console.warn(
         '[metro-file-map] Warning: Lost connection to Watchman, reconnecting..',
       );
-      self._init(
+      self.#init(
         () => {},
         error => self.emitError(error),
       );
     });
 
-    this.watchProjectInfo = null;
+    this.#watchProjectInfo = null;
 
     function getWatchRoot() {
-      return self.watchProjectInfo ? self.watchProjectInfo.root : self.root;
+      return self.#watchProjectInfo ? self.#watchProjectInfo.root : self.root;
     }
 
     function onWatchProject(error: ?Error, resp: WatchmanWatchResponse) {
@@ -109,14 +110,14 @@ export default class WatchmanWatcher extends AbstractWatcher {
 
       // NB: Watchman outputs posix-separated paths even on Windows, convert
       // them to system-native separators.
-      self.watchProjectInfo = {
+      self.#watchProjectInfo = {
         relativePath: resp.relative_path
           ? normalizePathSeparatorsToSystem(resp.relative_path)
           : '',
         root: normalizePathSeparatorsToSystem(resp.watch),
       };
 
-      self.client.command(['clock', getWatchRoot()], onClock);
+      self.#client.command(['clock', getWatchRoot()], onClock);
     }
 
     function onClock(error: ?Error, resp: WatchmanClockResponse) {
@@ -126,7 +127,7 @@ export default class WatchmanWatcher extends AbstractWatcher {
       }
 
       debug('Received clock response: %s', resp.clock);
-      const watchProjectInfo = self.watchProjectInfo;
+      const watchProjectInfo = self.#watchProjectInfo;
 
       invariant(
         watchProjectInfo != null,
@@ -138,7 +139,7 @@ export default class WatchmanWatcher extends AbstractWatcher {
       const options: WatchmanQuery = {
         fields: ['name', 'exists', 'new', 'type', 'size', 'mtime_ms'],
         since: resp.clock,
-        defer: self.watchmanDeferStates,
+        defer: self.#watchmanDeferStates,
         relative_root: watchProjectInfo.relativePath,
       };
 
@@ -154,7 +155,7 @@ export default class WatchmanWatcher extends AbstractWatcher {
         ];
       }
 
-      self.client.command(
+      self.#client.command(
         ['subscribe', getWatchRoot(), self.subscriptionName, options],
         onSubscribe,
       );
@@ -176,13 +177,13 @@ export default class WatchmanWatcher extends AbstractWatcher {
       onReady();
     };
 
-    self.client.command(['watch-project', getWatchRoot()], onWatchProject);
+    self.#client.command(['watch-project', getWatchRoot()], onWatchProject);
   }
 
   /**
    * Handles a change event coming from the subscription.
    */
-  _handleChangeEvent(resp: WatchmanSubscriptionEvent) {
+  #handleChangeEvent(resp: WatchmanSubscriptionEvent) {
     debug(
       'Received subscription response: %s (fresh: %s, files: %s, enter: %s, leave: %s, clock: %s)',
       resp.subscription,
@@ -200,12 +201,12 @@ export default class WatchmanWatcher extends AbstractWatcher {
     );
 
     if (Array.isArray(resp.files)) {
-      resp.files.forEach(change => this._handleFileChange(change, resp.clock));
+      resp.files.forEach(change => this.#handleFileChange(change, resp.clock));
     }
     const {'state-enter': stateEnter, 'state-leave': stateLeave} = resp;
     if (
       stateEnter != null &&
-      (this.watchmanDeferStates ?? []).includes(stateEnter)
+      (this.#watchmanDeferStates ?? []).includes(stateEnter)
     ) {
       this.#deferringStates?.add(stateEnter);
       debug(
@@ -215,7 +216,7 @@ export default class WatchmanWatcher extends AbstractWatcher {
     }
     if (
       stateLeave != null &&
-      (this.watchmanDeferStates ?? []).includes(stateLeave)
+      (this.#watchmanDeferStates ?? []).includes(stateLeave)
     ) {
       this.#deferringStates?.delete(stateLeave);
       debug(
@@ -228,12 +229,12 @@ export default class WatchmanWatcher extends AbstractWatcher {
   /**
    * Handles a single change event record.
    */
-  _handleFileChange(
+  #handleFileChange(
     changeDescriptor: WatchmanFileChange,
     rawClock: WatchmanSubscriptionEvent['clock'],
   ) {
     const self = this;
-    const watchProjectInfo = self.watchProjectInfo;
+    const watchProjectInfo = self.#watchProjectInfo;
 
     invariant(
       watchProjectInfo != null,
@@ -274,8 +275,8 @@ export default class WatchmanWatcher extends AbstractWatcher {
     }
 
     const clock =
-      typeof rawClock === 'string' && this.watchProjectInfo != null
-        ? ([this.watchProjectInfo.root, rawClock]: [string, string])
+      typeof rawClock === 'string' && this.#watchProjectInfo != null
+        ? ([this.#watchProjectInfo.root, rawClock] as [string, string])
         : undefined;
 
     if (!exists) {
@@ -313,11 +314,11 @@ export default class WatchmanWatcher extends AbstractWatcher {
   /**
    * Closes the watcher.
    */
-  async stopWatching() {
+  async stopWatching(): Promise<void> {
     await super.stopWatching();
-    if (this.client) {
-      this.client.removeAllListeners();
-      this.client.end();
+    if (this.#client) {
+      this.#client.removeAllListeners();
+      this.#client.end();
     }
     this.#deferringStates = null;
   }
@@ -340,7 +341,7 @@ export default class WatchmanWatcher extends AbstractWatcher {
 /**
  * Handles a warning in the watchman resp object.
  */
-function handleWarning(resp: $ReadOnly<{warning?: mixed, ...}>) {
+function handleWarning(resp: Readonly<{warning?: unknown, ...}>) {
   if ('warning' in resp) {
     if (RecrawlWarning.isRecrawlWarningDupe(resp.warning)) {
       return true;

package/src/watchers/common.js.flow

@@ -28,12 +28,12 @@ export const DELETE_EVENT = 'delete';
 export const TOUCH_EVENT = 'touch';
 export const ALL_EVENT = 'all';
 
-export type WatcherOptions = $ReadOnly<{
-  globs: $ReadOnlyArray<string>,
+export type WatcherOptions = Readonly<{
+  globs: ReadonlyArray<string>,
   dot: boolean,
   ignored: ?RegExp,
-  watchmanDeferStates: $ReadOnlyArray<string>,
-  watchman?: mixed,
+  watchmanDeferStates: ReadonlyArray<string>,
+  watchman?: unknown,
   watchmanPath?: string,
 }>;
 
@@ -42,7 +42,7 @@ export type WatcherOptions = $ReadOnly<{
  */
 export function includedByGlob(
   type: ?('f' | 'l' | 'd'),
-  globs: $ReadOnlyArray<string>,
+  globs: ReadonlyArray<string>,
   dot: boolean,
   relativePath: string,
 ): boolean {

package/src/worker.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 {
+  WorkerMessage,
+  WorkerMetadata,
+  WorkerSetupArgs,
+} from './flow-types';
+
+declare const worker: {
+  /**
+   * Called automatically by jest-worker before the first call to `worker` when
+   * this module is used as worker thread or child process.
+   */
+  setup: (args: WorkerSetupArgs) => void;
+  /**
+   * Called by jest-worker with each workload
+   */
+  processFile: (data: WorkerMessage) => WorkerMetadata;
+  /**
+   * Exposed for use outside a jest-worker context, ie when processing in-band.
+   */
+  Worker: {
+    new (setupArgs: WorkerSetupArgs): {
+      processFile(data: WorkerMessage): WorkerMetadata;
+    };
+  };
+};
+
+export = worker;

package/src/worker.js

@@ -1,87 +1,45 @@
 "use strict";
 
-const defaultDependencyExtractor = require("./lib/dependencyExtractor");
-const excludedExtensions = require("./workerExclusionList");
 const { createHash } = require("crypto");
 const fs = require("graceful-fs");
-const path = require("path");
-const PACKAGE_JSON = path.sep + "package.json";
-let hasteImpl = null;
-let hasteImplModulePath = null;
-function getHasteImpl(requestedModulePath) {
-  if (hasteImpl) {
-    if (requestedModulePath !== hasteImplModulePath) {
-      throw new Error("metro-file-map: hasteImplModulePath changed");
-    }
-    return hasteImpl;
-  }
-  hasteImplModulePath = requestedModulePath;
-  hasteImpl = require(hasteImplModulePath);
-  return hasteImpl;
-}
 function sha1hex(content) {
   return createHash("sha1").update(content).digest("hex");
 }
 class Worker {
-  constructor(args) {}
+  #plugins;
+  constructor({ plugins = [] }) {
+    this.#plugins = plugins.map(({ modulePath, setupArgs }) => {
+      const PluginWorker = require(modulePath);
+      return new PluginWorker(setupArgs);
+    });
+  }
   processFile(data) {
     let content;
-    let dependencies;
-    let id;
     let sha1;
-    const { computeDependencies, computeSha1, enableHastePackages, filePath } =
-      data;
+    const { computeSha1, filePath, pluginsToRun } = data;
     const getContent = () => {
       if (content == null) {
         content = fs.readFileSync(filePath);
       }
       return content;
     };
-    if (enableHastePackages && filePath.endsWith(PACKAGE_JSON)) {
-      try {
-        const fileData = JSON.parse(getContent().toString());
-        if (fileData.name) {
-          id = fileData.name;
-        }
-      } catch (err) {
-        throw new Error(`Cannot parse ${filePath} as JSON: ${err.message}`);
-      }
-    } else if (
-      (data.hasteImplModulePath != null || computeDependencies) &&
-      !excludedExtensions.has(filePath.substr(filePath.lastIndexOf(".")))
-    ) {
-      if (data.hasteImplModulePath != null) {
-        id = getHasteImpl(data.hasteImplModulePath).getHasteName(filePath);
-      }
-      if (computeDependencies) {
-        const dependencyExtractor =
-          data.dependencyExtractor != null
-            ? require(data.dependencyExtractor)
-            : null;
-        dependencies = Array.from(
-          dependencyExtractor != null
-            ? dependencyExtractor.extract(
-                getContent().toString(),
-                filePath,
-                defaultDependencyExtractor.extract,
-              )
-            : defaultDependencyExtractor.extract(getContent().toString()),
-        );
-      }
-    }
+    const workerUtils = {
+      getContent,
+    };
+    const pluginData = pluginsToRun.map((pluginIdx) =>
+      this.#plugins[pluginIdx].processFile(data, workerUtils),
+    );
     if (computeSha1) {
       sha1 = sha1hex(getContent());
     }
     return content && data.maybeReturnContent
       ? {
           content,
-          dependencies,
-          id,
+          pluginData,
           sha1,
         }
       : {
-          dependencies,
-          id,
+          pluginData,
           sha1,
         };
   }

package/src/worker.js.flow

@@ -12,56 +12,40 @@
 
 /*::
 import type {
-  DependencyExtractor,
+  FileMapPluginWorker,
+  MetadataWorker,
   WorkerMessage,
   WorkerMetadata,
   WorkerSetupArgs,
+  V8Serializable,
 } from './flow-types';
 */
 
 'use strict';
 
-const defaultDependencyExtractor = require('./lib/dependencyExtractor');
-const excludedExtensions = require('./workerExclusionList');
 const {createHash} = require('crypto');
 const fs = require('graceful-fs');
-const path = require('path');
-
-const PACKAGE_JSON = path.sep + 'package.json';
-
-let hasteImpl /*: ?{getHasteName: string => ?string} */ = null;
-let hasteImplModulePath /*: ?string */ = null;
-
-function getHasteImpl(
-  requestedModulePath /*: string */,
-) /*: {getHasteName: string => ?string} */ {
-  if (hasteImpl) {
-    if (requestedModulePath !== hasteImplModulePath) {
-      throw new Error('metro-file-map: hasteImplModulePath changed');
-    }
-    return hasteImpl;
-  }
-  hasteImplModulePath = requestedModulePath;
-  // $FlowFixMe[unsupported-syntax] - dynamic require
-  hasteImpl = require(hasteImplModulePath);
-  return hasteImpl;
-}
 
 function sha1hex(content /*: string | Buffer */) /*: string */ {
   return createHash('sha1').update(content).digest('hex');
 }
 
 class Worker {
-  constructor(args /*: WorkerSetupArgs */) {}
+  #plugins /*: ReadonlyArray<MetadataWorker> */;
+
+  constructor({plugins = []} /*: WorkerSetupArgs */) {
+    this.#plugins = plugins.map(({modulePath, setupArgs}) => {
+      // $FlowFixMe[unsupported-syntax] - dynamic require
+      const PluginWorker = require(modulePath);
+      return new PluginWorker(setupArgs);
+    });
+  }
 
   processFile(data /*: WorkerMessage */) /*: WorkerMetadata */ {
     let content /*: ?Buffer */;
-    let dependencies /*: WorkerMetadata['dependencies'] */;
-    let id /*: WorkerMetadata['id'] */;
     let sha1 /*: WorkerMetadata['sha1'] */;
 
-    const {computeDependencies, computeSha1, enableHastePackages, filePath} =
-      data;
+    const {computeSha1, filePath, pluginsToRun} = data;
 
     const getContent = () /*: Buffer */ => {
       if (content == null) {
@@ -71,44 +55,10 @@ class Worker {
       return content;
     };
 
-    if (enableHastePackages && filePath.endsWith(PACKAGE_JSON)) {
-      // Process a package.json that is returned as a PACKAGE type with its name.
-      try {
-        const fileData = JSON.parse(getContent().toString());
-
-        if (fileData.name) {
-          id = fileData.name;
-        }
-      } catch (err) {
-        throw new Error(`Cannot parse ${filePath} as JSON: ${err.message}`);
-      }
-    } else if (
-      (data.hasteImplModulePath != null || computeDependencies) &&
-      !excludedExtensions.has(filePath.substr(filePath.lastIndexOf('.')))
-    ) {
-      // Process a random file that is returned as a MODULE.
-      if (data.hasteImplModulePath != null) {
-        id = getHasteImpl(data.hasteImplModulePath).getHasteName(filePath);
-      }
-
-      if (computeDependencies) {
-        const dependencyExtractor /*: ?DependencyExtractor */ =
-          data.dependencyExtractor != null
-            ? // $FlowFixMe[unsupported-syntax] - dynamic require
-              require(data.dependencyExtractor)
-            : null;
-
-        dependencies = Array.from(
-          dependencyExtractor != null
-            ? dependencyExtractor.extract(
-                getContent().toString(),
-                filePath,
-                defaultDependencyExtractor.extract,
-              )
-            : defaultDependencyExtractor.extract(getContent().toString()),
-        );
-      }
-    }
+    const workerUtils = {getContent};
+    const pluginData = pluginsToRun.map(pluginIdx =>
+      this.#plugins[pluginIdx].processFile(data, workerUtils),
+    );
 
     // If a SHA-1 is requested on update, compute it.
     if (computeSha1) {
@@ -116,8 +66,8 @@ class Worker {
     }
 
     return content && data.maybeReturnContent
-      ? {content, dependencies, id, sha1}
-      : {dependencies, id, sha1};
+      ? {content, pluginData, sha1}
+      : {pluginData, sha1};
   }
 }
 

package/src/workerExclusionList.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
+ */
+
+declare const exclusionList: ReadonlySet<string>;
+
+export = exclusionList;

package/src/workerExclusionList.js.flow

@@ -23,7 +23,7 @@
 
 'use strict';
 
-const extensions /*: $ReadOnlySet<string> */ = new Set([
+const extensions /*: ReadonlySet<string> */ = new Set([
   // JSONs are never haste modules, except for "package.json", which is handled.
   '.json',
 

package/src/Watcher.d.ts

@@ -1,24 +0,0 @@
-/**
- * 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 HealthCheckResult =
-  | {type: 'error'; timeout: number; error: Error; watcher: string | null}
-  | {
-      type: 'success';
-      timeout: number;
-      timeElapsed: number;
-      watcher: string | null;
-    }
-  | {
-      type: 'timeout';
-      timeout: number;
-      watcher: string | null;
-      pauseReason: string | null;
-    };

package/src/cache/DiskCacheManager.d.ts

@@ -1,38 +0,0 @@
-/**
- * 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 {
-  BuildParameters,
-  CacheData,
-  CacheManager,
-  CacheManagerWriteOptions,
-} from '../flow-types';
-
-export interface DiskCacheConfig {
-  buildParameters: BuildParameters;
-  cacheFilePrefix?: string | null;
-  cacheDirectory?: string | null;
-}
-
-export class DiskCacheManager implements CacheManager {
-  constructor(options: DiskCacheConfig);
-  static getCacheFilePath(
-    buildParameters: BuildParameters,
-    cacheFilePrefix?: string | null,
-    cacheDirectory?: string | null,
-  ): string;
-  getCacheFilePath(): string;
-  read(): Promise<CacheData | null>;
-  write(
-    getSnapshot: () => CacheData,
-    opts: CacheManagerWriteOptions,
-  ): Promise<void>;
-  end(): Promise<void>;
-}