feat(NODE-6520): add client side operations timeoutMS #4095

W-A-James · 2024-04-23T20:36:58Z

Description

What is changing?

New Error

Added MongoOperationTimeoutError class that is thrown when a CSOT timeout is encountered

Changes to `Timeout`

Add Timeout.throwIfExpired() method
Add Timeout.remainingTime getter method

Updates to `AbstractOperation`

Add timeout field
- timeout is set at construction if the timeoutMS option is provided

Implementing CSOT behaviour for server selection

Update Topology.selectServer to accept a timeout option which it will use determine whether it has timed out when defined. Otherwise, constructs a Timeout using the serverSelectionMS option as before
Update Topology.selectServer to throw a MongoOperationTimeoutError on timeout when options.timeout is provided and retain previous error behaviour otherwise.
Update Topology._connect to pass down timeout to Server.command call used to execute ping on first connection

Implementing CSOT behaviour for connection checkout

Update Server.command to accept timeout option.
Update ConnectionPool.checkOut to accept timeout option
- only uses the passed in timeout if the configured serverSelectionTimeoutMS is greater than the duration on the timeout, otherwise, computes the time elapsed since server selection completed and creates timeout for the serverSelectionTimeoutMS deadline

Test changes

Implement Server Selection prose tests from CSOT spec. Left out last two since they require implementation of the connection creation cancellation behaviour that was decided against in DRIVERS-2347
Implement unit tests from CSOT spec related to server selection and connection checkout. Skipped tests with appropriate messages

Misc changes

Update resolveOptions to handle timeoutMS option propagation
- Add csotMin helper method that implements the CSOT min algorithm described here

Is there new documentation needed for these changes?

What is the motivation for this change?

Release Highlight

PLACEHOLDER FOR CSOT FEATURE HIGHLIGHT

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

src/cmap/connect.ts

src/cmap/connection.ts

src/cmap/connection_pool.ts

src/error.ts

src/operations/operation.ts

src/timeout.ts

src/admin.ts

W-A-James · 2024-05-03T22:19:43Z

Evergreen link

baileympearson

left some small comments. I'm out this week, so don't consider them blocking!

src/sdam/server.ts

src/operations/operation.ts

src/sdam/topology.ts

src/operations/execute_operation.ts

aditi-khare-mongoDB · 2024-05-06T17:33:07Z

Bookkeeping:
Waiting for Warren to respond to Bailey's comments and will proceed with review then.

src/sdam/topology.ts

test/integration/client-side-operations-timeout/client_side_operations_timeout.unit.test.ts

src/sdam/server.ts

src/sdam/topology.ts

W-A-James · 2024-05-07T20:00:49Z

@aditi-khare-mongoDB @nbbeeken should we conditionally clear the timeout on success/a non-timeout failure based on whether or not we created the timeout inside the function that we race the timeout with?
I ask because we don't always own Timeout instance we're using in Topology.selectServer or in ConnectionPool.checkOut.

src/cmap/connection_pool.ts

…4243) Co-authored-by: Warren James <[email protected]> Co-authored-by: Neal Beeken <[email protected]> Co-authored-by: Bailey Pearson <[email protected]>

…ion (#4273)

Co-authored-by: Warren James <[email protected]>

Co-authored-by: Aditi Khare <[email protected]> Co-authored-by: Daria Pardue <[email protected]>

Co-authored-by: Warren James <[email protected]> Co-authored-by: Neal Beeken <[email protected]> Co-authored-by: Bailey Pearson <[email protected]>

Co-authored-by: Neal Beeken <[email protected]>

…rt 1 (#4281)

… options (#4291)

Co-authored-by: Neal Beeken <[email protected]> Co-authored-by: Aditi Khare <[email protected]>

etc/notes/errors.md

src/client-side-encryption/auto_encrypter.ts

src/collection.ts

src/gridfs/download.ts

src/gridfs/upload.ts

src/sdam/topology.ts

src/sessions.ts

test/unit/index.test.ts

test/unit/operations/get_more.test.ts

… fix internal references (#4315)

dariakp

LGTM pending perf comparison

Everything is addressed

W-A-James force-pushed the NODE-6090 branch 2 times, most recently from 5688ba8 to b878c6c Compare April 26, 2024 23:48