fix(auth): Unblock fetchAuthSession call during a signIn flow (#2687)

Author: royjit

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/CodeGen/States/AuthorizationState.swift

@@ -13,8 +13,6 @@ enum AuthorizationState: State {
 
     case configured
 
-    case signingIn
-
     case signingOut(AmplifyCredentials?)
 
     case clearingFederation
@@ -47,8 +45,6 @@ extension AuthorizationState {
             return "AuthorizationState.notConfigured"
         case .configured:
             return "AuthorizationState.configured"
-        case .signingIn:
-            return "AuthorizationState.signingIn"
         case .signingOut:
             return "AuthorizationState.signingOut"
         case .federatingToIdentityPool:

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/CodeGen/States/DebugInfo/AuthorizationState+Debug.swift

@@ -14,7 +14,6 @@ extension AuthorizationState: CustomDebugDictionaryConvertible {
         switch self {
         case .notConfigured,
                 .configured,
-                .signingIn,
                 .signingOut,
                 .clearingFederation,
                 .deletingUser:

AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/Resolvers/Authorization/AuthorizationState+Resolver.swift

@@ -20,6 +20,22 @@ extension AuthorizationState {
             byApplying event: StateMachineEvent
         ) -> StateResolution<StateType> {
 
+            if let authEvent = event.isAuthenticationEvent {
+                switch authEvent {
+                case .signInCompleted(let signedInData):
+                    let action = InitializeFetchAuthSessionWithUserPool(
+                        signedInData: signedInData)
+                    return .init(
+                        newState: .fetchingAuthSessionWithUserPool(.notStarted, signedInData),
+                        actions: [action])
+                case .error(let error):
+                    return .init(newState: .error(AuthorizationError.service(error: error)))
+                case .cancelSignIn:
+                    return .init(newState: .configured)
+                default: break
+                }
+            }
+
             switch oldState {
             case .notConfigured:
                 guard let authZEvent = event.isAuthorizationEvent else {
@@ -29,11 +45,6 @@ extension AuthorizationState {
 
             case .configured:
 
-                if let authNEvent = event.isAuthenticationEvent,
-                   case .signInRequested = authNEvent {
-                    return .init(newState: .signingIn)
-                }
-
                 if case .fetchUnAuthSession = event.isAuthorizationEvent {
                     let action = InitializeFetchUnAuthSession()
                     return .init(newState: .fetchingUnAuthSession(.notStarted), actions: [action])
@@ -57,9 +68,7 @@ extension AuthorizationState {
 
             case .sessionEstablished(let credentials):
                 if let authNEvent = event.isAuthenticationEvent {
-                    if case .signInRequested = authNEvent {
-                        return .from(.signingIn)
-                    } else if case .signOutRequested = authNEvent {
+                    if case .signOutRequested = authNEvent {
                         return .from(.signingOut(credentials))
                     } else if case .clearFederationToIdentityPool = authNEvent {
                         return .from(.clearingFederation)
@@ -126,23 +135,6 @@ extension AuthorizationState {
                         existingCredentials: credentials),
                     actions: resolution.actions)
 
-            case .signingIn:
-                if let authEvent = event.isAuthenticationEvent {
-                    switch authEvent {
-                    case .signInCompleted(let signedInData):
-                        let action = InitializeFetchAuthSessionWithUserPool(
-                            signedInData: signedInData)
-                        return .init(newState: .fetchingAuthSessionWithUserPool(.notStarted, signedInData),
-                                     actions: [action])
-                    case .error(let error):
-                        return .init(newState: .error(AuthorizationError.service(error: error)))
-                    case .cancelSignIn:
-                        return .init(newState: .configured)
-                    default: return .from(.signingIn)
-                    }
-                }
-                return .from(.signingIn)
-
             case .signingOut(let credentials):
                 if let signOutEvent = event.isSignOutEvent,
                    case .signedOutSuccess = signOutEvent {
@@ -267,7 +259,7 @@ extension AuthorizationState {
 
                     switch authNEvent {
                     case .signInRequested:
-                        return .from(.signingIn)
+                        return .from(.configured)
                     case .signOutRequested:
                         return .from(.signingOut(nil))
                     case .cancelSignIn:

AmplifyPlugins/Auth/Tests/AWSCognitoAuthPluginUnitTests/TaskTests/AuthorizationTests/AWSAuthFetchSignInSessionOperationTests.swift

@@ -690,4 +690,52 @@ class AWSAuthFetchSignInSessionOperationTests: BaseAuthorizationTests {
             return
         }
     }
+
+    /// Test fetchAuthSession on a in progress signIn. The library is waiting for confirm signIn to complete and require user input
+    ///
+    /// - Given: Given an auth plugin with waiting for confirm signIn input and identityPool enabled
+    /// - When:
+    ///    - I invoke fetchAuthSession
+    /// - Then:
+    ///    - I should get an a valid session with the following details:
+    ///         - isSignedIn = false
+    ///         - aws credentails = valid values
+    ///         - identity id = valid values
+    ///
+    func testSessionWhenWaitingConfirmSignIn() async throws {
+        let signInMethod = SignInMethod.apiBased(.userSRP)
+        let challenge = SignInChallengeState.waitingForAnswer(.testData, signInMethod)
+        let initialState = AuthState.configured(
+            AuthenticationState.signingIn(
+                .resolvingChallenge(challenge, .smsMfa, signInMethod)),
+            AuthorizationState.configured
+        )
+
+        let getId: MockIdentity.MockGetIdResponse = { _ in
+            return .init(identityId: "mockIdentityId")
+        }
+
+        let getCredentials: MockIdentity.MockGetCredentialsResponse = { _ in
+            let credentials = CognitoIdentityClientTypes.Credentials(accessKeyId: "accessKey",
+                                                                     expiration: Date(),
+                                                                     secretKey: "secret",
+                                                                     sessionToken: "session")
+            return .init(credentials: credentials, identityId: "responseIdentityID")
+        }
+
+        let plugin = configurePluginWith(identityPool: {
+            MockIdentity(mockGetIdResponse: getId,
+                         mockGetCredentialsResponse: getCredentials) },
+                                         initialState: initialState)
+
+        let session = try await plugin.fetchAuthSession(options: AuthFetchSessionRequest.Options())
+        XCTAssertFalse(session.isSignedIn)
+
+        let creds = try? (session as? AuthAWSCredentialsProvider)?.getAWSCredentials().get()
+        XCTAssertNotNil(creds?.accessKeyId)
+        XCTAssertNotNil(creds?.secretAccessKey)
+
+        let identityId = try? (session as? AuthCognitoIdentityProvider)?.getIdentityId().get()
+        XCTAssertNotNil(identityId)
+    }
 }

AmplifyPlugins/Auth/Tests/AWSCognitoAuthPluginUnitTests/TestHarness/CodableStates/AuthorizationState+Codable.swift

@@ -82,8 +82,6 @@ extension AuthorizationState: Codable {
 
         } else if type == "AuthorizationState.Configured" {
             self = .configured
-        } else if type == "AuthorizationState.SigningIn" {
-            self = .signingIn
         } else {
             fatalError("Decoding not supported")
         }

AmplifyPlugins/Auth/Tests/AWSCognitoAuthPluginUnitTests/TestResources/states/SigningIn_SigningIn.json

@@ -19,6 +19,6 @@
         }
     },
     "AuthorizationState": {
-        "type": "AuthorizationState.SigningIn"
+        "type": "AuthorizationState.Configured"
     }
-}
+}