Salande/ua appid 2 (#5654)

* Adds the user agent appId metadata tag to client and system configuration options

* appId length check

* Fix imports

* moving appId to client override config

* remove appid from test

Author: cenedhryn

.changes/next-release/feature-AWSSDKforJavav2-0277feb.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS SDK for Java v2",
+    "contributor": "",
+    "description": "Adds an option to set 'appId' metadata to the client builder or to system settings and config files. This metadata string value will be added to the user agent string as `app/somevalue`"
+}

core/profiles/src/main/java/software/amazon/awssdk/profiles/ProfileProperty.java

@@ -177,6 +177,12 @@ public final class ProfileProperty {
      */
     public static final String ENDPOINT_URL = "endpoint_url";
 
+    /**
+     * Configure an optional identification value to be appended to the user agent header.
+     * The value should be less than 50 characters in length and is null by default.
+     */
+    public static final String SDK_UA_APP_ID = "sdk_ua_app_id";
+
     private ProfileProperty() {
     }
 }

core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkSystemSetting.java

@@ -224,7 +224,13 @@ public enum SdkSystemSetting implements SystemSetting {
      * Defines a file path from which partition metadata should be loaded. If this isn't specified, the partition
      * metadata deployed with the SDK client will be used instead.
      */
-    AWS_PARTITIONS_FILE("aws.partitionsFile", null)
+    AWS_PARTITIONS_FILE("aws.partitionsFile", null),
+
+    /**
+     * Configure an optional identification value to be appended to the user agent header.
+     * The value should be less than 50 characters in length and is null by default.
+     */
+    AWS_SDK_UA_APP_ID("sdk.ua.appId", null)
 
     ;
 

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/builder/SdkClientBuilder.java

@@ -95,4 +95,5 @@ default B addPlugin(SdkPlugin plugin) {
     default List<SdkPlugin> plugins() {
         throw new UnsupportedOperationException();
     }
+
 }

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/builder/SdkDefaultClientBuilder.java

@@ -48,6 +48,8 @@
 import static software.amazon.awssdk.core.client.config.SdkClientOption.RETRY_STRATEGY;
 import static software.amazon.awssdk.core.client.config.SdkClientOption.SCHEDULED_EXECUTOR_SERVICE;
 import static software.amazon.awssdk.core.client.config.SdkClientOption.SYNC_HTTP_CLIENT;
+import static software.amazon.awssdk.core.client.config.SdkClientOption.USER_AGENT_APP_ID;
+import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.APP_ID;
 import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.HTTP;
 import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.INTERNAL_METADATA_MARKER;
 import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.IO;
@@ -90,6 +92,7 @@
 import software.amazon.awssdk.core.internal.http.pipeline.stages.CompressRequestStage;
 import software.amazon.awssdk.core.internal.interceptor.HttpChecksumValidationInterceptor;
 import software.amazon.awssdk.core.internal.retry.SdkDefaultRetryStrategy;
+import software.amazon.awssdk.core.internal.useragent.AppIdResolver;
 import software.amazon.awssdk.core.internal.useragent.SdkClientUserAgentProperties;
 import software.amazon.awssdk.core.internal.useragent.SdkUserAgentBuilder;
 import software.amazon.awssdk.core.retry.RetryMode;
@@ -151,7 +154,6 @@ public abstract class SdkDefaultClientBuilder<B extends SdkClientBuilder<B, C>,
     private final List<SdkPlugin> plugins = new ArrayList<>();
 
 
-
     protected SdkDefaultClientBuilder() {
         this(DEFAULT_HTTP_CLIENT_BUILDER, DEFAULT_ASYNC_HTTP_CLIENT_BUILDER);
     }
@@ -413,7 +415,7 @@ private String resolveClientUserAgent(LazyValueSource config) {
         SdkClientUserAgentProperties clientProperties = new SdkClientUserAgentProperties();
 
         ClientType clientType = config.get(CLIENT_TYPE);
-        ClientType resolvedClientType = clientType == null ? ClientType.UNKNOWN : config.get(CLIENT_TYPE);
+        ClientType resolvedClientType = clientType == null ? ClientType.UNKNOWN : clientType;
 
         clientProperties.putProperty(RETRY_MODE, StringUtils.lowerCase(resolveRetryMode(config.get(RETRY_POLICY),
                                                                                         config.get(RETRY_STRATEGY))));
@@ -422,10 +424,20 @@ private String resolveClientUserAgent(LazyValueSource config) {
         clientProperties.putProperty(HTTP, SdkHttpUtils.urlEncode(clientName(resolvedClientType,
                                                                              config.get(SYNC_HTTP_CLIENT),
                                                                              config.get(ASYNC_HTTP_CLIENT))));
-
+        String appId = config.get(USER_AGENT_APP_ID);
+        String resolvedAppId = appId == null ? resolveAppId(config) : appId;
+        clientProperties.putProperty(APP_ID, resolvedAppId);
         return SdkUserAgentBuilder.buildClientUserAgentString(SystemUserAgent.getOrCreate(), clientProperties);
     }
 
+    private String resolveAppId(LazyValueSource config) {
+        Optional<String> appIdFromConfig = AppIdResolver.create()
+                                                        .profileFile(config.get(PROFILE_FILE_SUPPLIER))
+                                                        .profileName(config.get(PROFILE_NAME))
+                                                        .resolve();
+        return appIdFromConfig.orElse(null);
+    }
+
     private static String clientName(ClientType clientType, SdkHttpClient syncHttpClient, SdkAsyncHttpClient asyncHttpClient) {
         if (clientType == SYNC) {
             return syncHttpClient == null ? "null" : syncHttpClient.clientName();
@@ -446,7 +458,7 @@ private RetryStrategy resolveRetryStrategy(LazyValueSource config) {
                                        .resolve();
         return SdkDefaultRetryStrategy.forRetryMode(retryMode);
     }
-    
+
     /**
      * Finalize which sync HTTP client will be used for the created client.
      */

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/config/ClientOverrideConfiguration.java

@@ -34,6 +34,7 @@
 import static software.amazon.awssdk.core.client.config.SdkClientOption.RETRY_POLICY;
 import static software.amazon.awssdk.core.client.config.SdkClientOption.RETRY_STRATEGY;
 import static software.amazon.awssdk.core.client.config.SdkClientOption.SCHEDULED_EXECUTOR_SERVICE;
+import static software.amazon.awssdk.core.client.config.SdkClientOption.USER_AGENT_APP_ID;
 import static software.amazon.awssdk.utils.ScheduledExecutorUtils.unmanagedScheduledExecutor;
 import static software.amazon.awssdk.utils.ScheduledExecutorUtils.unwrapUnmanagedScheduledExecutor;
 
@@ -120,6 +121,7 @@ public final class ClientOverrideConfiguration
         options.add(CONFIGURED_RETRY_STRATEGY);
         options.add(CONFIGURED_RETRY_CONFIGURATOR);
         options.add(CONFIGURED_RETRY_MODE);
+        options.add(USER_AGENT_APP_ID);
         CLIENT_OVERRIDE_OPTIONS = Collections.unmodifiableSet(options);
 
         Set<ClientOption<?>> resolvedOptions = new HashSet<>();
@@ -381,6 +383,14 @@ public Optional<CompressionConfiguration> compressionConfiguration() {
         return Optional.ofNullable(compressionConfig);
     }
 
+    /**
+     * An optional user specified identification value to be appended to the user agent header.
+     * For more information, see {@link SdkClientOption#USER_AGENT_APP_ID}.
+     */
+    public Optional<String> appId() {
+        return Optional.ofNullable(config.option(USER_AGENT_APP_ID));
+    }
+
     @Override
     public String toString() {
         return ToString.builder("ClientOverrideConfiguration")
@@ -395,6 +405,7 @@ public String toString() {
                        .add("profileName", defaultProfileName().orElse(null))
                        .add("scheduledExecutorService", scheduledExecutorService().orElse(null))
                        .add("compressionConfiguration", compressionConfiguration().orElse(null))
+                       .add("appId", appId().orElse(null))
                        .build();
     }
 
@@ -757,6 +768,16 @@ default Builder compressionConfiguration(Consumer<CompressionConfiguration.Build
         }
 
         CompressionConfiguration compressionConfiguration();
+
+        /**
+         * Sets the appId for this client. See {@link SdkClientOption#USER_AGENT_APP_ID}.
+         */
+        Builder appId(String appId);
+
+        /**
+         * The appId for this client. See {@link SdkClientOption#USER_AGENT_APP_ID}.
+         */
+        String appId();
     }
 
     /**
@@ -1089,6 +1110,17 @@ public CompressionConfiguration compressionConfiguration() {
             return config.option(CONFIGURED_COMPRESSION_CONFIGURATION);
         }
 
+        @Override
+        public String appId() {
+            return config.option(USER_AGENT_APP_ID);
+        }
+
+        @Override
+        public Builder appId(String appId) {
+            config.option(USER_AGENT_APP_ID, appId);
+            return this;
+        }
+
         @Override
         public ClientOverrideConfiguration build() {
             return new ClientOverrideConfiguration(config.build(), resolvedConfig.build());

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/config/SdkClientOption.java

@@ -319,6 +319,24 @@ public final class SdkClientOption<T> extends ClientOption<T> {
     public static final SdkClientOption<CompressionConfiguration> COMPRESSION_CONFIGURATION =
         new SdkClientOption<>(CompressionConfiguration.class);
 
+    /**
+     * An optional identification value to be appended to the user agent header.
+     * The value should be less than 50 characters in length and is null by default.
+     * <p>
+     * Users can additionally supply the appId value through environment and JVM settings, and
+     * it will be resolved using the following order of precedence (highest first):
+     * <ol>
+     *  <li>This client option configuration </li>
+     *  <li>The {@code AWS_SDK_UA_APP_ID} environment variable</li>
+     *  <li>The {@code sdk.ua.appId} JVM system property</li>
+     *  <li>The {@code sdk_ua_app_id} setting in the profile file for the active profile</li>
+     * </ol>
+     * <p>
+     * This configuration option supersedes {@link SdkAdvancedClientOption#USER_AGENT_PREFIX} and
+     * {@link SdkAdvancedClientOption#USER_AGENT_SUFFIX} and should be used instead of those options.
+     */
+    public static final SdkClientOption<String> USER_AGENT_APP_ID = new SdkClientOption<>(String.class);
+
     /**
      * Option to specify a reference to the SDK client in use.
      */

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/useragent/AppIdResolver.java

@@ -0,0 +1,66 @@
+/*
+ * 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.core.internal.useragent;
+
+import java.util.Optional;
+import java.util.function.Supplier;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.core.SdkSystemSetting;
+import software.amazon.awssdk.profiles.ProfileFile;
+import software.amazon.awssdk.profiles.ProfileFileSystemSetting;
+import software.amazon.awssdk.profiles.ProfileProperty;
+import software.amazon.awssdk.utils.OptionalUtils;
+
+@SdkInternalApi
+public final class AppIdResolver {
+
+    private Supplier<ProfileFile> profileFile;
+    private String profileName;
+
+    private AppIdResolver() {
+    }
+
+    public static AppIdResolver create() {
+        return new AppIdResolver();
+    }
+
+    public AppIdResolver profileFile(Supplier<ProfileFile> profileFile) {
+        this.profileFile = profileFile;
+        return this;
+    }
+
+    public AppIdResolver profileName(String profileName) {
+        this.profileName = profileName;
+        return this;
+    }
+
+    public Optional<String> resolve() {
+        return OptionalUtils.firstPresent(fromSystemSettings(),
+                                          () -> fromProfileFile(profileFile, profileName));
+    }
+
+    private Optional<String> fromSystemSettings() {
+        return SdkSystemSetting.AWS_SDK_UA_APP_ID.getStringValue();
+    }
+
+    private Optional<String> fromProfileFile(Supplier<ProfileFile> profileFile, String profileName) {
+        profileFile = profileFile != null ? profileFile : ProfileFile::defaultProfileFile;
+        profileName = profileName != null ? profileName : ProfileFileSystemSetting.AWS_PROFILE.getStringValueOrThrow();
+        return profileFile.get()
+                          .profile(profileName)
+                          .flatMap(p -> p.property(ProfileProperty.SDK_UA_APP_ID));
+    }
+}

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/useragent/SdkUserAgentBuilder.java

@@ -15,6 +15,7 @@
 
 package software.amazon.awssdk.core.internal.useragent;
 
+import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.APP_ID;
 import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.CONFIG_METADATA;
 import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.ENV_METADATA;
 import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.HTTP;
@@ -34,6 +35,7 @@
 import software.amazon.awssdk.annotations.SdkProtectedApi;
 import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.core.util.SystemUserAgent;
+import software.amazon.awssdk.utils.Logger;
 import software.amazon.awssdk.utils.StringUtils;
 
 /**
@@ -43,6 +45,8 @@
 @SdkProtectedApi
 public final class SdkUserAgentBuilder {
 
+    private static final Logger log = Logger.loggerFor(SdkUserAgentBuilder.class);
+
     private SdkUserAgentBuilder() {
     }
 
@@ -77,6 +81,12 @@ public static String buildClientUserAgentString(SystemUserAgent systemValues,
             appendFieldAndSpace(uaString, CONFIG_METADATA, uaPair(RETRY_MODE, retryMode));
         }
 
+        String appId = userAgentProperties.getProperty(APP_ID);
+        if (!StringUtils.isEmpty(appId)) {
+            checkLengthAndWarn(appId);
+            appendFieldAndSpace(uaString, APP_ID, appId);
+        }
+
         removeFinalWhitespace(uaString);
         return uaString.toString();
     }
@@ -124,4 +134,12 @@ private static void appendAdditionalJvmMetadata(StringBuilder builder, SystemUse
             appendNonEmptyField(builder, METADATA, lang);
         }
     }
+
+    private static void checkLengthAndWarn(String appId) {
+        if (appId.length() > 50) {
+            log.warn(() -> String.format("The configured appId '%s' is longer than the recommended maximum length of 50. "
+                                         + "This could result in not being able to transmit and log the whole user agent string, "
+                                         + "including the complete value of this string.", appId));
+        }
+    }
 }

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/useragent/UserAgentConstant.java

@@ -36,6 +36,7 @@ public final class UserAgentConstant {
     public static final String FRAMEWORK_METADATA = "lib";
     public static final String METADATA = "md";
     public static final String INTERNAL_METADATA_MARKER = "internal";
+    public static final String APP_ID = "app";
 
     //Separators used in SDK user agent
     public static final String SLASH = "/";