fix(npm): improve peer dependency resolution with circular dependencies #18069
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
dsherret
commented
Mar 7, 2023
| nv: Arc<NpmPackageNv>, | ||
| /// Descendants in the path that circularly link to an ancestor in a child.These | ||
| /// descendants should be kept up to date and always point to this node. | ||
| linked_circular_descendants: Mutex<Vec<Arc<GraphPath>>>, |
There was a problem hiding this comment.
This is the new concept here. We keep track of descendants that have this ancestor as a child.
| @@ -1329,40 1465,30 @@ mod test { | |||
| assert_eq!( | |||
| packages, | |||
| vec![ | |||
| NpmResolutionPackage { | |||
| pkg_id: NpmPackageId::from_serialized("[email protected]").unwrap(), | |||
| TestNpmResolutionPackage { | |||
There was a problem hiding this comment.
Below this point is mostly updates to use a new less verbose struct for testing. At the bottom of this file and line 3124 there are some new tests. I have commented where those are.
| @@ -3377,6 3120,100 @@ mod test { | |||
| ); | |||
| } | |||
|
|
|||
| #[tokio::test] | |||
| async fn resolve_peer_deps_in_ancestor_root() { | |||
There was a problem hiding this comment.
Nice, these indeed look tricky
| @@ -3614,10 3411,254 @@ mod test { | |||
| ); | |||
| } | |||
|
|
|||
| #[tokio::test] | |||
There was a problem hiding this comment.
New tests here and below.
dsherret
commented
Mar 7, 2023
| std::env::var("DENO_UNSTABLE_NPM_SYNC_DOWNLOAD").is_ok() | ||
| // this gets called a lot when doing npm resolution and was taking | ||
| // a significant amount of time, so cache it in a lazy | ||
| *SHOULD_SYNC_DOWNLOAD |
There was a problem hiding this comment.
Before: 8.6% of execution -- After: 0%
bartlomieju
reviewed
Mar 8, 2023
|
|
||
| if !found_peer { | ||
| found_peer = !self.graph.borrow_node_mut(child_id).no_peers; | ||
| // cache all the dependencies' registry infos in parallel if should |
There was a problem hiding this comment.
This comment makes no sense :(
There was a problem hiding this comment.
I'm not sure how to reword this because it's saying what the next line does
bartlomieju
reviewed
Mar 8, 2023
Comment on lines
3478
to
3479
| // a -> b -> c -> d -> c where c has a peer dependency on b | ||
| // -> e -> f -> d -> c where f has a peer dep on a |
bartlomieju
approved these changes
Mar 8, 2023
kt3k
pushed a commit
that referenced
this pull request
Mar 10, 2023
…es (#18069) This improves peer dependency resolution yet again. We did not handle scenarios like the following: ``` // a -> b -> c -> d -> c -> b (peer) ``` ...which would maybe work ok the first time its run in some cases, but then lead to a lockfile that would error on load. This now keeps track of circular dependencies and updates nodes accordingly. That said, there is still a lurking bug in this code somewhere that I've added a comment for (there is a mitigation on the tail end that seems to work well). The current state is much better than before and I can look into it later. I think it's something small that's incorrect.
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.
This improves peer dependency resolution yet again. We did not handle scenarios like the following:
...which would maybe work ok the first time its run in some cases, but then lead to a lockfile that would error on load.
This now keeps track of circular dependencies and updates nodes accordingly. That said, there is still a lurking bug in this code somewhere that I've added a comment for (there is a mitigation on the tail end that seems to work well). The current state is much better than before and I can look into it later. I think it's something small that's incorrect.