feat: Add async overloads#1834
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds async delegate overloads for bUnit wait helpers, enabling WaitForStateAsync and WaitForAssertionAsync to await Func<Task<bool>> and Func<Task> checks for async assertion frameworks such as TUnit.
Changes:
- Refactors the shared wait helper pipeline to support awaited checks while preserving synchronous behavior.
- Adds public async predicate/assertion overloads and helper constructors.
- Adds tests and changelog coverage for the new overloads.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
src/bunit/Extensions/WaitForHelpers/WaitForHelper.cs |
Refactors wait execution to a ValueTask-based async pipeline with re-render coalescing. |
src/bunit/Extensions/WaitForHelpers/WaitForStateHelper.cs |
Adds constructor support for async state predicates. |
src/bunit/Extensions/WaitForHelpers/WaitForAssertionHelper.cs |
Adds constructor support for async assertions. |
src/bunit/Extensions/WaitForHelpers/RenderedComponentWaitForHelperExtensions.WaitForState.cs |
Exposes new public async overloads for state predicates and assertions. |
tests/bunit.tests/Extensions/WaitForHelpers/RenderedComponentWaitForHelperExtensions.cs |
Adds coverage for async wait success, timeout, exception, and dispatcher re-entry scenarios. |
CHANGELOG.md |
Documents the new async wait helper overloads under Unreleased. |
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Added |
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="WaitForAssertionHelper{TComponent}"/> class, | ||
| /// which will until the provided asynchronous <paramref name="assertion"/> passes (i.e. does not throw an |
| /// <param name="renderedComponent">The render fragment or component to attempt to verify state against.</param> | ||
| /// <param name="statePredicate">The asynchronous predicate to invoke after each render, which must return <c>true</c> when the desired state has been reached.</param> | ||
| /// <param name="timeout">The maximum time to wait for the desired state.</param> | ||
| /// <exception cref="WaitForFailedException">Thrown if the <paramref name="statePredicate"/> throw an exception during invocation, or if the timeout has been reached. See the inner exception for details.</exception> |
| /// <param name="renderedComponent">The render fragment or component to attempt to verify state against.</param> | ||
| /// <param name="statePredicate">The asynchronous predicate to invoke after each render, which must return <c>true</c> when the desired state has been reached.</param> | ||
| /// <param name="timeout">The maximum time to wait for the desired state.</param> | ||
| /// <exception cref="WaitForFailedException">Thrown if the <paramref name="statePredicate"/> throw an exception during invocation, or if the timeout has been reached. See the inner exception for details.</exception> |
Collaborator
Author
|
@egil Guess you are busy - I'd merge the PR and make a preview release so the person requested can check. As it is a preview version, we can still "revert" or reshape the PR in any fashion that suites us. Hope that is fine for you. In the spirite of: Better sorry than safe ;) |
Member
Yeah it's pretty extreme right now. Thanks for taking charge. |
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
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 #1833