Mark Task.wait() noasync and provide Task.get() #668
Merged
Conversation
This file contains hidden or 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
dnadoba
approved these changes
Feb 13, 2023
|
You need to generate linux tests, otherwise LGTM. |
ktoso
approved these changes
Feb 13, 2023
| /// - throws: The error value of the `EventLoopFuture` if it errors. | ||
| /// - returns: The value of ``futureResult`` when it completes. | ||
| /// - throws: The error value of ``futureResult`` if it errors. | ||
| @available(*, noasync, message: "wait() can block indefinitely, prefer get()", renamed: "get()") |
There was a problem hiding this comment.
You should be able to just #if around the available attribute and avoid the duplicate impl, if you wanted to
There was a problem hiding this comment.
This is a Swift 5.8 feature: https://github.com/apple/swift-evolution/blob/main/proposals/0367-conditional-attributes.md
Motivation Task.wait() is a convenience method to avoid needing to wait for the response future. This has had the effect of "laundering" a noasync warning from EventLoopFuture.wait(), hiding it within a purely sync call that may itself be used in an async context. We should discourage using these and prefer using .get() instead. Modifications Mark Task.wait() noasync. Add Task.get() for backward compatibility. Result Safer migration to Swift concurrency
Lukasa
force-pushed
the
cb-deprecate-task-wait
branch
from
8113707 to
7501e6b
Compare
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.
Motivation
Task.wait() is a convenience method to avoid needing to wait for the response future. This has had the effect of "laundering" a noasync warning from EventLoopFuture.wait(), hiding it within a purely sync call that may itself be used in an async context.
We should discourage using these and prefer using .get() instead.
Modifications
Mark Task.wait() noasync.
Add Task.get() for backward compatibility.
Result
Safer migration to Swift concurrency