Made UserAgentUtil throw for applicationIds longer than 24 characters. (Azure#23643)

* Aligned UserAgentUtil with ClientOptions and HttpLogOptions so all of them throw when an `applicationId` longer than 24 characters is provided.

* Updated tests.

* Updated JavaDocs.

* Applied PR feedback.

Author: vcolin7

sdk/core/azure-core/src/main/java/com/azure/core/http/policy/HttpLogOptions.java

@@ -29,6 +29,9 @@ public class HttpLogOptions {
     private final ClientLogger logger = new ClientLogger(HttpLogOptions.class);
 
     private static final int MAX_APPLICATION_ID_LENGTH = 24;
+    private static final String INVALID_APPLICATION_ID_LENGTH = "'applicationId' length cannot be greater than "
+        + MAX_APPLICATION_ID_LENGTH;
+    private static final String INVALID_APPLICATION_ID_SPACE = "'applicationId' cannot contain spaces.";
     private static final List<String> DEFAULT_HEADERS_WHITELIST = Arrays.asList(
         "x-ms-client-request-id",
         "x-ms-return-client-request-id",
@@ -173,23 +176,26 @@ public String getApplicationId() {
      * Sets the custom application specific id supplied by the user of the client library.
      *
      * @param applicationId The user specified application id.
+     *
      * @return The updated HttpLogOptions object.
+     *
+     * @throws IllegalArgumentException If {@code applicationId} contains spaces or is larger than 24 characters in
+     * length.
+     *
      * @deprecated Use {@link ClientOptions} to configure {@code applicationId}.
      */
     @Deprecated
     public HttpLogOptions setApplicationId(final String applicationId) {
         if (!CoreUtils.isNullOrEmpty(applicationId)) {
             if (applicationId.length() > MAX_APPLICATION_ID_LENGTH) {
-                throw logger
-                    .logExceptionAsError(new IllegalArgumentException("'applicationId' length cannot be greater than "
-                        + MAX_APPLICATION_ID_LENGTH));
+                throw logger.logExceptionAsError(new IllegalArgumentException(INVALID_APPLICATION_ID_LENGTH));
             } else if (applicationId.contains(" ")) {
-                throw logger
-                    .logExceptionAsError(new IllegalArgumentException("'applicationId' must not contain a space."));
-            } else {
-                this.applicationId = applicationId;
+                throw logger.logExceptionAsError(new IllegalArgumentException(INVALID_APPLICATION_ID_SPACE));
             }
         }
+
+        this.applicationId = applicationId;
+
         return this;
     }
 

sdk/core/azure-core/src/main/java/com/azure/core/util/ClientOptions.java

@@ -48,20 +48,23 @@ public String getApplicationId() {
      * {@codesnippet com.azure.core.util.ClientOptions.setApplicationId#String}
      *
      * @param applicationId The application ID.
+     *
      * @return The updated ClientOptions object.
-     * @throws IllegalArgumentException If {@code applicationId} contains spaces or larger than 24 in length.
+     *
+     * @throws IllegalArgumentException If {@code applicationId} contains spaces or is larger than 24 characters in
+     * length.
      */
     public ClientOptions setApplicationId(String applicationId) {
-        if (CoreUtils.isNullOrEmpty(applicationId)) {
-            this.applicationId = applicationId;
-        } else if (applicationId.length() > MAX_APPLICATION_ID_LENGTH) {
-            throw logger.logExceptionAsError(new IllegalArgumentException(INVALID_APPLICATION_ID_LENGTH));
-        } else if (applicationId.contains(" ")) {
-            throw logger.logExceptionAsError(new IllegalArgumentException(INVALID_APPLICATION_ID_SPACE));
-        } else {
-            this.applicationId = applicationId;
+        if (!CoreUtils.isNullOrEmpty(applicationId)) {
+            if (applicationId.length() > MAX_APPLICATION_ID_LENGTH) {
+                throw logger.logExceptionAsError(new IllegalArgumentException(INVALID_APPLICATION_ID_LENGTH));
+            } else if (applicationId.contains(" ")) {
+                throw logger.logExceptionAsError(new IllegalArgumentException(INVALID_APPLICATION_ID_SPACE));
+            }
         }
 
+        this.applicationId = applicationId;
+
         return this;
     }
 

sdk/core/azure-core/src/main/java/com/azure/core/util/UserAgentUtil.java

@@ -8,7 +8,10 @@
  * <a href="https://azure.github.io/azure-sdk/general_azurecore.html#telemetry-policy">design guidelines</a>.
  */
 public final class UserAgentUtil {
-
+    private static final int MAX_APPLICATION_ID_LENGTH = 24;
+    private static final String INVALID_APPLICATION_ID_LENGTH = "'applicationId' length cannot be greater than "
+        + MAX_APPLICATION_ID_LENGTH;
+    private static final String INVALID_APPLICATION_ID_SPACE = "'applicationId' cannot contain spaces.";
     public static final String DEFAULT_USER_AGENT_HEADER = "azsdk-java";
 
     // From the design guidelines, the platform info format is:
@@ -30,17 +33,24 @@ private UserAgentUtil() {
      * @param sdkVersion Version of the SDK.
      * @param configuration The configuration to use to determine if platform info should be included in the user agent
      * string.
+     *
      * @return User agent string as specified in design guidelines.
+     *
+     * @throws IllegalArgumentException If {@code applicationId} contains spaces or is larger than 24 characters in
+     * length.
      */
     public static String toUserAgentString(String applicationId, String sdkName, String sdkVersion,
         Configuration configuration) {
         StringBuilder userAgentBuilder = new StringBuilder();
 
-        // Only add the application ID if it is present as it is optional.
-        if (applicationId != null) {
-            applicationId = applicationId.length() > MAX_APP_ID_LENGTH ? applicationId.substring(0, MAX_APP_ID_LENGTH)
-                : applicationId;
-            userAgentBuilder.append(applicationId).append(" ");
+        if (!CoreUtils.isNullOrEmpty(applicationId)) {
+            if (applicationId.length() > MAX_APPLICATION_ID_LENGTH) {
+                throw new IllegalArgumentException(INVALID_APPLICATION_ID_LENGTH);
+            } else if (applicationId.contains(" ")) {
+                throw new IllegalArgumentException(INVALID_APPLICATION_ID_SPACE);
+            } else {
+                userAgentBuilder.append(applicationId).append(" ");
+            }
         }
 
         // Add the required default User-Agent string.

sdk/core/azure-core/src/test/java/com/azure/core/http/policy/HttpLogOptionsTest.java

@@ -13,8 +13,8 @@ public class HttpLogOptionsTest {
     @SuppressWarnings("deprecation")
     @Test
     public void testMaxApplicationId() {
-        assertThrows(IllegalArgumentException.class, () -> new HttpLogOptions()
-            .setApplicationId("AppId-0123456789012345678912345"));
+        assertThrows(IllegalArgumentException.class,
+            () -> new HttpLogOptions().setApplicationId("AppId-0123456789012345678912345"));
     }
 
     @SuppressWarnings("deprecation")

sdk/core/azure-core/src/test/java/com/azure/core/util/UserAgentUtilTest.java

@@ -4,6 +4,7 @@
 package com.azure.core.util;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 import org.junit.jupiter.api.Test;
 
@@ -38,7 +39,7 @@ void testUserAgentStringFormat() {
                 Configuration.getGlobalConfiguration().clone().put("AZURE_TELEMETRY_DISABLED", "true")));
 
         // long app id should be truncated
-        assertEquals("ReallyLongApplicationIde azsdk-java-azure-storage-blob/12.0.0 " + plaform,
+        assertThrows(IllegalArgumentException.class, () ->
             UserAgentUtil.toUserAgentString("ReallyLongApplicationIdentity", "azure-storage-blob", "12.0.0", null));
 
         // null sdk name and version