fix: add optional peer dependencies (yarn2/pnpm) #2606
Merged
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
|
For clarity, |
|
Hi @andreialecu, thanks for your contribution. Unfortunately, for the 3.6.x series we need to continue to support Node Argon so I don't think this approach will work. I just tried it locally, and npm automatically installs all of the peer dependencies which is explicitly what we're trying not to do. Are you unable to use the driver with |
|
Hey @mbroadst, thank you for explaining. I didn't consider the need to support I have simplified the PR to only add the See:
|
andreialecu
changed the title
require_optional and add aws4
Yarn 2 users can use an override mechanism called See: https://yarnpkg.com/getting-started/migration/#fix-dependencies-with-packageextensions |
mbroadst
approved these changes
Nov 5, 2020
There was a problem hiding this comment.
Thanks for the clarification @andreialecu , this looks good to me. Hopefully we'll all be able to move to v4 shortly, where we won't have this issue!
|
Hi Team, sounds like you resolved the issue using I did some up with this. packageExtensions:
"mongodb@*":
dependencies:
bson-ext: "*"
kerberos: "*"
"@mongodb-js/zstd": "*"
aws4: "*"
mongodb-core: "*"
bson: "*"
node-gyp: "*"
"mongodb-client-encryption": "*"
peerDependenciesMeta:
"@mongodb-js/zstd":
optional: true
snappy:
optional: true
bson-ext:
optional: true
kerberos:
optional: trueThis got me past a few errors but now I just get this crazy mess. Notice how it's just trying to load every possible operating systems match for both How has anyone managed to get this library to work with Yarn PnP? Can we please get some examples documentation. I submitted an issue here as this repo doesn't have a issue section? |
This was referenced Sep 25, 2022
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.
Description
It appears that
aws4was being required without being listed as a dependency. This results in errors when using strict package managers such as Yarn 2 (berry) and pnpm.Additionally, it seems a non-standard way of requiring optional modules was being used.All recent package managers support optional peer dependencies using the
peerDependenciesMetafield:npm as of: npm/cli#224
Yarn 1: https://classic.yarnpkg.com/en/docs/package-json#toc-peerdependenciesmeta
Yarn 2: https://yarnpkg.com/configuration/manifest/#peerDependenciesMeta
pnpm: https://pnpm.js.org/en/package_json#peerdependenciesmeta
What changed?
Removedrequire_optionaldependency and used standard optional peer dependency definitions.Added
aws4as an optional peer dependency. See:https://yarnpkg.com/advanced/rulebook/#packages-should-only-ever-require-what-they-formally-list-in-their-dependencies
Are there any files to ignore?
No