Add User Agent Api name for Cross region API calls (#4105)

* Add User Agent Api name for Cross region API calls

* Added test case for default client not to have user agent related to cross region

Author: joviegas

services/s3/src/main/java/software/amazon/awssdk/services/s3/internal/crossregion/S3CrossRegionAsyncClient.java

@@ -15,6 +15,8 @@
 
 package software.amazon.awssdk.services.s3.internal.crossregion;
 
+import static software.amazon.awssdk.services.s3.internal.crossregion.utils.CrossRegionUtils.updateUserAgentInConfig;
+
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Function;
@@ -39,11 +41,14 @@ public S3CrossRegionAsyncClient(S3AsyncClient s3Client) {
 
         Optional<String> bucket = request.getValueForField("Bucket", String.class);
 
+        AwsRequestOverrideConfiguration overrideConfiguration = updateUserAgentInConfig(request);
+        T userAgentUpdatedRequest = (T) request.toBuilder().overrideConfiguration(overrideConfiguration).build();
+
         if (!bucket.isPresent()) {
-            return operation.apply(request);
+            return operation.apply(userAgentUpdatedRequest);
         }
 
-        return operation.apply(requestWithDecoratedEndpointProvider(request, bucket.get()))
+        return operation.apply(requestWithDecoratedEndpointProvider(userAgentUpdatedRequest, bucket.get()))
                         .whenComplete((r, t) -> handleOperationFailure(t, bucket.get()));
     }
 

services/s3/src/main/java/software/amazon/awssdk/services/s3/internal/crossregion/S3CrossRegionSyncClient.java

@@ -15,6 +15,8 @@
 
 package software.amazon.awssdk.services.s3.internal.crossregion;
 
+import static software.amazon.awssdk.services.s3.internal.crossregion.utils.CrossRegionUtils.updateUserAgentInConfig;
+
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Function;
@@ -38,15 +40,18 @@ protected <T extends S3Request, ReturnT> ReturnT invokeOperation(T request, Func
 
         Optional<String> bucket = request.getValueForField("Bucket", String.class);
 
+        AwsRequestOverrideConfiguration overrideConfiguration = updateUserAgentInConfig(request);
+        T userAgentUpdatedRequest = (T) request.toBuilder().overrideConfiguration(overrideConfiguration).build();
+
         if (bucket.isPresent()) {
             try {
-                return operation.apply(requestWithDecoratedEndpointProvider(request, bucket.get()));
+                return operation.apply(requestWithDecoratedEndpointProvider(userAgentUpdatedRequest, bucket.get()));
             } catch (Exception e) {
                 handleOperationFailure(e, bucket.get());
             }
         }
 
-        return operation.apply(request);
+        return operation.apply(userAgentUpdatedRequest);
     }
 
     private void handleOperationFailure(Throwable t, String bucket) {

services/s3/src/main/java/software/amazon/awssdk/services/s3/internal/crossregion/utils/CrossRegionUtils.java

@@ -0,0 +1,43 @@
+/*
+ * 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.s3.internal.crossregion.utils;
+
+
+import java.util.function.Consumer;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
+import software.amazon.awssdk.core.ApiName;
+import software.amazon.awssdk.services.s3.model.S3Request;
+
+@SdkInternalApi
+public final class CrossRegionUtils {
+    private static final ApiName API_NAME = ApiName.builder().version("cross-region").name("hll").build();
+    private static final Consumer<AwsRequestOverrideConfiguration.Builder> USER_AGENT_APPLIER = b -> b.addApiName(API_NAME);
+
+    private CrossRegionUtils() {
+    }
+
+    public static <T extends S3Request> AwsRequestOverrideConfiguration updateUserAgentInConfig(T request) {
+        AwsRequestOverrideConfiguration overrideConfiguration =
+            request.overrideConfiguration().map(c -> c.toBuilder()
+                                                      .applyMutation(USER_AGENT_APPLIER)
+                                                      .build())
+                   .orElse(AwsRequestOverrideConfiguration.builder()
+                                                          .applyMutation(USER_AGENT_APPLIER)
+                                                          .build());
+        return overrideConfiguration;
+    }
+}

services/s3/src/test/java/software/amazon/awssdk/services/s3/internal/crossregion/S3CrossRegionAsyncClientTest.java

@@ -98,6 +98,20 @@ void crossRegionClient_createdWithWrapping_SuccessfullyIntercepts() {
         assertThat(captureInterceptor.endpointProvider).isInstanceOf(S3CrossRegionAsyncClient.BucketEndpointProvider.class);
     }
 
+    @Test
+    void standardOp_crossRegionClient_containUserAgent() {
+        S3AsyncClient crossRegionClient = clientBuilder().serviceConfiguration(c -> c.crossRegionAccessEnabled(true)).build();
+        crossRegionClient.getObject(r -> r.bucket(BUCKET).key(KEY), AsyncResponseTransformer.toBytes()).join();
+        assertThat(mockAsyncHttpClient.getLastRequest().firstMatchingHeader("User-Agent").get()).contains("hll/cross-region");
+    }
+
+    @Test
+    void standardOp_simpleClient_doesNotContainCrossRegionUserAgent() {
+        S3AsyncClient crossRegionClient = clientBuilder().serviceConfiguration(c -> c.crossRegionAccessEnabled(false)).build();
+        crossRegionClient.getObject(r -> r.bucket(BUCKET).key(KEY), AsyncResponseTransformer.toBytes()).join();
+        assertThat(mockAsyncHttpClient.getLastRequest().firstMatchingHeader("User-Agent").get()).doesNotContain("hll/cross-region");
+    }
+
     private S3AsyncClientBuilder clientBuilder() {
         return S3AsyncClient.builder()
                             .httpClient(mockAsyncHttpClient)

services/s3/src/test/java/software/amazon/awssdk/services/s3/internal/crossregion/S3CrossRegionSyncClientTest.java

@@ -20,6 +20,7 @@
 import java.net.URI;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import software.amazon.awssdk.core.async.AsyncResponseTransformer;
 import software.amazon.awssdk.core.interceptor.Context;
 import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
 import software.amazon.awssdk.core.interceptor.ExecutionInterceptor;
@@ -28,6 +29,7 @@
 import software.amazon.awssdk.http.AbortableInputStream;
 import software.amazon.awssdk.http.HttpExecuteResponse;
 import software.amazon.awssdk.http.SdkHttpResponse;
+import software.amazon.awssdk.services.s3.S3AsyncClient;
 import software.amazon.awssdk.services.s3.S3Client;
 import software.amazon.awssdk.services.s3.S3ClientBuilder;
 import software.amazon.awssdk.services.s3.model.GetObjectRequest;
@@ -95,6 +97,21 @@ void crossRegionClient_createdWithWrapping_SuccessfullyIntercepts() {
         assertThat(captureInterceptor.endpointProvider).isInstanceOf(S3CrossRegionSyncClient.BucketEndpointProvider.class);
     }
 
+    @Test
+    void standardOp_crossRegionClient_containUserAgent() {
+        S3Client crossRegionClient = clientBuilder().serviceConfiguration(c -> c.crossRegionAccessEnabled(true)).build();
+        crossRegionClient.getObject(r -> r.bucket(BUCKET).key(KEY));
+        assertThat(mockSyncHttpClient.getLastRequest().firstMatchingHeader("User-Agent").get()).contains("hll/cross-region");
+    }
+
+    @Test
+    void standardOp_simpleClient_doesNotContainCrossRegionUserAgent() {
+        S3Client crossRegionClient = clientBuilder().serviceConfiguration(c -> c.crossRegionAccessEnabled(false)).build();
+        crossRegionClient.getObject(r -> r.bucket(BUCKET).key(KEY));
+        assertThat(mockSyncHttpClient.getLastRequest().firstMatchingHeader("User-Agent").get())
+            .doesNotContain("hll/cross-region");
+    }
+
     private S3ClientBuilder clientBuilder() {
         return S3Client.builder()
                        .httpClient(mockSyncHttpClient)