Fix symlinked packages not respecting package.json redirections #1349
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
TreeFS.hierarchicalLookup is a recently introduced function for finding closest package.json for an input path. It works by traversing to the input path while "collecting ancestors" - i.e. all of the directory nodes on route to the input path, and then checking each of them in reverse order for package.json. This gets a bit complicated when traversal includes symlinks. For the test case in this commit: - `n_m/workspace/link-to-pkg` is a symlink to '../workspace-pkg'. - When resolving the package scope of `n_m/workspace/link-to-pkg/subpath`, we should check: - `n_m/workspace/link-to-pkg` (realpath: `../workspace-pkg`) - `n_m/workspace` (realpath: `n_m/workspace`) In particular, when traversing to `../workspace-pkg`, we should *not* collect `..` but we *should* collect `../workspace-pkg`. We attempt to do this by keeping track of an `unseenPathFromIdx`, which lets us skip ancestor collection when we're traversing from the root to the symlink target. The logic here was effectively off-by-one - we were correctly skipping segments before the symlink target, and correctly collecting segments after, but we missed the symlink target itself. By setting `unseenPathFromIdx` to the index of the start of the target's basename, we include it correctly. Fixes #1347 ``` - **[Fix]**: Fix #1347, failure during resolution to read package.json of symlinked workspace packages for exports or redirects. ``` Test plan: - New unit test - Verified e2e by patching metro-file-map in user's repro
facebook-github-bot
added
the
CLA Signed
|
@robhogan has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
robhogan
added a commit
that referenced
this pull request
Sep 8, 2024
Summary: `TreeFS.hierarchicalLookup` is a recently introduced function for finding closest package.json for an input path. It works by traversing to the input path while "collecting ancestors" - i.e. all of the directory nodes on route to the input path, and then checking each of them in reverse order for package.json. This gets a bit complicated when traversal includes symlinks. For the test case in this commit: - `n_m/workspace/link-to-pkg` is a symlink to '../workspace-pkg'. - When resolving the package scope of `n_m/workspace/link-to-pkg/subpath`, we should check: - `n_m/workspace/link-to-pkg` (realpath: `../workspace-pkg`) - `n_m/workspace` (realpath: `n_m/workspace`) In particular, when traversing to `../workspace-pkg`, we should *not* collect `..` but we *should* collect `../workspace-pkg`. We attempt to do this by keeping track of an `unseenPathFromIdx`, which lets us skip ancestor collection when we're traversing from the root to the symlink target. The logic here was effectively off-by-one - we were correctly skipping segments before the symlink target, and correctly collecting segments after, but we missed the symlink target itself. By setting `unseenPathFromIdx` to the index of the start of the target's basename, we include it correctly. Fixes #1347 Changelog: ``` - **[Fix]**: Fix #1347, symlinked packages not respecting package.json redirections. ``` Pull Request resolved: #1349 Test Plan: - New unit test - Verified e2e by patching metro-file-map in user's repro in #1347 Reviewed By: cortinico Differential Revision: D62343439 Pulled By: robhogan fbshipit-source-id: a823601daeffdc8dfd5b5bc3987b75889d44588f
robhogan
added a commit
that referenced
this pull request
Sep 8, 2024
Summary: `TreeFS.hierarchicalLookup` is a recently introduced function for finding closest package.json for an input path. It works by traversing to the input path while "collecting ancestors" - i.e. all of the directory nodes on route to the input path, and then checking each of them in reverse order for package.json. This gets a bit complicated when traversal includes symlinks. For the test case in this commit: - `n_m/workspace/link-to-pkg` is a symlink to '../workspace-pkg'. - When resolving the package scope of `n_m/workspace/link-to-pkg/subpath`, we should check: - `n_m/workspace/link-to-pkg` (realpath: `../workspace-pkg`) - `n_m/workspace` (realpath: `n_m/workspace`) In particular, when traversing to `../workspace-pkg`, we should *not* collect `..` but we *should* collect `../workspace-pkg`. We attempt to do this by keeping track of an `unseenPathFromIdx`, which lets us skip ancestor collection when we're traversing from the root to the symlink target. The logic here was effectively off-by-one - we were correctly skipping segments before the symlink target, and correctly collecting segments after, but we missed the symlink target itself. By setting `unseenPathFromIdx` to the index of the start of the target's basename, we include it correctly. Fixes #1347 Changelog: ``` - **[Fix]**: Fix #1347, symlinked packages not respecting package.json redirections. ``` Pull Request resolved: #1349 Test Plan: - New unit test - Verified e2e by patching metro-file-map in user's repro in #1347 Reviewed By: cortinico Differential Revision: D62343439 Pulled By: robhogan fbshipit-source-id: a823601daeffdc8dfd5b5bc3987b75889d44588f
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
TreeFS.hierarchicalLookupis a recently introduced function for finding closest package.json for an input path.It works by traversing to the input path while "collecting ancestors" - i.e. all of the directory nodes on route to the input path, and then checking each of them in reverse order for package.json.
This gets a bit complicated when traversal includes symlinks. For the test case in this commit:
n_m/workspace/link-to-pkgis a symlink to '../workspace-pkg'.n_m/workspace/link-to-pkg/subpath, we should check:n_m/workspace/link-to-pkg(realpath:../workspace-pkg)n_m/workspace(realpath:n_m/workspace)In particular, when traversing to
../workspace-pkg, we should not collect..but we should collect../workspace-pkg.We attempt to do this by keeping track of an
unseenPathFromIdx, which lets us skip ancestor collection when we're traversing from the root to the symlink target.The logic here was effectively off-by-one - we were correctly skipping segments before the symlink target, and correctly collecting segments after, but we missed the symlink target itself.
By setting
unseenPathFromIdxto the index of the start of the target's basename, we include it correctly.Fixes #1347
Changelog:
Test plan
Test plan: