Apply dynamodb enhanced client user agent for all requests made by dynamodbEnahncedClient via an interceptor. Updated javadocs

Author: zoewangg

services-custom/dynamodb-enhanced/pom.xml

@@ -90,6 +90,16 @@
     </build>
 
     <dependencies>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>aws-core</artifactId>
+            <version>${awsjavasdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>software.amazon.awssdk</groupId>
+            <artifactId>http-client-spi</artifactId>
+            <version>${awsjavasdk.version}</version>
+        </dependency>
         <dependency>
             <groupId>software.amazon.awssdk</groupId>
             <artifactId>sdk-core</artifactId>

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/AttributeConverter.java

@@ -19,7 +19,6 @@
 
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.annotations.ThreadSafe;
-import software.amazon.awssdk.enhanced.dynamodb.TypeToken;
 import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.InstantAsIntegerAttributeConverter;
 import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.InstantAsStringAttributeConverter;
 import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.StringAttributeConverter;

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/extensions/VersionedRecordExtension.java

@@ -37,15 +37,22 @@
  * to automatically track each revision of the record as it is modified. To use this extension, first load it as part
  * of your MappedTable instantiation:
  *
+ * <pre>
+ * {@code
  * MappedTable.builder()
  *            .extendWith(VersionedRecordExtension.builder().build())
  *            .build();
+ * }
+ * </pre>
  *
+ * <p>
  * Then create an attribute in your model that will be used to store the record version number. This attribute must
  * be an 'integer' type numeric (long or integer), and you need to tag it as the version attribute:
  *
+ * <p>
  * ..., integerNumber("version", Customer::getVersion, Customer::setVersion).as(version()), ...
  *
+ * <p>
  * Then, whenever a record is written the write operation will only succeed if the version number of the record has not
  * been modified since it was last read by the application. Every time a new version of the record is successfully
  * written to the database, the record version number will be automatically incremented.

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/extensions/WriteModification.java

@@ -23,10 +23,10 @@
 
 /**
  * Simple object for storing a modification to a write operation.
- *
+ * <p>
  * If a transformedItem is supplied then this item will be completely substituted in place of the item that was
  * previously going to be written.
- *
+ * <p>
  * If an additionalConditionalExpression is supplied then this condition will be coalesced with any other conditions
  * and added as a parameter to the write operation.
  */

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/ApplyUserAgentInterceptor.java

@@ -0,0 +1,56 @@
+/*
+ * 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.enhanced.dynamodb.internal;
+
+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.core.SdkRequest;
+import software.amazon.awssdk.core.interceptor.Context;
+import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
+import software.amazon.awssdk.core.interceptor.ExecutionInterceptor;
+import software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest;
+
+/**
+ * Apply dynamodb enhanced client specific user agent to the request
+ */
+@SdkInternalApi
+public final class ApplyUserAgentInterceptor implements ExecutionInterceptor {
+    private static final ApiName API_NAME =
+        ApiName.builder().version("ddb-enh").name("hll").build();
+    private static final Consumer<AwsRequestOverrideConfiguration.Builder> USER_AGENT_APPLIER =
+        b -> b.addApiName(API_NAME);
+
+    @Override
+    public SdkRequest modifyRequest(Context.ModifyRequest context, ExecutionAttributes executionAttributes) {
+        if (!(context.request() instanceof DynamoDbRequest)) {
+            // should never happen
+            return context.request();
+        }
+
+        DynamoDbRequest request = (DynamoDbRequest) context.request();
+        AwsRequestOverrideConfiguration overrideConfiguration =
+            request.overrideConfiguration().map(c -> c.toBuilder()
+                                                      .applyMutation(USER_AGENT_APPLIER)
+                                                      .build())
+                   .orElse((AwsRequestOverrideConfiguration.builder()
+                                                           .applyMutation(USER_AGENT_APPLIER)
+                                                           .build()));
+
+        return request.toBuilder().overrideConfiguration(overrideConfiguration).build();
+    }
+}

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/operations/PaginatedOperation.java

@@ -100,11 +100,14 @@ ResultT transformResponse(ResponseT response,
     /**
      * Default implementation of a complete synchronous execution of this operation against either the primary or a
      * secondary index.
+     * <p>
      * It performs three steps:
-     * 1) Call generateRequest() to get the request object.
-     * 2) Call getServiceCall() and call it using the request object generated in the previous step.
-     * 3) Wraps the {@link SdkIterable} that was returned by the previous step with a transformation that turns each
-     * object returned to a high level result.
+     * <ol>
+     * <li> Call {@link #generateRequest} to get the request object.</li>
+     * <li> Call {@link #asyncServiceCall} and call it using the request object generated in the previous step.</li>
+     * <li> Wraps the {@link SdkIterable} that was returned by the previous step with a transformation that turns each
+     * object returned to a high level result.</li>
+     * </ol>
      *
      * @param tableSchema A {@link TableSchema} that maps the table to a modelled object.
      * @param context An object containing the context, or target, of the command execution.
@@ -125,11 +128,14 @@ default SdkIterable<ResultT> execute(TableSchema<ItemT> tableSchema,
     /**
      * Default implementation of a complete non-blocking asynchronous execution of this operation against either the
      * primary or a secondary index.
+     * <p>
      * It performs three steps:
-     * 1) Call generateRequest() to get the request object.
-     * 2) Call getServiceCall() and call it using the request object generated in the previous step.
-     * 3) Wraps the {@link SdkPublisher} returned by the SDK in a new one that calls transformResponse() to
+     * <ol>
+     * <li> Call {@link #generateRequest} to get the request object.
+     * <li> Call {@link #asyncServiceCall} and call it using the request object generated in the previous step.
+     * <li> Wraps the {@link SdkPublisher} returned by the SDK in a new one that calls transformResponse() to
      * convert the response objects published to a high level result.
+     * </ol>
      *
      * @param tableSchema A {@link TableSchema} that maps the table to a modelled object.
      * @param context An object containing the context, or target, of the command execution.

services-custom/dynamodb-enhanced/src/main/resources/software/amazon/awssdk/services/dynamodb/execution.interceptors

@@ -0,0 +1 @@
+software.amazon.awssdk.enhanced.dynamodb.internal.ApplyUserAgentInterceptor

services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/LocalDynamoDb.java

@@ -14,13 +14,21 @@
  */
 package software.amazon.awssdk.enhanced.dynamodb.functionaltests;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 import com.amazonaws.services.dynamodbv2.local.main.ServerRunner;
 import com.amazonaws.services.dynamodbv2.local.server.DynamoDBProxyServer;
 import java.io.IOException;
 import java.net.ServerSocket;
 import java.net.URI;
+import java.util.List;
+import java.util.Optional;
 import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
 import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.core.interceptor.Context;
+import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
+import software.amazon.awssdk.core.interceptor.ExecutionInterceptor;
+import software.amazon.awssdk.core.util.VersionInfo;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient;
 import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
@@ -71,6 +79,7 @@ DynamoDbClient createClient() {
                              .region(Region.US_EAST_1)
                              .credentialsProvider(StaticCredentialsProvider.create(
                                  AwsBasicCredentials.create("dummy-key", "dummy-secret")))
+                             .overrideConfiguration(o -> o.addExecutionInterceptor(new VerifyUserAgentInterceptor()))
                              .build();
     }
 
@@ -81,6 +90,7 @@ DynamoDbAsyncClient createAsyncClient() {
                                   .region(Region.US_EAST_1)
                                   .credentialsProvider(StaticCredentialsProvider.create(
                                       AwsBasicCredentials.create("dummy-key", "dummy-secret")))
+                                  .overrideConfiguration(o -> o.addExecutionInterceptor(new VerifyUserAgentInterceptor()))
                                   .build();
     }
 
@@ -120,4 +130,15 @@ private static RuntimeException propagate(Exception e) {
         }
         throw new RuntimeException(e);
     }
+
+    private static class VerifyUserAgentInterceptor implements ExecutionInterceptor {
+
+        @Override
+        public void beforeTransmission(Context.BeforeTransmission context, ExecutionAttributes executionAttributes) {
+            Optional<String> headers = context.httpRequest().firstMatchingHeader("User-agent");
+            assertThat(headers).isPresent();
+            assertThat(headers.get()).contains("hll/ddb-enh");
+        }
+    }
+
 }

services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/internal/ApplyUserAgentInterceptorTest.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2010-2020 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.enhanced.dynamodb.internal;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
+import java.util.Optional;
+import org.junit.Test;
+import software.amazon.awssdk.core.RequestOverrideConfiguration;
+import software.amazon.awssdk.core.SdkField;
+import software.amazon.awssdk.core.SdkRequest;
+import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
+import software.amazon.awssdk.core.util.VersionInfo;
+import software.amazon.awssdk.services.dynamodb.model.GetItemRequest;
+
+public class ApplyUserAgentInterceptorTest {
+
+    private ApplyUserAgentInterceptor interceptor = new ApplyUserAgentInterceptor();
+
+    @Test
+    public void ddbRequest_shouldModifyRequest() {
+        GetItemRequest getItemRequest = GetItemRequest.builder().build();
+        SdkRequest sdkRequest = interceptor.modifyRequest(() -> getItemRequest, new ExecutionAttributes());
+
+        RequestOverrideConfiguration requestOverrideConfiguration = sdkRequest.overrideConfiguration().get();
+        assertThat(requestOverrideConfiguration.apiNames()
+                                               .stream()
+                                               .filter(a -> a.name()
+                                                             .equals("hll") &&
+                                                            a.version().equals("ddb-enh")).findAny())
+            .isPresent();
+    }
+
+    @Test
+    public void otherRequest_shouldNotModifyRequest() {
+        SdkRequest someOtherRequest = new SdkRequest() {
+            @Override
+            public List<SdkField<?>> sdkFields() {
+                return null;
+            }
+
+            @Override
+            public Optional<? extends RequestOverrideConfiguration> overrideConfiguration() {
+                return Optional.empty();
+            }
+
+            @Override
+            public Builder toBuilder() {
+                return null;
+            }
+        };
+        SdkRequest sdkRequest = interceptor.modifyRequest(() -> someOtherRequest, new ExecutionAttributes());
+
+        assertThat(sdkRequest).isEqualTo(someOtherRequest);
+    }
+}