Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(NODE-5398): use mongodb-js/saslprep instead of saslprep #3820

Merged
merged 1 commit into from
Aug 17, 2023
Merged

Conversation

baileympearson
Copy link
Contributor

@baileympearson baileympearson commented Aug 16, 2023

Description

What is changing?

@mongodb-js/saslprep has replaced saslprep as the optional dependency our driver users on for SCRAM-SHA-256 authentication.

Is there new documentation needed for these changes?

What is the motivation for this change?

Release Highlight

mongodb-js/saslprep is now installed by default

Until v6, 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 of saslprep 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

  • Ran npm run check:lint script
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@durran durran changed the title deps(NODE-5398): use mongodb-js/saslprep instead of saslprep feat(NODE-5398): use mongodb-js/saslprep instead of saslprep Aug 17, 2023
@durran durran self-assigned this Aug 17, 2023
@durran durran added the Team Review Needs review from team label Aug 17, 2023
@durran durran merged commit 5244711 into 4.x Aug 17, 2023
2 of 5 checks passed
@durran durran deleted the NODE-5398 branch August 17, 2023 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team Review Needs review from team
Projects
None yet
2 participants