fix(Logging): adding internal configure auth hub event listener to fi…

…x logging race condition (#3899)
aws-amplify · Oct 18, 2024 · 65da44e · 65da44e
1 parent 619867b
commit 65da44e
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 5 deletions.
diff --git a/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Operations/AuthConfigureOperation.swift b/AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Operations/AuthConfigureOperation.swift
@@ -37,6 +37,9 @@ class AuthConfigureOperation: ConfigureOperation {
     override public func main() {
         if isCancelled {
             finish()
+            dispatch(result: .failure(AuthError.configuration(
+                "Configuration operation was cancelled",
+                "", nil)))
             return
         }
 
@@ -51,6 +54,7 @@ class AuthConfigureOperation: ConfigureOperation {
             for await state in stateSequences {
                 if case .configured = state {
                     finish()
+                    dispatch(result: .success(()))
                     break
                 }
             }

diff --git a/...ts/AWSCognitoAuthPluginUnitTests/ConfigurationTests/AWSCognitoAuthPluginConfigTests.swift b/...ts/AWSCognitoAuthPluginUnitTests/ConfigurationTests/AWSCognitoAuthPluginConfigTests.swift
@@ -236,4 +236,45 @@ class AWSCognitoAuthPluginConfigTests: XCTestCase {
         }
     }
 
+    /// Test that the Auth plugin emits `InternalConfigureAuth` that is used by the Logging Category
+    ///
+    /// - Given: Given a valid config
+    /// - When:
+    ///    - I configure auth with the given configuration
+    /// - Then:
+    ///    - I should receive `InternalConfigureAuth` Hub event
+    ///
+    func testEmittingInternalConfigureAuthHubEvent() throws {
+        let expectation = expectation(description: "conifguration should complete")
+        let subscription = Amplify.Hub.publisher(for: .auth).sink { payload in
+
+            if payload.eventName == "InternalConfigureAuth" {
+                expectation.fulfill()
+            }
+        }
+        let plugin = AWSCognitoAuthPlugin()
+        try Amplify.add(plugin: plugin)
+
+        let categoryConfig = AuthCategoryConfiguration(plugins: [
+            "awsCognitoAuthPlugin": [
+                "CredentialsProvider": [
+                    "CognitoIdentity": [
+                        "Default": [
+                            "PoolId": "cc",
+                             "Region": "us-east-1"
+                        ]
+                    ]
+                ]
+            ]
+        ])
+        let amplifyConfig = AmplifyConfiguration(auth: categoryConfig)
+        do {
+            try Amplify.configure(amplifyConfig)
+        } catch {
+            XCTFail("Should not throw error. \(error)")
+        }
+        wait(for: [expectation], timeout: 5.0)
+        subscription.cancel()
+    }
+
 }
diff --git a/...ugins/Logging/Sources/AWSCloudWatchLoggingPlugin/AWSCloudWatchLoggingCategoryClient.swift b/...ugins/Logging/Sources/AWSCloudWatchLoggingPlugin/AWSCloudWatchLoggingCategoryClient.swift
@@ -87,9 +87,10 @@ final class AWSCloudWatchLoggingCategoryClient {
         enum CognitoEventName: String {
             case signInAPI = "Auth.signInAPI"
             case signOutAPI = "Auth.signOutAPI"
+            case configured = "InternalConfigureAuth"
         }
         switch payload.eventName {
-        case HubPayload.EventName.Auth.signedIn, CognitoEventName.signInAPI.rawValue:
+        case HubPayload.EventName.Auth.signedIn, CognitoEventName.signInAPI.rawValue, CognitoEventName.configured.rawValue:
             takeUserIdentifierFromCurrentUser()
         case HubPayload.EventName.Auth.signedOut, CognitoEventName.signOutAPI.rawValue:
             self.userIdentifier = nil

diff --git a/AmplifyPlugins/Logging/Sources/AWSCloudWatchLoggingPlugin/AWSCloudWatchLoggingPlugin.swift b/AmplifyPlugins/Logging/Sources/AWSCloudWatchLoggingPlugin/AWSCloudWatchLoggingPlugin.swift
@@ -154,10 +154,6 @@ public class AWSCloudWatchLoggingPlugin: LoggingCategoryPlugin {
             let localStore: LoggingConstraintsLocalStore = UserDefaults.standard
             localStore.reset()
         }
-
-        DispatchQueue.main.asyncAfter(deadline: .now() + .milliseconds(500)) {
-            self.loggingClient.takeUserIdentifierFromCurrentUser()
-        }
     }
 }