feat(NODE-6304): Add CSOT support for non-tailable cursors

[W-A-James]

Description

What is changing?

Operations (direct user-facing changes)

• Added support for timeoutMS and timeoutMode to all cursor-creating Collection and Db methods.

Cursors

AbstractCursor

• Added support for timeoutMS and timeoutMode options to all AbstractCursor
• Created CursorInitializeOptions type and updated AbstractCursor._initialize to take this type as its options. Updated overrides of this type to match this signature and utilize the new options.
• Added protected timeoutContext property to AbstractCursor that is constructed inside AbstractCursor.cursorInit()
• Added CSOT timeout logic to AbstractCursor.next(), AbstractCursor.tryNext() and AbstractCursor.hasNext()
• Added optional timeoutMS argument to AbstractCursor.close and added CSOT timeout logic to AbstractCursor.cleanup
• Added optional timeoutMS argument to AbstractCursor.cleanup
• Added logic to omit maxTimeMS field on getMore when CSOT is enabled

AggregationCursor

• Added logic to throw if $out or $merge stages are provided to an AggregationCursor with timeoutMode: ITERATION

ChangeStreamCursor (note, this implementation is not complete. Will be finished in NODE-6305)

• Updated _initialize to make use of aformentioned CursorInitializeOptions

FindCursor

• Updated _initialize to make use of aformentioned CursorInitializeOptions

ListCollectionsCursor

• Updated _initialize to make use of aformentioned CursorInitializeOptions

ListIndexesCursor

• Updated _initialize to make use of aformentioned CursorInitializeOptions

RunCommandCursor

• Updated _initialize to make use of aformentioned CursorInitializeOptions

Timeout and TimeoutContext

• Added TimeoutContext.refresh() method to reset active timeouts for cursor iteration and reuse a TimeoutContext
• Added TimeoutContext.clear() method to clear active timeouts associated with a TimeoutContext

Testing

• Implemented and skipped CSOT Prose Test 5 (will be unskipped in NODE-6305)
• Synced CSOT spec tests to be up-to-date with latest tests
• Unskipped CSOT non-tailable cursor tests, as well as other CSOT tests (see changes for details)
• Updated CSOT spec test skip logic to keep better track of which tests are skipped and where they will be addressed
• Added integration tests to ensure that ITERATION and CURSOR_LIFETIME modes work correctly for non-tailable cursors
• Updated UTR to ensure timeoutMode and timeoutMS options are passed through for runCursorCommand
• Added unit test for AggregationCursor to ensure that $out and $merge helpers throw if in ITERATION mode

Is there new documentation needed for these changes?

What is the motivation for this change?

Release Highlight

Fill in title or leave empty for no 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

[nbbeeken]

LGTM