Deprecate legacy classes and use new when possible #4154

sugmanue · 2023-06-29T16:52:06Z

Motivation and Context

Deprecate all the legacy RetryPolicy and adjacent types.
Update more places that were still using the legacy types.

Modifications

Testing

The same battery of tests that were in place for RetryPolicy should now pass with RetryStrategy.

Checklist

I have read the CONTRIBUTING document
Local run of mvn install succeeds
My code follows the code style of this project
My change requires a change to the Javadoc documentation
I have updated the Javadoc documentation accordingly
I have added tests to cover my changes
All new and existing tests passed
I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

I confirm that this pull request can be released under the Apache 2 license

sugmanue · 2023-06-29T16:55:53Z

core/retries/src/main/java/software/amazon/awssdk/retries/DefaultRetryStrategy.java

@@ -95,7 +95,7 @@ public static AdaptiveRetryStrategy.Builder adaptiveStrategyBuilder() {

    static final class Standard {
        static final int MAX_ATTEMPTS = 3;
-        static final Duration BASE_DELAY = Duration.ofSeconds(1);
+        static final Duration BASE_DELAY = Duration.ofMillis(100);


Bug fix, the value is 100ms see here.

joviegas · 2023-06-29T22:36:20Z

core/aws-core/src/main/java/software/amazon/awssdk/awscore/retry/AwsRetryPolicy.java

@@ -25,8 +25,11 @@

 /**
 * Retry Policy used by clients when communicating with AWS services.
+ *
+ * @deprecated Use instead {@link AwsRetryStrategy}
 */
 @SdkPublicApi


Can we remove this @SdkPublicApi since its deprecated i think we can remove this

I'm not sure that we can remove it, if I do the build will bark with:

SDK annotation is missing on this class. eg: @SdkProtectedApi [MissingSdkAnnotation]

If we do, which one should we use instead?

Deprecated shouldn't change the public/protected/internalness
Confirmed this with the team.
Thanks for the patience while I was waiting to get clarification on this.

joviegas · 2023-06-29T22:38:36Z

core/sdk-core/src/main/java/software/amazon/awssdk/core/retry/backoff/BackoffStrategy.java

@@ -21,8 +21,12 @@
 import software.amazon.awssdk.core.retry.RetryMode;
 import software.amazon.awssdk.core.retry.RetryPolicyContext;

+/**
+ * @deprecated Use instead {@link software.amazon.awssdk.retries.api.BackoffStrategy}
+ */
 @SdkPublicApi


SdkPublicApi can be removed if its deprecated. Generic comment for other classes

See above, the build requires each class to have one of the API scope annotations. If we remove this one, which one should we use?

...-core/src/main/java/software/amazon/awssdk/core/retry/backoff/FixedDelayBackoffStrategy.java

joviegas · 2023-06-29T22:40:27Z

...test/java/software/amazon/awssdk/core/internal/http/timers/HttpClientApiCallTimeoutTest.java

@@ -60,7 +60,6 @@ public class HttpClientApiCallTimeoutTest {
    @Before
    public void setup() {
        httpClient = testClientBuilder()
-            .retryPolicy(RetryPolicy.none())


Why we need to remove this now ?

Well, the class is deprecated so I figured we should also try to remove its uses, technically we don't have to do it now.

hmm... I might be over thinking but I was thinking of a case where due to some reason we want to modify older RetryPolicy (since they are not removed but just deprecated) , we might loose test cases for them

Sorry, I missed this comment, yeah, I think that's a fair concern, I will bring this up during review.

sonarcloud · 2023-06-30T05:32:59Z

SonarCloud Quality Gate failed.

1 Bug
0 Vulnerabilities
0 Security Hotspots
42 Code Smells

85.2% Coverage
1.6% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

@deprecated

* New API for the retries module (#3769) This new module includes the interfaces and classes that will be used to implement the new retry logic within the SDK. * Add default backoff strategies (#3906) * Add default backoff strategies * Moved the backoff strategires to the SPI package * Use AssertJ instead of Hamcrest * Add standard retry strategy (#3931) * Add standard retry strategy * Fix the AcquireInitialTokenRequestImpl API annotation Also add the package to the test/tests-coverage-reporting/pom.xml to get coverage reporting * Add adaptive retry strategy (#3975) * Add adaptive retry strategy * Address pull request comments * Address PR comments * Address PR comments * Update retries and retries-api to snapshot version: 2.20.64-SNAPSHOT * Fix SonarCloud code smells (#3991) * Fix SonarCloud code smells * Move AdaptiveRetryStrategyResourceConstrainedTest to an integration test This change is to workaround the SonarCloud code smell of the Sleep usage in this test * Add legacy retry strategy (#3988) * Add legacy retry strategy * Remove public modifiers from test classes to make SonarCloud happy * Fix another SonarCloud code smell * WIP * Address PR comments * Rename all the strategies to use Default prefix instead of Impl suffix * Address PR comments * Remove those tests that are now part of a different class * Update version after merge from master * Refactor retry strategies (#4039) * Refactor the retry strategies This change uses a single class to implement the core logic of all the retries strategies and adds extension points to tailor the behavior when needed. * Rename to BaseRetryStrategy and make it abstract * Remove previous implementations and rename the new ones * Update sdk version * Fix the retry condition to just look for the initial cause * Add new sync and async retryable stages (#4062) * Add new sync and async retryable stages * Address PR comments * Update sdk version * Change uses of RetryPolicy to RetryStrategy (#4125) * Update sdk version * Deprecate legacy classes and use new when possible (#4154) * Deprecate legacy classes and use new when possible * Fix checkstyle and add some more validation * Add missing @deprecated annotation * Add missing dependency to the retries-api module * Fix minor logging issues * Update sdk version * Add support for retryable trait (#4170) * Merge master * Update to support plugins * Add support for AWS retryable conditions * Use the correct token bucket exception cost value * Add ADAPTIVE_V2 retry mode to support the legacy behavior (#5123) * Add a new ADAPTIVE2 mode to support the legacy behavior * Fix dynamodb test to use adaptive2 mode * Fixes and tests for the expected behaviors * Rename the new adaptive mode to ADAPTIVE_V2 * More fixes related to the rename from adaptive2 to adaptive_v2 * Fix dynamodb retry resolver logic for adaptive mode * Properly clean up the test state * Address PR comments * Remove a small typo * Dumy commit * Dummy commit to kick the internal build * Rename retries-api to retries-spi * Add retry packages to brazil (#5215) * Add retry packages to brazil * Update pom's as per the new module checklist * Remove type params from RetryStrategy, but keep them in RetryStrategy… (#5262) * Remove type params from RetryStrategy, but keep them in RetryStrategy.Builder * Rename from `none` to `doNotRetry` to clarify the behavior * External names used for retry modes only support 'adaptive' (#5265) * Externally named retry modes only support 'adaptive' Behind the scenes this will be mapped to RetryMode.ADAPTIVE_V2 which makes it a non-backwards compatible behavioral change. * Sneak in a fix from the previous PR * Fix a test that expects adaptive to map to `RetryMode.ADAPTIVE` * Fix typos in the comments * Retries release (#5280) * Bump version to 2.26.0-SNAPSHOT * Add retry release changlog entry * Add missing deprecation annotation and javadoc tag * Archive the last changelog from the 2.25 series --------- Co-authored-by: John Viegas <70235430+joviegas@users.noreply.github.com>

@deprecated

* New API for the retries module (aws#3769) This new module includes the interfaces and classes that will be used to implement the new retry logic within the SDK. * Add default backoff strategies (aws#3906) * Add default backoff strategies * Moved the backoff strategires to the SPI package * Use AssertJ instead of Hamcrest * Add standard retry strategy (aws#3931) * Add standard retry strategy * Fix the AcquireInitialTokenRequestImpl API annotation Also add the package to the test/tests-coverage-reporting/pom.xml to get coverage reporting * Add adaptive retry strategy (aws#3975) * Add adaptive retry strategy * Address pull request comments * Address PR comments * Address PR comments * Update retries and retries-api to snapshot version: 2.20.64-SNAPSHOT * Fix SonarCloud code smells (aws#3991) * Fix SonarCloud code smells * Move AdaptiveRetryStrategyResourceConstrainedTest to an integration test This change is to workaround the SonarCloud code smell of the Sleep usage in this test * Add legacy retry strategy (aws#3988) * Add legacy retry strategy * Remove public modifiers from test classes to make SonarCloud happy * Fix another SonarCloud code smell * WIP * Address PR comments * Rename all the strategies to use Default prefix instead of Impl suffix * Address PR comments * Remove those tests that are now part of a different class * Update version after merge from master * Refactor retry strategies (aws#4039) * Refactor the retry strategies This change uses a single class to implement the core logic of all the retries strategies and adds extension points to tailor the behavior when needed. * Rename to BaseRetryStrategy and make it abstract * Remove previous implementations and rename the new ones * Update sdk version * Fix the retry condition to just look for the initial cause * Add new sync and async retryable stages (aws#4062) * Add new sync and async retryable stages * Address PR comments * Update sdk version * Change uses of RetryPolicy to RetryStrategy (aws#4125) * Update sdk version * Deprecate legacy classes and use new when possible (aws#4154) * Deprecate legacy classes and use new when possible * Fix checkstyle and add some more validation * Add missing @deprecated annotation * Add missing dependency to the retries-api module * Fix minor logging issues * Update sdk version * Add support for retryable trait (aws#4170) * Merge master * Update to support plugins * Add support for AWS retryable conditions * Use the correct token bucket exception cost value * Add ADAPTIVE_V2 retry mode to support the legacy behavior (aws#5123) * Add a new ADAPTIVE2 mode to support the legacy behavior * Fix dynamodb test to use adaptive2 mode * Fixes and tests for the expected behaviors * Rename the new adaptive mode to ADAPTIVE_V2 * More fixes related to the rename from adaptive2 to adaptive_v2 * Fix dynamodb retry resolver logic for adaptive mode * Properly clean up the test state * Address PR comments * Remove a small typo * Dumy commit * Dummy commit to kick the internal build * Rename retries-api to retries-spi * Add retry packages to brazil (aws#5215) * Add retry packages to brazil * Update pom's as per the new module checklist * Remove type params from RetryStrategy, but keep them in RetryStrategy… (aws#5262) * Remove type params from RetryStrategy, but keep them in RetryStrategy.Builder * Rename from `none` to `doNotRetry` to clarify the behavior * External names used for retry modes only support 'adaptive' (aws#5265) * Externally named retry modes only support 'adaptive' Behind the scenes this will be mapped to RetryMode.ADAPTIVE_V2 which makes it a non-backwards compatible behavioral change. * Sneak in a fix from the previous PR * Fix a test that expects adaptive to map to `RetryMode.ADAPTIVE` * Fix typos in the comments * Retries release (aws#5280) * Bump version to 2.26.0-SNAPSHOT * Add retry release changlog entry * Add missing deprecation annotation and javadoc tag * Archive the last changelog from the 2.25 series --------- Co-authored-by: John Viegas <70235430+joviegas@users.noreply.github.com>

Deprecate legacy classes and use new when possible

4f121e6

sugmanue requested a review from a team as a code owner June 29, 2023 16:52

sugmanue requested a review from joviegas June 29, 2023 16:54

sugmanue commented Jun 29, 2023

View reviewed changes

Fix checkstyle and add some more validation

a58d743

joviegas reviewed Jun 29, 2023

View reviewed changes

sugmanue added 2 commits June 29, 2023 17:24

Add missing @deprecated annotation

2379489

Add missing dependency to the retries-api module

216c219

sugmanue force-pushed the sugmanue/sra-retries-deprecate-legacy-classes branch from 02e19fc to 216c219 Compare June 30, 2023 03:48

joviegas approved these changes Jun 30, 2023

View reviewed changes

sugmanue merged commit 75842c1 into feature/master/sra-retries Jun 30, 2023
6 of 7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate legacy classes and use new when possible #4154

Deprecate legacy classes and use new when possible #4154

sugmanue commented Jun 29, 2023

sugmanue Jun 29, 2023

joviegas Jun 29, 2023

sugmanue Jun 29, 2023

joviegas Jun 30, 2023

joviegas Jun 29, 2023

sugmanue Jun 29, 2023

joviegas Jun 29, 2023

sugmanue Jun 29, 2023

joviegas Jun 30, 2023

sugmanue Jun 30, 2023

sonarcloud bot commented Jun 30, 2023

Deprecate legacy classes and use new when possible #4154

Deprecate legacy classes and use new when possible #4154

Conversation

sugmanue commented Jun 29, 2023

Motivation and Context

Modifications

Testing

Checklist

License

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Jun 30, 2023