Fix a bug that prevents a retry strategy override to get used

sugmanue commented 3 months ago

Motivation and Context

Fixes a bug that was found that prevents a retry strategy override from being used as it was overwritten once again to configure it for AWS.

The original logic was there to add AWS-specific retry conditions for when the user set the retry strategy using RetryMode or using the mutator to tailor the default one Consumer<RetryStrategy.Builder>. We eagerly created the retry strategy, but since this package (sdk-core) does not know about AWS packages was not able to set the correct one, thus we did patch it after the fact, but this logic is not correct as it prevents user defined overrides to take place and will "over-configure" if an already AWS aware retry strategy is given.

Modifications

We now resolve the retry strategy lazily, either when using RetryMode or the default one to apply the configured configurator. We need to add logic to the client builder classes and to the client to accomplish this in three different scenarios:

Client builder using client override configuration
Client builder using plugins
Request override configuration using plugins

For that the following method was added to the client builder and to the client to update the configuration after the plugins are run:

    private void updateRetryStrategyClientConfiguration(SdkClientConfiguration.Builder configuration) {
        ClientOverrideConfiguration.Builder builder = configuration.asOverrideConfigurationBuilder();
        RetryMode retryMode = builder.retryMode();
        if (retryMode != null) {
            configuration.option(SdkClientOption.RETRY_STRATEGY, AwsRetryStrategy.forRetryMode(retryMode));
            return;
        }
        Consumer<RetryStrategy.Builder<?, ?>> configurator = builder.retryStrategyConfigurator();
        if (configurator != null) {
            RetryStrategy.Builder<?, ?> defaultBuilder = AwsRetryStrategy.defaultRetryStrategy().toBuilder();
            configurator.accept(defaultBuilder);
            configuration.option(SdkClientOption.RETRY_STRATEGY, defaultBuilder.build());
            return;
        }
        RetryStrategy retryStrategy = builder.retryStrategy();
        if (retryStrategy != null) {
            configuration.option(SdkClientOption.RETRY_STRATEGY, retryStrategy);
        }
    }

This implies that now the clients themselves have a direct dependency on retries-spi which was also added for all services updating their pom.xml.

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

joviegas commented 3 months ago

There we lot of test files so was not able to pin point which test covers functional testing of this bug ? Could you please help with the Java test files which actually test the functionality when retry strategy is overridden.

sugmanue commented 3 months ago