fix(auth): Update the Auth plugin to enforce ordering of api calls (#1549)

Author: royjit

AmplifyPlugins/Auth/AWSCognitoAuthPlugin/AWSCognitoAuthPlugin+Configure.swift

@@ -42,11 +42,14 @@ extension AWSCognitoAuthPlugin {
             let userService = AuthUserServiceAdapter(awsMobileClient: awsMobileClient)
             let deviceService = AuthDeviceServiceAdapter(awsMobileClient: awsMobileClient)
             let hubEventHandler = AuthHubEventHandler()
+            let operationQueue = OperationQueue()
+            operationQueue.maxConcurrentOperationCount = 1
             configure(authenticationProvider: authenticationProvider,
                       authorizationProvider: authorizationProvider,
                       userService: userService,
                       deviceService: deviceService,
-                      hubEventHandler: hubEventHandler)
+                      hubEventHandler: hubEventHandler,
+                      queue: operationQueue)
         } catch let authError as AuthError {
             throw authError
 

AmplifyPlugins/Auth/AWSCognitoAuthPluginIntegrationTests/AWSAuthBaseTest.swift

@@ -11,14 +11,14 @@ import AWSCognitoAuthPlugin
 @testable import AmplifyTestCommon
 
 class AWSAuthBaseTest: XCTestCase {
-    
+
     let networkTimeout = TimeInterval(10)
     var email = UUID().uuidString + "@" + UUID().uuidString + ".com"
     var email2 = UUID().uuidString + "@" + UUID().uuidString + ".com"
-    
+
     let amplifyConfigurationFile = "testconfiguration/AWSCognitoAuthPluginIntegrationTests-amplifyconfiguration"
     let credentialsFile = "testconfiguration/AWSCognitoAuthPluginIntegrationTests-credentials"
-    
+
     func initializeAmplify() {
         do {
             let credentialsConfiguration = try TestConfigHelper.retrieveCredentials(forResource: credentialsFile)

AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/ConfigurationTests/AWSCognitoAuthPluginConfigTests.swift

@@ -146,11 +146,11 @@ class AWSCognitoAuthPluginConfigTests: XCTestCase {
             "awsCognitoAuthPlugin": [
                 "CredentialsProvider": ["CognitoIdentity": ["Default":
                     ["xx": "xx",
-                     "xx": "us-east-1"]
+                     "xx2": "us-east-1"]
                     ]],
                 "CognitoUserPool": ["Default": [
                     "xx": "xx",
-                    "xx": "us-east-1"
+                    "xx2": "us-east-1"
                     ]]
             ]
         ])
@@ -188,4 +188,61 @@ class AWSCognitoAuthPluginConfigTests: XCTestCase {
         }
     }
 
+    /// Test Auth configuration order of execution of apis
+    ///
+    /// - Given: Given valid config for user pool and identity pool
+    /// - When:
+    ///    - I call different auth apis after configuration
+    /// - Then:
+    ///    - I should get the result back based on the order in which the calls where made.
+    ///
+    func testAPIExecutionOrder() throws {
+        let plugin = AWSCognitoAuthPlugin()
+        try Amplify.add(plugin: plugin)
+
+        let categoryConfig = AuthCategoryConfiguration(plugins: [
+            "awsCognitoAuthPlugin": [
+                "CredentialsProvider": ["CognitoIdentity": ["Default":
+                    ["PoolId": "xx",
+                     "Region": "us-east-1"]
+                    ]],
+                "CognitoUserPool": ["Default": [
+                    "PoolId": "xx",
+                    "Region": "us-east-1",
+                    "AppClientId": "xx",
+                    "AppClientSecret": "xx"]]
+            ]
+        ])
+        let amplifyConfig = AmplifyConfiguration(auth: categoryConfig)
+        do {
+            try Amplify.configure(amplifyConfig)
+        } catch {
+            XCTFail("Should not throw error. \(error)")
+        }
+
+        let signUpExpectation = expectation(description: "Should receive a result")
+        _ = plugin.signUp(username: "mockUsername", password: "", options: nil) { _ in
+            signUpExpectation.fulfill()
+        }
+
+        var expectationList = [signUpExpectation]
+
+        for _ in 1 ... 50 {
+            let fetchSessionExpectation = expectation(description: "Should receive a result")
+            _ = plugin.fetchAuthSession(options: nil) { _ in
+                fetchSessionExpectation.fulfill()
+            }
+            expectationList.append(fetchSessionExpectation)
+        }
+
+        let signUpExpectation2 = expectation(description: "Should receive a result")
+        DispatchQueue.global().async {
+
+            _ = plugin.signUp(username: "mockUsername", password: "", options: nil) { _ in
+                signUpExpectation2.fulfill()
+            }
+        }
+        expectationList.append(signUpExpectation2)
+        wait(for: expectationList, timeout: 10, enforceOrder: true)
+    }
 }

AmplifyPlugins/Auth/AWSCognitoAuthPluginTests/Mocks/MockAuthHubEventBehavior.swift

@@ -20,6 +20,4 @@ class MockAuthHubEventBehavior: AuthHubEventBehavior {
     func sendSessionExpiredEvent() {
         // Incomplete implementation
     }
-
-
 }

AmplifyPlugins/Auth/Podfile.lock

@@ -29,7 +29,7 @@ PODS:
   - CwlPreconditionTesting (1.1.1):
     - CwlCatchException
   - SwiftFormat/CLI (0.44.17)
-  - SwiftLint (0.45.0)
+  - SwiftLint (0.45.1)
 
 DEPENDENCIES:
   - Amplify (from `../../`)
@@ -85,8 +85,8 @@ SPEC CHECKSUMS:
   CwlCatchException: 70a52ae44ea5d46db7bd385f801a94942420cd8c
   CwlPreconditionTesting: d33a4e4f285c0b885fddcae5dfedfbb34d4f3961
   SwiftFormat: 3b5caa6389b2b9adbc00e133b3ccc8c6e687a6a4
-  SwiftLint: e5c7f1fba68eccfc51509d5b2ce1699f5502e0c7
+  SwiftLint: 06ac37e4d38c7068e0935bb30cda95f093bec761
 
 PODFILE CHECKSUM: 371cf67fe35ebb5167d0880bad12b01618a0fb0e
 
-COCOAPODS: 1.10.1
+COCOAPODS: 1.11.2