Add adaptive retry strategy

[sugmanue]

This new module includes the interfaces and classes that will be used to implement the new retry logic within the SDK.

Motivation and Context

As part of the Smithy Reference Architecture this change adds the new default adaptive strategy.

Modifications

No modifications to existing code were made. We will make those changes in follow up pull requests.

Testing

• Added unit tests for the new AdaptiveRetryStrategy

Screenshots (if appropriate)

N/A

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

[joviegas]

I see that the implementation at https://github.com/aws/aws-sdk-java-v2/blob/master/core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/retry/RateLimitingTokenBucket.java uses commonly accepted API naming conventions, such as refill() as direct API of the bucket

[sugmanue]

Yeah, I have seen that as well. This class encapsulates that logic and exposes a better naming which makes the reading of the code using it easier to understand.

[joviegas]

It would be really helpful for readability if we could have APIs related to tokenBucket in RateLimiterTokenBucket class and other methods in a Helper class

[sugmanue]

Not sure what you mean by "other methods", all the code contained in this class is related to the rate limiter token bucket. Can you please point me which methods you think should go into a different class?

[joviegas]

I was trying to suggest that we limit the responsibilities of the RateLimiterTokenBucket class to acquiring and refilling tokens, and leave other functionalities like refilling based on success, exception, or throttle exception to be handled by a separate wrapping or helper class. This way, the RateLimiterTokenBucket class can focus solely on acquiring and refilling tokens, while the helper class can handle scenarios where tokens need to be acquired or refilled based on success or failure.
That we can limit RateLimiterTokenBucket responsibility to just acquire and refill and the helper class will acquire/refill based on the success failure scenarios

[joviegas]

Other methods are methods that updates the tokens based on error/success criteria like updateRateAfterThrottling etc

[joviegas]

Sorry for repeating the reference of RateLimitingTokenBucket but the java docs followed in that class is very helpful , can we add similar java docs here too

[sugmanue]

Sure, we can add something similar.

[sugmanue]

I have added some doc comments when appropriate, but I did not add any of the java docs that shows the pseudo-code of the method being implemented such as:

    /**
     * <pre>
     * _CUBICThrottle(rate_to_use)
     *   calculated_rate = rate_to_use * BETA
     *   return calculated_rate
     * </pre>
     */
    // Package private for testing
    double cubicThrottle(double rateToUse) {
        double calculatedRate = rateToUse * BETA;
        return calculatedRate;
    }

Since I think those actually makes the reading harder.

[joviegas]

Okay ,It would be great if the PR included a brief description of the modifications made to the classes, specifically in terms of their relationships.

[sonarqubecloud]

SonarCloud Quality Gate failed.   

1 Bug
0 Vulnerabilities
0 Security Hotspots
18 Code Smells

82.6% Coverage
5.7% Duplication