Skip to content

Commit 540f1f2

Browse files
harsh62harsh62
authored
feat(auth): ignore user cancel when session is expired on hostedui sign out (#3956)
* feat(auth): ignore user cancel when session is expired on hostedui sign out * fix warnings * fix merge issue.
1 parent f348973 commit 540f1f2

File tree

6 files changed

+95
-12
lines changed

6 files changed

+95
-12
lines changed

‎AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Actions/SignOut/InitiateSignOut.swift‎

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,49 @@ struct InitiateSignOut: Action {
1717

1818
func execute(withDispatcher dispatcher: EventDispatcher, environment: Environment) async {
1919
logVerbose("\(#fileID) Starting execution", environment: environment)
20-
20+
let updatedSignedInData = await getUpdatedSignedInData(environment: environment)
2121
let event: SignOutEvent
2222
if case .hostedUI(let options) = signedInData.signInMethod,
2323
options.preferPrivateSession == false {
2424
event = SignOutEvent(eventType: .invokeHostedUISignOut(signOutEventData,
25-
signedInData))
25+
updatedSignedInData))
2626
} else if signOutEventData.globalSignOut {
27-
event = SignOutEvent(eventType: .signOutGlobally(signedInData))
27+
event = SignOutEvent(eventType: .signOutGlobally(updatedSignedInData))
2828
} else {
29-
event = SignOutEvent(eventType: .revokeToken(signedInData))
29+
event = SignOutEvent(eventType: .revokeToken(updatedSignedInData))
3030
}
3131
logVerbose("\(#fileID) Sending event \(event.type)", environment: environment)
3232
await dispatcher.send(event)
3333
}
3434

35+
private func getUpdatedSignedInData(
36+
environment: Environment
37+
) async -> SignedInData {
38+
let credentialStoreClient = (environment as? AuthEnvironment)?.credentialsClient
39+
do {
40+
let data = try await credentialStoreClient?.fetchData(
41+
type: .amplifyCredentials
42+
)
43+
guard case .amplifyCredentials(let credentials) = data else {
44+
return signedInData
45+
}
46+
47+
// Update SignedInData based on credential type
48+
switch credentials {
49+
case .userPoolOnly(let updatedSignedInData):
50+
return updatedSignedInData
51+
case .userPoolAndIdentityPool(let updatedSignedInData, _, _):
52+
return updatedSignedInData
53+
case .identityPoolOnly, .identityPoolWithFederation, .noCredentials:
54+
return signedInData
55+
}
56+
} catch {
57+
let logger = (environment as? LoggerProvider)?.logger
58+
logger?.error("Unable to update credentials with error: \(error)")
59+
return signedInData
60+
}
61+
}
62+
3563
}
3664

3765
extension InitiateSignOut: CustomDebugDictionaryConvertible {

‎AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Actions/SignOut/ShowHostedUISignOut.swift‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,14 @@ class ShowHostedUISignOut: NSObject, Action {
4646
inPrivate: false,
4747
presentationAnchor: signOutEvent.presentationAnchor)
4848
await sendEvent(with: nil, dispatcher: dispatcher, environment: environment)
49+
} catch HostedUIError.cancelled {
50+
if signInData.isRefreshTokenExpired == true {
51+
self.logVerbose("\(#fileID) Received user cancelled error, but session is expired and continue signing out.", environment: environment)
52+
await sendEvent(with: nil, dispatcher: dispatcher, environment: environment)
53+
} else {
54+
self.logVerbose("\(#fileID) Received error \(HostedUIError.cancelled)", environment: environment)
55+
await sendEvent(with: HostedUIError.cancelled, dispatcher: dispatcher, environment: environment)
56+
}
4957
} catch {
5058
self.logVerbose("\(#fileID) Received error \(error)", environment: environment)
5159
await sendEvent(with: error, dispatcher: dispatcher, environment: environment)
@@ -101,4 +109,3 @@ extension ShowHostedUISignOut {
101109
debugDictionary.debugDescription
102110
}
103111
}
104-
//#endif

‎AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/ClientBehavior/AWSCognitoAuthPlugin+ClientBehavior.swift‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,12 @@ extension AWSCognitoAuthPlugin: AuthCategoryBehavior {
115115
let options = options ?? AuthFetchSessionRequest.Options()
116116
let request = AuthFetchSessionRequest(options: options)
117117
let forceReconfigure = secureStoragePreferences?.accessGroup?.name != nil
118-
let task = AWSAuthFetchSessionTask(request,
119-
authStateMachine: authStateMachine,
120-
configuration: authConfiguration,
121-
forceReconfigure: forceReconfigure)
118+
let task = AWSAuthFetchSessionTask(
119+
request,
120+
authStateMachine: authStateMachine,
121+
configuration: authConfiguration,
122+
environment: authEnvironment,
123+
forceReconfigure: forceReconfigure)
122124
return try await taskQueue.sync {
123125
return try await task.value
124126
} as! AuthSession

‎AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Operations/Helpers/FetchAuthSessionOperationHelper.swift‎

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@
77

88
import Foundation
99
import Amplify
10+
import AWSPluginsCore
1011

1112
class FetchAuthSessionOperationHelper {
1213

1314
typealias FetchAuthSessionCompletion = (Result<AuthSession, AuthError>) -> Void
15+
var environment: Environment? = nil
1416

1517
func fetch(_ authStateMachine: AuthStateMachine,
1618
forceRefresh: Bool = false) async throws -> AuthSession {
@@ -98,7 +100,7 @@ class FetchAuthSessionOperationHelper {
98100
case .sessionEstablished(let credentials):
99101
return credentials.cognitoSession
100102
case .error(let authorizationError):
101-
return try sessionResultWithError(
103+
return try await sessionResultWithError(
102104
authorizationError,
103105
authenticationState: authenticationState)
104106
default: continue
@@ -111,7 +113,7 @@ class FetchAuthSessionOperationHelper {
111113
func sessionResultWithError(
112114
_ error: AuthorizationError,
113115
authenticationState: AuthenticationState
114-
) throws -> AuthSession {
116+
) async throws -> AuthSession {
115117
log.verbose("Received fetch auth session error - \(error)")
116118

117119
var isSignedIn = false
@@ -129,8 +131,10 @@ class FetchAuthSessionOperationHelper {
129131
authError = fetchError.authError
130132
}
131133
case .sessionExpired(let error):
134+
await setRefreshTokenExpiredInSignedInData()
132135
let session = AuthCognitoSignedInSessionHelper.makeExpiredSignedInSession(
133136
underlyingError: error)
137+
134138
return session
135139
default:
136140
break
@@ -143,6 +147,43 @@ class FetchAuthSessionOperationHelper {
143147
cognitoTokensResult: .failure(authError))
144148
return session
145149
}
150+
151+
func setRefreshTokenExpiredInSignedInData() async {
152+
let credentialStoreClient = (environment as? AuthEnvironment)?.credentialsClient
153+
do {
154+
let data = try await credentialStoreClient?.fetchData(
155+
type: .amplifyCredentials
156+
)
157+
guard case .amplifyCredentials(var credentials) = data else {
158+
return
159+
}
160+
161+
// Update SignedInData based on credential type
162+
switch credentials {
163+
case .userPoolOnly(var signedInData):
164+
signedInData.isRefreshTokenExpired = true
165+
credentials = .userPoolOnly(signedInData: signedInData)
166+
167+
case .userPoolAndIdentityPool(var signedInData, let identityId, let awsCredentials):
168+
signedInData.isRefreshTokenExpired = true
169+
credentials = .userPoolAndIdentityPool(
170+
signedInData: signedInData,
171+
identityID: identityId,
172+
credentials: awsCredentials)
173+
174+
case .identityPoolOnly, .identityPoolWithFederation, .noCredentials:
175+
return
176+
}
177+
178+
try await credentialStoreClient?.storeData(data: .amplifyCredentials(credentials))
179+
} catch KeychainStoreError.itemNotFound {
180+
let logger = (environment as? LoggerProvider)?.logger
181+
logger?.info("No existing credentials found.")
182+
} catch {
183+
let logger = (environment as? LoggerProvider)?.logger
184+
logger?.error("Unable to update credentials with error: \(error)")
185+
}
186+
}
146187
}
147188

148189
extension FetchAuthSessionOperationHelper: DefaultLogger { }

‎AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/StateMachine/CodeGen/Data/SignedInData.swift‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ struct SignedInData {
1414
let signInMethod: SignInMethod
1515
let deviceMetadata: DeviceMetadata
1616
let cognitoUserPoolTokens: AWSCognitoUserPoolTokens
17+
var isRefreshTokenExpired: Bool?
1718

1819
init(signedInDate: Date,
1920
signInMethod: SignInMethod,
@@ -27,6 +28,7 @@ struct SignedInData {
2728
self.signInMethod = signInMethod
2829
self.deviceMetadata = deviceMetadata
2930
self.cognitoUserPoolTokens = cognitoUserPoolTokens
31+
self.isRefreshTokenExpired = false
3032
}
3133
}
3234

@@ -42,7 +44,8 @@ extension SignedInData: CustomDebugDictionaryConvertible {
4244
"signedInDate": signedInDate,
4345
"signInMethod": signInMethod,
4446
"deviceMetadata": deviceMetadata,
45-
"tokens": cognitoUserPoolTokens
47+
"tokens": cognitoUserPoolTokens,
48+
"refreshTokenExpired": isRefreshTokenExpired ?? false
4649
]
4750
}
4851
}

‎AmplifyPlugins/Auth/Sources/AWSCognitoAuthPlugin/Task/AWSAuthFetchSessionTask.swift‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,13 @@ class AWSAuthFetchSessionTask: AuthFetchSessionTask, DefaultLogger {
2424
_ request: AuthFetchSessionRequest,
2525
authStateMachine: AuthStateMachine,
2626
configuration: AuthConfiguration,
27+
environment: Environment,
2728
forceReconfigure: Bool = false
2829
) {
2930
self.request = request
3031
self.authStateMachine = authStateMachine
3132
self.fetchAuthSessionHelper = FetchAuthSessionOperationHelper()
33+
self.fetchAuthSessionHelper.environment = environment
3234
self.taskHelper = AWSAuthTaskHelper(authStateMachine: authStateMachine)
3335
self.configuration = configuration
3436
self.forceReconfigure = forceReconfigure

0 commit comments

Comments
 (0)