Skip to content
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

Add support for retryable trait #4170

Conversation

sugmanue
Copy link
Contributor

@sugmanue sugmanue commented Jul 7, 2023

Motivation and Context

Currently service models support adding a retryable trait (e.g. nimble or identitystore). This change adds support to honoring this trait by adding an override to a new method in the SdkServiceException class and another override to an existing method, e.g.,

/**
 * <p>
 * Indicates that the principal has crossed the throttling limits of the API operations.
 * </p>
 */
@Generated("software.amazon.awssdk:codegen")
public final class ThrottlingException extends IdentitystoreException implements
        ToCopyableBuilder<ThrottlingException.Builder, ThrottlingException> {

      ⋮
    @Override
    public boolean isRetryableException() {
        return true;
    }

    @Override
    public boolean isThrottlingException() {
        return true;
    }
      ⋮
}    

Modifications

  • Changed the codegen to pass down the retryable trait and for to codegen for it when present
  • Added a new retry condition that will check for this value in SdkServiceException instances

Testing

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

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 sugmanue requested a review from a team as a code owner July 7, 2023 22:08
@sugmanue sugmanue requested a review from L-Applin July 7, 2023 22:10
@sugmanue sugmanue force-pushed the sugmanue/sra-retries-add-support-for-retryable-trait branch from 37f78bf to e941afe Compare July 13, 2023 22:28
@@ -689,6 +691,28 @@ private CodeBlock getterStatement(MemberModel model) {
return CodeBlock.of("return $N;", modelVariable.getVariableName());
}

private List<MethodSpec> addRetryableOverrides() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: method name retryableOverrides() instead (to keep consistency with other calls to methodSpecs.addAll)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For what's worth you can add a "Suggestion" with the suggested change (the button before the formatting) that can be merged right from the Github UI.

@sonarcloud
Copy link

sonarcloud bot commented Jul 17, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug D 1 Bug
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 46 Code Smells

85.6% 85.6% Coverage
1.6% 1.6% Duplication

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

@sugmanue sugmanue merged commit 802ae19 into feature/master/sra-retries Jul 18, 2023
sugmanue added a commit that referenced this pull request Jun 11, 2024
* 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>
akidambisrinivasan pushed a commit to akidambisrinivasan/aws-sdk-java-v2 that referenced this pull request Jun 28, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants