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-6446): deprecate legacy timeout options #4279

Merged
merged 13 commits into from
Oct 25, 2024
Merged

Conversation

W-A-James
Copy link
Contributor

@W-A-James W-A-James commented Oct 15, 2024

Description

What is changing?

  • Mark socketTimeoutMS as deprecated
  • Mark waitQueueTimeotuMS as deprecated
  • Mark maxTimeMS and associated setter methods as deprecated
  • Add logic to prefer timeoutMS over wTimeoutMS
  • Conditionally apply explain timeout validation
Is there new documentation needed for these changes?

What is the motivation for this change?

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
    …ver selection

@W-A-James
Copy link
Contributor Author

Blocking on #4284

@W-A-James W-A-James added the Blocked Blocked on other work label Oct 17, 2024
@dariakp dariakp added wip and removed Blocked Blocked on other work labels Oct 21, 2024
@W-A-James W-A-James changed the title feat(NODE-3914): deprecate legacy timeout options feat(NODE-6446): deprecate legacy timeout options Oct 22, 2024
@W-A-James W-A-James marked this pull request as ready for review October 22, 2024 21:27
@W-A-James W-A-James removed the wip label Oct 22, 2024
Comment on lines 69 to 70
/** Specify a time limit to prevent write operations from blocking indefinitely
* @deprecated Will be removed in the next major version. Please use timeoutMS */
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's use the expectDeprecated helper in tsd to assert none of these get undeprecated and it will help us find them all later. It helps if we refactor the way we declare the options but we preserve these docs and info.

@nbbeeken nbbeeken self-assigned this Oct 23, 2024
@nbbeeken nbbeeken added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Oct 23, 2024
@W-A-James W-A-James requested a review from nbbeeken October 24, 2024 14:31
@W-A-James W-A-James requested a review from nbbeeken October 24, 2024 21:55
@nbbeeken nbbeeken merged commit 2e65cb9 into NODE-6090 Oct 25, 2024
21 of 27 checks passed
@nbbeeken nbbeeken deleted the NODE-3914 branch October 25, 2024 18:18
nbbeeken added a commit that referenced this pull request Nov 1, 2024
nbbeeken added a commit that referenced this pull request Nov 5, 2024
dariakp pushed a commit that referenced this pull request Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Primary Review In Review with primary reviewer, not yet ready for team's eyes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants