Add amz-sdk-request header, removed amz-sdk-retry header.

Most changes are from a rename of MockHttpClient to MockSyncHttpClient so that a common parent interface can be added for generic programming purposes.

The new amz-sdk-request header does not include the TTL, because it's not at all easy to calculate with pluggable HTTP clients and the specification lists it as optional. The TTL can be added when service teams ask for it.

Author: millems

.changes/next-release/feature-AWSSDKforJavav2-6f7b936.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS SDK for Java v2",
+    "contributor": "",
+    "description": "Added amz-sdk-request and removed amz-sdk-retry header. The new header matches the behavior of the other SDKs."
+}

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/http/pipeline/stages/utils/RetryableStageHelper.java

@@ -15,8 +15,6 @@
 
 package software.amazon.awssdk.core.internal.http.pipeline.stages.utils;
 
-import static software.amazon.awssdk.core.internal.retry.SdkDefaultRetrySetting.SDK_RETRY_INFO_HEADER;
-
 import java.time.Duration;
 import java.util.concurrent.CompletionException;
 import software.amazon.awssdk.annotations.SdkInternalApi;
@@ -37,7 +35,6 @@
 import software.amazon.awssdk.core.retry.RetryPolicy;
 import software.amazon.awssdk.core.retry.RetryPolicyContext;
 import software.amazon.awssdk.core.retry.RetryUtils;
-import software.amazon.awssdk.core.retry.conditions.TokenBucketRetryCondition;
 import software.amazon.awssdk.http.SdkHttpFullRequest;
 import software.amazon.awssdk.http.SdkHttpResponse;
 
@@ -47,6 +44,8 @@
  */
 @SdkInternalApi
 public class RetryableStageHelper {
+    public static final String SDK_RETRY_INFO_HEADER = "amz-sdk-request";
+
     public static final ExecutionAttribute<Duration> LAST_BACKOFF_DELAY_DURATION =
         new ExecutionAttribute<>("LastBackoffDuration");
 
@@ -140,14 +139,8 @@ public void logBackingOff(Duration backoffDelay) {
      * Retrieve the request to send to the service, including any detailed retry information headers.
      */
     public SdkHttpFullRequest requestToSend() {
-        Integer availableRetryCapacity = TokenBucketRetryCondition.getCapacityForExecution(context.executionAttributes())
-                                                                  .map(TokenBucketRetryCondition.Capacity::capacityRemaining)
-                                                                  .orElse(null);
-        String headerValue = (attemptNumber - 1) + "/" +
-                             context.executionAttributes().getAttribute(LAST_BACKOFF_DELAY_DURATION).toMillis() + "/" +
-                             (availableRetryCapacity != null ? availableRetryCapacity : "");
         return request.toBuilder()
-                      .putHeader(SDK_RETRY_INFO_HEADER, headerValue)
+                      .putHeader(SDK_RETRY_INFO_HEADER, "attempt=" + attemptNumber + "; max=" + retryPolicy.numRetries())
                       .build();
     }
 

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/retry/SdkDefaultRetrySetting.java

@@ -32,8 +32,6 @@
 
 @SdkInternalApi
 public final class SdkDefaultRetrySetting {
-    public static final String SDK_RETRY_INFO_HEADER = "amz-sdk-retry";
-
     public static final class Legacy {
         private static final int THROTTLE_EXCEPTION_TOKEN_COST = 0;
         private static final int DEFAULT_EXCEPTION_TOKEN_COST = 5;

core/sdk-core/src/main/java/software/amazon/awssdk/core/retry/conditions/TokenBucketRetryCondition.java

@@ -26,6 +26,7 @@
 import software.amazon.awssdk.core.retry.RetryMode;
 import software.amazon.awssdk.core.retry.RetryPolicy;
 import software.amazon.awssdk.core.retry.RetryPolicyContext;
+import software.amazon.awssdk.utils.Logger;
 import software.amazon.awssdk.utils.ToString;
 import software.amazon.awssdk.utils.Validate;
 
@@ -47,6 +48,8 @@
  */
 @SdkPublicApi
 public class TokenBucketRetryCondition implements RetryCondition {
+    private static final Logger log = Logger.loggerFor(TokenBucketRetryCondition.class);
+
     private static final ExecutionAttribute<Capacity> LAST_ACQUIRED_CAPACITY =
         new ExecutionAttribute<>("TokenBucketRetryCondition.LAST_ACQUIRED_CAPACITY");
 
@@ -122,9 +125,17 @@ public boolean shouldRetry(RetryPolicyContext context) {
             context.executionAttributes().putAttribute(LAST_ACQUIRED_CAPACITY, c);
             context.executionAttributes().putAttribute(RETRY_COUNT_OF_LAST_CAPACITY_ACQUISITION,
                                                        context.retriesAttempted());
+            log.trace(() -> "Successfully acquired token bucket capacity to retry this request. "
+                            + "Acquired: " + c.capacityAcquired + ". Remaining: " + c.capacityRemaining);
         });
 
-        return capacity.isPresent();
+        boolean hasCapacity = capacity.isPresent();
+
+        if (!hasCapacity) {
+            log.debug(() -> "This request will not be retried because the client has experienced too many recent call failures.");
+        }
+
+        return hasCapacity;
     }
 
     @Override

core/sdk-core/src/test/java/software/amazon/awssdk/core/http/RetryCountInUserAgentTest.java

@@ -34,13 +34,10 @@
 import software.amazon.awssdk.http.SdkHttpRequest;
 import software.amazon.awssdk.profiles.ProfileFile;
 import software.amazon.awssdk.regions.Region;
-import software.amazon.awssdk.services.s3.S3Client;
-import software.amazon.awssdk.services.s3.S3ClientBuilder;
-import software.amazon.awssdk.services.s3.S3Configuration;
 import software.amazon.awssdk.services.s3.internal.handlers.EndpointAddressInterceptor;
 import software.amazon.awssdk.services.s3.model.ListObjectsRequest;
 import software.amazon.awssdk.testutils.EnvironmentVariableHelper;
-import software.amazon.awssdk.testutils.service.http.MockHttpClient;
+import software.amazon.awssdk.testutils.service.http.MockSyncHttpClient;
 import software.amazon.awssdk.utils.StringInputStream;
 
 /**
@@ -53,12 +50,12 @@ public class S3EndpointResolutionTest {
     private static final String ENDPOINT_WITHOUT_BUCKET = "https://s3.ap-south-1.amazonaws.com";
     private static final String ENDPOINT_WITH_BUCKET = String.format("https://%s.s3.ap-south-1.amazonaws.com", BUCKET);
 
-    private MockHttpClient mockHttpClient;
+    private MockSyncHttpClient mockHttpClient;
     private Signer mockSigner;
 
     @Before
     public void setup() {
-        mockHttpClient = new MockHttpClient();
+        mockHttpClient = new MockSyncHttpClient();
         mockSigner = (request, executionAttributes) -> request;
     }
 

services/s3/src/test/java/software/amazon/awssdk/services/s3/S3EndpointResolutionTest.java

@@ -35,12 +35,12 @@
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.s3.S3Client;
 import software.amazon.awssdk.services.s3.model.ListObjectsRequest;
-import software.amazon.awssdk.testutils.service.http.MockHttpClient;
+import software.amazon.awssdk.testutils.service.http.MockSyncHttpClient;
 
 @RunWith(Parameterized.class)
 public class VirtualHostAddressingSepTest {
     private static final String TEST_FILE_PATH = "VirtualAddressingSepTestCases.json";
-    private MockHttpClient mockHttpClient;
+    private MockSyncHttpClient mockHttpClient;
     private TestCaseModel testCaseModel;
 
     public VirtualHostAddressingSepTest(TestCaseModel testCaseModel) {
@@ -49,7 +49,7 @@ public VirtualHostAddressingSepTest(TestCaseModel testCaseModel) {
 
     @Before
     public void setup() {
-        mockHttpClient = new MockHttpClient();
+        mockHttpClient = new MockSyncHttpClient();
     }
 
     @Parameterized.Parameters

services/s3/src/test/java/software/amazon/awssdk/services/s3/bucketaddressingsep/VirtualHostAddressingSepTest.java

@@ -18,42 +18,33 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
-import static software.amazon.awssdk.services.s3.S3MockUtils.mockListBucketsResponse;
 import static software.amazon.awssdk.services.s3.S3MockUtils.mockListObjectsResponse;
 
-import java.io.UnsupportedEncodingException;
 import java.net.URI;
 import org.junit.Before;
 import org.junit.Test;
 import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
 import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
-import software.amazon.awssdk.core.SdkSystemSetting;
-import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
-import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption;
 import software.amazon.awssdk.core.signer.Signer;
 import software.amazon.awssdk.http.SdkHttpRequest;
-import software.amazon.awssdk.profiles.ProfileFile;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.s3.S3Client;
 import software.amazon.awssdk.services.s3.S3ClientBuilder;
 import software.amazon.awssdk.services.s3.S3Configuration;
-import software.amazon.awssdk.services.s3.internal.handlers.EndpointAddressInterceptor;
 import software.amazon.awssdk.services.s3.model.ListObjectsRequest;
-import software.amazon.awssdk.testutils.EnvironmentVariableHelper;
-import software.amazon.awssdk.testutils.service.http.MockHttpClient;
-import software.amazon.awssdk.utils.StringInputStream;
+import software.amazon.awssdk.testutils.service.http.MockSyncHttpClient;
 
 /**
  * Functional tests for outpost access point ARN
  */
 public class OutpostAccessPointArnEndpointResolutionTest {
 
-    private MockHttpClient mockHttpClient;
+    private MockSyncHttpClient mockHttpClient;
     private Signer mockSigner;
 
     @Before
     public void setup() {
-        mockHttpClient = new MockHttpClient();
+        mockHttpClient = new MockSyncHttpClient();
         mockSigner = (request, executionAttributes) -> request;
     }
 

services/s3/src/test/java/software/amazon/awssdk/services/s3/internal/resource/OutpostAccessPointArnEndpointResolutionTest.java

@@ -30,23 +30,23 @@
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.protocolrestjson.ProtocolRestJsonAsyncClient;
 import software.amazon.awssdk.services.protocolrestjson.ProtocolRestJsonClient;
-import software.amazon.awssdk.testutils.service.http.MockAyncHttpClient;
-import software.amazon.awssdk.testutils.service.http.MockHttpClient;
+import software.amazon.awssdk.testutils.service.http.MockAsyncHttpClient;
+import software.amazon.awssdk.testutils.service.http.MockSyncHttpClient;
 import software.amazon.awssdk.utils.StringInputStream;
 import software.amazon.awssdk.utils.builder.SdkBuilder;
 
 public class HostPrefixTest {
 
-    private MockHttpClient mockHttpClient;
+    private MockSyncHttpClient mockHttpClient;
     private ProtocolRestJsonClient client;
-    private MockAyncHttpClient mockAsyncClient;
+    private MockAsyncHttpClient mockAsyncClient;
 
     private ProtocolRestJsonAsyncClient asyncClient;
 
     @Before
     public void setupClient() {
-        mockHttpClient = new MockHttpClient();
-        mockAsyncClient = new MockAyncHttpClient();
+        mockHttpClient = new MockSyncHttpClient();
+        mockAsyncClient = new MockAsyncHttpClient();
         client = ProtocolRestJsonClient.builder()
                                        .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create("akid",
                                                                                                                         "skid")))

test/codegen-generated-classes-test/src/test/java/software/amazon/awssdk/services/HostPrefixTest.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.services.retry;
+
+import java.net.URI;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.protocolrestjson.ProtocolRestJsonAsyncClient;
+import software.amazon.awssdk.services.protocolrestjson.ProtocolRestJsonClient;
+import software.amazon.awssdk.testutils.service.http.MockAsyncHttpClient;
+import software.amazon.awssdk.testutils.service.http.MockSyncHttpClient;
+
+public class AsyncRetryHeaderTest extends RetryHeaderTestSuite<MockAsyncHttpClient> {
+    private final ProtocolRestJsonAsyncClient client;
+
+    public AsyncRetryHeaderTest() {
+        super(new MockAsyncHttpClient());
+        client = ProtocolRestJsonAsyncClient.builder()
+                                            .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create("akid", "skid")))
+                                            .region(Region.US_EAST_1)
+                                            .endpointOverride(URI.create("http://localhost"))
+                                            .httpClient(mockHttpClient)
+                                            .build();
+    }
+
+    @Override
+    protected void callAllTypesOperation() {
+        client.allTypes().join();
+    }
+}