add custom UA header

Author: zhongkechen

sdk/pom.xml

@@ -66,6 +66,15 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+                <includes>
+                    <include>**/*.prop</include>
+                </includes>
+            </resource>
+        </resources>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

sdk/src/main/java/software/amazon/lambda/durable/DurableConfig.java

@@ -2,16 +2,21 @@
 // SPDX-License-Identifier: Apache-2.0
 package software.amazon.lambda.durable;
 
+import java.io.IOException;
+import java.io.InputStream;
 import java.time.Duration;
 import java.util.Objects;
+import java.util.Properties;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import software.amazon.awssdk.auth.credentials.EnvironmentVariableCredentialsProvider;
 import software.amazon.awssdk.core.SdkSystemSetting;
+import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.lambda.LambdaClient;
+import software.amazon.awssdk.services.lambda.LambdaClientBuilder;
 import software.amazon.awssdk.services.lambda.model.GetDurableExecutionStateRequest;
 import software.amazon.lambda.durable.client.DurableExecutionClient;
 import software.amazon.lambda.durable.client.LambdaDurableFunctionsClient;
@@ -64,6 +69,10 @@ public final class DurableConfig {
      */
     private static final String DEFAULT_REGION = "us-east-1";
 
+    private static final String VERSION_FILE = "/version.prop";
+    private static final String PROJECT_VERSION = getProjectVersion(VERSION_FILE);
+    private static final String USER_AGENT_SUFFIX = "@aws/durable-execution-sdk-java/" + PROJECT_VERSION;
+
     private final DurableExecutionClient durableExecutionClient;
     private final SerDes serDes;
     private final ExecutorService executorService;
@@ -169,9 +178,9 @@ private static DurableExecutionClient createDefaultDurableExecutionClient() {
             logger.debug("AWS_REGION not set, defaulting to: {}", region);
         }
 
-        var lambdaClient = LambdaClient.builder()
-                .credentialsProvider(EnvironmentVariableCredentialsProvider.create())
-                .region(Region.of(region))
+        var lambdaClient = addUserAgentSuffix(LambdaClient.builder()
+                        .credentialsProvider(EnvironmentVariableCredentialsProvider.create())
+                        .region(Region.of(region)))
                 .build();
 
         try {
@@ -194,6 +203,27 @@ private static DurableExecutionClient createDefaultDurableExecutionClient() {
         return new LambdaDurableFunctionsClient(lambdaClient);
     }
 
+    static LambdaClientBuilder addUserAgentSuffix(LambdaClientBuilder builder) {
+        return builder.overrideConfiguration(builder.overrideConfiguration().toBuilder()
+                .putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX, USER_AGENT_SUFFIX)
+                .build());
+    }
+
+    private static String getProjectVersion(String versionFile) {
+        InputStream stream = DurableConfig.class.getResourceAsStream(versionFile);
+        if (stream == null) {
+            return "UNKNOWN";
+        }
+        Properties props = new Properties();
+        try {
+            props.load(stream);
+            stream.close();
+            return (String) props.get("version");
+        } catch (IOException e) {
+            return "UNKNOWN";
+        }
+    }
+
     /**
      * Creates a default ExecutorService for running user-defined operations. Uses a cached thread pool with daemon
      * threads by default.
@@ -230,23 +260,23 @@ private Builder() {}
          * <p>Example:
          *
          * <pre>{@code
-         * LambdaClient lambdaClient = LambdaClient.builder()
+         * LambdaClientBuilder lambdaClientBuilder = LambdaClient.builder()
          *     .region(Region.US_WEST_2)
-         *     .credentialsProvider(ProfileCredentialsProvider.create("my-profile"))
-         *     .build();
+         *     .credentialsProvider(ProfileCredentialsProvider.create("my-profile"));
          *
          * DurableConfig.builder()
-         *     .withLambdaClient(lambdaClient)
+         *     .withLambdaClientBuilder(lambdaClientBuilder)
          *     .build();
          * }</pre>
          *
-         * @param lambdaClient Custom LambdaClient instance
+         * @param lambdaClientBuilder Custom LambdaClientBuilder instance
          * @return This builder
          * @throws NullPointerException if lambdaClient is null
          */
-        public Builder withLambdaClient(LambdaClient lambdaClient) {
-            Objects.requireNonNull(lambdaClient, "LambdaClient cannot be null");
-            this.durableExecutionClient = new LambdaDurableFunctionsClient(lambdaClient);
+        public Builder withLambdaClientBuilder(LambdaClientBuilder lambdaClientBuilder) {
+            Objects.requireNonNull(lambdaClientBuilder, "LambdaClient cannot be null");
+            this.durableExecutionClient = new LambdaDurableFunctionsClient(
+                    addUserAgentSuffix(lambdaClientBuilder).build());
             return this;
         }
 
@@ -255,7 +285,7 @@ public Builder withLambdaClient(LambdaClient lambdaClient) {
          *
          * <p><b>Note:</b> This method is primarily intended for testing with mock clients (e.g.,
          * {@code LocalMemoryExecutionClient}). For production use with a custom AWS SDK client, prefer
-         * {@link #withLambdaClient(LambdaClient)}.
+         * {@link #withLambdaClientBuilder(LambdaClientBuilder)}.
          *
          * @param durableExecutionClient Custom DurableExecutionClient instance
          * @return This builder

sdk/src/main/resources/version.prop

@@ -0,0 +1 @@
+version=${project.version}

sdk/src/test/java/software/amazon/lambda/durable/DurableConfigTest.java

@@ -9,11 +9,14 @@
 import static org.junit.jupiter.api.Assertions.assertNotSame;
 import static org.junit.jupiter.api.Assertions.assertSame;
 import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.mockito.Mockito.mock;
 
 import java.util.concurrent.ExecutorService;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption;
+import software.amazon.awssdk.services.lambda.LambdaClient;
 import software.amazon.lambda.durable.client.DurableExecutionClient;
 import software.amazon.lambda.durable.client.LambdaDurableFunctionsClient;
 import software.amazon.lambda.durable.serde.JacksonSerDes;
@@ -231,4 +234,64 @@ void testBuilder_PartialConfiguration_FillsDefaults() {
         assertInstanceOf(LambdaDurableFunctionsClient.class, config.getDurableExecutionClient());
         assertNotNull(config.getExecutorService());
     }
+
+    @Test
+    void testBuilder_WithLambdaClientBuilder_CreatesLambdaDurableFunctionsClient() {
+        var lambdaClientBuilder = LambdaClient.builder()
+                .region(software.amazon.awssdk.regions.Region.US_WEST_2)
+                .credentialsProvider(software.amazon.awssdk.auth.credentials.StaticCredentialsProvider.create(
+                        software.amazon.awssdk.auth.credentials.AwsBasicCredentials.create("test", "test")));
+
+        var config = DurableConfig.builder()
+                .withLambdaClientBuilder(lambdaClientBuilder)
+                .build();
+
+        assertNotNull(config.getDurableExecutionClient());
+        assertInstanceOf(LambdaDurableFunctionsClient.class, config.getDurableExecutionClient());
+    }
+
+    @Test
+    void testBuilder_WithLambdaClientBuilder_NullThrowsException() {
+        var builder = DurableConfig.builder();
+
+        var exception = assertThrows(NullPointerException.class, () -> builder.withLambdaClientBuilder(null));
+
+        assertEquals("LambdaClient cannot be null", exception.getMessage());
+    }
+
+    @Test
+    void testAddUserAgentSuffix_SetsUserAgentOnBuilder() {
+        var lambdaClientBuilder = LambdaClient.builder();
+
+        var result = DurableConfig.addUserAgentSuffix(lambdaClientBuilder);
+
+        var overrideConfig = result.overrideConfiguration();
+        var userAgentSuffix = overrideConfig.advancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX);
+        assertTrue(userAgentSuffix.isPresent(), "USER_AGENT_SUFFIX should be set");
+        assertTrue(
+                userAgentSuffix.get().contains("@aws/durable-execution-sdk-java/"),
+                "User agent suffix should contain SDK identifier, got: " + userAgentSuffix.get());
+    }
+
+    @Test
+    void testAddUserAgentSuffix_PreservesExistingConfiguration() {
+        var lambdaClientBuilder =
+                LambdaClient.builder().overrideConfiguration(c -> c.putHeader("X-Custom-Header", "test-value"));
+
+        var result = DurableConfig.addUserAgentSuffix(lambdaClientBuilder);
+
+        var overrideConfig = result.overrideConfiguration();
+        var userAgentSuffix = overrideConfig.advancedOption(SdkAdvancedClientOption.USER_AGENT_SUFFIX);
+        assertTrue(userAgentSuffix.isPresent());
+        assertTrue(userAgentSuffix.get().contains("@aws/durable-execution-sdk-java/"));
+    }
+
+    @Test
+    void testAddUserAgentSuffix_ReturnsSameBuilderInstance() {
+        var lambdaClientBuilder = LambdaClient.builder();
+
+        var result = DurableConfig.addUserAgentSuffix(lambdaClientBuilder);
+
+        assertSame(lambdaClientBuilder, result);
+    }
 }