fix(NODE-6067): make topology descriptions JSON stringifiable #4076
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?
5.x backport of #4070.
Is there new documentation needed for these changes?
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