Add TimerOptions to Workflow.sleep and timed Workflow.await - #3109
Open
sangkyoonnam wants to merge 2 commits into
Open
sangkyoonnam wants to merge 2 commits into
sangkyoonnam wants to merge 2 commits into
Conversation
…sleep-await # Conflicts: # CHANGELOG.md
This branch has not been deployed
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
1 participant
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.
What was changed
Workflow.sleep(Duration, TimerOptions)andWorkflow.await(Duration, TimerOptions, Supplier)pass the options to the timer they create, so the timer can carry a summary the waynewTimer(Duration, TimerOptions)already does.WorkflowOutboundCallsInterceptorgets matchingsleepandawaitmethods, with forwarding in its Base andTracingWorkerInterceptorand unsupported-operation stubs inTestActivityEnvironmentInternal, following #2218. The existing overloads still go through the existing interceptor methods, so an interceptor that overrides only those keeps seeing every call it saw before.Why?
#3108. Python and Go already accept a summary here, and temporalio/features#669 tracks it across SDKs.
Breaking changes: interceptors that implement
WorkflowOutboundCallsInterceptordirectly, instead of extending the Base, need the two new methods. The interface is@Experimental, and #2218 did the same fornewTimer.Server PR: none needed.
Checklist
Closes Allow a timer summary on Workflow.sleep and Workflow.await with timeout #3108
How was this tested:
TimerMetadataTestchecks theTimerStartedsummary for a sleep, an await that times out, and an await whose condition is satisfied. The live await tests take theCANCEL_AWAIT_TIMER_ON_CONDITIONbranch, soSyncWorkflowContextTestforces the branch without that flag through a mocked replay context. Each of these fails when its branch drops the options.A replay of
awaitTimerConditionOldBehavior.json, recorded without a summary, passes with a workflow that now sets one; replay matches timer commands by type and ID, not metadata, so this needs no SDK flag.:temporal-sdk:test,:temporal-testing:test, and:temporal-opentracing:testpass locally on JDK 21.Javadoc and CHANGELOG are updated. No other docs.