"feat(aws-android-sdk-cognitoidentityprovider): support custom endpoint" (#2455)

Author: thisisabhash

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

@@ -274,7 +274,6 @@ public CognitoUserPool(Context context, String userPoolId, String clientId, Stri
         this.pinpointEndpointId = CognitoPinpointSharedContext.getPinpointEndpoint(context, pinpointAppId);
     }
 
-
     /**
      * Constructs a user-pool with default {@link ClientConfiguration}.
      *
@@ -303,15 +302,37 @@ public CognitoUserPool(Context context, String userPoolId, String clientId, Stri
      * @param pinpointAppId         REQUIRED: AWS Pinpoint App Id for analytics.
      */
     public CognitoUserPool(Context context, String userPoolId, String clientId, String clientSecret, AmazonCognitoIdentityProvider client, String pinpointAppId) {
+        this(context, userPoolId, clientId, clientSecret, client, pinpointAppId, null);
+    }
+
+    /**
+     * Constructs a user-pool with custom endpoint for Cognito User Pool
+     *
+     * @param context               REQUIRED: Android application context.
+     * @param userPoolId            REQUIRED: User-pool-Id of the user-pool.
+     * @param clientId              REQUIRED: Client-Id generated for this app and user-pool at the
+     *                              Cognito Identity Provider developer console.
+     * @param clientSecret          REQUIRED: Client Secret generated for this app and user-pool at
+     *                              the Cognito Identity Provider developer console.
+     * @param pinpointAppId         REQUIRED: AWS Pinpoint App Id for analytics.
+     * @param cognitoUserPoolCustomEndpoint REQUIRED: Custom endpoint for Cognito Userpool
+     */
+    public CognitoUserPool(Context context, String userPoolId, String clientId, String clientSecret, AmazonCognitoIdentityProvider client, String pinpointAppId, String cognitoUserPoolCustomEndpoint) {
         initialize(context);
         this.context = context;
         this.userPoolId = userPoolId;
         this.clientId = clientId;
         this.clientSecret = clientSecret;
         this.client = client;
         this.pinpointEndpointId = CognitoPinpointSharedContext.getPinpointEndpoint(context, pinpointAppId);
+
+        // check if the custom endpoint is not empty
+        if(cognitoUserPoolCustomEndpoint != null && !cognitoUserPoolCustomEndpoint.isEmpty()) {
+            this.client.setEndpoint(cognitoUserPoolCustomEndpoint);
+        }
     }
 
+
     private void initialize(final Context context) {
         this.awsKeyValueStore = new AWSKeyValueStore(context,
                 DEFAULT_SHARED_PREFERENCES_NAME,

aws-android-sdk-cognitoidentityprovider/src/test/java/CognitoIdentityProviderCustomEndPointTest.java

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2020-2021 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.
+ */
+
+import android.content.Context;
+
+import com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUserPool;
+import com.amazonaws.services.cognitoidentityprovider.AmazonCognitoIdentityProvider;
+import com.amazonaws.services.cognitoidentityprovider.AmazonCognitoIdentityProviderClient;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyZeroInteractions;
+
+/**
+ * Unit test cases for checking the custom end points for Cognito User Identity Pool
+ */
+public class CognitoIdentityProviderCustomEndPointTest {
+
+    private CognitoUserPool testPool;
+    public static final String TEST_USER_POOL           = "DummyUserPool";
+    public static final String TEST_CLIENT_ID           = "DummyClientId";
+    public static final String TEST_CLIENT_SECRET       = "DummyClientSecret";
+    public static final String TEST_PINPOINT_APP_ID     = "DummyPinpointAppId";
+    public static final String DUMMY_CUSTOM_ENDPOINT    = "my-custom-endpoint.amazon.com";
+
+    @Mock
+    private AmazonCognitoIdentityProviderClient mockCustomEndpointClient;
+
+    @Mock
+    private Context appContext;
+
+    @Before
+    public void init() {
+        MockitoAnnotations.initMocks(this);
+    }
+
+    /**
+     * Test that end point is set for the {@link AmazonCognitoIdentityProviderClient } with correct value
+     * when {@link CognitoUserPool#CognitoUserPool(Context, String, String, String, AmazonCognitoIdentityProvider, String, String)} is called
+     * with a valid endpoint
+     */
+    @Test
+    public void testForCustomEndpoint() {
+        testPool = new CognitoUserPool(appContext, TEST_USER_POOL, TEST_CLIENT_ID, TEST_CLIENT_SECRET, mockCustomEndpointClient, TEST_PINPOINT_APP_ID, DUMMY_CUSTOM_ENDPOINT);
+        verify(mockCustomEndpointClient).setEndpoint(DUMMY_CUSTOM_ENDPOINT);
+    }
+
+    /**
+     * Test that end point is not set for the {@link AmazonCognitoIdentityProviderClient }
+     * when {@link CognitoUserPool#CognitoUserPool(Context, String, String, String, AmazonCognitoIdentityProvider, String, String)} is called
+     * with a null endpoint
+     */
+    @Test
+    public void testForCustomEndpointWhenNull() {
+        testPool = new CognitoUserPool(appContext, TEST_USER_POOL, TEST_CLIENT_ID, TEST_CLIENT_SECRET, mockCustomEndpointClient, TEST_PINPOINT_APP_ID, null);
+        verifyZeroInteractions(mockCustomEndpointClient);
+    }
+
+    /**
+     * Test that end point is not set for the {@link AmazonCognitoIdentityProviderClient }
+     * when {@link CognitoUserPool#CognitoUserPool(Context, String, String, String, AmazonCognitoIdentityProvider, String, String)} is called
+     * with an empty endpoint
+     */
+    @Test
+    public void testForCustomEndpointWhenEmpty() {
+        testPool = new CognitoUserPool(appContext, TEST_USER_POOL, TEST_CLIENT_ID, TEST_CLIENT_SECRET, mockCustomEndpointClient, TEST_PINPOINT_APP_ID, "");
+        verifyZeroInteractions(mockCustomEndpointClient);
+    }
+
+
+}

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

@@ -189,6 +189,12 @@ public final class AWSMobileClient implements AWSCredentialsProvider {
     private static final String FACEBOOK = "FacebookSignIn";
     private static final String GOOGLE = "GoogleSignIn";
     private static final String GOOGLE_WEBAPP_CONFIG_KEY = "ClientId-WebApp";
+
+    /**
+     * Configuration key for Cognito User Pool Custom Endpoint
+     */
+    private static final String COGNITO_USERPOOL_CUSTOM_ENDPOINT = "Endpoint";
+
     /**
      * Singleton instance for AWSMobileClient.
      */
@@ -557,6 +563,7 @@ public void onUserSignedOut() {
                             final String clientId = userPoolJSON.getString("AppClientId");
                             final String clientSecret = userPoolJSON.optString("AppClientSecret");
                             final String pinpointEndpointId = CognitoPinpointSharedContext.getPinpointEndpoint(context, userPoolJSON.optString("PinpointAppId"));
+                            final String cognitoUserPoolCustomEndpoint = userPoolJSON.optString(COGNITO_USERPOOL_CUSTOM_ENDPOINT);
 
                             final ClientConfiguration clientConfig = new ClientConfiguration();
                             clientConfig.setUserAgent(DEFAULT_USER_AGENT + " " + awsConfiguration.getUserAgent());
@@ -569,7 +576,7 @@ public void onUserSignedOut() {
 
                             userpoolsLoginKey = String.format("cognito-idp.%s.amazonaws.com/%s", userPoolJSON.getString("Region"), userPoolJSON.getString("PoolId"));
 
-                            userpool = new CognitoUserPool(mContext, mUserPoolPoolId, clientId, clientSecret, userpoolLL, pinpointEndpointId);
+                            userpool = new CognitoUserPool(mContext, mUserPoolPoolId, clientId, clientSecret, userpoolLL, pinpointEndpointId, cognitoUserPoolCustomEndpoint);
                             userpool.setPersistenceEnabled(mIsPersistenceEnabled);
 
                             mDeviceOperations = new DeviceOperations(AWSMobileClient.this, userpoolLL);