Skip to content
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

feat(NODE-5678): add options parsing support for timeoutMS and defaultTimeoutMS #4068

Conversation

W-A-James
Copy link
Contributor

@W-A-James W-A-James commented Apr 3, 2024

Description

What is changing?

timeoutMS option changes
  • Add internal timeoutMS field to the following option Interfaces
    • CollectionOptions
    • AbstractCursorOptions
    • DbOptions
    • GridFSBucketReadStreamOptions
    • GridFSBucketOptions
    • GridFSBucketWriteStreamOptions
    • MongoClientOptions
    • MongoOptions
    • OperationOptions
  • Add internal timeoutMS field to ClientSession
  • Add URI options support for timeoutMS
defaultTimeoutMS option changes
  • Add internal defaultTimeoutMS field to ClientSessionOptions
Test changes
  • Pull in uri spec tests from DRIVERS-555
  • Add timeoutMS option support to uri spec runner
  • Add timeoutMS client option tests
  • Add tests confirming expected behaviour of timeoutMS option inheritance
misc improvements
  • Convert 2 test files relevant to this PR to typescript
Is there new documentation needed for these changes?

What is the motivation for this change?

Release 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

@W-A-James W-A-James changed the title convert to typescript feat(NODE-5678): add options parsing support for timeoutMS and defaultTimeoutMS Apr 3, 2024
Comment on lines 37 to 39

/** @internal */
timeoutMS?: number;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applies to all operations, including cursor operations

@W-A-James
Copy link
Contributor Author

NOTE: leaving release highlight blank for this PR as we are not making any of these changes public until CSOT release

@W-A-James W-A-James marked this pull request as ready for review April 5, 2024 19:58
@durran durran self-assigned this Apr 8, 2024
@durran durran added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team Review Needs review from team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants