Open source our jest-haste-map fork as metro-file-map (#812)

Summary:
Pull Request resolved: #812

## Motivation
Internally at Meta we need to make various modifications to `jest-haste-map` for use by Metro (eg instrumentation, internal cache support), which up to now we've achieved using a fork, a subclass, the `hasteMapModulePath` option and some monkey-patching.

This isn't an ideal situation, and we're also coming up against the limits of what we can do whilst remaining faithful to the `jest-haste-map` API. We don't want to bloat an open source Jest subpackage (which rightly serves Jest first) with Metro-specific accommodations, and we want to be able to make changes, including breaking changes, at Metro's release cadence.

## Approach
Therefore, we're publishing our lightly-modified fork of `[email protected]` as `metro-file-map` and making it a first-class Metro citizen, with the intention to decouple from Jest and make updates and modifications with fewer constraints.

`jest-haste-map` is still heavily in use at Meta by Jest itself, so we'll still look to share/upstream as much as makes sense, and we'll be open to re-partitioning (for direct code sharing) or even re-converging down the line.

## Possibilities
Additionally, I'm optimistic that reducing the friction around Metro-oriented file crawling/watching might enable/encourage tackling some longstanding issues, such as [symlink support](#1) and [lazy loading](jestjs/jest#12231).

Reviewed By: motiz88

Differential Revision: D35744151

fbshipit-source-id: c794e9fe1886b6d9599f1ec03349a02845c3189c

packages/metro-file-map/src/HasteFS.js

@@ -0,0 +1,104 @@
+/**
+ * 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
+ * @flow strict-local
+ */
+
+import type {FileData, Path} from './flow-types';
+
+import H from './constants';
+import * as fastPath from './lib/fast_path';
+// $FlowFixMe[untyped-import] - jest-util
+import {globsToMatcher, replacePathSepForGlob} from 'jest-util';
+
+// $FlowFixMe[unclear-type] - Check TS Config.Glob
+type Glob = any;
+
+export default class HasteFS {
+  +_rootDir: Path;
+  +_files: FileData;
+
+  constructor({rootDir, files}: {rootDir: Path, files: FileData}) {
+    this._rootDir = rootDir;
+    this._files = files;
+  }
+
+  getModuleName(file: Path): ?string {
+    const fileMetadata = this._getFileData(file);
+    return (fileMetadata && fileMetadata[H.ID]) || null;
+  }
+
+  getSize(file: Path): ?number {
+    const fileMetadata = this._getFileData(file);
+    return (fileMetadata && fileMetadata[H.SIZE]) || null;
+  }
+
+  getDependencies(file: Path): ?Array<string> {
+    const fileMetadata = this._getFileData(file);
+
+    if (fileMetadata) {
+      return fileMetadata[H.DEPENDENCIES]
+        ? fileMetadata[H.DEPENDENCIES].split(H.DEPENDENCY_DELIM)
+        : [];
+    } else {
+      return null;
+    }
+  }
+
+  getSha1(file: Path): ?string {
+    const fileMetadata = this._getFileData(file);
+    return (fileMetadata && fileMetadata[H.SHA1]) ?? null;
+  }
+
+  exists(file: Path): boolean {
+    return this._getFileData(file) != null;
+  }
+
+  getAllFiles(): Array<Path> {
+    return Array.from(this.getAbsoluteFileIterator());
+  }
+
+  getFileIterator(): Iterable<Path> {
+    return this._files.keys();
+  }
+
+  *getAbsoluteFileIterator(): Iterable<Path> {
+    for (const file of this.getFileIterator()) {
+      yield fastPath.resolve(this._rootDir, file);
+    }
+  }
+
+  matchFiles(pattern: RegExp | string): Array<Path> {
+    const regexpPattern =
+      pattern instanceof RegExp ? pattern : new RegExp(pattern);
+    const files = [];
+    for (const file of this.getAbsoluteFileIterator()) {
+      if (regexpPattern.test(file)) {
+        files.push(file);
+      }
+    }
+    return files;
+  }
+
+  matchFilesWithGlob(globs: $ReadOnlyArray<Glob>, root: ?Path): Set<Path> {
+    const files = new Set<string>();
+    const matcher = globsToMatcher(globs);
+
+    for (const file of this.getAbsoluteFileIterator()) {
+      const filePath = root != null ? fastPath.relative(root, file) : file;
+      if (matcher(replacePathSepForGlob(filePath))) {
+        files.add(file);
+      }
+    }
+    return files;
+  }
+
+  _getFileData(file: Path) {
+    const relativePath = fastPath.relative(this._rootDir, file);
+    return this._files.get(relativePath);
+  }
+}

packages/metro-file-map/src/ModuleMap.js

@@ -0,0 +1,269 @@
+/**
+ * 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
+ */
+
+import type {
+  DuplicatesSet,
+  HTypeValue,
+  IModuleMap,
+  ModuleMetaData,
+  Path,
+  RawModuleMap,
+  SerializableModuleMap,
+} from './flow-types';
+
+import H from './constants';
+import * as fastPath from './lib/fast_path';
+
+const EMPTY_OBJ: {[string]: ModuleMetaData} = {};
+const EMPTY_MAP = new Map();
+
+export default class ModuleMap implements IModuleMap<SerializableModuleMap> {
+  static DuplicateHasteCandidatesError: typeof DuplicateHasteCandidatesError;
+  +_raw: RawModuleMap;
+  _json: ?SerializableModuleMap;
+
+  // $FlowFixMe[unclear-type] - Refactor away this function
+  static _mapToArrayRecursive(map: Map<string, any>): Array<[string, any]> {
+    let arr = Array.from(map);
+    if (arr[0] && arr[0][1] instanceof Map) {
+      arr = arr.map(
+        // $FlowFixMe[unclear-type] - Refactor away this function
+        el => ([el[0], this._mapToArrayRecursive(el[1])]: [string, any]),
+      );
+    }
+    return arr;
+  }
+
+  static _mapFromArrayRecursive(
+    // $FlowFixMe[unclear-type] - Refactor away this function
+    arr: $ReadOnlyArray<[string, any]>,
+    // $FlowFixMe[unclear-type] - Refactor away this function
+  ): Map<string, any> {
+    if (arr[0] && Array.isArray(arr[1])) {
+      // $FlowFixMe[reassign-const] - Refactor away this function
+      arr = (arr.map(el => [
+        el[0],
+        // $FlowFixMe[unclear-type] - Refactor away this function
+        this._mapFromArrayRecursive((el[1]: Array<[string, any]>)),
+        // $FlowFixMe[unclear-type] - Refactor away this function
+      ]): Array<[string, any]>);
+    }
+    return new Map(arr);
+  }
+
+  constructor(raw: RawModuleMap) {
+    this._raw = raw;
+  }
+
+  getModule(
+    name: string,
+    platform?: ?string,
+    supportsNativePlatform?: ?boolean,
+    type?: ?HTypeValue,
+  ): ?Path {
+    const module = this._getModuleMetadata(
+      name,
+      platform,
+      !!supportsNativePlatform,
+    );
+    if (module && module[H.TYPE] === (type ?? H.MODULE)) {
+      const modulePath = module[H.PATH];
+      return modulePath && fastPath.resolve(this._raw.rootDir, modulePath);
+    }
+    return null;
+  }
+
+  getPackage(
+    name: string,
+    platform: ?string,
+    _supportsNativePlatform?: ?boolean,
+  ): ?Path {
+    return this.getModule(name, platform, null, H.PACKAGE);
+  }
+
+  getMockModule(name: string): ?Path {
+    const mockPath =
+      this._raw.mocks.get(name) || this._raw.mocks.get(name + '/index');
+    return mockPath != null
+      ? fastPath.resolve(this._raw.rootDir, mockPath)
+      : null;
+  }
+
+  getRawModuleMap(): RawModuleMap {
+    return {
+      duplicates: this._raw.duplicates,
+      map: this._raw.map,
+      mocks: this._raw.mocks,
+      rootDir: this._raw.rootDir,
+    };
+  }
+
+  toJSON(): SerializableModuleMap {
+    if (!this._json) {
+      this._json = {
+        duplicates: (ModuleMap._mapToArrayRecursive(
+          this._raw.duplicates,
+        ): SerializableModuleMap['duplicates']),
+        map: Array.from(this._raw.map),
+        mocks: Array.from(this._raw.mocks),
+        rootDir: this._raw.rootDir,
+      };
+    }
+    return this._json;
+  }
+
+  static fromJSON(serializableModuleMap: SerializableModuleMap): ModuleMap {
+    return new ModuleMap({
+      duplicates: (ModuleMap._mapFromArrayRecursive(
+        serializableModuleMap.duplicates,
+      ): RawModuleMap['duplicates']),
+      map: new Map(serializableModuleMap.map),
+      mocks: new Map(serializableModuleMap.mocks),
+      rootDir: serializableModuleMap.rootDir,
+    });
+  }
+
+  /**
+   * When looking up a module's data, we walk through each eligible platform for
+   * the query. For each platform, we want to check if there are known
+   * duplicates for that name+platform pair. The duplication logic normally
+   * removes elements from the `map` object, but we want to check upfront to be
+   * extra sure. If metadata exists both in the `duplicates` object and the
+   * `map`, this would be a bug.
+   */
+  _getModuleMetadata(
+    name: string,
+    platform: ?string,
+    supportsNativePlatform: boolean,
+  ): ModuleMetaData | null {
+    const map = this._raw.map.get(name) || EMPTY_OBJ;
+    const dupMap = this._raw.duplicates.get(name) || EMPTY_MAP;
+    if (platform != null) {
+      this._assertNoDuplicates(
+        name,
+        platform,
+        supportsNativePlatform,
+        dupMap.get(platform),
+      );
+      if (map[platform] != null) {
+        return map[platform];
+      }
+    }
+    if (supportsNativePlatform) {
+      this._assertNoDuplicates(
+        name,
+        H.NATIVE_PLATFORM,
+        supportsNativePlatform,
+        dupMap.get(H.NATIVE_PLATFORM),
+      );
+      if (map[H.NATIVE_PLATFORM]) {
+        return map[H.NATIVE_PLATFORM];
+      }
+    }
+    this._assertNoDuplicates(
+      name,
+      H.GENERIC_PLATFORM,
+      supportsNativePlatform,
+      dupMap.get(H.GENERIC_PLATFORM),
+    );
+    if (map[H.GENERIC_PLATFORM]) {
+      return map[H.GENERIC_PLATFORM];
+    }
+    return null;
+  }
+
+  _assertNoDuplicates(
+    name: string,
+    platform: string,
+    supportsNativePlatform: boolean,
+    relativePathSet: ?DuplicatesSet,
+  ) {
+    if (relativePathSet == null) {
+      return;
+    }
+    // Force flow refinement
+    const previousSet = relativePathSet;
+    const duplicates = new Map();
+
+    for (const [relativePath, type] of previousSet) {
+      const duplicatePath = fastPath.resolve(this._raw.rootDir, relativePath);
+      duplicates.set(duplicatePath, type);
+    }
+
+    throw new DuplicateHasteCandidatesError(
+      name,
+      platform,
+      supportsNativePlatform,
+      duplicates,
+    );
+  }
+
+  static create(rootDir: Path): ModuleMap {
+    return new ModuleMap({
+      duplicates: new Map(),
+      map: new Map(),
+      mocks: new Map(),
+      rootDir,
+    });
+  }
+}
+
+class DuplicateHasteCandidatesError extends Error {
+  hasteName: string;
+  platform: string | null;
+  supportsNativePlatform: boolean;
+  duplicatesSet: DuplicatesSet;
+
+  constructor(
+    name: string,
+    platform: string,
+    supportsNativePlatform: boolean,
+    duplicatesSet: DuplicatesSet,
+  ) {
+    const platformMessage = getPlatformMessage(platform);
+    super(
+      `The name \`${name}\` was looked up in the Haste module map. It ` +
+        'cannot be resolved, because there exists several different ' +
+        'files, or packages, that provide a module for ' +
+        `that particular name and platform. ${platformMessage} You must ` +
+        'delete or exclude files until there remains only one of these:\n\n' +
+        Array.from(duplicatesSet)
+          .map(
+            ([dupFilePath, dupFileType]) =>
+              `  * \`${dupFilePath}\` (${getTypeMessage(dupFileType)})\n`,
+          )
+          .sort()
+          .join(''),
+    );
+    this.hasteName = name;
+    this.platform = platform;
+    this.supportsNativePlatform = supportsNativePlatform;
+    this.duplicatesSet = duplicatesSet;
+  }
+}
+
+function getPlatformMessage(platform: string) {
+  if (platform === H.GENERIC_PLATFORM) {
+    return 'The platform is generic (no extension).';
+  }
+  return `The platform extension is \`${platform}\`.`;
+}
+
+function getTypeMessage(type: number) {
+  switch (type) {
+    case H.MODULE:
+      return 'module';
+    case H.PACKAGE:
+      return 'package';
+  }
+  return 'unknown';
+}
+
+ModuleMap.DuplicateHasteCandidatesError = DuplicateHasteCandidatesError;