Add Async.await() for non-blocking condition waiting #2751
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
cretz
reviewed
Jan 5, 2026
| * expired, or exceptionally with CanceledFailure if the enclosing CancellationScope is | ||
| * canceled | ||
| */ | ||
| Promise<Boolean> awaitAsync(Duration timeout, Supplier<Boolean> unblockCondition); |
Member
There was a problem hiding this comment.
Will defer to Java SDK reviewers for PR in general, but I wonder if as part of this review we also need to think about an overload that provides a summary to the timer this creates. Also applies to await and part of me wonders if we can reuse reason in await as timer summary, and add reason here. Or if we should just have an overload of both await and awaitAsync that accepts timer options.
Member
Author
There was a problem hiding this comment.
Added timerSummary to await
Introduces Async.await() methods that return a Promise instead of blocking, allowing workflows to wait for conditions asynchronously. This enables concurrent condition waiting and Promise composition with anyOf/allOf. Key changes: - Add Async.await(Supplier<Boolean>) returning Promise<Void> - Add Async.await(Duration, Supplier<Boolean>) returning Promise<Boolean> - Implement condition watchers in SyncWorkflowContext evaluated via beforeThreadsWakeUp callback in DeterministicRunner - Support cancellation through CancellationScope - Add comprehensive tests including chaining, anyOf/allOf, and cancellation
- Add testTimedAsyncAwaitCancellation: verifies cancellation of the timed Async.await(Duration, Supplier) variant via CancellationScope - Add testAsyncAwaitConditionThrows: verifies that exceptions thrown by conditions during subsequent evaluations complete the promise exceptionally
Link Workflow.sleep, Workflow.newTimer, Workflow.await, and Async.await in Javadoc to help developers discover blocking vs non-blocking alternatives.
…it() Add overloads for await methods that accept AwaitOptions, allowing users to specify a timer summary that appears in the workflow history UI/CLI. - Add AwaitOptions class with timerSummary field - Add Async.await(Duration, AwaitOptions, Supplier) for non-blocking waits - Add Workflow.await(Duration, AwaitOptions, Supplier) for blocking waits - Add test validating timer summary is set in workflow history
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.
Summary
Async.await(Supplier<Boolean>)andAsync.await(Duration, Supplier<Boolean>)methods for non-blocking condition waiting that return aPromise@seeJavadoc tags betweenWorkflow.sleep,Workflow.newTimer,Workflow.await, andAsync.awaitto help developers discover blocking vs non-blocking alternativesTest plan
Async.await()with immediate condition satisfactionAsync.await()with timeout expiration