Use "full jitter" & updated base delay for STANDARD retry mode defaults #2648
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "category": "AWS SDK for Java v2", | ||
| "contributor": "", | ||
| "type": "bugfix", | ||
| "description": "Use \"full jitter\" & updated base delay for STANDARD retry mode defaults" | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://aws.amazon.com/apache2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.core.retry.backoff; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.AdditionalAnswers.returnsFirstArg; | ||
| import static org.mockito.Matchers.anyInt; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import java.time.Duration; | ||
| import java.util.Arrays; | ||
| import java.util.Collection; | ||
| import java.util.Random; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.Parameterized; | ||
| import org.junit.runners.Parameterized.Parameter; | ||
| import org.junit.runners.Parameterized.Parameters; | ||
| import org.mockito.Mock; | ||
| import org.mockito.stubbing.Answer; | ||
| import software.amazon.awssdk.core.retry.RetryMode; | ||
| import software.amazon.awssdk.core.retry.RetryPolicyContext; | ||
|
|
||
| @RunWith(Parameterized.class) | ||
| public class FullJitterBackoffStrategyTest { | ||
|
|
||
|
|
||
| @Parameters | ||
| public static Collection<TestCase> parameters() throws Exception { | ||
| return Arrays.asList( | ||
| new TestCase().backoffStrategy(BackoffStrategy.defaultStrategy(RetryMode.STANDARD)) | ||
| .retriesAttempted(0) | ||
| .expectedMaxDelay(Duration.ofSeconds(1)) | ||
| .expectedMedDelay(Duration.ofMillis(500)) | ||
| .expectedMinDelay(Duration.ofMillis(1)), | ||
| new TestCase().backoffStrategy(BackoffStrategy.defaultStrategy(RetryMode.STANDARD)) | ||
| .retriesAttempted(1) | ||
| .expectedMaxDelay(Duration.ofSeconds(2)) | ||
| .expectedMedDelay(Duration.ofSeconds(1)) | ||
| .expectedMinDelay(Duration.ofMillis(1)), | ||
| new TestCase().backoffStrategy(BackoffStrategy.defaultStrategy(RetryMode.STANDARD)) | ||
| .retriesAttempted(2) | ||
| .expectedMaxDelay(Duration.ofSeconds(4)) | ||
| .expectedMedDelay(Duration.ofSeconds(2)) | ||
| .expectedMinDelay(Duration.ofMillis(1)), | ||
| new TestCase().backoffStrategy(BackoffStrategy.defaultStrategy(RetryMode.STANDARD)) | ||
| .retriesAttempted(3) | ||
| .expectedMaxDelay(Duration.ofSeconds(8)) | ||
| .expectedMedDelay(Duration.ofSeconds(4)) | ||
| .expectedMinDelay(Duration.ofMillis(1)), | ||
| new TestCase().backoffStrategy(BackoffStrategy.defaultStrategy(RetryMode.STANDARD)) | ||
| .retriesAttempted(4) | ||
| .expectedMaxDelay(Duration.ofSeconds(16)) | ||
| .expectedMedDelay(Duration.ofSeconds(8)) | ||
| .expectedMinDelay(Duration.ofMillis(1)), | ||
| new TestCase().backoffStrategy(BackoffStrategy.defaultStrategy(RetryMode.STANDARD)) | ||
| .retriesAttempted(5) | ||
| .expectedMaxDelay(Duration.ofSeconds(20)) | ||
| .expectedMedDelay(Duration.ofSeconds(10)) | ||
| .expectedMinDelay(Duration.ofMillis(1)) | ||
| ); | ||
| } | ||
|
|
||
| @Parameter | ||
| public TestCase testCase; | ||
|
|
||
| @Mock | ||
| private Random mockRandom = mock(Random.class); | ||
|
|
||
| @Before | ||
| public void setUp() throws Exception { | ||
| testCase.backoffStrategy = injectMockRandom(testCase.backoffStrategy); | ||
| } | ||
|
|
||
| @Test | ||
| public void testMaxDelay() { | ||
| mockMaxRandom(); | ||
| test(testCase.backoffStrategy, testCase.retriesAttempted, testCase.expectedMaxDelay); | ||
| } | ||
|
|
||
| @Test | ||
| public void testMedDelay() { | ||
| mockMediumRandom(); | ||
| test(testCase.backoffStrategy, testCase.retriesAttempted, testCase.expectedMedDelay); | ||
| } | ||
|
|
||
| @Test | ||
| public void testMinDelay() { | ||
| mockMinRandom(); | ||
| test(testCase.backoffStrategy, testCase.retriesAttempted, testCase.expectedMinDelay); | ||
| } | ||
|
|
||
| private static void test(BackoffStrategy backoffStrategy, int retriesAttempted, Duration expectedDelay) { | ||
| RetryPolicyContext context = RetryPolicyContext.builder() | ||
| .retriesAttempted(retriesAttempted) | ||
| .build(); | ||
| Duration computedDelay = backoffStrategy.computeDelayBeforeNextRetry(context); | ||
| assertThat(computedDelay).isEqualTo(expectedDelay); | ||
| } | ||
|
|
||
| private FullJitterBackoffStrategy injectMockRandom(BackoffStrategy strategy) { | ||
| FullJitterBackoffStrategy.Builder builder = ((FullJitterBackoffStrategy) strategy).toBuilder(); | ||
| return new FullJitterBackoffStrategy(builder.baseDelay(), builder.maxBackoffTime(), mockRandom); | ||
| } | ||
|
|
||
| private void mockMaxRandom() { | ||
| when(mockRandom.nextInt(anyInt())).then((Answer<Integer>) invocationOnMock -> { | ||
| Integer firstArg = (Integer) returnsFirstArg().answer(invocationOnMock); | ||
| return firstArg - 1; | ||
| }); | ||
| } | ||
|
|
||
| private void mockMinRandom() { | ||
| when(mockRandom.nextInt(anyInt())).then((Answer<Integer>) invocationOnMock -> { | ||
| return 0; | ||
| }); | ||
| } | ||
|
|
||
| private void mockMediumRandom() { | ||
| when(mockRandom.nextInt(anyInt())).then((Answer<Integer>) invocationOnMock -> { | ||
| Integer firstArg = (Integer) returnsFirstArg().answer(invocationOnMock); | ||
| return firstArg / 2 - 1; | ||
| }); | ||
| } | ||
|
|
||
| private static class TestCase { | ||
| private BackoffStrategy backoffStrategy; | ||
| private int retriesAttempted; | ||
| private Duration expectedMinDelay; | ||
| private Duration expectedMedDelay; | ||
| private Duration expectedMaxDelay; | ||
|
|
||
| public TestCase backoffStrategy(BackoffStrategy backoffStrategy) { | ||
| this.backoffStrategy = backoffStrategy; | ||
| return this; | ||
| } | ||
|
|
||
| public TestCase retriesAttempted(int retriesAttempted) { | ||
| this.retriesAttempted = retriesAttempted; | ||
| return this; | ||
| } | ||
|
|
||
| public TestCase expectedMinDelay(Duration expectedMinDelay) { | ||
| this.expectedMinDelay = expectedMinDelay; | ||
| return this; | ||
| } | ||
|
|
||
| public TestCase expectedMedDelay(Duration expectedMedDelay) { | ||
| this.expectedMedDelay = expectedMedDelay; | ||
| return this; | ||
| } | ||
|
|
||
| public TestCase expectedMaxDelay(Duration expectedMaxDelay) { | ||
| this.expectedMaxDelay = expectedMaxDelay; | ||
| return this; | ||
| } | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing copyright header