Move package-relative path calculation under context.getPackageForModule
#1268
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
|
This pull request was exported from Phabricator. Differential Revision: D56823091 |
Summary: This is a simple relabelling to make clear when resolution-related methods expect *absolute* paths, as opposed to origin-relative, package-relative or bare specifiers that are present under the name `modulePath`. It should make the next diffs a little easier to reason about. Changelog: Internal Differential Revision: D56788884
…dule` (facebook#1268) Summary: During resolution using `package.json#exports` or the `browser` spec, we need package-relative subpaths of resolution candidates to check against these export/redirect maps. Currently, we derive these using (pseudo code): ``` const absolutePathOfPackageRoot = context.getPackageForModule(absolutePathOfCandidate).rootPath; const packageRelativePath = path.relative(absolutePathOfPackageRoot, absolutePathOfCandidate); ``` However, this implicitly assumes that both paths are either real, or traverse the same set of symlinks, so that the former is a prefix of the latter. If `getPackageForModule` returned `rootPath: fs.realpath(packageRoot)`, this assumption would not hold. Eg: if `/workspace-root/pgk-a/foo.js` imports `pkg-b/bar.js`, we will try a candidate `/workspace-root/node_modules/pkg-b/bar.js`, but `node_modles/pkg-b` may be a symlink to `/workspace-root/pkg-b`, and `path.relative(realPackageRoot, candidate)` will give `../node_modules/pkg-b/bar.js`, which will not match against an export map, though it represents the same location on the filesystem. Instead, we move the calculation of `packageRelativePath` inside `getPackageForModule` and close to implementation of the package search, where we know that the `path.relative` call is safe under the current implementation, and allowing an alternative implementation to use an alternative mechanism. This is in preparation for a new implementation of `getClosestPackage`, which currently dominates resolution time, using `FileSystem`, which will natively return only *real* paths. Changelog: Internal Differential Revision: D56823091
robhogan
force-pushed
the
export-D56823091
branch
from
248951b
to
9707689
Compare
|
This pull request was exported from Phabricator. Differential Revision: D56823091 |
|
This pull request has been merged in e303578. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
During resolution using
package.json#exportsor thebrowserspec, we need package-relative subpaths of resolution candidates to check against these export/redirect maps.Currently, we derive these using (pseudo code):
However, this implicitly assumes that both paths are either real, or traverse the same set of symlinks, so that the former is a prefix of the latter. If
getPackageForModulereturnedrootPath: fs.realpath(packageRoot), this assumption would not hold.Eg: if
/workspace-root/pgk-a/foo.jsimportspkg-b/bar.js, we will try a candidate/workspace-root/node_modules/pkg-b/bar.js, butnode_modles/pkg-bmay be a symlink to/workspace-root/pkg-b, andpath.relative(realPackageRoot, candidate)will give../node_modules/pkg-b/bar.js, which will not match against an export map, though it represents the same location on the filesystem.Instead, we move the calculation of
packageRelativePathinsidegetPackageForModuleand close to implementation of the package search, where we know that thepath.relativecall is safe under the current implementation, and allowing an alternative implementation to use an alternative mechanism.This is in preparation for a new implementation of
getClosestPackage, which currently dominates resolution time, usingFileSystem, which will natively return only real paths.Differential Revision: D56823091