metro 0.77.0 → 0.78.0

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

@@ -43,7 +43,14 @@ class ModuleResolver {
     if (!emptyModule) {
       emptyModule = this.resolveDependency(
         this._projectRootFakeModule,
-        this._options.emptyModulePath,
+        {
+          name: this._options.emptyModulePath,
+          data: {
+            key: this._options.emptyModulePath,
+            asyncType: null,
+            locs: [],
+          },
+        },
         false,
         null,
         /* resolverOptions */ {}
@@ -54,7 +61,7 @@ class ModuleResolver {
   }
   resolveDependency(
     fromModule,
-    moduleName,
+    dependency,
     allowHaste,
     platform,
     resolverOptions
@@ -77,34 +84,37 @@ class ModuleResolver {
     } = this._options;
     try {
       const result = Resolver.resolve(
-        createDefaultContext({
-          allowHaste,
-          assetExts,
-          disableHierarchicalLookup,
-          doesFileExist,
-          extraNodeModules,
-          mainFields,
-          nodeModulesPaths,
-          preferNativePlatform,
-          resolveAsset,
-          resolveRequest,
-          sourceExts,
-          unstable_conditionNames,
-          unstable_conditionsByPlatform,
-          unstable_enablePackageExports,
-          unstable_getRealPath,
-          unstable_logWarning: this._logWarning,
-          customResolverOptions: resolverOptions.customResolverOptions ?? {},
-          originModulePath: fromModule.path,
-          resolveHasteModule: (name) =>
-            this._options.getHasteModulePath(name, platform),
-          resolveHastePackage: (name) =>
-            this._options.getHastePackagePath(name, platform),
-          getPackage: this._getPackage,
-          getPackageForModule: (modulePath) =>
-            this._getPackageForModule(fromModule, modulePath),
-        }),
-        moduleName,
+        createDefaultContext(
+          {
+            allowHaste,
+            assetExts,
+            disableHierarchicalLookup,
+            doesFileExist,
+            extraNodeModules,
+            mainFields,
+            nodeModulesPaths,
+            preferNativePlatform,
+            resolveAsset,
+            resolveRequest,
+            sourceExts,
+            unstable_conditionNames,
+            unstable_conditionsByPlatform,
+            unstable_enablePackageExports,
+            unstable_getRealPath,
+            unstable_logWarning: this._logWarning,
+            customResolverOptions: resolverOptions.customResolverOptions ?? {},
+            originModulePath: fromModule.path,
+            resolveHasteModule: (name) =>
+              this._options.getHasteModulePath(name, platform),
+            resolveHastePackage: (name) =>
+              this._options.getHastePackagePath(name, platform),
+            getPackage: this._getPackage,
+            getPackageForModule: (modulePath) =>
+              this._getPackageForModule(fromModule, modulePath),
+          },
+          dependency
+        ),
+        dependency.name,
         platform
       );
       return this._getFileResolvedModule(result);
@@ -113,7 +123,7 @@ class ModuleResolver {
         const { candidates } = error;
         throw new UnableToResolveError(
           fromModule.path,
-          moduleName,
+          dependency.name,
           [
             "\n\nNone of these files exist:",
             `  * ${Resolver.formatFileCandidates(
@@ -125,6 +135,7 @@ class ModuleResolver {
           ].join("\n"),
           {
             cause: error,
+            dependency,
           }
         );
       }
@@ -138,13 +149,16 @@ class ModuleResolver {
         const hint = displayDirPaths.length ? " or in these directories:" : "";
         throw new UnableToResolveError(
           fromModule.path,
-          moduleName,
+          dependency.name,
           [
-            `${moduleName} could not be found within the project${hint || "."}`,
+            `${dependency.name} could not be found within the project${
+              hint || "."
+            }`,
             ...displayDirPaths.map((dirPath) => `  ${dirPath}`),
           ].join("\n"),
           {
             cause: error,
+            dependency,
           }
         );
       }
@@ -245,7 +259,7 @@ class UnableToResolveError extends Error {
     super();
     this.originModulePath = originModulePath;
     this.targetModuleName = targetModuleName;
-    const codeFrameMessage = this.buildCodeFrameMessage();
+    const codeFrameMessage = this.buildCodeFrameMessage(options?.dependency);
     this.message =
       util.format(
         "Unable to resolve module %s from %s: %s",
@@ -255,7 +269,7 @@ class UnableToResolveError extends Error {
       ) + (codeFrameMessage ? "\n" + codeFrameMessage : "");
     this.cause = options?.cause;
   }
-  buildCodeFrameMessage() {
+  buildCodeFrameMessage(dependency) {
     let file;
     try {
       file = fs.readFileSync(this.originModulePath, "utf8");
@@ -269,31 +283,104 @@ class UnableToResolveError extends Error {
       }
       throw error;
     }
-    const lines = file.split("\n");
-    let lineNumber = 0;
-    let column = -1;
-    for (let line = 0; line < lines.length; line++) {
-      const columnLocation = lines[line].lastIndexOf(this.targetModuleName);
-      if (columnLocation >= 0) {
-        lineNumber = line;
-        column = columnLocation;
-        break;
-      }
-    }
+    const location = dependency?.data.locs.length
+      ? refineDependencyLocation(
+          dependency.data.locs[0],
+          file,
+          this.targetModuleName
+        )
+      : // TODO: Ultimately we shouldn't ever have to guess the location.
+        guessDependencyLocation(file, this.targetModuleName);
     return codeFrameColumns(
       fs.readFileSync(this.originModulePath, "utf8"),
-      {
-        start: {
-          column: column + 1,
-          line: lineNumber + 1,
-        },
-      },
+      location,
       {
         forceColor: process.env.NODE_ENV !== "test",
       }
     );
   }
 }
+
+// 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;
+    const minColumn = line === loc.start.line ? loc.start.column - 1 : 0;
+    const lineStr = lines[line];
+    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 = lineSlice.lastIndexOf(targetSpecifier, offset - 1)
+    ) {
+      const maybeQuoteBefore = lineSlice[minColumn + offset - 1];
+      const maybeQuoteAfter =
+        lineStr[minColumn + offset + targetSpecifier.length];
+      if (isQuote(maybeQuoteBefore) && maybeQuoteBefore === maybeQuoteAfter) {
+        return {
+          start: {
+            line: line + 1,
+            column: minColumn + offset + 1,
+          },
+        };
+      }
+    }
+  }
+  // Otherwise, if this is a single-line loc, return it exactly, as a range.
+  if (loc.start.line === loc.end.line) {
+    return {
+      start: {
+        line: loc.start.line,
+        column: loc.start.column + 1,
+      },
+      end: {
+        line: loc.end.line,
+        column: loc.end.column + 1,
+      },
+    };
+  }
+  // Otherwise, point to the first column of the loc, to avoid including too
+  // much unnecessary context.
+  return {
+    start: {
+      line: loc.start.line,
+      column: loc.start.column + 1,
+    },
+  };
+}
+function guessDependencyLocation(fileContents, targetSpecifier) {
+  const lines = fileContents.split("\n");
+  let lineNumber = 0;
+  let column = -1;
+  for (let line = 0; line < lines.length; line++) {
+    const columnLocation = lines[line].lastIndexOf(targetSpecifier);
+    if (columnLocation >= 0) {
+      lineNumber = line;
+      column = columnLocation;
+      break;
+    }
+  }
+  return {
+    start: {
+      column: column + 1,
+      line: lineNumber + 1,
+    },
+  };
+}
+function isQuote(str) {
+  return str === '"' || str === "'" || str === "`";
+}
 module.exports = {
   ModuleResolver,
   UnableToResolveError,

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

@@ -29,7 +29,10 @@ const Resolver = require('metro-resolver');
 const createDefaultContext = require('metro-resolver/src/createDefaultContext');
 const path = require('path');
 const util = require('util');
-import type {BundlerResolution} from '../../DeltaBundler/types.flow';
+import type {
+  BundlerResolution,
+  TransformResultDependency,
+} from '../../DeltaBundler/types.flow';
 import type {Reporter} from '../../lib/reporting';
 
 export type DirExistsFn = (filePath: string) => boolean;
@@ -107,7 +110,14 @@ class ModuleResolver<TPackage: Packageish> {
     if (!emptyModule) {
       emptyModule = this.resolveDependency(
         this._projectRootFakeModule,
-        this._options.emptyModulePath,
+        {
+          name: this._options.emptyModulePath,
+          data: {
+            key: this._options.emptyModulePath,
+            asyncType: null,
+            locs: [],
+          },
+        },
         false,
         null,
         /* resolverOptions */ {},
@@ -119,7 +129,7 @@ class ModuleResolver<TPackage: Packageish> {
 
   resolveDependency(
     fromModule: Moduleish,
-    moduleName: string,
+    dependency: TransformResultDependency,
     allowHaste: boolean,
     platform: string | null,
     resolverOptions: ResolverInputOptions,
@@ -143,34 +153,37 @@ class ModuleResolver<TPackage: Packageish> {
 
     try {
       const result = Resolver.resolve(
-        createDefaultContext({
-          allowHaste,
-          assetExts,
-          disableHierarchicalLookup,
-          doesFileExist,
-          extraNodeModules,
-          mainFields,
-          nodeModulesPaths,
-          preferNativePlatform,
-          resolveAsset,
-          resolveRequest,
-          sourceExts,
-          unstable_conditionNames,
-          unstable_conditionsByPlatform,
-          unstable_enablePackageExports,
-          unstable_getRealPath,
-          unstable_logWarning: this._logWarning,
-          customResolverOptions: resolverOptions.customResolverOptions ?? {},
-          originModulePath: fromModule.path,
-          resolveHasteModule: (name: string) =>
-            this._options.getHasteModulePath(name, platform),
-          resolveHastePackage: (name: string) =>
-            this._options.getHastePackagePath(name, platform),
-          getPackage: this._getPackage,
-          getPackageForModule: (modulePath: string) =>
-            this._getPackageForModule(fromModule, modulePath),
-        }),
-        moduleName,
+        createDefaultContext(
+          {
+            allowHaste,
+            assetExts,
+            disableHierarchicalLookup,
+            doesFileExist,
+            extraNodeModules,
+            mainFields,
+            nodeModulesPaths,
+            preferNativePlatform,
+            resolveAsset,
+            resolveRequest,
+            sourceExts,
+            unstable_conditionNames,
+            unstable_conditionsByPlatform,
+            unstable_enablePackageExports,
+            unstable_getRealPath,
+            unstable_logWarning: this._logWarning,
+            customResolverOptions: resolverOptions.customResolverOptions ?? {},
+            originModulePath: fromModule.path,
+            resolveHasteModule: (name: string) =>
+              this._options.getHasteModulePath(name, platform),
+            resolveHastePackage: (name: string) =>
+              this._options.getHastePackagePath(name, platform),
+            getPackage: this._getPackage,
+            getPackageForModule: (modulePath: string) =>
+              this._getPackageForModule(fromModule, modulePath),
+          },
+          dependency,
+        ),
+        dependency.name,
         platform,
       );
       return this._getFileResolvedModule(result);
@@ -179,7 +192,7 @@ class ModuleResolver<TPackage: Packageish> {
         const {candidates} = error;
         throw new UnableToResolveError(
           fromModule.path,
-          moduleName,
+          dependency.name,
           [
             '\n\nNone of these files exist:',
             `  * ${Resolver.formatFileCandidates(
@@ -191,6 +204,7 @@ class ModuleResolver<TPackage: Packageish> {
           ].join('\n'),
           {
             cause: error,
+            dependency,
           },
         );
       }
@@ -206,13 +220,16 @@ class ModuleResolver<TPackage: Packageish> {
 
         throw new UnableToResolveError(
           fromModule.path,
-          moduleName,
+          dependency.name,
           [
-            `${moduleName} could not be found within the project${hint || '.'}`,
+            `${dependency.name} could not be found within the project${
+              hint || '.'
+            }`,
             ...displayDirPaths.map((dirPath: string) => `  ${dirPath}`),
           ].join('\n'),
           {
             cause: error,
+            dependency,
           },
         );
       }
@@ -324,13 +341,14 @@ class UnableToResolveError extends Error {
     targetModuleName: string,
     message: string,
     options?: $ReadOnly<{
+      dependency?: ?TransformResultDependency,
       cause?: Error,
     }>,
   ) {
     super();
     this.originModulePath = originModulePath;
     this.targetModuleName = targetModuleName;
-    const codeFrameMessage = this.buildCodeFrameMessage();
+    const codeFrameMessage = this.buildCodeFrameMessage(options?.dependency);
     this.message =
       util.format(
         'Unable to resolve module %s from %s: %s',
@@ -342,7 +360,7 @@ class UnableToResolveError extends Error {
     this.cause = options?.cause;
   }
 
-  buildCodeFrameMessage(): ?string {
+  buildCodeFrameMessage(dependency: ?TransformResultDependency): ?string {
     let file;
     try {
       file = fs.readFileSync(this.originModulePath, 'utf8');
@@ -357,28 +375,111 @@ class UnableToResolveError extends Error {
       throw error;
     }
 
-    const lines = file.split('\n');
-    let lineNumber = 0;
-    let column = -1;
-    for (let line = 0; line < lines.length; line++) {
-      const columnLocation = lines[line].lastIndexOf(this.targetModuleName);
-      if (columnLocation >= 0) {
-        lineNumber = line;
-        column = columnLocation;
-        break;
-      }
-    }
-
+    const location = dependency?.data.locs.length
+      ? refineDependencyLocation(
+          dependency.data.locs[0],
+          file,
+          this.targetModuleName,
+        )
+      : // TODO: Ultimately we shouldn't ever have to guess the location.
+        guessDependencyLocation(file, this.targetModuleName);
     return codeFrameColumns(
       fs.readFileSync(this.originModulePath, 'utf8'),
-      {
-        start: {column: column + 1, line: lineNumber + 1},
-      },
+      location,
       {forceColor: process.env.NODE_ENV !== 'test'},
     );
   }
 }
 
+// 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: BabelSourceLocation,
+  fileContents: string,
+  targetSpecifier: string,
+): {
+  start: {column: number, line: number},
+  end?: {column: number, line: number},
+} {
+  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;
+    const minColumn = line === loc.start.line ? loc.start.column - 1 : 0;
+    const lineStr = lines[line];
+    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 = lineSlice.lastIndexOf(targetSpecifier, offset - 1)
+    ) {
+      const maybeQuoteBefore = lineSlice[minColumn + offset - 1];
+      const maybeQuoteAfter =
+        lineStr[minColumn + offset + targetSpecifier.length];
+      if (isQuote(maybeQuoteBefore) && maybeQuoteBefore === maybeQuoteAfter) {
+        return {
+          start: {
+            line: line + 1,
+            column: minColumn + offset + 1,
+          },
+        };
+      }
+    }
+  }
+  // Otherwise, if this is a single-line loc, return it exactly, as a range.
+  if (loc.start.line === loc.end.line) {
+    return {
+      start: {
+        line: loc.start.line,
+        column: loc.start.column + 1,
+      },
+      end: {
+        line: loc.end.line,
+        column: loc.end.column + 1,
+      },
+    };
+  }
+  // Otherwise, point to the first column of the loc, to avoid including too
+  // much unnecessary context.
+  return {
+    start: {
+      line: loc.start.line,
+      column: loc.start.column + 1,
+    },
+  };
+}
+
+function guessDependencyLocation(
+  fileContents: string,
+  targetSpecifier: string,
+) {
+  const lines = fileContents.split('\n');
+  let lineNumber = 0;
+  let column = -1;
+  for (let line = 0; line < lines.length; line++) {
+    const columnLocation = lines[line].lastIndexOf(targetSpecifier);
+    if (columnLocation >= 0) {
+      lineNumber = line;
+      column = columnLocation;
+      break;
+    }
+  }
+  return {
+    start: {column: column + 1, line: lineNumber + 1},
+  };
+}
+
+function isQuote(str: ?string): boolean {
+  return str === '"' || str === "'" || str === '`';
+}
+
 module.exports = {
   ModuleResolver,
   UnableToResolveError,

package/src/node-haste/DependencyGraph.d.ts

@@ -11,7 +11,10 @@
 import {EventEmitter} from 'events';
 import {ConfigT} from 'metro-config';
 import {ResolverInputOptions} from '../shared/types';
-import {BundlerResolution} from '../DeltaBundler/types';
+import {
+  BundlerResolution,
+  TransformResultDependency,
+} from '../DeltaBundler/types';
 
 export default class DependencyGraph extends EventEmitter {
   constructor(
@@ -48,7 +51,7 @@ export default class DependencyGraph extends EventEmitter {
 
   resolveDependency(
     from: string,
-    to: string,
+    to: TransformResultDependency,
     platform: string | null,
     resolverOptions: ResolverInputOptions,
     options: {assumeFlatNodeModules: boolean},

package/src/node-haste/DependencyGraph.js

@@ -239,7 +239,7 @@ class DependencyGraph extends EventEmitter {
   }
   resolveDependency(
     from,
-    to,
+    dependency,
     platform,
     resolverOptions,
     // TODO: Fold assumeFlatNodeModules into resolverOptions and add to graphId
@@ -247,6 +247,7 @@ class DependencyGraph extends EventEmitter {
       assumeFlatNodeModules: false,
     }
   ) {
+    const to = dependency.name;
     const isSensitiveToOriginFolder =
       // Resolution is always relative to the origin folder unless we assume a flat node_modules
       !assumeFlatNodeModules ||
@@ -280,7 +281,7 @@ class DependencyGraph extends EventEmitter {
       try {
         resolution = this._moduleResolver.resolveDependency(
           this._moduleCache.getModule(from),
-          to,
+          dependency,
           true,
           platform,
           resolverOptions

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

@@ -36,7 +36,10 @@ const {InvalidPackageError} = require('metro-resolver');
 const nullthrows = require('nullthrows');
 const path = require('path');
 import type {ResolverInputOptions} from '../shared/types.flow';
-import type {BundlerResolution} from '../DeltaBundler/types.flow';
+import type {
+  BundlerResolution,
+  TransformResultDependency,
+} from '../DeltaBundler/types.flow';
 
 const NULL_PLATFORM = Symbol();
 
@@ -310,7 +313,7 @@ class DependencyGraph extends EventEmitter {
 
   resolveDependency(
     from: string,
-    to: string,
+    dependency: TransformResultDependency,
     platform: string | null,
     resolverOptions: ResolverInputOptions,
 
@@ -319,6 +322,7 @@ class DependencyGraph extends EventEmitter {
       assumeFlatNodeModules: false,
     },
   ): BundlerResolution {
+    const to = dependency.name;
     const isSensitiveToOriginFolder =
       // Resolution is always relative to the origin folder unless we assume a flat node_modules
       !assumeFlatNodeModules ||
@@ -353,7 +357,7 @@ class DependencyGraph extends EventEmitter {
       try {
         resolution = this._moduleResolver.resolveDependency(
           this._moduleCache.getModule(from),
-          to,
+          dependency,
           true,
           platform,
           resolverOptions,

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

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow strict
+ * @flow strict-local
  * @format
  * @oncall react_native
  */