This repository has been archived by the owner on Jan 20, 2022. It is now read-only.
Do not ERESOLVE on peerOptionals not added to tree #227
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
ruyadorno
reviewed
Feb 11, 2021
| "optional": false, | ||
| "path": "{CWD}/test/fixtures/peer-optional-eresolve/a/node_modules/@isaacs/testing-peer-optional-conflict-a-x", | ||
| "peer": false, | ||
| "realpath": "{CWD}/test/fixtures/peer-optional-eresolve/a/node_modules/@isaacs/testing-peer-optional-conflict-a-x", |
There was a problem hiding this comment.
heads up, looks like cleanSnapshot is failing to clean {CWD} in all windows ci targets
There was a problem hiding this comment.
Yeah, I missed something there. Gotta get that fixed before landing, might be a real issue.
nlf
reviewed
Feb 11, 2021
test/arborist/build-ideal-tree.js
Outdated
| for (const c of cases) { | ||
| t.test(`case ${c}`, async t => { | ||
| const path = resolve(base, c) | ||
| t.matchSnapshot(await buildIdeal(path)) |
There was a problem hiding this comment.
Suggested change
| t.matchSnapshot(await buildIdeal(path)) | |
| t.matchSnapshot(await printIdeal(path)) |
There was a problem hiding this comment.
ahhhh, right, because the print does the cleanup. Thanks!
isaacs
force-pushed
the
isaacs/fix-peer-optional-eresolve
branch
from
6e4824e
to
2f8dc90
Compare
For these dependency graphs:
# case a
root -> (x, y@1)
x -> PEEROPTIONAL(z)
z -> PEER(y@2)
# case b
root -> (x) PEEROPTIONAL(y@1)
x -> PEEROPTIONAL(y@2)
# case c
root -> (x) PEEROPTIONAL(y@1)
x -> PEER(z)
z -> PEEROPTIONAL(y@2)
The peerOptional dependency is included in the peerSet, which would
raise an ERESOLVE conflict at the peerSet generation stage, even though
the peerOptional dependencies will not actually be added to the tree.
To address this, this commit tracks the nodes which are actually
required in the peerSet generation phase, by virtue of being
non-optionally depended upon by a required node in the peerSet.
If a conflict occurs on a node which is not in the required set during
the peerSet generation phase, we ignore it in much the same way that we
would ignore peerSet errors in metadependencies or when --force is used.
Of course, if the peerOptional dependency is _actually_ required, to
avoid a conflict with an invalid resolution present in the tree already,
and there is no suitable placement for it, then ERESOLVE will still be
raised.
Fix: #223
Fix: npm/cli#2667
PR-URL: #227
Credit: @isaacs
Close: #227
Reviewed-by: @ruyadorno
isaacs
force-pushed
the
isaacs/fix-peer-optional-eresolve
branch
from
2f8dc90
to
f375873
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Based on #225, land that first.
For these dependency graphs:
The peerOptional dependency is included in the peerSet, which would
raise an ERESOLVE conflict at the peerSet generation stage, even though
the peerOptional dependencies will not actually be added to the tree.
To address this, this commit tracks the nodes which are actually
required in the peerSet generation phase, by virtue of being
non-optionally depended upon by a required node in the peerSet.
If a conflict occurs on a node which is not in the required set during
the peerSet generation phase, we ignore it in much the same way that we
would ignore peerSet errors in metadependencies or when --force is used.
Of course, if the peerOptional dependency is actually required, to
avoid a conflict with an invalid resolution present in the tree already,
and there is no suitable placement for it, then ERESOLVE will still be
raised.
Fix: #223
Fix: npm/cli#2667