fix: permit passing client metadata to signin (#2053)

Resolves: #2048

Author: jamesonwilliams

aws-android-sdk-cognitoidentityprovider/build.gradle

@@ -10,10 +10,16 @@ android {
         versionCode 1
         versionName '1.0'
     }
+
+    testOptions.unitTests.includeAndroidResources = true
 }
 
 dependencies {
     api project(':aws-android-sdk-core')
     implementation 'com.amazonaws:aws-android-sdk-cognitoidentityprovider-asf:1.0.0'
-}
 
+    testImplementation 'junit:junit:4.13'
+    testImplementation 'org.mockito:mockito-core:1.10.19'
+    testImplementation 'org.robolectric:robolectric:4.3.1'
+    testImplementation 'androidx.test:core:1.2.0'
+}

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

@@ -24,6 +24,7 @@
 import com.amazonaws.mobileconnectors.cognitoidentityprovider.handlers.AuthenticationHandler;
 
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.Map;
 
 /**
@@ -47,17 +48,10 @@ public class AuthenticationContinuation implements CognitoIdentityProviderContin
     private final Context context;
     private final AuthenticationHandler callback;
     private final boolean runInBackground;
+    private final Map<String, String> clientMetadata;
 
     private AuthenticationDetails authenticationDetails = null;
-    private Map<String, String> clientMetadata;
 
-    /**
-     * Constructs a new continuation in the authentication process.
-     *
-     * @param user
-     * @param runInBackground
-     * @param callback
-     */
     /**
      * Constructs a new continuation in the authentication process.
      *
@@ -74,7 +68,7 @@ public AuthenticationContinuation(CognitoUser user,
         this.context = context;
         this.runInBackground = runInBackground;
         this.callback = callback;
-        this.clientMetadata = Collections.emptyMap();
+        this.clientMetadata = new HashMap<>();
     }
 
     /**
@@ -84,8 +78,9 @@ public AuthenticationContinuation(CognitoUser user,
      * </p>
      * @return ClientMetadata
      */
+    @SuppressWarnings("unused")
     public Map<String, String> getClientMetaData() {
-        return clientMetadata;
+        return Collections.unmodifiableMap(clientMetadata);
     }
 
     /**
@@ -94,14 +89,17 @@ public Map<String, String> getClientMetaData() {
      */
     public void setClientMetaData(Map<String, String> clientMetadata) {
         this.clientMetadata.clear();
-        this.clientMetadata.putAll(clientMetadata);
+        if (clientMetadata != null) {
+            this.clientMetadata.putAll(clientMetadata);
+        }
     }
 
     /**
      * Returns the parameters required for this continuation.
      *
      * @return
      */
+    @SuppressWarnings("JavaDoc")
     @Override
     public String getParameters() {
         return "AuthenticationDetails";

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

@@ -46,6 +46,7 @@ public class ChallengeContinuation implements CognitoIdentityProviderContinuatio
      */
     public static final boolean RUN_IN_CURRENT = false;
 
+    protected final Map<String, String> challengeResponses;
     private final RespondToAuthChallengeResult challengeResult;
     private final Context context;
     private final String clientId;
@@ -54,8 +55,7 @@ public class ChallengeContinuation implements CognitoIdentityProviderContinuatio
     private final String username;
     private final AuthenticationHandler callback;
     private final boolean runInBackground;
-    protected Map<String, String> challengeResponses;
-    protected Map<String, String> clientMetaData;
+    private final Map<String, String> clientMetaData;
 
     /**
      * Constructs a continuation for a challenge to be presented to the user.
@@ -86,8 +86,8 @@ public ChallengeContinuation(CognitoUser user,
         this.username = username;
         this.callback = callback;
         this.runInBackground = runInBackground;
-        challengeResponses = new HashMap<>();
-        clientMetaData = new HashMap<>();
+        this.challengeResponses = new HashMap<>();
+        this.clientMetaData = new HashMap<>();
     }
 
     /**
@@ -98,15 +98,18 @@ public ChallengeContinuation(CognitoUser user,
      * @return ClientMetadata
      */
     public Map<String, String> getClientMetaData() {
-        return clientMetaData;
+        return Collections.unmodifiableMap(clientMetaData);
     }
 
     /**
      * Mutator for <code>clientMetadata</code>.
      * @param clientMetaData MetaData to be passed as input to the lambda triggers.
      */
     public void setClientMetaData(Map<String, String> clientMetaData) {
-        this.clientMetaData = Collections.unmodifiableMap(clientMetaData);
+        this.clientMetaData.clear();
+        if (clientMetaData != null) {
+            this.clientMetaData.putAll(clientMetaData);
+        }
     }
 
     /**
@@ -162,7 +165,7 @@ public void continueTask() {
         respondToAuthChallengeRequest.setSession(challengeResult.getSession());
         respondToAuthChallengeRequest.setClientId(clientId);
         respondToAuthChallengeRequest.setChallengeResponses(challengeResponses);
-        if (clientMetaData != null) {
+        if (!clientMetaData.isEmpty()) {
             respondToAuthChallengeRequest.setClientMetadata(clientMetaData);
         }
         if (runInBackground) {

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

@@ -21,6 +21,7 @@
 import com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUserCodeDeliveryDetails;
 import com.amazonaws.mobileconnectors.cognitoidentityprovider.handlers.ForgotPasswordHandler;
 
+import java.util.HashMap;
 import java.util.Map;
 
 /**
@@ -42,10 +43,10 @@ public class ForgotPasswordContinuation implements CognitoIdentityProviderContin
     private final CognitoUser user;
     private final CognitoUserCodeDeliveryDetails parameters;
     private final boolean runInBackground;
+    private final Map<String, String> clientMetadata;
 
     private String password = null;
     private String verificationCode = null;
-    private Map<String, String> clientMetadata;
 
     /**
      * Constructs a new Continuation for forgot password process.
@@ -63,6 +64,7 @@ public ForgotPasswordContinuation(CognitoUser user,
         this.user = user;
         this.parameters = parameters;
         this.runInBackground = runInBackground;
+        this.clientMetadata = new HashMap<>();
     }
 
     /**
@@ -110,6 +112,9 @@ public void setVerificationCode(String verificationCode) {
      * @param clientMetadata
      */
     public void setClientMetadata(final Map<String, String> clientMetadata) {
-        this.clientMetadata = clientMetadata;
+        this.clientMetadata.clear();
+        if (clientMetadata != null) {
+            this.clientMetadata.putAll(clientMetadata);
+        }
     }
 }

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

@@ -27,6 +27,7 @@
 import com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeResult;
 
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.Map;
 
 /**
@@ -49,8 +50,9 @@ public class MultiFactorAuthenticationContinuation implements CognitoIdentityPro
     private final RespondToAuthChallengeResult challenge;
     private final boolean runInBackground;
     private final AuthenticationHandler callback;
+    private final Map<String, String> clientMetadata;
+
     private String mfaCode = null;
-    private Map<String, String> clientMetadata;
 
     /**
      * Constructs a multi-factor authentication continuation.
@@ -71,7 +73,7 @@ public MultiFactorAuthenticationContinuation(CognitoUser user,
         this.callback = callback;
         this.runInBackground = runInBackground;
         this.challenge = challenge;
-        this.clientMetadata = Collections.emptyMap();
+        this.clientMetadata = new HashMap<>();
     }
 
     /**
@@ -82,7 +84,7 @@ public MultiFactorAuthenticationContinuation(CognitoUser user,
      * @return ClientMetadata
      */
     public Map<String, String> getClientMetaData() {
-        return clientMetadata;
+        return Collections.unmodifiableMap(clientMetadata);
     }
 
     /**
@@ -91,7 +93,9 @@ public Map<String, String> getClientMetaData() {
      */
     public void setClientMetaData(Map<String, String> clientMetadata) {
         this.clientMetadata.clear();
-        this.clientMetadata.putAll(clientMetadata);
+        if (clientMetadata != null) {
+            this.clientMetadata.putAll(clientMetadata);
+        }
     }
 
     /**

aws-android-sdk-cognitoidentityprovider/src/test/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:tools="http://schemas.android.com/tools"
+    package="com.amazonaws.services.cognitoidentityprovider">
+    <uses-sdk tools:overrideLibrary="androidx.test.core, androidx.test" />
+</manifest>

aws-android-sdk-cognitoidentityprovider/src/test/java/com/amazonaws/mobileconnectors/cognitoidentityprovider/continuations/AuthenticationContinuationTest.java

@@ -0,0 +1,72 @@
+/*
+ *  Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Licensed under the Amazon Software License (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/asl/
+ *
+ *  or in the "license" file accompanying this file. This file is
+ *  distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ *  CONDITIONS OF ANY KIND, express or implied. See the License
+ *  for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations;
+
+import com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUser;
+import com.amazonaws.mobileconnectors.cognitoidentityprovider.handlers.AuthenticationHandler;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.annotation.Config;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+import static androidx.test.core.app.ApplicationProvider.getApplicationContext;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+
+/**
+ * Tests the {@link AuthenticationContinuation}.
+ */
+@RunWith(RobolectricTestRunner.class)
+@Config(manifest= Config.NONE, sdk = 27)
+public final class AuthenticationContinuationTest {
+    /**
+     * What happens when we try to pass client metadata into the handler?
+     * @throws InterruptedException If {@link CountDownRunnable} is interrupted while pending result
+     */
+    @Test
+    public void setMetadataAndContinueTask() throws InterruptedException {
+        AuthenticationHandler handler = mock(AuthenticationHandler.class);
+        CognitoUser user = mock(CognitoUser.class);
+
+        AuthenticationDetails authenticationDetails = mock(AuthenticationDetails.class);
+        Map<String, String> metadata = Collections.singletonMap("blacklives", "matter");
+        AuthenticationContinuation authenticationContinuation =
+            new AuthenticationContinuation(user, getApplicationContext(), false, handler);
+        authenticationContinuation.setClientMetaData(metadata);
+        authenticationContinuation.setAuthenticationDetails(authenticationDetails);
+
+        CountDownRunnable countDownRunnable = CountDownRunnable.create();
+        doReturn(countDownRunnable)
+            .when(user)
+            .initiateUserAuthentication(eq(metadata), eq(authenticationDetails), eq(handler), eq(false));
+
+        // Act: continue task
+        authenticationContinuation.continueTask();
+
+        // Assert: action was invoked
+        assertTrue(countDownRunnable.await(5, TimeUnit.SECONDS));
+        assertEquals(metadata, authenticationContinuation.getClientMetaData());
+    }
+}

aws-android-sdk-cognitoidentityprovider/src/test/java/com/amazonaws/mobileconnectors/cognitoidentityprovider/continuations/CountDownRunnable.java

@@ -0,0 +1,41 @@
+/*
+ *  Copyright 2020 Amazon.com,
+ *  Inc. or its affiliates. All Rights Reserved.
+ *
+ *  Licensed under the Amazon Software License (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/asl/
+ *
+ *  or in the "license" file accompanying this file. This file is
+ *  distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ *  CONDITIONS OF ANY KIND, express or implied. See the License
+ *  for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations;
+
+import java.util.concurrent.CountDownLatch;
+
+/**
+ * A {@link CountDownLatch} which implements the {@link Runnable} contract by
+ * counting down the latch whenever {@link Runnable#run()} is invoked.
+ *
+ * A CountDownRunnable always starts at 1.
+ */
+final class CountDownRunnable extends CountDownLatch implements Runnable {
+    private CountDownRunnable() {
+        super(1);
+    }
+
+    static CountDownRunnable create() {
+        return new CountDownRunnable();
+    }
+
+    @Override
+    public void run() {
+        super.countDown();
+    }
+}