Merge pull request #7 from aws-cloudformation/update-retry-policy

Update retry policy used in CodeGuruProfilerClient

Author: gimki

aws-codeguruprofiler-profilinggroup/README.md

@@ -14,7 +14,7 @@ automatically overwritten.
 After modifying the JSON schema or changing the handlers implementation make sure you do the following before sending a pull-request:
 
 ```
-pre-commit run --all-files && AWS_REGION=us-east-1 mvn clean package
+pre-commit run --all-files && AWS_REGION=us-east-1 mvn clean verify package
 ```
 
 **References**

aws-codeguruprofiler-profilinggroup/src/main/java/software/amazon/codeguruprofiler/profilinggroup/CodeGuruProfilerClientBuilder.java

@@ -2,9 +2,13 @@
 
 import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
 import software.amazon.awssdk.core.internal.retry.SdkDefaultRetrySetting;
+import software.amazon.awssdk.core.exception.AbortedException;
 import software.amazon.awssdk.core.retry.RetryPolicy;
+import software.amazon.awssdk.core.retry.RetryPolicyContext;
 import software.amazon.awssdk.core.retry.backoff.BackoffStrategy;
 import software.amazon.awssdk.core.retry.backoff.EqualJitterBackoffStrategy;
+import software.amazon.awssdk.core.retry.conditions.OrRetryCondition;
+import software.amazon.awssdk.core.retry.conditions.RetryCondition;
 import software.amazon.awssdk.http.SdkHttpClient;
 import software.amazon.awssdk.http.apache.ApacheHttpClient;
 import software.amazon.awssdk.services.codeguruprofiler.CodeGuruProfilerClient;
@@ -70,23 +74,41 @@ private static RetryPolicy getRetryPolicy() {
                 .backoffStrategy(failureBackoffStrategy)
                 .throttlingBackoffStrategy(throttlingBackoffStrategy)
                 .numRetries(MAX_ERROR_RETRY) // We can be a bit slower in CloudFormation for the sake of not failing the deployment!
+                .retryCondition(getRetryCondition())
                 .build();
     }
 
+    private static RetryCondition getRetryCondition() {
+        return OrRetryCondition.create(
+                RetryCondition.defaultRetryCondition(), // Pull in SDK defaults
+                shouldRetryAbortedException() // https://github.com/aws/aws-sdk-java-v2/issues/1684
+        );
+    }
+
+    private static RetryCondition shouldRetryAbortedException() {
+        return (RetryPolicyContext c) ->
+                   c.exception().getCause() != null &&
+                       c.exception().getCause().getClass().equals(AbortedException.class);
+    }
+
     private static SdkHttpClient getHttpClient() {
         return ApacheHttpClient.builder()
                 .connectionTimeout(CONNECTION_TIMEOUT)
                 .socketTimeout(SOCKET_TIMEOUT)
                 .build();
     }
 
+    static ClientOverrideConfiguration getClientConfiguration() {
+        return ClientOverrideConfiguration.builder()
+                   .retryPolicy(getRetryPolicy())
+                   .apiCallTimeout(OVERALL_TIMEOUT)
+                   .apiCallAttemptTimeout(ATTEMPT_TIMEOUT)
+                   .build();
+    }
+
     public static CodeGuruProfilerClient create() {
         return CodeGuruProfilerClient.builder()
-                .overrideConfiguration(ClientOverrideConfiguration.builder()
-                        .retryPolicy(getRetryPolicy())
-                        .apiCallTimeout(OVERALL_TIMEOUT)
-                        .apiCallAttemptTimeout(ATTEMPT_TIMEOUT)
-                        .build())
+                .overrideConfiguration(getClientConfiguration())
                 .httpClient(getHttpClient())
                 .build();
     }

aws-codeguruprofiler-profilinggroup/src/test/java/software/amazon/codeguruprofiler/profilinggroup/CodeGuruProfilerClientConfigurationTest.java

@@ -0,0 +1,58 @@
+package software.amazon.codeguruprofiler.profilinggroup;
+
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.junit.jupiter.MockitoExtension;
+import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
+import software.amazon.awssdk.core.exception.AbortedException;
+import software.amazon.awssdk.core.exception.SdkClientException;
+import software.amazon.awssdk.core.exception.SdkException;
+import software.amazon.awssdk.core.retry.RetryPolicyContext;
+import software.amazon.awssdk.core.retry.conditions.RetryCondition;
+import software.amazon.awssdk.services.codeguruprofiler.model.ConflictException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@ExtendWith(MockitoExtension.class)
+public class CodeGuruProfilerClientConfigurationTest {
+
+    @Nested
+    class DescribeRetryCondition {
+        @Test
+        public void itShouldNotRetryClientErrorsByDefault() {
+            assertThat(getRetryCondition().shouldRetry(createRetryContext(SdkClientException.create("test")))).isFalse();
+        }
+
+        @Test
+        public void itShouldNotRetryErrorsWhenClientErrorsNotCausedByAbortedException() {
+            SdkClientException clientException =
+                SdkClientException.create("test", ConflictException.builder().build());
+            assertThat(getRetryCondition().shouldRetry(createRetryContext(clientException))).isFalse();
+        }
+
+        @Test
+        public void itShouldRetryClientErrorsCausedByAbortedException() {
+            // Until https://github.com/aws/aws-sdk-java-v2/issues/1684 is fixed
+            SdkClientException clientException =
+                SdkClientException.create("test", AbortedException.create("test aborted exception"));
+            assertThat(getRetryCondition().shouldRetry(createRetryContext(clientException))).isTrue();
+        }
+    }
+
+    private RetryCondition getRetryCondition() {
+        return getClientConfiguration()
+                   .retryPolicy().get()
+                   .retryCondition();
+    }
+
+    private ClientOverrideConfiguration getClientConfiguration() {
+        return CodeGuruProfilerClientBuilder.getClientConfiguration();
+    }
+
+    private RetryPolicyContext createRetryContext(SdkException exception) {
+        return RetryPolicyContext.builder()
+                   .exception(exception)
+                   .build();
+    }
+}