-
Notifications
You must be signed in to change notification settings - Fork 228
Feat: Add jitterfactor to retry policy #1687
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
javier-aliaga
wants to merge
8
commits into
dapr:master
from
javier-aliaga:add-jitterfactor-retry-activity
Closed
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
170663b
fix: MaxRetryInterval was not propagate
javier-aliaga 215de45
feat: Add jitter to retryPolicy
javier-aliaga eef0bbf
chore: Tests
javier-aliaga a062651
Merge branch 'master' into add-jitterfactor-retry-activity
javier-aliaga 987919e
chore: Fix review comments
javier-aliaga e4c3cb3
Apply suggestions from code review
javier-aliaga f499659
chore: Nextdelay must be greater than 0
javier-aliaga 399d05d
Merge branch 'master' into add-jitterfactor-retry-activity
javier-aliaga File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
151 changes: 151 additions & 0 deletions
151
durabletask-client/src/test/java/io/dapr/durabletask/RetryPolicyTest.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| /* | ||
| * Copyright 2026 The Dapr Authors | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package io.dapr.durabletask; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.time.Duration; | ||
| import java.util.Random; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.*; | ||
|
|
||
| public class RetryPolicyTest { | ||
|
|
||
| // ---- default value ---- | ||
|
|
||
| @Test | ||
| void jitterFactorDefaultsToZero() { | ||
| RetryPolicy policy = new RetryPolicy(3, Duration.ofSeconds(1)); | ||
| assertEquals(0.0, policy.getJitterFactor()); | ||
| } | ||
|
|
||
| // ---- valid boundary values ---- | ||
|
|
||
| @Test | ||
| void jitterFactorZeroIsAccepted() { | ||
| RetryPolicy policy = new RetryPolicy(3, Duration.ofSeconds(1)); | ||
| RetryPolicy returned = policy.setJitterFactor(0.0); | ||
| assertEquals(0.0, policy.getJitterFactor()); | ||
| assertSame(policy, returned, "setJitterFactor should return this for chaining"); | ||
| } | ||
|
|
||
| @Test | ||
| void jitterFactorOneIsAccepted() { | ||
| RetryPolicy policy = new RetryPolicy(3, Duration.ofSeconds(1)); | ||
| policy.setJitterFactor(1.0); | ||
| assertEquals(1.0, policy.getJitterFactor()); | ||
| } | ||
|
|
||
| @Test | ||
| void jitterFactorMidRangeIsAccepted() { | ||
| RetryPolicy policy = new RetryPolicy(3, Duration.ofSeconds(1)); | ||
| policy.setJitterFactor(0.5); | ||
| assertEquals(0.5, policy.getJitterFactor()); | ||
| } | ||
|
|
||
| // ---- invalid values ---- | ||
|
|
||
| @Test | ||
| void jitterFactorBelowZeroThrows() { | ||
| RetryPolicy policy = new RetryPolicy(3, Duration.ofSeconds(1)); | ||
| assertThrows(IllegalArgumentException.class, () -> policy.setJitterFactor(-0.1)); | ||
| } | ||
|
|
||
| @Test | ||
| void jitterFactorAboveOneThrows() { | ||
| RetryPolicy policy = new RetryPolicy(3, Duration.ofSeconds(1)); | ||
| assertThrows(IllegalArgumentException.class, () -> policy.setJitterFactor(1.1)); | ||
| } | ||
|
|
||
| @Test | ||
| void jitterFactorNaNThrows() { | ||
| RetryPolicy policy = new RetryPolicy(3, Duration.ofSeconds(1)); | ||
| assertThrows(IllegalArgumentException.class, () -> policy.setJitterFactor(Double.NaN)); | ||
| } | ||
|
|
||
| @Test | ||
| void jitterFactorPositiveInfinityThrows() { | ||
| RetryPolicy policy = new RetryPolicy(3, Duration.ofSeconds(1)); | ||
| assertThrows(IllegalArgumentException.class, () -> policy.setJitterFactor(Double.POSITIVE_INFINITY)); | ||
| } | ||
|
|
||
| // ---- deterministic delay formula ---- | ||
|
|
||
| /** | ||
| * Verifies that the jitter reduction formula is deterministic: given the same | ||
| * firstAttempt epoch millis and attempt number (which together form the seed), | ||
| * the reduced delay must always equal the pre-computed expected value. | ||
| * | ||
| * <p>This mirrors the logic in TaskOrchestrationExecutor.RetriableTask.getNextDelay(): | ||
| * <pre> | ||
| * seed = firstAttempt.toEpochMilli() + attemptNumber | ||
| * reduction = new Random(seed).nextDouble() * jitterFactor | ||
| * delay = (long)(baseDelayMillis * (1.0 - reduction)) | ||
| * </pre> | ||
| */ | ||
| @Test | ||
| void jitterDelayIsDeterministicForGivenSeed() { | ||
| long firstAttemptEpochMillis = 1_700_000_000_000L; | ||
| int attemptNumber = 1; | ||
| long baseDelayMillis = 1000L; | ||
| double jitterFactor = 0.5; | ||
|
|
||
| long seed = firstAttemptEpochMillis + attemptNumber; | ||
| double reduction = new Random(seed).nextDouble() * jitterFactor; | ||
| long expected = (long) (baseDelayMillis * (1.0 - reduction)); | ||
|
|
||
| // Calling with the same seed twice must produce the same result. | ||
| long seed2 = firstAttemptEpochMillis + attemptNumber; | ||
| double reduction2 = new Random(seed2).nextDouble() * jitterFactor; | ||
| long result2 = (long) (baseDelayMillis * (1.0 - reduction2)); | ||
|
|
||
| assertEquals(expected, result2); | ||
| } | ||
|
|
||
|
javier-aliaga marked this conversation as resolved.
Outdated
|
||
| /** | ||
| * Verifies that with jitterFactor=0.5 the reduced delay is always between | ||
| * 50% and 100% of the base delay (i.e. never negative or exceeding the base). | ||
| */ | ||
| @Test | ||
| void jitterReducedDelayIsWithinExpectedBounds() { | ||
| long baseDelayMillis = 2000L; | ||
| double jitterFactor = 0.5; | ||
|
|
||
| for (int attempt = 1; attempt <= 10; attempt++) { | ||
| long seed = System.currentTimeMillis() + attempt; | ||
| double reduction = new Random(seed).nextDouble() * jitterFactor; | ||
| long reduced = (long) (baseDelayMillis * (1.0 - reduction)); | ||
|
|
||
| assertTrue(reduced >= (long) (baseDelayMillis * (1.0 - jitterFactor)), | ||
| "Reduced delay should be >= base * (1 - jitterFactor)"); | ||
| assertTrue(reduced <= baseDelayMillis, | ||
| "Reduced delay should not exceed base delay"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
|
javier-aliaga marked this conversation as resolved.
Outdated
|
||
| * With jitterFactor=0 the delay must be unchanged. | ||
| */ | ||
| @Test | ||
| void zeroJitterLeavesDelayUnchanged() { | ||
| long baseDelayMillis = 3000L; | ||
| double jitterFactor = 0.0; | ||
|
|
||
| long seed = 42L; | ||
| double reduction = new Random(seed).nextDouble() * jitterFactor; | ||
| long reduced = (long) (baseDelayMillis * (1.0 - reduction)); | ||
|
|
||
| assertEquals(baseDelayMillis, reduced); | ||
| } | ||
| } | ||
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.