fix(auth): Remove parallel event that move auth plugin to an error state and other cleanups (#2612)

- When an error happens in Auth signIn flow, we return the statemachine with an error and sends two parallel events: one for cancelling signIn flow and another to update authentication state to error. Both of these could be processed after the running signIn flow is completed, which can affect a new signIn flow that immediately follow. This PR removes the parallel events and moves the cancel signIn flow to the Task so that the current signIn flow is complete only when the state machine is cleaned up.
-  The line number and file info passed in recovery suggestion is not giving any useful information. This PR removes those details from the message.
- Masked device meta data information

Author: royjit

Amplify/Categories/Auth/Error/AuthError.swift

@@ -77,7 +77,7 @@ extension AuthError: AmplifyError {
              .invalidState(_, let recoverySuggestion, _):
             return recoverySuggestion
         case .unknown:
-            return AmplifyErrorMessages.shouldNotHappenReportBugToAWS()
+            return AmplifyErrorMessages.shouldNotHappenReportBugToAWSWithoutLineInfo()
         }
     }
 

Amplify/Core/Support/AmplifyErrorMessages.swift

@@ -27,4 +27,13 @@ public struct AmplifyErrorMessages {
         "This should not happen. \(reportBugToAWS(file: file, function: function, line: line))"
     }
 
+    public static func shouldNotHappenReportBugToAWSWithoutLineInfo() -> String {
+        """
+        This should not happen. There is a possibility that there is a bug if this error persists. \
+        Please take a look at https://github.com/aws-amplify/amplify-swift/issues to see if there \
+        are any existing issues that match your scenario, and file an issue with the details of \
+        the bug if there isn't.
+        """
+    }
+
 }

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Operations/Helpers/HostedUISignInHelper.swift

@@ -81,13 +81,19 @@ struct HostedUISignInHelper {
                 }
 
             case .error(let error):
-                throw AuthError.unknown("Sign in reached an error state", error)
+                await waitForSignInCancel()
+                throw error.authError
 
             case .signingIn(let signInState):
-                guard let result = try UserPoolSignInHelper.checkNextStep(signInState) else {
-                    continue
+                do {
+                    guard let result = try UserPoolSignInHelper.checkNextStep(signInState) else {
+                        continue
+                    }
+                    return result
+                } catch {
+                    await waitForSignInCancel()
+                    throw error
                 }
-                return result
             default:
                 continue
             }
@@ -121,4 +127,19 @@ struct HostedUISignInHelper {
         await authStateMachine.send(event)
     }
 
+    private func waitForSignInCancel() async {
+        await sendCancelSignInEvent()
+        let stateSequences = await authStateMachine.listen()
+        for await state in stateSequences {
+            guard case .configured(let authenticationState, _) = state else {
+                continue
+            }
+
+            switch authenticationState {
+            case .signedOut:
+                return
+            default: continue
+            }
+        }
+    }
 }

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/CodeGen/Data/DeviceMetadata.swift

@@ -33,6 +33,29 @@ extension DeviceMetadata: Codable { }
 
 extension DeviceMetadata: Equatable { }
 
+extension DeviceMetadata: CustomDebugDictionaryConvertible {
+
+    var debugDictionary: [String: Any] {
+        switch self {
+        case .noData:
+            return ["noData": "noData"]
+        case .metadata(let data):
+            return [
+                "deviceKey": data.deviceKey.masked(interiorCount: 5),
+                "deviceGroupKey": data.deviceGroupKey.masked(interiorCount: 5),
+                "deviceSecret": data.deviceSecret.masked(interiorCount: 5)
+            ]
+        }
+    }
+}
+
+extension DeviceMetadata: CustomDebugStringConvertible {
+
+    var debugDescription: String {
+        debugDictionary.debugDescription
+    }
+}
+
 extension CognitoIdentityProviderClientTypes.AuthenticationResultType {
 
     var deviceMetadata: DeviceMetadata {

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/Resolvers/Authentication/AuthenticationState+Resolver.swift

@@ -221,8 +221,7 @@ extension AuthenticationState {
                                            event: StateMachineEvent) -> StateResolution<StateType> {
             if let authEvent = event as? AuthenticationEvent,
                case .error(let error) = authEvent.eventType {
-                let action = CancelSignIn()
-                return .init(newState: .error(error), actions: [action])
+                return .init(newState: .error(error))
             }
             /// Move to signedOut state if cancelSignIn
             if let authEvent = event as? AuthenticationEvent,

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/Resolvers/CustomAuth/CustomSignInState+Resolver.swift

@@ -74,10 +74,8 @@ extension CustomSignInState {
 
         private func errorStateWithCancelSignIn(_ error: SignInError)
         -> StateResolution<CustomSignInState> {
-            let action = CancelSignIn()
             return StateResolution(
-                newState: CustomSignInState.error(error),
-                actions: [action]
+                newState: CustomSignInState.error(error)
             )
         }
     }

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/Resolvers/MigrateAuth/MigrateSignInState+Resolver.swift

@@ -83,10 +83,8 @@ extension MigrateSignInState {
 
         private func errorStateWithCancelSignIn(_ error: SignInError)
         -> StateResolution<MigrateSignInState> {
-            let action = CancelSignIn()
             return StateResolution(
-                newState: MigrateSignInState.error(error),
-                actions: [action]
+                newState: MigrateSignInState.error(error)
             )
         }
     }

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/Resolvers/SRP/SRPSignInState+Resolver.swift

@@ -114,10 +114,8 @@ extension SRPSignInState {
 
         private func errorState(_ error: SignInError)
         -> StateResolution<SRPSignInState> {
-            let action = ThrowSignInError(error: error)
             return StateResolution(
-                newState: SRPSignInState.error(error),
-                actions: [action]
+                newState: SRPSignInState.error(error)
             )
         }
 

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/Resolvers/SignIn/HostedUISignInState+Resolver.swift

@@ -30,6 +30,7 @@ extension HostedUISignInState {
 
             case .showingUI:
                 if case .throwError(let error) = event.isHostedUIEvent {
+                    // Remove this?
                     let action = CancelSignIn()
                     return .init(newState: .error(error), actions: [action])
                 }
@@ -42,6 +43,7 @@ extension HostedUISignInState {
 
             case .fetchingToken:
                 if case .throwError(let error) = event.isHostedUIEvent {
+                    // Remove this?
                     let action = CancelSignIn()
                     return .init(newState: .error(error), actions: [action])
                 }

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthSignInTask.swift

@@ -39,7 +39,12 @@ class AWSAuthSignInTask: AuthSignInTask {
         try await validateCurrentState()
 
         let authflowType = authFlowType(userPoolConfiguration: userPoolConfiguration)
-        return try await doSignIn(authflowType: authflowType)
+        do {
+           return try await doSignIn(authflowType: authflowType)
+        } catch {
+            await waitForSignInCancel()
+            throw error
+        }
     }
 
     private func validateCurrentState() async throws {
@@ -101,6 +106,22 @@ class AWSAuthSignInTask: AuthSignInTask {
         await authStateMachine.send(event)
     }
 
+    private func waitForSignInCancel() async {
+        await sendCancelSignInEvent()
+        let stateSequences = await authStateMachine.listen()
+        for await state in stateSequences {
+            guard case .configured(let authenticationState, _) = state else {
+                continue
+            }
+            
+            switch authenticationState {
+            case .signedOut:
+                return
+            default: continue
+            }
+        }
+    }
+
     private func sendSignInEvent(authflowType: AuthFlowType) async {
         let signInData = SignInEventData(
             username: request.username,