install/dedupe: fix hoisting of packages with peerDeps #147
Conversation
Co-Authored-By: sokra <[email protected]>
|
Hi! Thanks for submitting this PR. Me and @iarna are gonna be doing a more thorough review of this tomorrow when we can pair on it. The initial response is that we're pretty sure we've tried this approach before and it broke a different set of people, but we're gonna look at it closely and see if this addresses the other breakage. |
|
Thanks for considering it 😀 |
There was a problem hiding this comment.
Thanks so much for this! Go figure that it'd be such a small patch to resolve this issue. I guess our assumptions about needing that rewrite weren't quite there, though that's coming anyway ;)
One last thing we'd like to see before landing this is a test to verify the behavior, and it looks like you're most of the way there because you have a repro repo, especially one that uses file:. A good way to make a test for this is to clone the repo and call scripts/maketest on it, which will give you a nice test template to work off of.
Thanks again, and let me know if you have any questions! 🎉
lib/install/deps.js
Outdated
| var peerDeps = pkg.peerDependencies | ||
| if (peerDeps) { | ||
| if (Object.keys(peerDeps).some(function (name) { | ||
| return deps[name] || devDeps[name] |
There was a problem hiding this comment.
This should have a check where we only check devDeps if tree.isTop (see the var devDeps ... section just above this one). We think this is otherwise fine and actually a pretty nice patch!
lib/dedupe.js
Outdated
| // child is marked as removed so it's ignored when finding a location | ||
| child.removed = true | ||
| var hoistTo = earliestInstallable(tree, tree, child.package, log) | ||
| child.removed = false |
There was a problem hiding this comment.
I think we'd rather add an argument here than patch a child statefully like this. This otherwise makes sense.
|
@zkat ready for review again |
|
Hi! Do you know which version of npm includes / will include this fix? Thanks! |
fixes https://npm.community/t/packages-with-peerdependencies-are-incorrectly-hoisted/4794
This PR changes
earliestInstallableto respectpeerDependenciesin the package. It hoists packages with peer deps no further than the package containing dependencies on the peer dependencies.It also changes
dedupeto start looking for earliest installable location in the current tree instead of the parent. This ensures that break conditions (whichreturn treeinearliestInstallable) are correctly followed. To avoid finding itself, the package is marked as removed (this could be solved differently with an argument onearliestInstallableto ignore itself).