Annotate async expectations with awaitNotRequired - #2700
Open
natebosch wants to merge 1 commit into
Open
Conversation
Closes #2139 Asynchronous expectations which return a `Future` already use `TestHandle.current.markPending()` so that test cases are not considered complete until after the expectations are complete. Some uses will want to `await` anyway to maintain execution order in tests, but it's valid to "fire and forget" asynchronous expectations when execution order doesn't matter. Annotate with `@awaitNotRequired` so this is explicit and the `unawaited_futures` lint is suppressed at call sites.
PR HealthChangelog Entry ✔️
Changes to files need to be accounted for in their respective changelogs. This check can be disabled by tagging the PR with |
jakemac53
approved these changes
Jul 20, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #2139
Asynchronous expectations which return a
Futurealready useTestHandle.current.markPending()so that test cases are not consideredcomplete until after the expectations are complete. Some uses will want
to
awaitanyway to maintain execution order in tests, but it's validto "fire and forget" asynchronous expectations when execution order
doesn't matter. Annotate with
@awaitNotRequiredso this is explicitand the
unawaited_futureslint is suppressed at call sites.