feat(amplify_auth_cognito): enables clientMetadata for signUp (#713)

Author: haverchuck

packages/amplify_analytics_pinpoint/android/build.gradle

@@ -60,8 +60,8 @@ dependencies {
     api amplifyCore
 
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation 'com.amplifyframework:aws-analytics-pinpoint:1.20.1'
-    implementation 'com.amplifyframework:aws-auth-cognito:1.20.1'
+    implementation 'com.amplifyframework:aws-analytics-pinpoint:1.22.0'
+    implementation 'com.amplifyframework:aws-auth-cognito:1.22.0'
     testImplementation 'junit:junit:4.13'
     testImplementation 'org.mockito:mockito-core:3.1.0'
     testImplementation 'org.mockito:mockito-inline:3.1.0'

packages/amplify_api/android/build.gradle

@@ -55,8 +55,8 @@ dependencies {
     api amplifyCore
 
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation "com.amplifyframework:aws-api:1.20.1"
-    implementation "com.amplifyframework:aws-api-appsync:1.20.1"
+    implementation "com.amplifyframework:aws-api:1.22.0"
+    implementation "com.amplifyframework:aws-api-appsync:1.22.0"
 
     testImplementation 'junit:junit:4.13'
     testImplementation 'org.mockito:mockito-core:3.10.0'

packages/amplify_auth_cognito/android/build.gradle

@@ -61,7 +61,7 @@ android {
 dependencies {
     api amplifyCore
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation 'com.amplifyframework:aws-auth-cognito:1.20.1'
+    implementation 'com.amplifyframework:aws-auth-cognito:1.22.0'
     testImplementation 'junit:junit:4.13'
     testImplementation 'org.mockito:mockito-core:3.1.0'
     testImplementation 'org.mockito:mockito-inline:3.1.0'

packages/amplify_auth_cognito/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/types/FlutterSignUpRequest.kt

@@ -32,6 +32,7 @@ data class FlutterSignUpRequest(val map: HashMap<String, *>) {
         val optionsBuilder =  AWSCognitoAuthSignUpOptions.builder()
         if (rawOptions != null) {
             val attributeData = rawOptions["userAttributes"] as? MutableMap<String, String>
+            val clientMetadata = rawOptions["clientMetadata"] as? MutableMap<String, String>
             val validationData = rawOptions["validationData"] as? MutableMap<String, String>
 
             if (attributeData is MutableMap<String, String>) {
@@ -45,6 +46,10 @@ data class FlutterSignUpRequest(val map: HashMap<String, *>) {
                 optionsBuilder.validationData(validationData)
             }
 
+            if (clientMetadata is MutableMap<String, String>) {
+                optionsBuilder.clientMetadata(clientMetadata)
+            }
+
         }
         return optionsBuilder.build()
     }

packages/amplify_auth_cognito/android/src/test/kotlin/com/amazonaws/amplify/amplify_auth_cognito/AmplifyAuthCognitoPluginTest.kt

@@ -16,10 +16,7 @@
 package com.amazonaws.amplify.amplify_auth_cognito
 
 import android.app.Activity
-import com.amazonaws.amplify.amplify_auth_cognito.types.FlutterConfirmUserAttributeRequest
-import com.amazonaws.amplify.amplify_auth_cognito.types.FlutterResendUserAttributeConfirmationCodeRequest
-import com.amazonaws.amplify.amplify_auth_cognito.types.FlutterUpdateUserAttributeRequest
-import com.amazonaws.amplify.amplify_auth_cognito.types.FlutterUpdateUserAttributesRequest
+import com.amazonaws.amplify.amplify_auth_cognito.types.*
 import com.amazonaws.amplify.amplify_core.exception.InvalidRequestException
 import com.amazonaws.auth.AWSCredentials
 import com.amazonaws.auth.BasicAWSCredentials
@@ -46,8 +43,7 @@ import com.amplifyframework.logging.Logger
 import com.google.gson.internal.LinkedTreeMap
 import io.flutter.plugin.common.MethodCall
 import io.flutter.plugin.common.MethodChannel
-import org.junit.Assert.assertThrows
-import org.junit.Assert.fail
+import org.junit.Assert.*
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -123,6 +119,50 @@ class AmplifyAuthCognitoPluginTest {
         verify(mockResult, times(1)).success(res);
     }
 
+    @Test
+    fun signUpRequestMetadata_returnsSuccess() {
+        // Arrange
+        val clientMetadata = hashMapOf("attribute" to "value")
+        val options = hashMapOf(
+            "clientMetadata" to clientMetadata
+        )
+        val data: HashMap<String, *> = hashMapOf(
+            "username" to "testUser",
+            "password" to "testPassword",
+            "options" to options
+        )
+
+        // Act
+        val request  = FlutterSignUpRequest(data)
+
+        // Assert
+        assertEquals(clientMetadata, request.options.clientMetadata)
+        assertEquals(0, request.options.validationData.size)
+        assertEquals(0, request.options.userAttributes.size)
+    }
+
+    @Test
+    fun signUpRequestValidationdata_returnsSuccess() {
+        // Arrange
+        val validationData = hashMapOf("attribute" to "value")
+        val options = hashMapOf(
+            "validationData" to validationData
+        )
+        val data: HashMap<String, *> = hashMapOf(
+            "username" to "testUser",
+            "password" to "testPassword",
+            "options" to options
+        )
+
+        // Act
+        val request  = FlutterSignUpRequest(data)
+
+        // Assert
+        assertEquals(validationData, request.options.validationData)
+        assertEquals(0, request.options.clientMetadata.size)
+        assertEquals(0, request.options.userAttributes.size)
+    }
+
     @Test
     fun signUpNoOptions_returnsSuccess() {
         // Arrange

packages/amplify_auth_cognito/example/ios/unit_tests/amplify_auth_cognito_tests.swift

@@ -96,6 +96,7 @@ class amplify_auth_cognito_tests: XCTestCase {
         })
     }
 
+    
     func test_signUpSuccessPhone() {
 
         class SignUpMock: AuthCognitoBridge {
@@ -281,14 +282,34 @@ class amplify_auth_cognito_tests: XCTestCase {
         XCTAssertNoThrow(try FlutterSignUpRequest.validate(dict: rawData))
     }
 
-    func test_signUpFormatAttributes() {
+    func test_signUpWithUserAttributes() {
         let rawAttributes: Dictionary<String, Any> = ["email": _email, "customAttribute": "female"]
         let rawOptions: Dictionary<String, Any> = ["userAttributes": rawAttributes]
         let rawData: NSMutableDictionary = ["options":rawOptions, "username": _username, "password": _password]
         let request = FlutterSignUpRequest(dict: rawData);
         XCTAssertEqual(2, request.options?.userAttributes?.count)
     }
 
+    func test_signUpWithClientMetadata() {
+        let metadata: Dictionary<String, Any> = ["attribute": "value"]
+        let rawOptions: Dictionary<String, Any> = ["clientMetadata": metadata]
+        let rawData: NSMutableDictionary = ["options":rawOptions, "username": _username, "password": _password]
+        let request = FlutterSignUpRequest(dict: rawData);
+        let options = request.options?.pluginOptions as! AWSAuthSignUpOptions
+        XCTAssertEqual("value", options.metadata!["attribute"])
+        XCTAssertNil(options.validationData)
+    }
+    
+    func test_signUpWithValidationdata() {
+        let validationData: Dictionary<String, Any> = ["attribute": "value"]
+        let rawOptions: Dictionary<String, Any> = ["validationData": validationData]
+        let rawData: NSMutableDictionary = ["options":rawOptions, "username": _username, "password": _password]
+        let request = FlutterSignUpRequest(dict: rawData);
+        let options = request.options?.pluginOptions as! AWSAuthSignUpOptions
+        XCTAssertEqual("value", options.validationData!["attribute"])
+        XCTAssertNil(options.metadata)
+    }
+    
     func test_signUpError() {
 
         class SignUpMock: AuthCognitoBridge {

packages/amplify_auth_cognito/ios/Classes/FlutterSignUpRequest.swift

@@ -30,12 +30,20 @@ struct FlutterSignUpRequest {
     }
 
     private func createOptions(options: Dictionary<String, Any>?) -> AuthSignUpRequest.Options? {
+        var userAttributes: [AuthUserAttribute]? = nil
+        var pluginOptions: AWSAuthSignUpOptions? = nil
         if (options?["userAttributes"] is Dictionary<String, String>) {
             let rawAttributes = options!["userAttributes"] as! Dictionary<String, String>
-            let userAttributes = createAuthUserAttributes(rawAttributes: rawAttributes)
-            return AuthSignUpRequest.Options(userAttributes: userAttributes)
+            userAttributes = createAuthUserAttributes(rawAttributes: rawAttributes)
         }
-        return nil
+        
+        if (options?["clientMetadata"] is Dictionary<String, String> || options?["validationData"] is Dictionary<String, String>) {
+            pluginOptions = AWSAuthSignUpOptions(
+                validationData: options?["validationData"] as? [String: String],
+                metadata: options?["clientMetadata"] as? [String : String]
+            )
+        }
+        return AuthSignUpRequest.Options(userAttributes: userAttributes, pluginOptions: pluginOptions)
     }
 
     private func createAuthUserAttributes(rawAttributes: Dictionary<String, String>) -> [AuthUserAttribute] {

packages/amplify_auth_cognito/lib/src/CognitoSignUp/CognitoSignUpOptions.dart

@@ -23,6 +23,11 @@ class CognitoSignUpOptions extends SignUpOptions {
   /// Currently supported on `Android` only.
   final Map<String, String>? validationData;
 
+  /// Additional custom attributes to be sent to the service such as information
+  /// about the client.
+  ///
+  final Map<String, String>? clientMetadata;
+
   /// Creates a sign up configuration with the given user attributes and validation data.
   ///
   /// [userAttributes] is a map of key-value pairs, where the key is one of the standard
@@ -54,16 +59,18 @@ class CognitoSignUpOptions extends SignUpOptions {
   ///     - Phone number verification is enabled
   ///     - Phone number was marked as a required attribute
   ///   - **and** users sign up with a chosen username or email
-  const CognitoSignUpOptions({
-    Map<String, String> userAttributes = const {},
-    this.validationData,
-  }) : super(userAttributes: userAttributes);
+  const CognitoSignUpOptions(
+      {Map<String, String> userAttributes = const {},
+      this.validationData,
+      this.clientMetadata})
+      : super(userAttributes: userAttributes);
 
   @override
   Map<String, dynamic> serializeAsMap() {
     final Map<String, dynamic> pendingRequest = {
       'validationData': validationData,
-      'userAttributes': userAttributes
+      'userAttributes': userAttributes,
+      'clientMetadata': clientMetadata
     };
     pendingRequest.removeWhere((_, v) => v == null);
     return pendingRequest;

packages/amplify_core/android/build.gradle

@@ -61,7 +61,7 @@ android {
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation 'com.amplifyframework:core:1.20.1'
+    implementation 'com.amplifyframework:core:1.22.0'
     implementation 'com.google.code.gson:gson:2.8.6'
     testImplementation 'junit:junit:4.13'
     testImplementation 'org.mockito:mockito-core:3.1.0'

packages/amplify_datastore/android/build.gradle

@@ -57,8 +57,8 @@ android {
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation "com.amplifyframework:aws-datastore:1.20.1"
-    implementation "com.amplifyframework:aws-api-appsync:1.20.1"
+    implementation "com.amplifyframework:aws-datastore:1.22.0"
+    implementation "com.amplifyframework:aws-api-appsync:1.22.0"
     testImplementation 'junit:junit:4.13'
     testImplementation 'org.mockito:mockito-core:3.10.0'
     testImplementation 'org.mockito:mockito-inline:3.10.0'