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

fix(NODE-5641): BsonVersionError improve message clarity #630

Merged
merged 1 commit into from
Sep 19, 2023

Conversation

nbbeeken
Copy link
Contributor

Description

What is changing?

  • Change BSONVersionError to say MAJOR.x.x instead of MAJOR.0 or later
Is there new documentation needed for these changes?

No

What is the motivation for this change?

Release Highlight

Clarify BSONVersionError message

Previously our BSONVersionError when thrown stated that the "bson type must be from 5.0 or later" our intention is to prevent cross major bson types from reaching the serialization logic as breaking changes to the types could lead to silent incompatibilities in the serialization process. We've updated the message to make that intention clear: "bson types must be from bson 5.x.x"

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

@nbbeeken nbbeeken marked this pull request as ready for review September 18, 2023 15:38
@durran durran self-assigned this Sep 19, 2023
@durran durran added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Sep 19, 2023
@durran durran merged commit d1ca218 into 5.x Sep 19, 2023
3 checks passed
@durran durran deleted the NODE-5641-bson-version-message branch September 19, 2023 14:21
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
2 participants