metro-file-map 0.83.1 → 0.83.2

package/package.json

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

package/src/Watcher.js

@@ -8,13 +8,13 @@ var _node = _interopRequireDefault(require("./crawlers/node"));
 var _watchman = _interopRequireDefault(require("./crawlers/watchman"));
 var _common = require("./watchers/common");
 var _FallbackWatcher = _interopRequireDefault(
-  require("./watchers/FallbackWatcher")
+  require("./watchers/FallbackWatcher"),
 );
 var _NativeWatcher = _interopRequireDefault(
-  require("./watchers/NativeWatcher")
+  require("./watchers/NativeWatcher"),
 );
 var _WatchmanWatcher = _interopRequireDefault(
-  require("./watchers/WatchmanWatcher")
+  require("./watchers/WatchmanWatcher"),
 );
 var _events = _interopRequireDefault(require("events"));
 var fs = _interopRequireWildcard(require("fs"));
@@ -42,7 +42,7 @@ function _interopRequireWildcard(e, r) {
       var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
       i && (i.get || i.set) ? Object.defineProperty(n, u, i) : (n[u] = e[u]);
     }
-  return (n.default = e), t && t.set(e, n), n;
+  return ((n.default = e), t && t.set(e, n), n);
 }
 function _interopRequireDefault(e) {
   return e && e.__esModule ? e : { default: e };
@@ -94,13 +94,13 @@ class Watcher extends _events.default {
             "empty `.watchmanconfig` file in your project's root folder or " +
             "initialize a git or hg repository in your project.\n" +
             "  " +
-            error.toString()
+            error.toString(),
         );
         return (0, _node.default)(crawlerOptions).catch((e) => {
           throw new Error(
             "Crawler retry failed:\n" +
               `  Original error: ${error.message}\n` +
-              `  Retry error: ${e.message}\n`
+              `  Retry error: ${e.message}\n`,
           );
         });
       }
@@ -112,7 +112,7 @@ class Watcher extends _events.default {
         crawler,
         delta.changedFiles.size,
         delta.removedFiles.size,
-        delta.clocks?.size ?? 0
+        delta.clocks?.size ?? 0,
       );
       this._options.perfLogger?.point("crawl_end");
       return delta;
@@ -129,8 +129,8 @@ class Watcher extends _events.default {
     const WatcherImpl = useWatchman
       ? _WatchmanWatcher.default
       : _NativeWatcher.default.isSupported()
-      ? _NativeWatcher.default
-      : _FallbackWatcher.default;
+        ? _NativeWatcher.default
+        : _FallbackWatcher.default;
     let watcher = "fallback";
     if (WatcherImpl === _WatchmanWatcher.default) {
       watcher = "watchman";
@@ -159,7 +159,7 @@ class Watcher extends _events.default {
       return new Promise(async (resolve, reject) => {
         const rejectTimeout = setTimeout(
           () => reject(new Error("Failed to start watch mode.")),
-          MAX_WAIT_TIME
+          MAX_WAIT_TIME,
         );
         watcher.onFileEvent((change) => {
           const basename = path.basename(change.relativePath);
@@ -168,7 +168,7 @@ class Watcher extends _events.default {
               debug(
                 "Observed possible health check cookie: %s in %s",
                 change.relativePath,
-                root
+                root,
               );
               this._handleHealthCheckObservation(basename);
             }
@@ -182,7 +182,7 @@ class Watcher extends _events.default {
       });
     };
     this._backends = await Promise.all(
-      this._options.roots.map(createWatcherBackend)
+      this._options.roots.map(createWatcherBackend),
     );
   }
   _handleHealthCheckObservation(basename) {
@@ -213,7 +213,7 @@ class Watcher extends _events.default {
     const healthCheckPath = path.join(this._options.rootDir, basename);
     let result;
     const timeoutPromise = new Promise((resolve) =>
-      setTimeout(resolve, timeout)
+      setTimeout(resolve, timeout),
     ).then(() => {
       if (!result) {
         result = {
@@ -256,7 +256,7 @@ class Watcher extends _events.default {
     ]);
     this._pendingHealthChecks.delete(basename);
     creationPromise.then(() =>
-      fs.promises.unlink(healthCheckPath).catch(() => {})
+      fs.promises.unlink(healthCheckPath).catch(() => {}),
     );
     debug("Health check result: %o", result);
     return (0, _nullthrows.default)(result);

package/src/Watcher.js.flow

@@ -32,6 +32,7 @@ import nullthrows from 'nullthrows';
 import * as path from 'path';
 import {performance} from 'perf_hooks';
 
+// eslint-disable-next-line import/no-commonjs
 const debug = require('debug')('Metro:Watcher');
 
 const MAX_WAIT_TIME = 240000;
@@ -124,7 +125,7 @@ export class Watcher extends EventEmitter {
             '  ' +
             error.toString(),
         );
-        // $FlowFixMe[prop-missing] Found when updating Promise type definition
+        // $FlowFixMe[incompatible-type] Found when updating Promise type definition
         return nodeCrawl(crawlerOptions).catch<CrawlResult>(e => {
           throw new Error(
             'Crawler retry failed:\n' +
@@ -151,7 +152,7 @@ export class Watcher extends EventEmitter {
 
     debug('Beginning crawl with "%s".', crawler);
     try {
-      // $FlowFixMe[incompatible-call] Found when updating Promise type definition
+      // $FlowFixMe[incompatible-type] Found when updating Promise type definition
       return crawl(crawlerOptions).catch<CrawlResult>(retry).then(logEnd);
     } catch (error) {
       return retry(error).then(logEnd);

package/src/cache/DiskCacheManager.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.DiskCacheManager = void 0;
 var _rootRelativeCacheKeys = _interopRequireDefault(
-  require("../lib/rootRelativeCacheKeys")
+  require("../lib/rootRelativeCacheKeys"),
 );
 var _fs = require("fs");
 var _os = require("os");
@@ -29,12 +29,12 @@ class DiskCacheManager {
   #stopListening;
   constructor(
     { buildParameters },
-    { autoSave = {}, cacheDirectory, cacheFilePrefix }
+    { autoSave = {}, cacheDirectory, cacheFilePrefix },
   ) {
     this.#cachePath = DiskCacheManager.getCacheFilePath(
       buildParameters,
       cacheFilePrefix,
-      cacheDirectory
+      cacheDirectory,
     );
     if (autoSave) {
       const { debounceMs = DEFAULT_AUTO_SAVE_DEBOUNCE_MS } =
@@ -49,9 +49,7 @@ class DiskCacheManager {
     _rootRelativeCacheKeys.default)(buildParameters);
     return _path.default.join(
       cacheDirectory ?? DEFAULT_DIRECTORY,
-      `${
-        cacheFilePrefix ?? DEFAULT_PREFIX
-      }-${rootDirHash}-${relativeConfigHash}`
+      `${cacheFilePrefix ?? DEFAULT_PREFIX}-${rootDirHash}-${relativeConfigHash}`,
     );
   }
   getCacheFilePath() {
@@ -69,7 +67,7 @@ class DiskCacheManager {
   }
   async write(
     getSnapshot,
-    { changedSinceCacheRead, eventSource, onWriteError }
+    { changedSinceCacheRead, eventSource, onWriteError },
   ) {
     const tryWrite = (this.#tryWrite = () => {
       this.#writePromise = this.#writePromise
@@ -81,7 +79,7 @@ class DiskCacheManager {
           this.#hasUnwrittenChanges = false;
           await _fs.promises.writeFile(
             this.#cachePath,
-            (0, _v.serialize)(data)
+            (0, _v.serialize)(data),
           );
           debug("Written cache to %s", this.#cachePath);
         })
@@ -98,7 +96,7 @@ class DiskCacheManager {
         } else {
           this.#debounceTimeout = (0, _timers.setTimeout)(
             () => tryWrite(),
-            autoSave.debounceMs
+            autoSave.debounceMs,
           ).unref();
         }
       });

package/src/cache/DiskCacheManager.js.flow

@@ -24,17 +24,18 @@ import path from 'path';
 import {Timeout, clearTimeout, setTimeout} from 'timers';
 import {deserialize, serialize} from 'v8';
 
+// eslint-disable-next-line import/no-commonjs
 const debug = require('debug')('Metro:FileMapCache');
 
 type AutoSaveOptions = $ReadOnly<{
   debounceMs: number,
 }>;
 
-type DiskCacheConfig = {
+type DiskCacheConfig = $ReadOnly<{
   autoSave?: Partial<AutoSaveOptions> | boolean,
   cacheFilePrefix?: ?string,
   cacheDirectory?: ?string,
-};
+}>;
 
 const DEFAULT_PREFIX = 'metro-file-map';
 const DEFAULT_DIRECTORY = tmpdir();

package/src/constants.js

@@ -2,13 +2,13 @@
 
 const constants = {
   DEPENDENCY_DELIM: "\0",
-  ID: 0,
-  MTIME: 1,
-  SIZE: 2,
-  VISITED: 3,
-  DEPENDENCIES: 4,
-  SHA1: 5,
-  SYMLINK: 6,
+  MTIME: 0,
+  SIZE: 1,
+  VISITED: 2,
+  DEPENDENCIES: 3,
+  SHA1: 4,
+  SYMLINK: 5,
+  ID: 6,
   PATH: 0,
   TYPE: 1,
   MODULE: 0,

package/src/constants.js.flow

@@ -8,6 +8,8 @@
  * @noformat - Flow comment syntax
  */
 
+/* eslint-disable import/no-commonjs */
+
 /*
  * This file exports a set of constants that are used for Jest's haste map
  * serialization. On very large repositories, the haste map cache becomes very
@@ -28,13 +30,13 @@ const constants/*: HType */ = {
   DEPENDENCY_DELIM: '\0',
 
   /* file map attributes */
-  ID: 0,
-  MTIME: 1,
-  SIZE: 2,
-  VISITED: 3,
-  DEPENDENCIES: 4,
-  SHA1: 5,
-  SYMLINK: 6,
+  MTIME: 0,
+  SIZE: 1,
+  VISITED: 2,
+  DEPENDENCIES: 3,
+  SHA1: 4,
+  SYMLINK: 5,
+  ID: 6,
 
   /* module map attributes */
   PATH: 0,

package/src/crawlers/node/index.js

@@ -1,8 +1,12 @@
 "use strict";
 
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.default = nodeCrawl;
 var _RootPathUtils = require("../../lib/RootPathUtils");
 var _hasNativeFindSupport = _interopRequireDefault(
-  require("./hasNativeFindSupport")
+  require("./hasNativeFindSupport"),
 );
 var _child_process = require("child_process");
 var fs = _interopRequireWildcard(require("graceful-fs"));
@@ -29,7 +33,7 @@ function _interopRequireWildcard(e, r) {
       var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
       i && (i.get || i.set) ? Object.defineProperty(n, u, i) : (n[u] = e[u]);
     }
-  return (n.default = e), t && t.set(e, n), n;
+  return ((n.default = e), t && t.set(e, n), n);
 }
 function _interopRequireDefault(e) {
   return e && e.__esModule ? e : { default: e };
@@ -42,7 +46,7 @@ function find(
   includeSymlinks,
   rootDir,
   console,
-  callback
+  callback,
 ) {
   const result = new Map();
   let activeCalls = 0;
@@ -58,9 +62,7 @@ function find(
         activeCalls--;
         if (err) {
           console.warn(
-            `Error "${
-              err.code ?? err.message
-            }" reading contents of "${directory}", skipping. Add this directory to your ignore list to exclude it.`
+            `Error "${err.code ?? err.message}" reading contents of "${directory}", skipping. Add this directory to your ignore list to exclude it.`,
           );
         } else {
           entries.forEach((entry) => {
@@ -82,13 +84,13 @@ function find(
                 const ext = path.extname(file).substr(1);
                 if (stat.isSymbolicLink() || extensions.includes(ext)) {
                   result.set(pathUtils.absoluteToNormal(file), [
-                    "",
                     stat.mtime.getTime(),
                     stat.size,
                     0,
                     "",
                     null,
                     stat.isSymbolicLink() ? 1 : 0,
+                    "",
                   ]);
                 }
               }
@@ -101,7 +103,7 @@ function find(
         if (activeCalls === 0) {
           callback(result);
         }
-      }
+      },
     );
   }
   if (roots.length > 0) {
@@ -117,23 +119,21 @@ function findNative(
   includeSymlinks,
   rootDir,
   console,
-  callback
+  callback,
 ) {
   const extensionClause = extensions.length
     ? `( ${extensions.map((ext) => `-iname *.${ext}`).join(" -o ")} )`
     : "";
-  const expression = `( ( -type f ${extensionClause} ) ${
-    includeSymlinks ? "-o -type l " : ""
-  })`;
+  const expression = `( ( -type f ${extensionClause} ) ${includeSymlinks ? "-o -type l " : ""})`;
   const pathUtils = new _RootPathUtils.RootPathUtils(rootDir);
   const child = (0, _child_process.spawn)(
     "find",
-    roots.concat(expression.split(" "))
+    roots.concat(expression.split(" ")),
   );
   let stdout = "";
   if (child.stdout == null) {
     throw new Error(
-      "stdout is null - this should never happen. Please open up an issue at https://github.com/facebook/metro"
+      "stdout is null - this should never happen. Please open up an issue at https://github.com/facebook/metro",
     );
   }
   child.stdout.setEncoding("utf-8");
@@ -152,13 +152,13 @@ function findNative(
         fs.lstat(path, (err, stat) => {
           if (!err && stat) {
             result.set(pathUtils.absoluteToNormal(path), [
-              "",
               stat.mtime.getTime(),
               stat.size,
               0,
               "",
               null,
               stat.isSymbolicLink() ? 1 : 0,
+              "",
             ]);
           }
           if (--count === 0) {
@@ -169,7 +169,7 @@ function findNative(
     }
   });
 }
-module.exports = async function nodeCrawl(options) {
+async function nodeCrawl(options) {
   const {
     console,
     previousState,
@@ -208,7 +208,7 @@ module.exports = async function nodeCrawl(options) {
         includeSymlinks,
         rootDir,
         console,
-        callback
+        callback,
       );
     } else {
       find(
@@ -218,8 +218,8 @@ module.exports = async function nodeCrawl(options) {
         includeSymlinks,
         rootDir,
         console,
-        callback
+        callback,
       );
     }
   });
-};
+}

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

@@ -24,6 +24,7 @@ import * as fs from 'graceful-fs';
 import {platform} from 'os';
 import * as path from 'path';
 
+// eslint-disable-next-line import/no-commonjs
 const debug = require('debug')('Metro:NodeCrawler');
 
 type Callback = (result: FileData) => void;
@@ -75,13 +76,13 @@ function find(
               const ext = path.extname(file).substr(1);
               if (stat.isSymbolicLink() || extensions.includes(ext)) {
                 result.set(pathUtils.absoluteToNormal(file), [
-                  '',
                   stat.mtime.getTime(),
                   stat.size,
                   0,
                   '',
                   null,
                   stat.isSymbolicLink() ? 1 : 0,
+                  '',
                 ]);
               }
             }
@@ -153,13 +154,13 @@ function findNative(
         fs.lstat(path, (err, stat) => {
           if (!err && stat) {
             result.set(pathUtils.absoluteToNormal(path), [
-              '',
               stat.mtime.getTime(),
               stat.size,
               0,
               '',
               null,
               stat.isSymbolicLink() ? 1 : 0,
+              '',
             ]);
           }
           if (--count === 0) {
@@ -171,7 +172,7 @@ function findNative(
   });
 }
 
-module.exports = async function nodeCrawl(options: CrawlerOptions): Promise<{
+export default async function nodeCrawl(options: CrawlerOptions): Promise<{
   removedFiles: Set<CanonicalPath>,
   changedFiles: FileData,
 }> {
@@ -235,4 +236,4 @@ module.exports = async function nodeCrawl(options: CrawlerOptions): Promise<{
       );
     }
   });
-};
+}

package/src/crawlers/watchman/index.js

@@ -1,13 +1,18 @@
 "use strict";
 
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.default = watchmanCrawl;
 var _normalizePathSeparatorsToPosix = _interopRequireDefault(
-  require("../../lib/normalizePathSeparatorsToPosix")
+  require("../../lib/normalizePathSeparatorsToPosix"),
 );
 var _normalizePathSeparatorsToSystem = _interopRequireDefault(
-  require("../../lib/normalizePathSeparatorsToSystem")
+  require("../../lib/normalizePathSeparatorsToSystem"),
 );
 var _RootPathUtils = require("../../lib/RootPathUtils");
 var _planQuery = require("./planQuery");
+var _fbWatchman = _interopRequireDefault(require("fb-watchman"));
 var _invariant = _interopRequireDefault(require("invariant"));
 var path = _interopRequireWildcard(require("path"));
 var _perf_hooks = require("perf_hooks");
@@ -32,12 +37,11 @@ function _interopRequireWildcard(e, r) {
       var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
       i && (i.get || i.set) ? Object.defineProperty(n, u, i) : (n[u] = e[u]);
     }
-  return (n.default = e), t && t.set(e, n), n;
+  return ((n.default = e), t && t.set(e, n), n);
 }
 function _interopRequireDefault(e) {
   return e && e.__esModule ? e : { default: e };
 }
-const watchman = require("fb-watchman");
 const WATCHMAN_WARNING_INITIAL_DELAY_MILLISECONDS = 10000;
 const WATCHMAN_WARNING_INTERVAL_MILLISECONDS = 20000;
 const watchmanURL = "https://facebook.github.io/watchman/docs/troubleshooting";
@@ -47,7 +51,7 @@ function makeWatchmanError(error) {
     `is running for this project. See ${watchmanURL}.`;
   return error;
 }
-module.exports = async function watchmanCrawl({
+async function watchmanCrawl({
   abortSignal,
   computeSha1,
   extensions,
@@ -60,7 +64,7 @@ module.exports = async function watchmanCrawl({
   roots,
 }) {
   abortSignal?.throwIfAborted();
-  const client = new watchman.Client();
+  const client = new _fbWatchman.default.Client();
   const pathUtils = new _RootPathUtils.RootPathUtils(rootDir);
   abortSignal?.addEventListener("abort", () => client.end());
   perfLogger?.point("watchmanCrawl_start");
@@ -84,14 +88,14 @@ module.exports = async function watchmanCrawl({
       logWatchmanWaitMessage();
       intervalOrTimeoutId = setInterval(
         logWatchmanWaitMessage,
-        WATCHMAN_WARNING_INTERVAL_MILLISECONDS
+        WATCHMAN_WARNING_INTERVAL_MILLISECONDS,
       );
     }, WATCHMAN_WARNING_INITIAL_DELAY_MILLISECONDS);
     try {
       const response = await new Promise((resolve, reject) =>
         client.command([command, ...args], (error, result) =>
-          error ? reject(makeWatchmanError(error)) : resolve(result)
-        )
+          error ? reject(makeWatchmanError(error)) : resolve(result),
+        ),
       );
       if ("warning" in response) {
         onStatus({
@@ -127,7 +131,7 @@ module.exports = async function watchmanCrawl({
             watchmanRoots.set(response.watch, {
               watcher: response.watcher,
               directoryFilters: (existing?.directoryFilters || []).concat(
-                response.relative_path
+                response.relative_path,
               ),
             });
           } else {
@@ -137,7 +141,7 @@ module.exports = async function watchmanCrawl({
             });
           }
         }
-      })
+      }),
     );
     perfLogger?.point("watchmanCrawl/getWatchmanRoots_end");
     return watchmanRoots;
@@ -153,10 +157,10 @@ module.exports = async function watchmanCrawl({
             (0, _normalizePathSeparatorsToPosix.default)(
               pathUtils.absoluteToNormal(
                 (0, _normalizePathSeparatorsToSystem.default)(
-                  posixSeparatedRoot
-                )
-              )
-            )
+                  posixSeparatedRoot,
+                ),
+              ),
+            ),
           );
           perfLogger?.annotate({
             bool: {
@@ -185,8 +189,8 @@ module.exports = async function watchmanCrawl({
             isFresh = isFresh || response.is_fresh_instance;
           }
           results.set(posixSeparatedRoot, response);
-        }
-      )
+        },
+      ),
     );
     perfLogger?.point("watchmanCrawl/queryWatchmanForDirs_end");
     return {
@@ -238,7 +242,9 @@ module.exports = async function watchmanCrawl({
     const relativeFsRoot = pathUtils.absoluteToNormal(fsRoot);
     newClocks.set(
       (0, _normalizePathSeparatorsToPosix.default)(relativeFsRoot),
-      typeof response.clock === "string" ? response.clock : response.clock.clock
+      typeof response.clock === "string"
+        ? response.clock
+        : response.clock.clock,
     );
     for (const fileData of response.files) {
       const filePath =
@@ -254,7 +260,7 @@ module.exports = async function watchmanCrawl({
         const { mtime_ms, size } = fileData;
         (0, _invariant.default)(
           mtime_ms != null && size != null,
-          "missing file data in watchman response"
+          "missing file data in watchman response",
         );
         const mtime =
           typeof mtime_ms === "number" ? mtime_ms : mtime_ms.toNumber();
@@ -266,7 +272,7 @@ module.exports = async function watchmanCrawl({
         if (fileData.type === "l") {
           symlinkInfo = fileData["symlink_target"] ?? 1;
         }
-        const nextData = ["", mtime, size, 0, "", sha1hex ?? null, symlinkInfo];
+        const nextData = [mtime, size, 0, "", sha1hex ?? null, symlinkInfo, ""];
         if (isFresh) {
           freshFileData.set(relativeFilePath, nextData);
         } else {
@@ -287,4 +293,4 @@ module.exports = async function watchmanCrawl({
     removedFiles,
     clocks: newClocks,
   };
-};
+}

package/src/crawlers/watchman/index.js.flow

@@ -24,12 +24,11 @@ import normalizePathSeparatorsToPosix from '../../lib/normalizePathSeparatorsToP
 import normalizePathSeparatorsToSystem from '../../lib/normalizePathSeparatorsToSystem';
 import {RootPathUtils} from '../../lib/RootPathUtils';
 import {planQuery} from './planQuery';
+import watchman from 'fb-watchman';
 import invariant from 'invariant';
 import * as path from 'path';
 import {performance} from 'perf_hooks';
 
-const watchman = require('fb-watchman');
-
 type WatchmanRoots = Map<
   string, // Posix-separated absolute path
   $ReadOnly<{directoryFilters: Array<string>, watcher: string}>,
@@ -47,7 +46,7 @@ function makeWatchmanError(error: Error): Error {
   return error;
 }
 
-module.exports = async function watchmanCrawl({
+export default async function watchmanCrawl({
   abortSignal,
   computeSha1,
   extensions,
@@ -103,7 +102,7 @@ module.exports = async function watchmanCrawl({
     try {
       const response = await new Promise<WatchmanQueryResponse>(
         (resolve, reject) =>
-          // $FlowFixMe[incompatible-call] - dynamic call of command
+          // $FlowFixMe[incompatible-type] - dynamic call of command
           client.command(
             [command, ...args],
             (error: ?Error, result: WatchmanQueryResponse) =>
@@ -117,10 +116,10 @@ module.exports = async function watchmanCrawl({
           command,
         });
       }
-      // $FlowFixMe[incompatible-return]
+      // $FlowFixMe[incompatible-type]
       return response;
     } finally {
-      // $FlowFixMe[incompatible-call] clearInterval / clearTimeout are interchangeable
+      // $FlowFixMe[incompatible-type] clearInterval / clearTimeout are interchangeable
       clearInterval(intervalOrTimeoutId);
       if (didLogWatchmanWaitMessage) {
         onStatus({
@@ -334,13 +333,13 @@ module.exports = async function watchmanCrawl({
         }
 
         const nextData: FileMetadata = [
-          '',
           mtime,
           size,
           0,
           '',
           sha1hex ?? null,
           symlinkInfo,
+          '',
         ];
 
         // If watchman is fresh, the removed files map starts with all files
@@ -367,4 +366,4 @@ module.exports = async function watchmanCrawl({
     removedFiles,
     clocks: newClocks,
   };
-};
+}