-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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-5530): make topology descriptions JSON stringifiable #4070
Merged
Conversation
This file contains 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
nbbeeken
changed the title
fix(node-5530): make topology descriptions JSON stringifiable
fix(NODE-5530): make topology descriptions JSON stringifiable
Apr 5, 2024
aditi-khare-mongoDB
requested changes
Apr 8, 2024
test/integration/server-discovery-and-monitoring/topology_description.test.ts
Show resolved
Hide resolved
aditi-khare-mongoDB
added
the
Primary Review
In Review with primary reviewer, not yet ready for team's eyes
label
Apr 8, 2024
aditi-khare-mongoDB
requested changes
Apr 8, 2024
aditi-khare-mongoDB
approved these changes
Apr 8, 2024
aditi-khare-mongoDB
added
Team Review
Needs review from team
and removed
Primary Review
In Review with primary reviewer, not yet ready for team's eyes
labels
Apr 8, 2024
W-A-James
reviewed
Apr 9, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM but can we have a short release note since this is public facing
aditi-khare-mongoDB
approved these changes
Apr 10, 2024
W-A-James
approved these changes
Apr 10, 2024
baileympearson
added a commit
to baileympearson/node-mongodb-native
that referenced
this pull request
Apr 11, 2024
…b#4070) Co-authored-by: Aditi Khare <106987683+aditi-khare-mongoDB@users.noreply.github.com>
baileympearson
added a commit
to baileympearson/node-mongodb-native
that referenced
this pull request
Apr 15, 2024
…b#4070) Co-authored-by: Aditi Khare <106987683+aditi-khare-mongoDB@users.noreply.github.com>
5 tasks
This was referenced Sep 6, 2024
This was referenced Sep 7, 2024
This was referenced Sep 24, 2024
This was referenced Oct 1, 2024
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.
Description
What is changing?
This is basically entirely invisible to users. However, the TopologyDescription is a field on
MongoServerSelectionError
s, so if a user is calling JSON.stringify on their errors, they will now see theservers
field in the output instead of an empty object.Is there new documentation needed for these changes?
No.
What is the motivation for this change?
Release Highlight
TopologyDescription now properly stringifies itself to JSON
The
TopologyDescription
class is exposed by the driver in server selection errors and topology monitoring events to provide insight into the driver's current representation of the server's topology and to aid in debugging. However, the TopologyDescription usesMap
s internally, which get serialized to{}
when JSON stringified. We recommend using Node'sutil.inspect()
helper to print topology descriptions becauseinspect
properly handles all JS types and all types we use in the driver. However, if JSON must be used, theTopologyDescription
now provides a customtoJSON()
hook:Double check the following
npm run check:lint
scripttype(NODE-xxxx)[!]: description
feat(NODE-1234)!: rewriting everything in coffeescript