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.

Sign up for GitHub

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

Jump to bottom

feat(NODE-6421): add support for timeoutMS to explain helpers #4268

Merged
merged 4 commits into from
Oct 21, 2024
Merged

feat(NODE-6421): add support for timeoutMS to explain helpers #4268

merged 4 commits into from
Oct 21, 2024

Conversation

baileympearson
Copy link
Contributor

@baileympearson baileympearson commented Oct 8, 2024 •
edited
Loading

Description

What is changing?

Explain helpers now support timeoutMS.

Is there new documentation needed for these changes?

What is the motivation for this change?

Release Highlight

Explain helpers support timeoutMS

Explain helpers support timeoutMS:

await collection.deleteMany({}, { timeoutMS: 1_000, explain: true });
await collection.find().explain(
  { verbosity: 'queryPlanner' },
  { timeoutMS: 1_000 }
)

Note

Providing a maxTimeMS value with a timeoutMS value will throw errors.

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

@baileympearson baileympearson changed the title feat(NODE-6090): Implement CSOT logic for connection checkout and ser… feat(NODE-xxxx): add support for timeoutMS to explain helpers Oct 8, 2024
@baileympearson baileympearson changed the title feat(NODE-xxxx): add support for timeoutMS to explain helpers feat(https://jira.mongodb.org/browse/NODE-6421): add support for timeoutMS to explain helpers Oct 9, 2024
@baileympearson baileympearson changed the title feat(https://jira.mongodb.org/browse/NODE-6421): add support for timeoutMS to explain helpers feat(NODE-6421): add support for timeoutMS to explain helpers Oct 9, 2024
@baileympearson baileympearson force-pushed the NODE-6090 branch 2 times, most recently from 3591368 to a645d9f Compare October 10, 2024 20:40
@baileympearson
Copy link
Contributor Author

evergreen retry

1 similar comment
@baileympearson
Copy link
Contributor Author

evergreen retry

@baileympearson baileympearson marked this pull request as ready for review October 17, 2024 20:50
@durran durran self-assigned this Oct 17, 2024
@durran durran added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Oct 17, 2024
durran
durran requested changes Oct 17, 2024
View reviewed changes
src/cursor/aggregation_cursor.ts Outdated Show resolved Hide resolved
src/cursor/find_cursor.ts Outdated Show resolved Hide resolved
test/tools/runner/config.ts Show resolved Hide resolved
test/integration/crud/explain.test.ts Show resolved Hide resolved
@baileympearson baileympearson requested a review from durran October 18, 2024 14:25
@durran durran added Team Review Needs review from team and removed Primary Review In Review with primary reviewer, not yet ready for team's eyes labels Oct 18, 2024
nbbeeken
nbbeeken reviewed Oct 18, 2024
View reviewed changes
Copy link
Contributor

@nbbeeken nbbeeken left a comment

Choose a reason for hiding this comment

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

bson import small fix, lgtm otherwise

src/explain.ts Outdated Show resolved Hide resolved
@durran durran merged commit d224fff into NODE-6090 Oct 21, 2024
24 of 27 checks passed
@durran durran deleted the explain-csot branch October 21, 2024 11:25
baileympearson added a commit that referenced this pull request Oct 21, 2024
@baileympearson
feat(NODE-6421): add support for timeoutMS to explain helpers (#4268)
c3f31da
baileympearson added a commit that referenced this pull request Oct 21, 2024
@baileympearson
feat(NODE-6421): add support for timeoutMS to explain helpers (#4268)
4fd4b24
nbbeeken pushed a commit that referenced this pull request Nov 1, 2024
@baileympearson @nbbeeken
feat(NODE-6421): add support for timeoutMS to explain helpers (#4268)
8b7f898
nbbeeken pushed a commit that referenced this pull request Nov 5, 2024
@baileympearson @nbbeeken
feat(NODE-6421): add support for timeoutMS to explain helpers (#4268)
583024c
dariakp pushed a commit that referenced this pull request Nov 6, 2024
@baileympearson @dariakp
feat(NODE-6421): add support for timeoutMS to explain helpers (#4268)
5b2629b
@github-actions github-actions bot mentioned this pull request Nov 6, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nbbeeken nbbeeken nbbeeken approved these changes

@durran durran Awaiting requested review from durran

Assignees

@durran durran

Labels
Team Review Needs review from team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@baileympearson @durran @nbbeeken