GODRIVER-2495 Undeprecate legacy timeouts. #1026
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kevinAlbs
approved these changes
Jul 19, 2022
mongo/options/aggregateoptions.go
Outdated
| // Deprecated: This option is deprecated and will eventually be removed in version 2.0 of the driver. The more general | ||
| // Timeout option should be used in its place to control the amount of time that the Aggregate operation can run before | ||
| // returning an error. MaxTime is still usable through the deprecated setter. | ||
| // NOTE(benjirewis): The use of MaxTime is discouraged. The more general Timeout option should be used in its place |
There was a problem hiding this comment.
Suggested change
| // NOTE(benjirewis): The use of MaxTime is discouraged. The more general Timeout option should be used in its place | |
| // NOTE(benjirewis): MaxTime will be deprecated in a future release. The more general Timeout option may be used in its place |
Until Timeout is documented as stable, I do not think users should be discouraged from using other timeouts. The behavior of Timeout is subject to change.
benjirewis
added a commit
that referenced
this pull request
Jul 19, 2022
Uses NOTEs to suggest that users use Timeout instead of legacy timeout options as opposed to deprecating legacy timeout options.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GODRIVER-2495
Changes
Deprecated:notices for legacy timeouts toNOTEsections suggesting usingTimeoutin place of the given legacy timeout option.Deprecating legacy timeout options with the addition of
TimeouttoClientOptionshas left some users with static analysis failures (deprecation warnings) and no stable alternative (asTimeoutis still provisional API). We should wait until CSOT is more stable before doing GODRIVER-2342.