metro-file-map 0.73.7 → 0.74.1

package/package.json

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

package/src/HasteFS.js

@@ -65,18 +65,78 @@ class HasteFS {
   #rootDir;
   #files;
   constructor({ rootDir, files }) {
-    // $FlowIssue[cannot-write] - should be fixed in Flow 0.193 (D41130671)
     this.#rootDir = rootDir;
-    // $FlowIssue[cannot-write] - should be fixed in Flow 0.193 (D41130671)
     this.#files = files;
   }
+  _normalizePath(relativeOrAbsolutePath) {
+    return path.isAbsolute(relativeOrAbsolutePath)
+      ? fastPath.relative(this.#rootDir, relativeOrAbsolutePath)
+      : path.normalize(relativeOrAbsolutePath);
+  }
+  remove(filePath) {
+    this.#files.delete(this._normalizePath(filePath));
+  }
+  bulkAddOrModify(changedFiles) {
+    for (const [relativePath, metadata] of changedFiles) {
+      this.#files.set(relativePath, metadata);
+    }
+  }
+  addOrModify(filePath, metadata) {
+    this.#files.set(this._normalizePath(filePath), metadata);
+  }
+  setVisitMetadata(filePath, visitResult) {
+    const metadata = this._getFileData(filePath);
+    if (!metadata) {
+      throw new Error("Visited file not found in file map: " + filePath);
+    }
+    metadata[_constants.default.VISITED] = 1;
+    if (visitResult.hasteId != null) {
+      metadata[_constants.default.ID] = visitResult.hasteId;
+    }
+    if ("sha1" in visitResult) {
+      metadata[_constants.default.SHA1] = visitResult.sha1;
+    }
+    if (visitResult.dependencies != null) {
+      metadata[_constants.default.DEPENDENCIES] = visitResult.dependencies;
+    }
+    if (visitResult.symlinkTarget != null) {
+      metadata[_constants.default.SYMLINK] = visitResult.symlinkTarget;
+    }
+  }
+  getSerializableSnapshot() {
+    return new Map(Array.from(this.#files.entries(), ([k, v]) => [k, [...v]]));
+  }
   getModuleName(file) {
+    var _ref;
     const fileMetadata = this._getFileData(file);
-    return (fileMetadata && fileMetadata[_constants.default.ID]) || null;
+    return (_ref = fileMetadata && fileMetadata[_constants.default.ID]) !==
+      null && _ref !== void 0
+      ? _ref
+      : null;
   }
   getSize(file) {
+    var _ref2;
     const fileMetadata = this._getFileData(file);
-    return (fileMetadata && fileMetadata[_constants.default.SIZE]) || null;
+    return (_ref2 = fileMetadata && fileMetadata[_constants.default.SIZE]) !==
+      null && _ref2 !== void 0
+      ? _ref2
+      : null;
+  }
+  getSymlinkTarget(file) {
+    const fileMetadata = this._getFileData(file);
+    if (fileMetadata == null) {
+      return null;
+    }
+    return typeof fileMetadata[_constants.default.SYMLINK] === "string"
+      ? fileMetadata[_constants.default.SYMLINK]
+      : null;
+  }
+  getType(file) {
+    const fileMetadata = this._getFileData(file);
+    if (fileMetadata == null) {
+      return null;
+    }
+    return fileMetadata[_constants.default.SYMLINK] === 0 ? "f" : "l";
   }
   getDependencies(file) {
     const fileMetadata = this._getFileData(file);
@@ -91,11 +151,19 @@ class HasteFS {
     }
   }
   getSha1(file) {
-    var _ref;
+    var _ref3;
     const fileMetadata = this._getFileData(file);
-    return (_ref = fileMetadata && fileMetadata[_constants.default.SHA1]) !==
-      null && _ref !== void 0
-      ? _ref
+    return (_ref3 = fileMetadata && fileMetadata[_constants.default.SHA1]) !==
+      null && _ref3 !== void 0
+      ? _ref3
+      : null;
+  }
+  getModifiedTime(file) {
+    var _ref4;
+    const fileMetadata = this._getFileData(file);
+    return (_ref4 = fileMetadata && fileMetadata[_constants.default.MTIME]) !==
+      null && _ref4 !== void 0
+      ? _ref4
       : null;
   }
   exists(file) {
@@ -168,9 +236,14 @@ class HasteFS {
     }
     return files;
   }
-  _getFileData(file) {
-    const relativePath = fastPath.relative(this.#rootDir, file);
-    return this.#files.get(relativePath);
+  _getFileData(filePath) {
+    // Shortcut to avoid any file path parsing if the given path is already
+    // normalised.
+    const optimisticMetadata = this.#files.get(filePath);
+    if (optimisticMetadata) {
+      return optimisticMetadata;
+    }
+    return this.#files.get(this._normalizePath(filePath));
   }
 }
 exports.default = HasteFS;

package/src/HasteFS.js.flow

@@ -11,9 +11,10 @@
 import type {
   FileData,
   FileMetaData,
-  FileSystem,
   Glob,
+  MutableFileSystem,
   Path,
+  VisitMetadata,
 } from './flow-types';
 
 import H from './constants';
@@ -21,25 +22,97 @@ import * as fastPath from './lib/fast_path';
 import * as path from 'path';
 import {globsToMatcher, replacePathSepForGlob} from 'jest-util';
 
-export default class HasteFS implements FileSystem {
+export default class HasteFS implements MutableFileSystem {
   +#rootDir: Path;
   +#files: FileData;
 
   constructor({rootDir, files}: {rootDir: Path, files: FileData}) {
-    // $FlowIssue[cannot-write] - should be fixed in Flow 0.193 (D41130671)
     this.#rootDir = rootDir;
-    // $FlowIssue[cannot-write] - should be fixed in Flow 0.193 (D41130671)
     this.#files = files;
   }
 
+  _normalizePath(relativeOrAbsolutePath: Path): string {
+    return path.isAbsolute(relativeOrAbsolutePath)
+      ? fastPath.relative(this.#rootDir, relativeOrAbsolutePath)
+      : path.normalize(relativeOrAbsolutePath);
+  }
+
+  remove(filePath: Path) {
+    this.#files.delete(this._normalizePath(filePath));
+  }
+
+  bulkAddOrModify(changedFiles: FileData) {
+    for (const [relativePath, metadata] of changedFiles) {
+      this.#files.set(relativePath, metadata);
+    }
+  }
+
+  addOrModify(filePath: Path, metadata: FileMetaData) {
+    this.#files.set(this._normalizePath(filePath), metadata);
+  }
+
+  setVisitMetadata(
+    filePath: Path,
+    visitResult: $ReadOnly<VisitMetadata>,
+  ): void {
+    const metadata = this._getFileData(filePath);
+    if (!metadata) {
+      throw new Error('Visited file not found in file map: ' + filePath);
+    }
+    metadata[H.VISITED] = 1;
+
+    if (visitResult.hasteId != null) {
+      metadata[H.ID] = visitResult.hasteId;
+    }
+
+    if ('sha1' in visitResult) {
+      metadata[H.SHA1] = visitResult.sha1;
+    }
+
+    if (visitResult.dependencies != null) {
+      metadata[H.DEPENDENCIES] = visitResult.dependencies;
+    }
+
+    if (visitResult.symlinkTarget != null) {
+      metadata[H.SYMLINK] = visitResult.symlinkTarget;
+    }
+  }
+
+  getSerializableSnapshot(): FileData {
+    return new Map(
+      Array.from(this.#files.entries(), ([k, v]: [Path, FileMetaData]) => [
+        k,
+        [...v],
+      ]),
+    );
+  }
+
   getModuleName(file: Path): ?string {
     const fileMetadata = this._getFileData(file);
-    return (fileMetadata && fileMetadata[H.ID]) || null;
+    return (fileMetadata && fileMetadata[H.ID]) ?? null;
   }
 
   getSize(file: Path): ?number {
     const fileMetadata = this._getFileData(file);
-    return (fileMetadata && fileMetadata[H.SIZE]) || null;
+    return (fileMetadata && fileMetadata[H.SIZE]) ?? null;
+  }
+
+  getSymlinkTarget(file: Path): ?string {
+    const fileMetadata = this._getFileData(file);
+    if (fileMetadata == null) {
+      return null;
+    }
+    return typeof fileMetadata[H.SYMLINK] === 'string'
+      ? fileMetadata[H.SYMLINK]
+      : null;
+  }
+
+  getType(file: Path): ?('f' | 'l') {
+    const fileMetadata = this._getFileData(file);
+    if (fileMetadata == null) {
+      return null;
+    }
+    return fileMetadata[H.SYMLINK] === 0 ? 'f' : 'l';
   }
 
   getDependencies(file: Path): ?Array<string> {
@@ -59,6 +132,11 @@ export default class HasteFS implements FileSystem {
     return (fileMetadata && fileMetadata[H.SHA1]) ?? null;
   }
 
+  getModifiedTime(file: Path): ?number {
+    const fileMetadata = this._getFileData(file);
+    return (fileMetadata && fileMetadata[H.MTIME]) ?? null;
+  }
+
   exists(file: Path): boolean {
     return this._getFileData(file) != null;
   }
@@ -148,8 +226,13 @@ export default class HasteFS implements FileSystem {
     return files;
   }
 
-  _getFileData(file: Path): void | FileMetaData {
-    const relativePath = fastPath.relative(this.#rootDir, file);
-    return this.#files.get(relativePath);
+  _getFileData(filePath: Path): void | FileMetaData {
+    // Shortcut to avoid any file path parsing if the given path is already
+    // normalised.
+    const optimisticMetadata = this.#files.get(filePath);
+    if (optimisticMetadata) {
+      return optimisticMetadata;
+    }
+    return this.#files.get(this._normalizePath(filePath));
   }
 }

package/src/Watcher.js

@@ -101,7 +101,7 @@ class Watcher extends _events.default {
     const crawlerOptions = {
       abortSignal: options.abortSignal,
       computeSha1: options.computeSha1,
-      enableSymlinks: options.enableSymlinks,
+      includeSymlinks: options.enableSymlinks,
       extensions: options.extensions,
       forceNodeFilesystemAPI: options.forceNodeFilesystemAPI,
       ignore,

package/src/Watcher.js.flow

@@ -100,7 +100,7 @@ export class Watcher extends EventEmitter {
     const crawlerOptions: CrawlerOptions = {
       abortSignal: options.abortSignal,
       computeSha1: options.computeSha1,
-      enableSymlinks: options.enableSymlinks,
+      includeSymlinks: options.enableSymlinks,
       extensions: options.extensions,
       forceNodeFilesystemAPI: options.forceNodeFilesystemAPI,
       ignore,
@@ -162,7 +162,7 @@ export class Watcher extends EventEmitter {
       type: string,
       filePath: string,
       root: string,
-      metadata: ?ChangeEventMetadata,
+      metadata: ChangeEventMetadata,
     ) => void,
   ) {
     const {extensions, ignorePattern, useWatchman} = this._options;
@@ -214,7 +214,7 @@ export class Watcher extends EventEmitter {
               type: string,
               filePath: string,
               root: string,
-              metadata: ?ChangeEventMetadata,
+              metadata: ChangeEventMetadata,
             ) => {
               const basename = path.basename(filePath);
               if (basename.startsWith(this._options.healthCheckFilePrefix)) {

package/src/cache/DiskCacheManager.js.flow

@@ -11,9 +11,9 @@
 
 import type {
   BuildParameters,
+  CacheData,
   CacheManager,
   FileData,
-  InternalData,
 } from '../flow-types';
 
 import rootRelativeCacheKeys from '../lib/rootRelativeCacheKeys';
@@ -66,7 +66,7 @@ export class DiskCacheManager implements CacheManager {
     return this._cachePath;
   }
 
-  async read(): Promise<?InternalData> {
+  async read(): Promise<?CacheData> {
     try {
       return deserialize(readFileSync(this._cachePath));
     } catch (e) {
@@ -80,7 +80,7 @@ export class DiskCacheManager implements CacheManager {
   }
 
   async write(
-    dataSnapshot: InternalData,
+    dataSnapshot: CacheData,
     {changed, removed}: $ReadOnly<{changed: FileData, removed: FileData}>,
   ): Promise<void> {
     if (changed.size > 0 || removed.size > 0) {

package/src/constants.js

@@ -33,6 +33,7 @@ const constants /*: HType */ = {
   VISITED: 3,
   DEPENDENCIES: 4,
   SHA1: 5,
+  SYMLINK: 6,
   /* module map attributes */
   PATH: 0,
   TYPE: 1,

package/src/constants.js.flow

@@ -34,6 +34,7 @@ const constants/*: HType */ = {
   VISITED: 3,
   DEPENDENCIES: 4,
   SHA1: 5,
+  SYMLINK: 6,
 
   /* module map attributes */
   PATH: 0,

package/src/crawlers/__fixtures__/directory/bar.js

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+"use strict";

package/src/crawlers/__fixtures__/directory/bar.js.flow

@@ -0,0 +1,10 @@
+/**
+ * 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
+ * @format
+ * @oncall react_native
+ */

package/src/crawlers/__fixtures__/foo.js

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+"use strict";

package/src/crawlers/__fixtures__/foo.js.flow

@@ -0,0 +1,10 @@
+/**
+ * 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
+ * @format
+ * @oncall react_native
+ */

package/src/crawlers/__fixtures__/ignored/hidden.js

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+"use strict";

package/src/crawlers/__fixtures__/ignored/hidden.js.flow

@@ -0,0 +1,10 @@
+/**
+ * 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
+ * @format
+ * @oncall react_native
+ */

package/src/crawlers/__fixtures__/link-to-directory/bar.js

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+"use strict";

package/src/crawlers/__fixtures__/link-to-directory/bar.js.flow

@@ -0,0 +1,10 @@
+/**
+ * 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
+ * @format
+ * @oncall react_native
+ */

package/src/crawlers/__fixtures__/link-to-foo.js

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+"use strict";

package/src/crawlers/__fixtures__/link-to-foo.js.flow

@@ -0,0 +1,10 @@
+/**
+ * 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
+ * @format
+ * @oncall react_native
+ */

package/src/crawlers/node/hasNativeFindSupport.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.default = hasNativeFindSupport;
+var _child_process = require("child_process");
+/**
+ * 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
+ */
+
+async function hasNativeFindSupport() {
+  try {
+    return await new Promise((resolve) => {
+      // Check the find binary supports the non-POSIX -iname parameter wrapped in parens.
+      const args = [
+        ".",
+        "-type",
+        "f",
+        "(",
+        "-iname",
+        "*.ts",
+        "-o",
+        "-iname",
+        "*.js",
+        ")",
+      ];
+      const child = (0, _child_process.spawn)("find", args, {
+        cwd: __dirname,
+      });
+      child.on("error", () => {
+        resolve(false);
+      });
+      child.on("exit", (code) => {
+        resolve(code === 0);
+      });
+    });
+  } catch {
+    return false;
+  }
+}

package/src/crawlers/node/hasNativeFindSupport.js.flow

@@ -0,0 +1,41 @@
+/**
+ * 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 {spawn} from 'child_process';
+
+export default async function hasNativeFindSupport(): Promise<boolean> {
+  try {
+    return await new Promise(resolve => {
+      // Check the find binary supports the non-POSIX -iname parameter wrapped in parens.
+      const args = [
+        '.',
+        '-type',
+        'f',
+        '(',
+        '-iname',
+        '*.ts',
+        '-o',
+        '-iname',
+        '*.js',
+        ')',
+      ];
+      const child = spawn('find', args, {cwd: __dirname});
+      child.on('error', () => {
+        resolve(false);
+      });
+      child.on('exit', code => {
+        resolve(code === 0);
+      });
+    });
+  } catch {
+    return false;
+  }
+}