feat: Update SignIn API to accept authFlowType (#2846)

Co-authored-by: Dhuka <[email protected]>

Author: sdhuka

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

@@ -109,6 +109,7 @@
 import com.amazonaws.services.cognitoidentity.model.NotAuthorizedException;
 import com.amazonaws.services.cognitoidentityprovider.AmazonCognitoIdentityProvider;
 import com.amazonaws.services.cognitoidentityprovider.AmazonCognitoIdentityProviderClient;
+import com.amazonaws.services.cognitoidentityprovider.model.AuthFlowType;
 import com.amazonaws.services.cognitoidentityprovider.model.GlobalSignOutRequest;
 import com.amazonaws.services.cognitoidentityprovider.model.InvalidUserPoolConfigurationException;
 import com.amazonaws.util.StringUtils;
@@ -1192,7 +1193,19 @@ public void signIn(final String username,
                        final Callback<SignInResult> callback) {
 
         final InternalCallback<SignInResult> internalCallback = new InternalCallback<SignInResult>(callback);
-        internalCallback.async(_signIn(username, password, validationData, clientMetadata, internalCallback));
+        internalCallback.async(_signIn(username, password, validationData, clientMetadata, null, internalCallback));
+    }
+
+    @AnyThread
+    public void signIn(final String username,
+                       final String password,
+                       final Map<String, String> validationData,
+                       final Map<String, String> clientMetadata,
+                       final AuthFlowType authFlowType,
+                       final Callback<SignInResult> callback) {
+
+        final InternalCallback<SignInResult> internalCallback = new InternalCallback<SignInResult>(callback);
+        internalCallback.async(_signIn(username, password, validationData, clientMetadata, authFlowType, internalCallback));
     }
 
     @WorkerThread
@@ -1209,13 +1222,25 @@ public SignInResult signIn(final String username,
                                final Map<String, String> clientMetadata) throws Exception {
 
         final InternalCallback<SignInResult> internalCallback = new InternalCallback<SignInResult>();
-        return internalCallback.await(_signIn(username, password, validationData, clientMetadata, internalCallback));
+        return internalCallback.await(_signIn(username, password, validationData, clientMetadata, null, internalCallback));
+    }
+
+    @WorkerThread
+    public SignInResult signIn(final String username,
+                               final String password,
+                               final Map<String, String> validationData,
+                               final Map<String, String> clientMetadata,
+                               final AuthFlowType authFlowType) throws Exception {
+
+        final InternalCallback<SignInResult> internalCallback = new InternalCallback<SignInResult>();
+        return internalCallback.await(_signIn(username, password, validationData, clientMetadata, authFlowType, internalCallback));
     }
 
     private Runnable _signIn(final String username,
                              final String password,
                              final Map<String, String> validationData,
                              final Map<String, String> clientMetadata,
+                             final AuthFlowType authFlowType,
                              final Callback<SignInResult> callback) {
 
         this.signInCallback = callback;
@@ -1264,18 +1289,19 @@ public void getAuthenticationDetails(AuthenticationContinuation authenticationCo
                                     awsConfiguration.optJsonObject(AUTH_KEY).has("authenticationFlowType");
 
                                 try {
-                                    String authFlowType = authFlowTypeInConfig ?
-                                        awsConfiguration.optJsonObject(AUTH_KEY).getString("authenticationFlowType") :
-                                        null;
-                                    if (authFlowTypeInConfig && AUTH_TYPE_INIT_CUSTOM_AUTH.equals(authFlowType)) {
+                                    String resolvedAuthFlowType = authFlowType != null ? authFlowType.name() : null;
+                                    if (resolvedAuthFlowType == null && authFlowTypeInConfig) {
+                                        resolvedAuthFlowType = awsConfiguration.optJsonObject(AUTH_KEY).getString("authenticationFlowType");
+                                    }
+                                    if (resolvedAuthFlowType != null && AUTH_TYPE_INIT_CUSTOM_AUTH.equals(resolvedAuthFlowType)) {
                                         // If there's a value in the config and it's CUSTOM_AUTH, we'll
                                         // use one of the below constructors depending on what's passed in.
                                         if (password != null) {
                                             authenticationContinuation.setAuthenticationDetails(new AuthenticationDetails(username, password, authParameters, validationData));
                                         } else {
                                             authenticationContinuation.setAuthenticationDetails(new AuthenticationDetails(username, authParameters, validationData));
                                         }
-                                    } else if (authFlowTypeInConfig && AUTH_TYPE_INIT_USER_PASSWORD.equals(authFlowType)) {
+                                    } else if (resolvedAuthFlowType != null && AUTH_TYPE_INIT_USER_PASSWORD.equals(resolvedAuthFlowType)) {
                                         // If there's a value in the config and it's USER_PASSWORD_AUTH, set the auth type (challenge name)
                                         // to be USER_PASSWORD.
                                         AuthenticationDetails authenticationDetails = new AuthenticationDetails(username, password, validationData);
@@ -1703,7 +1729,7 @@ public void deleteUser(final Callback<Void> callback) {
         final InternalCallback<Void> internalCallback = new InternalCallback<>(callback);
         internalCallback.async(_deleteUser(internalCallback));
     }
-    
+
     private Runnable _deleteUser(final Callback<Void> callback) {
         return () -> {
             if (userpool == null) {

aws-android-sdk-mobile-client/src/test/java/com/amazonaws/mobile/client/AWSMobileClientAuthFlowSettingTest.java

@@ -27,6 +27,7 @@
 import com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.AuthenticationDetails;
 import com.amazonaws.mobileconnectors.cognitoidentityprovider.handlers.AuthenticationHandler;
 
+import com.amazonaws.services.cognitoidentityprovider.model.AuthFlowType;
 import org.json.JSONException;
 import org.json.JSONObject;
 import org.junit.Before;
@@ -82,54 +83,71 @@ public void beforeEachTest() {
     public void testUserPasswordAuth() throws JSONException, InterruptedException {
         String flowFromConfig = "USER_PASSWORD_AUTH";
         String expectedAuthType = "USER_PASSWORD";
-        verifyScenario(flowFromConfig, expectedAuthType);
+        verifyScenario(flowFromConfig, null, expectedAuthType);
     }
 
     @Test
     public void testUserSrpAuth() throws JSONException, InterruptedException {
         String flowFromConfig = "USER_SRP_AUTH";
         String expectedAuthType = "PASSWORD_VERIFIER";
-        verifyScenario(flowFromConfig, expectedAuthType);
+        verifyScenario(flowFromConfig, null, expectedAuthType);
     }
 
     @Test
     public void testCustomAuth() throws JSONException, InterruptedException {
         String flowFromConfig = "CUSTOM_AUTH";
         String expectedAuthType = "CUSTOM_CHALLENGE";
-        verifyScenario(flowFromConfig, expectedAuthType);
+        verifyScenario(flowFromConfig, null, expectedAuthType);
     }
 
     @Test
     public void testNoAuthFlowInConfig() throws JSONException, InterruptedException {
         String flowFromConfig = null;
         String expectedAuthType = "PASSWORD_VERIFIER";
-        verifyScenario(flowFromConfig, expectedAuthType);
+        verifyScenario(flowFromConfig, null, expectedAuthType);
+    }
+
+    @Test
+    public void testSwitchAuthFlowInAPI() throws JSONException, InterruptedException {
+        String flowFromConfig = "USER_SRP_AUTH";
+        String expectedAuthType = "CUSTOM_CHALLENGE";
+        verifyScenario(flowFromConfig, "CUSTOM_AUTH", expectedAuthType);
+    }
+
+    @Test
+    public void testSwitchFromNoAuthFlowInConfig() throws JSONException, InterruptedException {
+        String flowFromConfig = null;
+        String expectedAuthType = "USER_PASSWORD";
+        verifyScenario(flowFromConfig, "USER_PASSWORD_AUTH", expectedAuthType);
     }
 
     /**
      * Verify that the correct auth type (aka challenge name) is passed in based on the
      * auth flow type from the config file.
-     * @param authFlowType The auth flow type from the config.
+     * @param configAuthFlowType The auth flow type from the config.
      * @param expectedAuthType The auth type expected.
+     * @param overridenAuthFlowType The authType passed to the API
      * @throws JSONException Not expected.
      * @throws InterruptedException Not expected.
      */
-    private void verifyScenario(String authFlowType, String expectedAuthType) throws JSONException, InterruptedException {
+    private void verifyScenario(String configAuthFlowType, String overridenAuthFlowType, String expectedAuthType) throws JSONException, InterruptedException {
         AuthenticationContinuation mockContinuation = setupMockContinuation();
         CognitoUserPool mockUserPool = setupMockUserPool(mockContinuation);
-        initMobileClientAndWait(authFlowType, mockUserPool);
-        signinAndWait();
+        initMobileClientAndWait(configAuthFlowType, mockUserPool);
+        signinAndWait(overridenAuthFlowType);
         ArgumentCaptor<AuthenticationDetails> argumentCaptor = ArgumentCaptor.forClass(AuthenticationDetails.class);
         verify(mockContinuation).setAuthenticationDetails(argumentCaptor.capture());
         AuthenticationDetails actualAuthDetails = argumentCaptor.getValue();
         assertEquals(expectedAuthType, actualAuthDetails.getAuthenticationType());
     }
 
-    private void signinAndWait() throws InterruptedException {
+    private void signinAndWait(String overridenAuthFlowType) throws InterruptedException {
+        AuthFlowType overridenAuthFlowEnum = overridenAuthFlowType == null ? null : AuthFlowType.valueOf(overridenAuthFlowType);
         mobileClient.signIn("test",
                             "fakepassword",
                             Collections.emptyMap(),
                             Collections.emptyMap(),
+                            overridenAuthFlowEnum,
                             new Callback<SignInResult>() {
                                 @Override
                                 public void onResult(SignInResult result) {