Move useragent info to ServiceVersionInfo

Author: RanVaknin

.changes/next-release/feature-AWSSDKforJavav2-e1e404e.json

@@ -2,5 +2,5 @@
     "type": "feature",
     "category": "AWS SDK for Java v2",
     "contributor": "",
-    "description": "Adding the version of the used service to the useragent"
+    "description": "Add the sdk service client version to the useragent"
 }

codegen/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/CommonInternalGeneratorTasks.java

@@ -23,7 +23,6 @@
 import software.amazon.awssdk.codegen.poet.client.EnvironmentTokenSystemSettingsClass;
 import software.amazon.awssdk.codegen.poet.client.SdkClientOptions;
 import software.amazon.awssdk.codegen.poet.client.specs.ServiceVersionInfoSpec;
-import software.amazon.awssdk.codegen.poet.client.specs.ServiceVersionUserAgentSpec;
 import software.amazon.awssdk.codegen.poet.common.UserAgentUtilsSpec;
 
 public class CommonInternalGeneratorTasks extends BaseGeneratorTasks {
@@ -43,7 +42,6 @@ protected List<GeneratorTask> createTasks() throws Exception {
             tasks.add(createEnvironmentTokenSystemSettingTask());
         }
         tasks.add(createServiceVersionInfoTask());
-        tasks.add(createServiceVersionUserAgentTask());
         return tasks;
     }
 
@@ -67,11 +65,6 @@ private GeneratorTask createServiceVersionInfoTask() {
                                      new ServiceVersionInfoSpec(params.getModel()));
     }
 
-    private GeneratorTask createServiceVersionUserAgentTask() {
-        return new PoetGeneratorTask(clientOptionsDir(), params.getModel().getFileHeader(),
-                                     new ServiceVersionUserAgentSpec(params.getModel()));
-    }
-
     private String clientOptionsDir() {
         return params.getPathProvider().getClientInternalDirectory();
     }

codegen/src/main/java/software/amazon/awssdk/codegen/poet/PoetExtension.java

@@ -83,10 +83,6 @@ public ClassName getServiceVersionInfoClass() {
         return ClassName.get(model.getMetadata().getFullClientInternalPackageName(), "ServiceVersionInfo");
     }
 
-    public ClassName getServiceVersionUserAgentClass() {
-        return ClassName.get(model.getMetadata().getFullClientInternalPackageName(), "ServiceVersionUserAgent");
-    }
-
     public ClassName getEnvironmentTokenSystemSettingsClass() {
         return ClassName.get(model.getMetadata().getFullClientInternalPackageName(), "EnvironmentTokenSystemSettings");
     }

codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/AsyncClientClass.java

@@ -234,7 +234,7 @@ private MethodSpec constructor(TypeSpec.Builder classBuilder) {
                                       SdkClientOption.class,
                                       SdkClientOption.class,
                                       ClassName.get(model.getMetadata().getFullClientInternalPackageName(),
-                                        "ServiceVersionUserAgent"));
+                                        "ServiceVersionInfo"));
 
         FieldSpec protocolFactoryField = protocolSpec.protocolFactory(model);
         if (model.getMetadata().isJsonProtocol()) {

codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/SyncClientClass.java

@@ -206,7 +206,7 @@ private MethodSpec constructor() {
                                       SdkClientOption.class,
                                       SdkClientOption.class,
                                       ClassName.get(model.getMetadata().getFullClientInternalPackageName(),
-                                       "ServiceVersionUserAgent"));
+                                       "ServiceVersionInfo"));
 
         FieldSpec protocolFactoryField = protocolSpec.protocolFactory(model);
         if (model.getMetadata().isJsonProtocol()) {

codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/specs/ServiceVersionInfoSpec.java

@@ -22,29 +22,34 @@
 import com.squareup.javapoet.MethodSpec;
 import com.squareup.javapoet.TypeSpec;
 import javax.lang.model.element.Modifier;
+import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
 import software.amazon.awssdk.codegen.poet.ClassSpec;
 import software.amazon.awssdk.codegen.poet.PoetExtension;
 import software.amazon.awssdk.codegen.poet.PoetUtils;
 
 public class ServiceVersionInfoSpec implements ClassSpec {
     private final PoetExtension poetExtension;
+    private final IntermediateModel model;
 
     public ServiceVersionInfoSpec(IntermediateModel model) {
         this.poetExtension = new PoetExtension(model);
+        this.model = model;
     }
 
     @Override
     public TypeSpec poetSpec() {
         TypeSpec.Builder builder = TypeSpec.classBuilder("ServiceVersionInfo")
                                            .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                                            .addAnnotation(PoetUtils.generatedAnnotation())
+                                           .addAnnotation(SdkInternalApi.class)
                                            .addField(FieldSpec.builder(
                                                String.class, "VERSION", Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL)
                                                               .initializer("$S", SDK_VERSION)
                                                               .addJavadoc("Returns the current version for the AWS SDK in which"
                                                                           + " this class is running.")
                                                               .build())
+                                           .addField(userAgentField())
                                            .addMethod(privateConstructor());
 
         return builder.build();
@@ -56,6 +61,20 @@ protected MethodSpec privateConstructor() {
                          .build();
     }
 
+    private FieldSpec userAgentField() {
+        return FieldSpec.builder(String.class, "USER_AGENT", Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL)
+                        .initializer("$S", transformServiceId(model.getMetadata().getServiceId()) + "#" + SDK_VERSION)
+                        .addAnnotation(SdkInternalApi.class)
+                        .addJavadoc("Returns a user agent containing the service and "
+                                    + "version info")
+                        .build();
+    }
+
+    private String transformServiceId(String serviceId) {
+        // According to User Agent 2.0 spec, replace spaces with underscores
+        return serviceId.replace(" ", "_");
+    }
+
     @Override
     public ClassName className() {
         return poetExtension.getServiceVersionInfoClass();

codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/specs/ServiceVersionUserAgentSpec.java

@@ -31,15 +31,21 @@
 public class ServiceVersionInfoSpecTest {
 
     // Fixture test that compares generated ServiceVersionInfo class against expected output.
-    // The fixture file uses {{VERSION}} as a placeholder which gets replaced with the current
-    // SDK version at test time, since the generated code injects the actual version at build time.
+    // The fixture file uses {{VERSION}} as a placeholder for the SDK version and {{USER_AGENT}}
+    // as a placeholder for the service-specific user agent metadata. Both placeholders get
+    // replaced with actual values at test time, since the generated code injects the actual
+    // version and transformed service ID at build time.
     @Test
     void testServiceVersionInfoClass() {
         String currVersion = VersionInfo.SDK_VERSION;
+        String currUserAgent =
+            transformServiceId(ClientTestModels.restJsonServiceModels().getMetadata().getServiceId()) + "#" + currVersion;
         ClassSpec serviceVersionInfoSpec = new ServiceVersionInfoSpec(ClientTestModels.restJsonServiceModels());
 
         String expectedContent = loadFixtureFile("test-service-version-info-class.java");
-        expectedContent = expectedContent.replace("{{VERSION}}", currVersion);
+        expectedContent = expectedContent
+            .replace("{{VERSION}}", currVersion)
+            .replace("{{USER_AGENT}}", currUserAgent);
 
         String actualContent = generateContent(serviceVersionInfoSpec);
 
@@ -56,4 +62,8 @@ private String generateContent(ClassSpec spec) {
         JavaFile javaFile = JavaFile.builder(spec.className().packageName(), typeSpec).build();
         return javaFile.toString();
     }
+
+    private String transformServiceId(String serviceId) {
+        return serviceId.replace(" ", "_");
+    }
 }

codegen/src/test/java/software/amazon/awssdk/codegen/poet/client/ServiceVersionInfoSpecTest.java

@@ -2,14 +2,22 @@
 
 import java.lang.String;
 import software.amazon.awssdk.annotations.Generated;
+import software.amazon.awssdk.annotations.SdkInternalApi;
 
 @Generated("software.amazon.awssdk:codegen")
+@SdkInternalApi
 public final class ServiceVersionInfo {
   /**
    * Returns the current version for the AWS SDK in which this class is running.
    */
   public static final String VERSION = "{{VERSION}}";
 
+  /**
+   * Returns a user agent containing the service and version info
+   */
+  @SdkInternalApi
+  public static final String USER_AGENT = "{{USER_AGENT}}";
+
   private ServiceVersionInfo() {
   }
 }