metro 0.80.4 → 0.80.6

package/src/lib/getPreludeCode.js

@@ -1,14 +1,3 @@
-/**
- * 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";
 
 function getPreludeCode({
@@ -18,8 +7,6 @@ function getPreludeCode({
   requireCycleIgnorePatterns,
 }) {
   const vars = [
-    // Ensure these variable names match the ones referenced in metro-runtime
-    // require.js
     "__BUNDLE_START_TIME__=this.nativePerformanceNow?nativePerformanceNow():Date.now()",
     `__DEV__=${String(isDev)}`,
     ...formatExtraVars(extraVars),
@@ -27,8 +14,6 @@ function getPreludeCode({
     `__METRO_GLOBAL_PREFIX__='${globalPrefix}'`,
   ];
   if (isDev) {
-    // Ensure these variable names match the ones referenced in metro-runtime
-    // require.js
     vars.push(
       `${globalPrefix}__requireCycleIgnorePatterns=[${requireCycleIgnorePatterns
         .map((regex) => regex.toString())
@@ -44,9 +29,6 @@ function formatExtraVars(extraVars) {
   const assignments = [];
   for (const key in extraVars) {
     if (extraVars.hasOwnProperty(key) && !excluded.has(key)) {
-      /* $FlowFixMe(>=0.95.0 site=react_native_fb) This comment suppresses an
-       * error found when Flow v0.95 was deployed. To see the error, delete
-       * this comment and run Flow. */
       assignments.push(`${key}=${JSON.stringify(extraVars[key])}`);
     }
   }

package/src/lib/getPrependedScripts.js

@@ -1,14 +1,3 @@
-/**
- * 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";
 
 var _CountingSet = _interopRequireDefault(require("./CountingSet"));
@@ -26,8 +15,6 @@ async function getPrependedScripts(
   bundler,
   deltaBundler
 ) {
-  // Get all the polyfills from the relevant option params (the
-  // `getPolyfills()` method and the `polyfillModuleNames` variable).
   const polyfillModuleNames = config.serializer
     .getPolyfills({
       platform: options.platform,

package/src/lib/logToConsole.js

@@ -1,15 +1,3 @@
-/**
- * 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
- *
- */
-
-/* eslint-disable no-console */
-
 "use strict";
 
 const chalk = require("chalk");
@@ -29,7 +17,6 @@ module.exports = (terminal, level, mode, ...data) => {
   } else if (level === "groupCollapsed") {
     groupStack.push(level);
     clearTimeout(collapsedGuardTimer);
-    // Inform users that logs get swallowed if they forget to call `groupEnd`.
     collapsedGuardTimer = setTimeout(() => {
       if (groupStack.includes("groupCollapsed")) {
         terminal.log(
@@ -48,7 +35,6 @@ module.exports = (terminal, level, mode, ...data) => {
     return;
   }
   if (!groupStack.includes("groupCollapsed")) {
-    // Remove excess whitespace at the end of a log message, if possible.
     const lastItem = data[data.length - 1];
     if (typeof lastItem === "string") {
       data[data.length - 1] = lastItem.trimEnd();
@@ -58,10 +44,6 @@ module.exports = (terminal, level, mode, ...data) => {
     terminal.log(
       color.bold(` ${modePrefix}${logFunction.toUpperCase()} `) +
         "".padEnd(groupStack.length * 2, " "),
-      // `util.format` actually accepts any arguments.
-      // If the first argument is a string, it tries to format it.
-      // Otherwise, it just concatenates all arguments.
-      // $FlowIssue[incompatible-call] util.format expected the first argument to be a string
       util.format(...data)
     );
   }

package/src/lib/parseCustomResolverOptions.js

@@ -1,14 +1,3 @@
-/**
- * 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";
 
 const nullthrows = require("nullthrows");

package/src/lib/parseCustomTransformOptions.js

@@ -1,14 +1,3 @@
-/**
- * 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";
 
 const nullthrows = require("nullthrows");
@@ -18,7 +7,6 @@ module.exports = function parseCustomTransformOptions(urlObj) {
   const query = nullthrows(urlObj.query);
   Object.keys(query).forEach((key) => {
     if (key.startsWith(PREFIX)) {
-      // $FlowFixMe[prop-missing]
       customTransformOptions[key.substr(PREFIX.length)] = query[key];
     }
   });

package/src/lib/parseOptionsFromUrl.js

@@ -1,14 +1,3 @@
-/**
- * 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";
 
 const parsePlatformFilePath = require("../node-haste/lib/parsePlatformFilePath");
@@ -29,7 +18,7 @@ const getTransformProfile = (transformProfile) =>
     ? transformProfile
     : "default";
 module.exports = function parseOptionsFromUrl(normalizedRequestUrl, platforms) {
-  const parsedURL = nullthrows(url.parse(normalizedRequestUrl, true)); // `true` to parse the query param as an object.
+  const parsedURL = nullthrows(url.parse(normalizedRequestUrl, true));
   const query = nullthrows(parsedURL.query);
   const pathname =
     query.bundleEntry ||
@@ -55,11 +44,6 @@ module.exports = function parseOptionsFromUrl(normalizedRequestUrl, platforms) {
     shallow: getBoolean(query, "shallow", false),
     sourceMapUrl: url.format({
       ...parsedURL,
-      // The Chrome Debugger loads bundles via Blob urls, whose
-      // protocol is blob:http. This breaks loading source maps through
-      // protocol-relative URLs, which is why we must force the HTTP protocol
-      // when loading the bundle for either Android or iOS.
-      // TODO(T167298674): Remove when remote debugging is not needed in React Native
       protocol:
         platform != null && platform.match(/^(android|ios|vr|windows|macos)$/)
           ? "http"

package/src/lib/relativizeSourceMap.js

@@ -1,19 +1,7 @@
-/**
- * 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";
 
 const path = require("path");
 function relativizeSourceMapInline(sourceMap, sourcesRoot) {
-  // eslint-disable-next-line lint/strictly-null
   if (sourceMap.mappings === undefined) {
     for (let i = 0; i < sourceMap.sections.length; i++) {
       relativizeSourceMapInline(sourceMap.sections[i].map, sourcesRoot);

package/src/lib/reporting.js

@@ -1,49 +1,19 @@
-/**
- * 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";
 
 const chalk = require("chalk");
 const stripAnsi = require("strip-ansi");
 const util = require("util");
-/**
- * A standard way to log a warning to the terminal. This should not be called
- * from some arbitrary Metro logic, only from the reporters. Instead of
- * calling this, add a new type of ReportableEvent instead, and implement a
- * proper handler in the reporter(s).
- */
 function logWarning(terminal, format, ...args) {
   const str = util.format(format, ...args);
   terminal.log("%s: %s", chalk.yellow("warning"), str);
 }
-
-/**
- * Similar to `logWarning`, but for messages that require the user to act.
- */
 function logError(terminal, format, ...args) {
   terminal.log(
     "%s: %s",
     chalk.red("error"),
-    // Syntax errors may have colors applied for displaying code frames
-    // in various places outside of where Metro is currently running.
-    // If the current terminal does not support color, we'll strip the colors
-    // here.
     util.format(chalk.supportsColor ? format : stripAnsi(format), ...args)
   );
 }
-
-/**
- * A reporter that does nothing. Errors and warnings will be swallowed, that
- * is generally not what you want.
- */
 const nullReporter = {
   update() {},
 };

package/src/lib/splitBundleOptions.js

@@ -1,19 +1,5 @@
-/**
- * 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";
 
-/**
- * Splits a BundleOptions object into smaller, more manageable parts.
- */
 function splitBundleOptions(options) {
   return {
     entryFile: options.entryFile,

package/src/lib/transformHelpers.js

@@ -1,14 +1,3 @@
-/**
- * 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";
 
 var _contextModuleTemplates = require("./contextModuleTemplates");
@@ -43,10 +32,6 @@ async function calcTransformerOptions(
     platform: options.platform,
     unstable_transformProfile: options.unstable_transformProfile,
   };
-
-  // When we're processing scripts, we don't need to calculate any
-  // inlineRequires information, since scripts by definition don't have
-  // requires().
   if (options.type === "script") {
     return {
       ...baseOptions,
@@ -129,11 +114,6 @@ async function getTransformFn(
     let templateBuffer;
     if (requireContext) {
       const graph = await bundler.getDependencyGraph();
-
-      // TODO: Check delta changes to avoid having to look over all files each time
-      // this is a massive performance boost.
-
-      // Search against all files in a subtree.
       const files = Array.from(
         graph.matchFilesWithContext(requireContext.from, {
           filter: requireContext.filter,

package/src/node-haste/DependencyGraph/ModuleResolution.js

@@ -1,14 +1,3 @@
-/**
- * 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";
 
 const { codeFrameColumns } = require("@babel/code-frame");
@@ -19,10 +8,6 @@ const createDefaultContext = require("metro-resolver/src/createDefaultContext");
 const path = require("path");
 const util = require("util");
 class ModuleResolver {
-  // A module representing the project root, used as the origin when resolving `emptyModulePath`.
-
-  // An empty module, the result of resolving `emptyModulePath` from the project root.
-
   constructor(options) {
     this._options = options;
     const { projectRoot, moduleCache } = this._options;
@@ -53,7 +38,7 @@ class ModuleResolver {
         },
         false,
         null,
-        /* resolverOptions */ {
+        {
           dev: false,
         }
       );
@@ -171,20 +156,14 @@ class ModuleResolver {
   _getPackage = (packageJsonPath) => {
     try {
       return this._options.moduleCache.getPackage(packageJsonPath).read();
-    } catch (e) {
-      // Do nothing. The standard module cache does not trigger any error, but
-      // the ModuleGraph one does, if the module does not exist.
-    }
+    } catch (e) {}
     return null;
   };
   _getPackageForModule = (fromModule, modulePath) => {
     let pkg;
     try {
       pkg = this._options.moduleCache.getPackageOf(modulePath);
-    } catch (e) {
-      // Do nothing. The standard module cache does not trigger any error, but
-      // the ModuleGraph one does, if the module does not exist.
-    }
+    } catch (e) {}
     return pkg != null
       ? {
           rootPath: path.dirname(pkg.path),
@@ -192,17 +171,11 @@ class ModuleResolver {
         }
       : null;
   };
-
-  /**
-   * TODO: Return Resolution instead of coercing to BundlerResolution here
-   */
   _getFileResolvedModule(resolution) {
     switch (resolution.type) {
       case "sourceFile":
         return resolution;
       case "assetFiles":
-        // FIXME: we should forward ALL the paths/metadata,
-        // not just an arbitrary item!
         const arbitrary = getArrayLowestItem(resolution.filePaths);
         invariant(arbitrary != null, "invalid asset resolution");
         return {
@@ -245,19 +218,6 @@ function getArrayLowestItem(a) {
   return lowest;
 }
 class UnableToResolveError extends Error {
-  /**
-   * File path of the module that tried to require a module, ex. `/js/foo.js`.
-   */
-
-  /**
-   * The name of the module that was required, no necessarily a path,
-   * ex. `./bar`, or `invariant`.
-   */
-
-  /**
-   * Original error that causes this error
-   */
-
   constructor(originModulePath, targetModuleName, message, options) {
     super();
     this.originModulePath = originModulePath;
@@ -278,10 +238,6 @@ class UnableToResolveError extends Error {
       file = fs.readFileSync(this.originModulePath, "utf8");
     } catch (error) {
       if (error.code === "ENOENT" || error.code === "EISDIR") {
-        // We're probably dealing with a virtualised file system where
-        // `this.originModulePath` doesn't actually exist on disk.
-        // We can't show a code frame, but there's no need to let this I/O
-        // error shadow the original module resolution error.
         return null;
       }
       throw error;
@@ -292,8 +248,7 @@ class UnableToResolveError extends Error {
           file,
           this.targetModuleName
         )
-      : // TODO: Ultimately we shouldn't ever have to guess the location.
-        guessDependencyLocation(file, this.targetModuleName);
+      : guessDependencyLocation(file, this.targetModuleName);
     return codeFrameColumns(
       fs.readFileSync(this.originModulePath, "utf8"),
       location,
@@ -303,16 +258,8 @@ class UnableToResolveError extends Error {
     );
   }
 }
-
-// Given a source location for an import declaration or `require()` call (etc),
-// return a location for use with @babel/code-frame in the resolution error.
 function refineDependencyLocation(loc, fileContents, targetSpecifier) {
   const lines = fileContents.split("\n");
-  // If we can find the module name in range of the given loc, surrounded by
-  // matching quotes, that's likely our specifier. Point to the first column of
-  // the *last* valid occurrence.
-  // Note that module names may not always be found in the source code verbatim,
-  // whether because of escaping or because of exotic dependency APIs.
   for (let line = loc.end.line - 1; line >= loc.start.line - 1; line--) {
     const maxColumn =
       line === loc.end.line ? loc.end.column + 2 : lines[line].length;
@@ -321,10 +268,7 @@ function refineDependencyLocation(loc, fileContents, targetSpecifier) {
     const lineSlice = lineStr.slice(minColumn, maxColumn);
     for (
       let offset = lineSlice.lastIndexOf(targetSpecifier);
-      offset !== -1 &&
-      // leave room for quotes
-      offset > 0 &&
-      offset < lineSlice.length - 1;
+      offset !== -1 && offset > 0 && offset < lineSlice.length - 1;
       offset = lineSlice.lastIndexOf(targetSpecifier, offset - 1)
     ) {
       const maybeQuoteBefore = lineSlice[minColumn + offset - 1];
@@ -340,7 +284,6 @@ function refineDependencyLocation(loc, fileContents, targetSpecifier) {
       }
     }
   }
-  // Otherwise, if this is a single-line loc, return it exactly, as a range.
   if (loc.start.line === loc.end.line) {
     return {
       start: {
@@ -353,8 +296,6 @@ function refineDependencyLocation(loc, fileContents, targetSpecifier) {
       },
     };
   }
-  // Otherwise, point to the first column of the loc, to avoid including too
-  // much unnecessary context.
   return {
     start: {
       line: loc.start.line,

package/src/node-haste/DependencyGraph/createFileMap.js

@@ -41,24 +41,10 @@ function _interopRequireWildcard(obj, nodeInterop) {
   }
   return newObj;
 }
-/**
- * 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
- */
-
 const ci = require("ci-info");
 function getIgnorePattern(config) {
-  // For now we support both options
   const { blockList, blacklistRE } = config.resolver;
   const ignorePattern = blacklistRE || blockList;
-
-  // If neither option has been set, use default pattern
   if (!ignorePattern) {
     return / ^/;
   }
@@ -81,8 +67,6 @@ function getIgnorePattern(config) {
         .join("|"),
       regexes[0]?.flags ?? ""
     );
-
-  // If ignorePattern is an array, merge it into one
   if (Array.isArray(ignorePattern)) {
     return combine(ignorePattern);
   }

package/src/node-haste/DependencyGraph.js

@@ -1,17 +1,6 @@
 "use strict";
 
 var _metroFileMap = require("metro-file-map");
-/**
- * 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
- */
-
 const createFileMap = require("./DependencyGraph/createFileMap");
 const { ModuleResolver } = require("./DependencyGraph/ModuleResolution");
 const ModuleCache = require("./ModuleCache");
@@ -50,9 +39,6 @@ class DependencyGraph extends EventEmitter {
     const fileMap = createFileMap(config, {
       watch,
     });
-
-    // We can have a lot of graphs listening to Haste for changes.
-    // Bump this up to silence the max listeners EventEmitter warning.
     fileMap.setMaxListeners(1000);
     this._haste = fileMap;
     this._haste.on("status", (status) => this._onWatcherStatus(status));
@@ -86,15 +72,9 @@ class DependencyGraph extends EventEmitter {
       status,
     });
   }
-
-  // Waits for the dependency graph to become ready after initialisation.
-  // Don't read anything from the graph until this resolves.
   async ready() {
     await this._readyPromise;
   }
-
-  // Creates the dependency graph and waits for it to become ready.
-  // @deprecated Use the constructor + ready() directly.
   static async load(config, options) {
     const self = new DependencyGraph(config, options);
     await self.ready();
@@ -105,8 +85,6 @@ class DependencyGraph extends EventEmitter {
     const root = parsedPath.root;
     let dir = path.join(parsedPath.dir, parsedPath.base);
     do {
-      // If we've hit a node_modules directory, the closest package was not
-      // found (`filePath` was likely nonexistent).
       if (path.basename(dir) === "node_modules") {
         return null;
       }
@@ -127,6 +105,10 @@ class DependencyGraph extends EventEmitter {
     this.emit("change");
   }
   _createModuleResolver() {
+    const getRealPathIfFile = (path) => {
+      const result = this._fileSystem.lookup(path);
+      return result.exists && result.type === "f" ? result.realPath : null;
+    };
     this._moduleResolver = new ModuleResolver({
       assetExts: new Set(this._config.resolver.assetExts),
       dirExists: (filePath) => {
@@ -159,9 +141,7 @@ class DependencyGraph extends EventEmitter {
           ),
         ];
         if (this._config.resolver.unstable_enableSymlinks) {
-          assets = assets
-            .map((candidate) => this._fileSystem.getRealPath(candidate))
-            .filter(Boolean);
+          assets = assets.map(getRealPathIfFile).filter(Boolean);
         } else {
           assets = assets.filter((candidate) =>
             this._fileSystem.exists(candidate)
@@ -177,7 +157,7 @@ class DependencyGraph extends EventEmitter {
       unstable_enablePackageExports:
         this._config.resolver.unstable_enablePackageExports,
       unstable_getRealPath: this._config.resolver.unstable_enableSymlinks
-        ? (path) => this._fileSystem.getRealPath(path)
+        ? getRealPathIfFile
         : null,
     });
   }
@@ -190,15 +170,6 @@ class DependencyGraph extends EventEmitter {
     return nullthrows(this._fileSystem).getAllFiles();
   }
   getSha1(filename) {
-    // Prior to unstable_enableSymlinks:
-    // Calling realpath allows us to get a hash for a given path even when
-    // it's a symlink to a file, which prevents Metro from crashing in such a
-    // case. However, it doesn't allow Metro to track changes to the target file
-    // of the symlink. We should fix this by implementing a symlink map into
-    // Metro (or maybe by implementing those "extra transformation sources" we've
-    // been talking about for stuff like CSS or WASM).
-    //
-    // This is unnecessary with a symlink-aware fileSystem implementation.
     const resolvedPath = this._config.resolver.unstable_enableSymlinks
       ? filename
       : fs.realpathSync(filename);
@@ -215,11 +186,8 @@ class DependencyGraph extends EventEmitter {
     return this._haste;
   }
   end() {
-    // $FlowFixMe[unused-promise]
     this._haste.end();
   }
-
-  /** Given a search context, return a list of file paths matching the query. */
   matchFilesWithContext(from, context) {
     return this._fileSystem.matchFiles({
       rootDir: from,
@@ -234,30 +202,22 @@ class DependencyGraph extends EventEmitter {
     dependency,
     platform,
     resolverOptions,
-    // TODO: Fold assumeFlatNodeModules into resolverOptions and add to graphId
     { assumeFlatNodeModules } = {
       assumeFlatNodeModules: false,
     }
   ) {
     const to = dependency.name;
     const isSensitiveToOriginFolder =
-      // Resolution is always relative to the origin folder unless we assume a flat node_modules
       !assumeFlatNodeModules ||
-      // Path requests are resolved relative to the origin folder
       to.includes("/") ||
       to === "." ||
       to === ".." ||
-      // Preserve standard assumptions under node_modules
       from.includes(path.sep + "node_modules" + path.sep);
-
-    // Compound key for the resolver cache
     const resolverOptionsKey =
       JSON.stringify(resolverOptions ?? {}, canonicalize) ?? "";
     const originKey = isSensitiveToOriginFolder ? path.dirname(from) : "";
     const targetKey = to;
     const platformKey = platform ?? NULL_PLATFORM;
-
-    // Traverse the resolver cache, which is a tree of maps
     const mapByResolverOptions = this._resolutionCache;
     const mapByOrigin = getOrCreateMap(
       mapByResolverOptions,

package/src/node-haste/DependencyGraph.js.flow

@@ -180,6 +180,11 @@ class DependencyGraph extends EventEmitter {
   }
 
   _createModuleResolver() {
+    const getRealPathIfFile = (path: string) => {
+      const result = this._fileSystem.lookup(path);
+      return result.exists && result.type === 'f' ? result.realPath : null;
+    };
+
     this._moduleResolver = new ModuleResolver({
       assetExts: new Set(this._config.resolver.assetExts),
       dirExists: (filePath: string) => {
@@ -213,9 +218,7 @@ class DependencyGraph extends EventEmitter {
         ];
 
         if (this._config.resolver.unstable_enableSymlinks) {
-          assets = assets
-            .map(candidate => this._fileSystem.getRealPath(candidate))
-            .filter(Boolean);
+          assets = assets.map(getRealPathIfFile).filter(Boolean);
         } else {
           assets = assets.filter(candidate =>
             this._fileSystem.exists(candidate),
@@ -232,7 +235,7 @@ class DependencyGraph extends EventEmitter {
       unstable_enablePackageExports:
         this._config.resolver.unstable_enablePackageExports,
       unstable_getRealPath: this._config.resolver.unstable_enableSymlinks
-        ? path => this._fileSystem.getRealPath(path)
+        ? getRealPathIfFile
         : null,
     });
   }