Adds override for User Agent in AWSMobileClient (#2024)

Currently if the user agent value is set in the client config, it may be appended to other values. This PR adds the ability to set a user agent override value which will ensure that nothing is appended on to it and it is sent as the final user agent.

The reason for this change is that Amplify Auth uses AWSMobileClient which uses underlying User Pool and Identity Pool SDKs. This is how user agents are currently handled:

Someone uses aws-android-sdk-auth-userpools: User Agent = userpools_UA
Someone uses aws-android-sdk-cognitoidentityprovider: User Agent = cognitoidentityprovider_UA
Someone uses AWSMobileClient:
Methods using userpools: User Agent = userpools_UA + AMC_string
Methods using cognito identity provider: User Agent = cognitoidentityprovider_UA + AMC_string
Until now, someone using Amplify Auth would have the same user agent sent as AWSMobileClient because it uses AWSMobileClient. This is a problem since Amplify Auth usage can't be correctly attributed. The solution requested by the product team is that someone using Amplify Auth has the Amplify user agent sent, completely overriding any of the other user agents the SDKs currently use.

Author: TrekSoft

aws-android-sdk-auth-core/src/main/java/com/amazonaws/mobile/auth/core/IdentityManager.java

@@ -223,7 +223,9 @@ public IdentityManager(final Context context,
                            final AWSConfiguration awsConfiguration) {
         this.appContext = context.getApplicationContext();
         this.awsConfiguration = awsConfiguration;
-        this.clientConfiguration = new ClientConfiguration().withUserAgent(awsConfiguration.getUserAgent());
+        this.clientConfiguration = new ClientConfiguration()
+                .withUserAgent(awsConfiguration.getUserAgent())
+                .withUserAgentOverride(awsConfiguration.getUserAgentOverride());
         this.credentialsProviderHolder = new AWSCredentialsProviderHolder();
         createCredentialsProvider(this.appContext, this.clientConfiguration);
         this.awsKeyValueStore = new AWSKeyValueStore(appContext, SHARED_PREF_NAME, isPersistenceEnabled);
@@ -905,7 +907,6 @@ public void login(final Context context,
      */
     private void createCredentialsProvider(final Context context,
                                            final ClientConfiguration clientConfiguration) {
-
         Log.d(LOG_TAG, "Creating the Cognito Caching Credentials Provider "
                 + "with a refreshing Cognito Identity Provider.");
 
@@ -929,9 +930,16 @@ private void createCredentialsProvider(final Context context,
             new AWSRefreshingCognitoIdentityProvider(null, poolId,
                 clientConfiguration, cognitoIdentityRegion);
 
-        final CognitoCachingCredentialsProvider cognitoCachingCredentialsProvider = new CognitoCachingCredentialsProvider(context, refreshingCredentialsProvider,
-                cognitoIdentityRegion, clientConfiguration);
+        final CognitoCachingCredentialsProvider cognitoCachingCredentialsProvider =
+                new CognitoCachingCredentialsProvider(
+                        context,
+                        refreshingCredentialsProvider,
+                        cognitoIdentityRegion,
+                        clientConfiguration);
         cognitoCachingCredentialsProvider.setPersistenceEnabled(isPersistenceEnabled);
+        if (clientConfiguration.getUserAgentOverride() != null) {
+            cognitoCachingCredentialsProvider.setUserAgentOverride(clientConfiguration.getUserAgentOverride());
+        }
         credentialsProviderHolder.setUnderlyingProvider(cognitoCachingCredentialsProvider);
     }
 

aws-android-sdk-cognitoidentityprovider/src/main/java/com/amazonaws/mobileconnectors/cognitoidentityprovider/CognitoUserPool.java

@@ -189,6 +189,7 @@ public CognitoUserPool(Context context, AWSConfiguration awsConfiguration) {
 
             final ClientConfiguration clientConfig = new ClientConfiguration();
             clientConfig.setUserAgent(awsConfiguration.getUserAgent());
+            clientConfig.setUserAgentOverride(awsConfiguration.getUserAgentOverride());
             this.client = new AmazonCognitoIdentityProviderClient(new AnonymousAWSCredentials(), clientConfig);
             this.client.setRegion(com.amazonaws.regions.Region.getRegion(Regions.fromName(userPoolConfiguration.getString("Region"))));
         } catch (Exception e) {

aws-android-sdk-core/src/main/java/com/amazonaws/ClientConfiguration.java

@@ -59,6 +59,12 @@ public class ClientConfiguration {
     /** The HTTP user agent header passed with all HTTP requests. */
     private String userAgent = DEFAULT_USER_AGENT;
 
+    /**
+     * The {@link #userAgent} string is sometimes combined with other strings. If this property is set, it instructs the
+     * client to only use this as the full user agent string.
+     */
+    private String userAgentOverride;
+
     /**
      * The maximum number of times that a retryable failed request (ex: a 5xx
      * response from a service) will be retried. Or -1 if the user has not
@@ -193,6 +199,7 @@ public ClientConfiguration(ClientConfiguration other) {
         this.preemptiveBasicProxyAuth = other.preemptiveBasicProxyAuth;
         this.socketTimeout = other.socketTimeout;
         this.userAgent = other.userAgent;
+        this.userAgentOverride = other.userAgentOverride;
         this.socketReceiveBufferSizeHint = other.socketReceiveBufferSizeHint;
         this.socketSendBufferSizeHint = other.socketSendBufferSizeHint;
         this.signerOverride = other.signerOverride;
@@ -326,6 +333,39 @@ public ClientConfiguration withUserAgent(String userAgent) {
         return this;
     }
 
+    /**
+     * The {@link #userAgent} string is sometimes combined with other strings. If this property is set, it instructs the
+     * client to only use this as the full user agent string.
+     *
+     * @return The string to use as the full user agent when sending requests.
+     */
+    public String getUserAgentOverride() {
+        return userAgentOverride;
+    }
+
+    /**
+     * The {@link #userAgent} string is sometimes combined with other strings. If this property is set, it instructs the
+     * client to only use this as the full user agent string.
+     *
+     * @param userAgentOverride The string to use as the full user agent when sending requests.
+     */
+    public void setUserAgentOverride(String userAgentOverride) {
+        this.userAgentOverride = userAgentOverride;
+    }
+
+    /**
+     * The {@link #userAgent} string is sometimes combined with other strings. If this property is set, it instructs the
+     * client to only use this as the full user agent string.
+     *
+     * @param userAgentOverride The string to use as the full user agent when sending requests.
+     * @return The updated ClientConfiguration object.
+     */
+    @SuppressWarnings("checkstyle:hiddenfield")
+    public ClientConfiguration withUserAgentOverride(String userAgentOverride) {
+        setUserAgentOverride(userAgentOverride);
+        return this;
+    }
+
     /**
      * Returns the optional local address the client will bind to.
      *

aws-android-sdk-core/src/main/java/com/amazonaws/auth/CognitoCachingCredentialsProvider.java

@@ -110,6 +110,7 @@ public void identityChanged(String oldIdentityId, String newIdentityId) {
         }
     };
     private boolean isPersistenceEnabled = true;
+    private String userAgentOverride;
 
     /**
      * Constructs a new {@link CognitoCachingCredentialsProvider}, which will
@@ -660,7 +661,11 @@ private void saveIdentityId(String identityId) {
 
     @Override
     protected String getUserAgent() {
-        return USER_AGENT;
+        if (userAgentOverride != null) {
+            return userAgentOverride;
+        } else {
+            return USER_AGENT;
+        }
     }
 
     // To support multiple identity pools in the same app, namespacing the keys
@@ -695,4 +700,14 @@ public void setPersistenceEnabled(boolean isPersistenceEnabled) {
         this.isPersistenceEnabled = isPersistenceEnabled;
         this.awsKeyValueStore.setPersistenceEnabled(isPersistenceEnabled);
     }
+
+    /**
+     * The user agent string is sometimes combined with other strings. If this property is set, it instructs the
+     * client to only use this as the full user agent string.
+     *
+     * @param userAgentOverride The string to use as the full user agent when sending requests.
+     */
+    public void setUserAgentOverride(String userAgentOverride) {
+        this.userAgentOverride = userAgentOverride;
+    }
 }

aws-android-sdk-core/src/main/java/com/amazonaws/http/AmazonHttpClient.java

@@ -534,7 +534,8 @@ void setUserAgent(Request<?> request) {
         if (!ClientConfiguration.DEFAULT_USER_AGENT.equals(config.getUserAgent())) {
             userAgent = createUserAgentString(userAgent, config.getUserAgent());
         }
-        request.addHeader(HEADER_USER_AGENT, userAgent);
+        request.addHeader(HEADER_USER_AGENT,
+                config.getUserAgentOverride() != null ? config.getUserAgentOverride() : userAgent);
     }
 
     /**

aws-android-sdk-core/src/main/java/com/amazonaws/mobile/config/AWSConfiguration.java

@@ -181,6 +181,20 @@ public String getUserAgent() {
         }
     }
 
+    /**
+     * The user agent is sometimes combined with other strings. If this property is set, it instructs the
+     * client to only use this as the full user agent string.
+     *
+     * @return The user agent override specified in the configuration file.
+     */
+    public String getUserAgentOverride() {
+        try {
+            return this.mJSONObject.getString("UserAgentOverride");
+        } catch (JSONException je) {
+            return null;
+        }
+    }
+
     /**
      * Change the settings that are being read in. This is "Default" by default.
      * 

aws-android-sdk-mobile-client/src/main/java/com/amazonaws/mobile/client/AWSMobileClient.java

@@ -166,8 +166,9 @@ public final class AWSMobileClient implements AWSCredentialsProvider {
      * Log Tag.
      */
     private static final String TAG = AWSMobileClient.class.getSimpleName();
-    public static final String USER_AGENT = "AWSMobileClient";
+    public static final String DEFAULT_USER_AGENT = "AWSMobileClient";
 
+    static final String AUTH_KEY = "Auth";
     static final String SHARED_PREFERENCES_KEY = "com.amazonaws.mobile.client";
     static final String PROVIDER_KEY = "provider";
     static final String TOKEN_KEY = "token";
@@ -266,6 +267,7 @@ public final class AWSMobileClient implements AWSCredentialsProvider {
     Auth hostedUI;
     OAuth2Client mOAuth2Client;
     String mUserPoolPoolId;
+    String userAgentOverride;
 
     enum SignInMode {
         SIGN_IN("0"),
@@ -464,10 +466,10 @@ public void run() {
                     // Read Persistence key from the awsconfiguration.json and set the flag
                     // appropriately.
                     try {
-                        if (awsConfiguration.optJsonObject("Auth") != null &&
-                                awsConfiguration.optJsonObject("Auth").has("Persistence")) {
+                        if (awsConfiguration.optJsonObject(AUTH_KEY) != null &&
+                                awsConfiguration.optJsonObject(AUTH_KEY).has("Persistence")) {
                             mIsPersistenceEnabled = awsConfiguration
-                                    .optJsonObject("Auth")
+                                    .optJsonObject(AUTH_KEY)
                                     .getBoolean("Persistence");
                         }
                     } catch (final Exception ex) {
@@ -476,6 +478,7 @@ public void run() {
                         return;
                     }
 
+                    userAgentOverride = awsConfiguration.getUserAgentOverride();
                     mContext = context.getApplicationContext();
                     mStore = new AWSMobileClientStore(AWSMobileClient.this);
 
@@ -525,15 +528,21 @@ public void onUserSignedOut() {
                             final String poolId = identityPoolJSON.getString("PoolId");
                             final String regionStr = identityPoolJSON.getString("Region");
                             final ClientConfiguration clientConfig = new ClientConfiguration();
-                            clientConfig.setUserAgent(USER_AGENT + " " + awsConfiguration.getUserAgent());
+                            clientConfig.setUserAgent(DEFAULT_USER_AGENT + " " + awsConfiguration.getUserAgent());
+                            if (userAgentOverride != null) {
+                                clientConfig.setUserAgentOverride(userAgentOverride);
+                            }
                             AmazonCognitoIdentityClient cibClient =
-                                    new AmazonCognitoIdentityClient(new AnonymousAWSCredentials());
+                                    new AmazonCognitoIdentityClient(new AnonymousAWSCredentials(), clientConfig);
                             cibClient.setRegion(Region.getRegion(regionStr));
                             provider = new AWSMobileClientCognitoIdentityProvider(
                                     null, poolId, cibClient);
                             cognitoIdentity = new CognitoCachingCredentialsProvider(
                                     mContext, provider, Regions.fromName(regionStr));
                             cognitoIdentity.setPersistenceEnabled(mIsPersistenceEnabled);
+                            if (userAgentOverride != null) {
+                                cognitoIdentity.setUserAgentOverride(userAgentOverride);
+                            }
                         } catch (Exception e) {
                             callback.onError(new RuntimeException("Failed to initialize Cognito Identity; please check your awsconfiguration.json", e));
                             return;
@@ -549,7 +558,10 @@ public void onUserSignedOut() {
                             final String pinpointEndpointId = CognitoPinpointSharedContext.getPinpointEndpoint(context, userPoolJSON.optString("PinpointAppId"));
 
                             final ClientConfiguration clientConfig = new ClientConfiguration();
-                            clientConfig.setUserAgent(USER_AGENT + " " + awsConfiguration.getUserAgent());
+                            clientConfig.setUserAgent(DEFAULT_USER_AGENT + " " + awsConfiguration.getUserAgent());
+                            if (userAgentOverride != null) {
+                               clientConfig.setUserAgentOverride(userAgentOverride);
+                            }
                             userpoolLL =
                                     new AmazonCognitoIdentityProviderClient(new AnonymousAWSCredentials(), clientConfig);
                             userpoolLL.setRegion(com.amazonaws.regions.Region.getRegion(Regions.fromName(userPoolJSON.getString("Region"))));
@@ -575,6 +587,7 @@ public void onUserSignedOut() {
                                 Log.d(TAG, "initialize: OAuth2 client detected");
                                 mOAuth2Client = new OAuth2Client(mContext, AWSMobileClient.this);
                                 mOAuth2Client.setPersistenceEnabled(mIsPersistenceEnabled);
+                                mOAuth2Client.setUserAgentOverride(userAgentOverride);
                             } else {
                                 _initializeHostedUI(hostedUIJSON);
                             }
@@ -638,7 +651,7 @@ JSONObject getHostedUIJSONFromJSON() {
     }
 
     JSONObject getHostedUIJSONFromJSON(final AWSConfiguration awsConfig) {
-        final JSONObject mobileClientJSON = awsConfig.optJsonObject("Auth");
+        final JSONObject mobileClientJSON = awsConfig.optJsonObject(AUTH_KEY);
         if (mobileClientJSON != null && mobileClientJSON.has("OAuth")) {
             try {
                 JSONObject hostedUIJSONFromJSON = mobileClientJSON.getJSONObject("OAuth");
@@ -1192,18 +1205,20 @@ public void onSuccess(CognitoUserSession userSession, CognitoDevice newDevice) {
                             public void getAuthenticationDetails(AuthenticationContinuation authenticationContinuation, String userId) {
                                 Log.d(TAG, "Sending password.");
                                 try {
-                                    if (awsConfiguration.optJsonObject("Auth") != null &&
-                                            awsConfiguration.optJsonObject("Auth").has("authenticationFlowType") &&
-                                            awsConfiguration.optJsonObject("Auth").getString("authenticationFlowType").equals("CUSTOM_AUTH")
+                                    if (
+                                            awsConfiguration.optJsonObject(AUTH_KEY) != null &&
+                                            awsConfiguration.optJsonObject(AUTH_KEY).has("authenticationFlowType") &&
+                                            awsConfiguration.optJsonObject(AUTH_KEY).getString("authenticationFlowType").equals("CUSTOM_AUTH")
                                     ) {
-                                        final HashMap<String, String> authParameters = new HashMap<String,String>();
+                                        final HashMap<String, String> authParameters = new HashMap<String, String>();
                                         authenticationContinuation.setAuthenticationDetails(new AuthenticationDetails(username, password, authParameters, validationData));
                                     } else {
                                         authenticationContinuation.setAuthenticationDetails(new AuthenticationDetails(username, password, validationData));
                                     }
                                 } catch (JSONException e) {
                                     e.printStackTrace();
                                 }
+
                                 authenticationContinuation.continueTask();
                             }
 
@@ -1451,9 +1466,9 @@ public void signOut() {
         mFederatedLoginsMap.clear();
         mStore.clear();
         String hostedUIJSON = null;
-        if (awsConfiguration.optJsonObject("Auth") != null && awsConfiguration.optJsonObject("Auth").has("OAuth")) {
+        if (awsConfiguration.optJsonObject(AUTH_KEY) != null && awsConfiguration.optJsonObject(AUTH_KEY).has("OAuth")) {
             try {
-                hostedUIJSON = awsConfiguration.optJsonObject("Auth").getJSONObject("OAuth").toString();
+                hostedUIJSON = awsConfiguration.optJsonObject(AUTH_KEY).getJSONObject("OAuth").toString();
             } catch (JSONException e) {
                 e.printStackTrace();
             }
@@ -3815,32 +3830,6 @@ class AWSMobileClientCognitoIdentityProvider extends AWSAbstractCognitoIdentityP
 
     boolean isDeveloperAuthenticated;
 
-    /**
-     * An extension of the AbstractCognitoProvider that is used to communicate
-     * with Cognito.
-     *
-     * @param accountId the account id of the developer
-     * @param identityPoolId the identity pool id of the app/user in question
-     */
-    public AWSMobileClientCognitoIdentityProvider(String accountId, String identityPoolId) {
-        this(accountId, identityPoolId, new ClientConfiguration());
-    }
-
-    /**
-     * An extension of the AbstractCognitoProvider that is used to communicate
-     * with Cognito.
-     *
-     * @param accountId the account id of the developer
-     * @param identityPoolId the identity pool id of the app/user in question
-     * @param clientConfiguration the configuration to apply to service clients
-     *            created
-     */
-    public AWSMobileClientCognitoIdentityProvider(String accountId, String identityPoolId,
-                                              ClientConfiguration clientConfiguration) {
-        this(accountId, identityPoolId, new AmazonCognitoIdentityClient
-                (new AnonymousAWSCredentials(), clientConfiguration));
-    }
-
     /**
      * An extension of the AbstractCognitoProvider that is used to communicate
      * with Cognito.
@@ -3857,7 +3846,7 @@ public AWSMobileClientCognitoIdentityProvider(String accountId, String identityP
 
     @Override
     protected String getUserAgent() {
-        return "AWSMobileClient";
+        return AWSMobileClient.DEFAULT_USER_AGENT;
     }
 
     /**