feat(NODE-5396): add mongodb-js/saslprep as a required dependency
#3815
Conversation
This file contains hidden or 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
Co-authored-by: Durran Jordan <[email protected]> Co-authored-by: Neal Beeken <[email protected]>
addaleax
previously approved these changes
Aug 15, 2023
nbbeeken
requested changes
Aug 15, 2023
nbbeeken
added
the
Primary Review
nbbeeken
approved these changes
Aug 15, 2023
nbbeeken
added
Team Review
orgads
pushed a commit
to orgads/node-mongodb-native
that referenced
this pull request
Aug 22, 2023
…ongodb#3815) (cherry picked from commit bd031fc)
orgads
pushed a commit
to orgads/node-mongodb-native
that referenced
this pull request
Aug 22, 2023
…ongodb#3815) (cherry picked from commit bd031fc)
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.
What is changing?
We no longer use the third-party
saslpreppackage in favor of mongodb-js/saslprep (which can be bundled). We also madesaslprepa required dependency and it will now always be installed.Is there new documentation needed for these changes?
No.
What is the motivation for this change?
mongodb-js/saslprepcan be bundledRelease Highlight
mongodb-js/saslprepis now installed by defaultUntil v6, the driver included the
saslpreppackage as an optional dependency for SCRAM-SHA-256 authentication.saslprepbreaks when bundled with webpack because it attempted to read a file relative to the package location and consequently the driver would throw errors when using SCRAM-SHA-256 if it were bundled.The driver now depends on
mongodb-js/saslprep, a fork ofsaslprepthat can be bundled with webpack because it includes the necessary saslprep data in memory upon loading. This will be installed by default but will only be used if SCRAM-SHA-256 authentication is used.Double check the following
npm run check:lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript