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-5399): use mongodb-js/saslprep instead of saslprep #3818

Merged
merged 1 commit into from
Aug 17, 2023
Merged

Conversation

baileympearson
Copy link
Contributor

@baileympearson baileympearson commented Aug 15, 2023

Description

What is changing?

@mongodb-js/saslprep has replaced saslprep 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 default

Until 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 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

@baileympearson baileympearson marked this pull request as ready for review August 16, 2023 01:01
Copy link
Contributor

@nbbeeken nbbeeken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes lgtm, can you fill out the release highlight and make this a feat

@nbbeeken nbbeeken self-assigned this Aug 16, 2023
@nbbeeken nbbeeken added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Aug 16, 2023
@baileympearson baileympearson changed the title deps(NODE-5399): use mongodb-js/saslprep instead of saslprep feat(NODE-5399): use mongodb-js/saslprep instead of saslprep Aug 17, 2023
@nbbeeken nbbeeken merged commit c0d3927 into 5.x Aug 17, 2023
@nbbeeken nbbeeken deleted the NODE-5399 branch August 17, 2023 16:53
@Zeng-Jun-Wei
Copy link

Zeng-Jun-Wei commented Aug 23, 2023

image v5.8 has this problem @baileympearson

@Zeng-Jun-Wei
Copy link

image v5.8 has this problem @baileympearson

It seems that v5.8.1 has been solved

@alexbevi
Copy link
Contributor

Hi @ZengJun-cloud, thanks for your comment yesterday, which helped us identify and address this issue quickly and push out a patch release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Primary Review In Review with primary reviewer, not yet ready for team's eyes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants