feat(auth): runtime authFlow attribute (#1687)

haverchuck · haverchuck · commit 513fb5b4bbd0 · 2022-07-14T07:49:40.000-07:00
diff --git a/packages/amplify/amplify_flutter_ios/ios/amplify_flutter_ios.podspec b/packages/amplify/amplify_flutter_ios/ios/amplify_flutter_ios.podspec
@@ -17,9 +17,9 @@ Pod::Spec.new do |s|
   s.source = { :git => 'https://github.com/aws-amplify/amplify-flutter.git' }
   s.source_files = 'Classes/**/*'
   s.dependency 'Flutter'
-  s.dependency 'Amplify', '1.23.0'
-  s.dependency 'AWSPluginsCore', '1.23.0'
-  s.dependency 'AmplifyPlugins/AWSCognitoAuthPlugin', '1.23.0'
+  s.dependency 'Amplify', '1.25.0'
+  s.dependency 'AWSPluginsCore', '1.25.0'
+  s.dependency 'AmplifyPlugins/AWSCognitoAuthPlugin', '1.25.0'
   s.dependency 'amplify_core'
   s.dependency 'SwiftLint'
   s.dependency 'SwiftFormat/CLI'
diff --git a/packages/amplify_datastore/ios/amplify_datastore.podspec b/packages/amplify_datastore/ios/amplify_datastore.podspec
@@ -15,8 +15,8 @@ The DataStore module for Amplify Flutter.
   s.source = { :git => 'https://github.com/aws-amplify/amplify-flutter.git' }
   s.source_files = 'Classes/**/*'
   s.dependency 'Flutter'
-  s.dependency 'Amplify', '1.23.0'
-  s.dependency 'AmplifyPlugins/AWSDataStorePlugin', '1.23.0'
+  s.dependency 'Amplify', '1.25.0'
+  s.dependency 'AmplifyPlugins/AWSDataStorePlugin', '1.25.0'
   s.dependency 'amplify_core'
   s.platform = :ios, '13.0'
 
diff --git a/packages/analytics/amplify_analytics_pinpoint_ios/ios/amplify_analytics_pinpoint_ios.podspec b/packages/analytics/amplify_analytics_pinpoint_ios/ios/amplify_analytics_pinpoint_ios.podspec
@@ -15,8 +15,8 @@ This code is the iOS part of the Amplify Flutter Pinpoint Analytics Plugin.  The
   s.source = { :git => 'https://github.com/aws-amplify/amplify-flutter.git' }
   s.source_files = 'Classes/**/*'
   s.dependency 'Flutter'
-  s.dependency 'Amplify', '1.23.0'
-  s.dependency 'AmplifyPlugins/AWSPinpointAnalyticsPlugin', '1.23.0'
+  s.dependency 'Amplify', '1.25.0'
+  s.dependency 'AmplifyPlugins/AWSPinpointAnalyticsPlugin', '1.25.0'
   s.dependency 'amplify_core'
   s.platform = :ios, '11.0'
 
diff --git a/packages/api/amplify_api_ios/ios/amplify_api_ios.podspec b/packages/api/amplify_api_ios/ios/amplify_api_ios.podspec
@@ -15,8 +15,8 @@ The API module for Amplify Flutter.
   s.source           = { :git => 'https://github.com/aws-amplify/amplify-flutter.git' }
   s.source_files = 'Classes/**/*'
   s.dependency 'Flutter'
-  s.dependency 'Amplify', '1.23.0'
-  s.dependency 'AmplifyPlugins/AWSAPIPlugin', '1.23.0'
+  s.dependency 'Amplify', '1.25.0'
+  s.dependency 'AmplifyPlugins/AWSAPIPlugin', '1.25.0'
   s.dependency 'amplify_core'
   s.platform = :ios, '11.0'
 
diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/custom_auth_passwordless_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/custom_auth_passwordless_test.dart
@@ -26,6 +26,8 @@ void main() {
   IntegrationTestWidgetsFlutterBinding.ensureInitialized();
   late String username;
   late String password;
+  CognitoSignInOptions options =
+      CognitoSignInOptions(authFlowType: AuthenticationFlowType.customAuth);
   group(
     'custom auth passwordless signIn',
     () {
@@ -36,6 +38,9 @@ void main() {
       setUpAll(() async {
         await configureAuth(
           customAuth: true,
+          additionalPlugins: [
+            AmplifyAPI(),
+          ],
         );
         // create new user for each test
         username = generateUsername();
@@ -79,6 +84,7 @@ void main() {
           final res = await Amplify.Auth.signIn(
             username: username,
             password: null,
+            options: options,
           );
           expect(
             res.isSignedIn,
@@ -102,6 +108,7 @@ void main() {
           await Amplify.Auth.signIn(
             username: username,
             password: null,
+            options: options,
           );
           // '123' is the arbitrary challenge answer defined in lambda code
           final res = await Amplify.Auth.confirmSignIn(
@@ -117,7 +124,11 @@ void main() {
       testWidgets(
         'an incorrect challenge reply should throw a NotAuthorizedException',
         (WidgetTester tester) async {
-          await Amplify.Auth.signIn(username: username, password: null);
+          await Amplify.Auth.signIn(
+            username: username,
+            password: null,
+            options: options,
+          );
           // '123' is the arbitrary challenge answer defined in lambda code
           expect(
             Amplify.Auth.confirmSignIn(confirmationValue: 'wrong'),
diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/sign_in_sign_out_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/sign_in_sign_out_test.dart
@@ -13,10 +13,11 @@
  * permissions and limitations under the License.
  */
 
+import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
 import 'package:amplify_flutter/amplify_flutter.dart';
 import 'package:amplify_test/amplify_test.dart';
-import 'package:integration_test/integration_test.dart';
 import 'package:flutter_test/flutter_test.dart';
+import 'package:integration_test/integration_test.dart';
 
 import 'utils/mock_data.dart';
 import 'utils/setup_utils.dart';
diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/utils/setup_utils.dart b/packages/auth/amplify_auth_cognito/example/integration_test/utils/setup_utils.dart
@@ -20,13 +20,11 @@ import 'package:amplify_auth_cognito_example/amplifyconfiguration.dart';
 import 'package:amplify_flutter/amplify_flutter.dart';
 
 Future<void> configureAuth(
-    {List<AmplifyPluginInterface> additionalPlugins = const [],
-    bool customAuth = false}) async {
+    {List<AmplifyPluginInterface> additionalPlugins = const []}) async {
   if (!Amplify.isConfigured) {
     final authPlugin = AmplifyAuthCognito();
-    String config = _createConfig(amplifyconfig, customAuth: customAuth);
     await Amplify.addPlugins([authPlugin, ...additionalPlugins]);
-    await Amplify.configure(config);
+    await Amplify.configure(amplifyconfig);
   }
 }
 
@@ -38,15 +36,3 @@ Future<void> signOutUser() async {
     // Ignore a signOut error because we only care when someone signed in.
   }
 }
-
-// parse json, and switch auth mode if required by test
-String _createConfig(String amplifyconfig, {bool customAuth = false}) {
-  String config = amplifyconfig;
-  if (customAuth) {
-    var configString = jsonDecode(amplifyconfig);
-    configString['auth']['plugins']['awsCognitoAuthPlugin']['Auth']['Default']
-        ['authenticationFlowType'] = 'CUSTOM_AUTH';
-    config = jsonEncode(configString);
-  }
-  return config;
-}
diff --git a/packages/auth/amplify_auth_cognito/lib/src/CognitoSignIn/CognitoSignInOptions.dart b/packages/auth/amplify_auth_cognito/lib/src/CognitoSignIn/CognitoSignInOptions.dart
@@ -17,10 +17,13 @@ import 'package:amplify_core/amplify_core.dart';
 
 class CognitoSignInOptions extends SignInOptions {
   Map<String, String>? clientMetadata;
-  CognitoSignInOptions({this.clientMetadata}) : super();
+  final AuthenticationFlowType? authFlowType;
+
+  CognitoSignInOptions({this.clientMetadata, this.authFlowType}) : super();
   Map<String, dynamic> serializeAsMap() {
     final Map<String, dynamic> pendingRequest = {
-      'clientMetadata': clientMetadata
+      'clientMetadata': clientMetadata,
+      'authFlowType': authFlowType?.name,
     };
     pendingRequest.removeWhere((_, v) => v == null);
     return pendingRequest;
diff --git a/packages/auth/amplify_auth_cognito/test/amplify_auth_cognito_signin_test.dart b/packages/auth/amplify_auth_cognito/test/amplify_auth_cognito_signin_test.dart
@@ -14,6 +14,7 @@
  */
 
 import 'package:amplify_auth_cognito/method_channel_auth_cognito.dart';
+import 'package:amplify_core/amplify_core.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
@@ -68,13 +69,17 @@ void main() {
   });
 
   test('signIn request accepts and serializes options', () async {
-    var options = CognitoSignInOptions(clientMetadata: {'key': 'val'});
+    var options = CognitoSignInOptions(
+      clientMetadata: {'key': 'val'},
+      authFlowType: AuthenticationFlowType.userSrpAuth,
+    );
     var req =
         SignInRequest(username: 'testUser', password: '123', options: options)
             .serializeAsMap();
     expect(req['options'], isInstanceOf<Map>());
     expect((req['options'] as Map)['clientMetadata'], isInstanceOf<Map>());
     expect((req['options'] as Map)['clientMetadata']['key'], equals('val'));
+    expect((req['options'] as Map)['authFlowType'], equals('userSrpAuth'));
   });
 
   test('signIn thrown PlatFormException results in AuthError', () async {
diff --git a/packages/auth/amplify_auth_cognito_android/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/types/FlutterSignInRequest.kt b/packages/auth/amplify_auth_cognito_android/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/types/FlutterSignInRequest.kt
@@ -17,6 +17,7 @@ package com.amazonaws.amplify.amplify_auth_cognito.types
 
 import com.amplifyframework.auth.AuthUser
 import com.amplifyframework.auth.cognito.options.AWSCognitoAuthSignInOptions
+import com.amplifyframework.auth.cognito.options.AuthFlowType
 import com.amplifyframework.core.Amplify
 
 data class FlutterSignInRequest(val map: HashMap<String, *>) {
@@ -35,6 +36,13 @@ data class FlutterSignInRequest(val map: HashMap<String, *>) {
         if (rawOptions?.get("clientMetadata") != null)
             options.metadata(rawOptions["clientMetadata"] as HashMap<String, String>)
 
+        if (rawOptions?.get("authFlowType") != null) {
+            when (rawOptions?.get("authFlowType")) {
+                "userSrpAuth" -> options.authFlowType(AuthFlowType.USER_SRP_AUTH)
+                "customAuth" -> options.authFlowType(AuthFlowType.CUSTOM_AUTH)
+            }
+        }
+
     return options.build();
   }
 
diff --git a/packages/auth/amplify_auth_cognito_android/android/src/test/kotlin/com/amazonaws/amplify/amplify_auth_cognito/AmplifyAuthCognitoPluginTest.kt b/packages/auth/amplify_auth_cognito_android/android/src/test/kotlin/com/amazonaws/amplify/amplify_auth_cognito/AmplifyAuthCognitoPluginTest.kt
@@ -32,6 +32,7 @@ import com.amplifyframework.auth.AuthUserAttribute
 import com.amplifyframework.auth.AuthUserAttributeKey
 import com.amplifyframework.auth.cognito.AWSCognitoAuthSession
 import com.amplifyframework.auth.cognito.AWSCognitoUserPoolTokens
+import com.amplifyframework.auth.cognito.options.AuthFlowType
 import com.amplifyframework.auth.cognito.options.AWSCognitoAuthConfirmResetPasswordOptions
 import com.amplifyframework.auth.cognito.options.AWSCognitoAuthConfirmSignInOptions
 import com.amplifyframework.auth.cognito.options.AWSCognitoAuthConfirmSignUpOptions
@@ -451,7 +452,8 @@ class AmplifyAuthCognitoPluginTest {
             "username" to "testUser",
             "password" to "testPassword",
             "options" to hashMapOf(
-                "clientMetadata" to metadata
+                "clientMetadata" to metadata,
+                "authFlowType" to "customAuth",
             )
         )
         val arguments: HashMap<String, Any> = hashMapOf("data" to data)
@@ -461,7 +463,7 @@ class AmplifyAuthCognitoPluginTest {
         plugin.onMethodCall(call, mockResult)
 
         // Assert
-        var expectedOptions = AWSCognitoAuthSignInOptions.builder().metadata(metadata).build()
+        var expectedOptions = AWSCognitoAuthSignInOptions.builder().metadata(metadata).authFlowType(AuthFlowType.CUSTOM_AUTH).build()
         verify(mockResult, times(1)).success(ArgumentMatchers.any<LinkedTreeMap<String, Any>>())
         verify(mockAuth).signIn(ArgumentMatchers.eq("testUser"), ArgumentMatchers.eq("testPassword"), ArgumentMatchers.eq(expectedOptions), ArgumentMatchers.any<Consumer<AuthSignInResult>>(), ArgumentMatchers.any<Consumer<AuthException>>())
     }
diff --git a/packages/auth/amplify_auth_cognito_ios/example/ios/unit_tests/amplify_auth_cognito_ios_tests.swift b/packages/auth/amplify_auth_cognito_ios/example/ios/unit_tests/amplify_auth_cognito_ios_tests.swift
@@ -696,6 +696,19 @@ class amplify_auth_cognito_tests: XCTestCase {
         })
     }
     
+    func test_signInOptions() {
+        let metadata: Dictionary<String, Any> = ["attribute": "value"]
+        let rawOptions: Dictionary<String, Any> = ["clientMetadata": metadata, "authFlowType": "customAuth"]
+        let rawData: NSMutableDictionary = [
+            "username": _username,
+            "options": rawOptions
+        ]
+        let request = FlutterSignInRequest(dict: rawData);
+        let options = request.options?.pluginOptions as! AWSAuthSignInOptions
+        XCTAssertEqual("value", options.metadata!["attribute"])
+        XCTAssertEqual(AuthFlowType.custom, options.authFlowType)
+    }
+    
     func test_signInSuccessNewPassword() {
         
         class SignInMock: AuthCognitoBridge {
diff --git a/packages/auth/amplify_auth_cognito_ios/ios/Classes/FlutterSignInRequest.swift b/packages/auth/amplify_auth_cognito_ios/ios/Classes/FlutterSignInRequest.swift
@@ -30,10 +30,22 @@ struct FlutterSignInRequest {
   }
     
    func formatOptions(options: Dictionary<String, Any>?) -> AuthSignInOperation.Request.Options {
+     
+     let authFlowType: AuthFlowType = {
+       switch options?["authFlowType"] as? String {
+         case "userSrpAuth":
+           return AuthFlowType.userSRP
+         case "customAuth":
+           return AuthFlowType.custom
+         default:
+           return AuthFlowType.unknown
+         }
+     }()
     
-     let pluginOptions =  AWSAuthSignInOptions(
-       metadata: options?["clientMetadata"] as? [String : String]
+     let pluginOptions = AWSAuthSignInOptions(
+       metadata: options?["clientMetadata"] as? [String : String],
+       authFlowType: authFlowType
      )
+       
      return AuthSignInOperation.Request.Options(pluginOptions: pluginOptions)
-  }
-}
+  }}
diff --git a/packages/auth/amplify_auth_cognito_ios/ios/amplify_auth_cognito_ios.podspec b/packages/auth/amplify_auth_cognito_ios/ios/amplify_auth_cognito_ios.podspec
@@ -15,8 +15,8 @@ Pod::Spec.new do |s|
   s.source = { :git => 'https://github.com/aws-amplify/amplify-flutter.git' }
   s.source_files = 'Classes/**/*'
   s.dependency 'Flutter'
-  s.dependency 'Amplify', '1.23.0'
-  s.dependency 'AmplifyPlugins/AWSCognitoAuthPlugin', '1.23.0'
+  s.dependency 'Amplify', '1.25.0'
+  s.dependency 'AmplifyPlugins/AWSCognitoAuthPlugin', '1.25.0'
   s.dependency 'ObjectMapper'
   s.dependency 'amplify_core'
   s.platform = :ios, '11.0'
diff --git a/packages/storage/amplify_storage_s3_ios/ios/amplify_storage_s3_ios.podspec b/packages/storage/amplify_storage_s3_ios/ios/amplify_storage_s3_ios.podspec
@@ -15,8 +15,8 @@ Pod::Spec.new do |s|
   s.source           = { :path => '.' }
   s.source_files = 'Classes/**/*'
   s.dependency 'Flutter'
-  s.dependency 'Amplify', '1.23.0'
-  s.dependency 'AmplifyPlugins/AWSS3StoragePlugin', '1.23.0'
+  s.dependency 'Amplify', '1.25.0'
+  s.dependency 'AmplifyPlugins/AWSS3StoragePlugin', '1.25.0'
   s.dependency 'amplify_core'
   s.platform = :ios, '11.0'
 
