fix(NODE-5225): concurrent MongoClient.close() calls each attempt to close the client #4376
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
baileympearson
added
the
Primary Review
baileympearson
requested changes
Jan 23, 2025
aditi-khare-mongoDB
changed the title
baileympearson
requested changes
Jan 28, 2025
baileympearson
added
Team Review
aditi-khare-mongoDB
force-pushed
the
NODE-5225/close-lock
branch
from
28eeda3 to
b9a588b
Compare
aditi-khare-mongoDB
changed the title
baileympearson
approved these changes
Jan 29, 2025
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
Previously, concurrent calls to
client.close()would throw an error.What is changing?
This PR introduces a locking mechanism on
client.close(). TheIs there new documentation needed for these changes?
No.
What is the motivation for this change?
User submitted bug: NODE-5225
Release Highlight
MongoClient.close() can be called concurrently
In the past, concurrent calls to
MongoClient.close()had poorly defined behavior depending on the exact timing of the second (or more) calls to close(). In some cases, this could also throw errors.With these changes, MongoClient.close() can be called concurrently safely and always return the same promise.
Note
This is intended as a correctness fix - we don't recommend calling MongoClient.close() concurrently if it can be avoided.
Double check the following
npm run check:lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript