feat: add ResettableTimer for simplified timer management #1467
+265
−0
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
Marpond
requested review from
3vilhamster,
Groxx,
demirkayaender,
dkrotx,
jakobht,
shijiesheng and
taylanisikdemir
as code owners
jakobht
reviewed
Nov 3, 2025
|
|
||
| // NewResettableTimer creates a new resettable timer that fires after duration d. | ||
| // The timer can be reset using Reset() to restart the countdown. | ||
| func NewResettableTimer(ctx Context, d time.Duration) ResettableTimer { |
There was a problem hiding this comment.
We should return a struct, generally we want to return structs and accept interfaces. This makes backwards compatability easier
| err := f.Get(ctx, nil) | ||
| s.NoError(err) | ||
| timerFired = true | ||
| }).Select(ctx) |
There was a problem hiding this comment.
Nit: we could check that 5 seconds actually passed (the cadence workflow test framework mocks time, so it should be fine)
| // Reset - Cancels the current timer and starts a new one with the given duration. | ||
| // If duration is not provided, uses the previous duration. | ||
| // If the timer has already fired, Reset has no effect. | ||
| Reset(d ...time.Duration) |
There was a problem hiding this comment.
We should not take a list if we want 0 or 1, I suggest just always taking the reset interval.
Suggested change
| Reset(d ...time.Duration) | |
| Reset(d time.Duration) |
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.
What changed?
Introduces an abstraction of resetting timers via
ResettableTimerin workflows.Why?
Simplifies common timer patterns where timers need to be updated or extended. Previously, we had to manually cancel the existing timer context, handle
CanceledError, and create a new timer. WithResettableTimer, a singleReset()call handles this automatically.How did you test it?
Added workflow unit tests to ensure functional correctness and deterministic replay behavior.
Potential risks
Low risk. Does not alter current timer behavior, only adds a user-friendly interface built on existing timer primitives.