feat(NODE-5399): use mongodb-js/saslprep instead of saslprep #3818
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
What is changing?
@mongodb-js/saslprep
has replacedsaslprep
as the optional dependency our driver users on for SCRAM-SHA-256 authentication.All existing passing tests are passing. The failures for FLE are unrelated (they also are failing on
5.x
).Is there new documentation needed for these changes?
What is the motivation for this change?
Release Highlight
mongodb-js/saslprep
is now installed by defaultUntil this release, the driver included the
saslprep
package as an optional dependency for SCRAM-SHA-256 authentication.saslprep
breaks 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 ofsaslprep
that 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:lint
scripttype(NODE-xxxx)[!]: description
feat(NODE-1234)!: rewriting everything in coffeescript