Fix BrowserSignin cancel() causing an unexpected hang

AlexNachbaur · AlexNachbaur · commit 5096bf4bf62d · 2025-07-09T11:12:02.000-07:00
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -8,7 +8,6 @@ on:
   push:
     branches:
       - master
-      - release/*
   pull_request:
 
 env:
diff --git a/OktaAuthFoundation.podspec b/OktaAuthFoundation.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
     s.name             = "OktaAuthFoundation"
     s.module_name      = "AuthFoundation"
-    s.version          = "2.0.1"
+    s.version          = "2.0.2"
     s.summary          = "Okta Authentication Foundation"
     s.description      = <<-DESC
 Provides the foundation and common features used to authenticate users, managing the lifecycle and storage of tokens and credentials, and provide a base for other Okta SDKs to build upon.
diff --git a/OktaBrowserSignin.podspec b/OktaBrowserSignin.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
     s.name             = "OktaBrowserSignin"
     s.module_name      = "BrowserSignin"
-    s.version          = "2.0.1"
+    s.version          = "2.0.2"
     s.summary          = "Okta Browser Sign In UI"
     s.description      = <<-DESC
 Authenticate users using web-based OIDC.
diff --git a/OktaClient.podspec b/OktaClient.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
     s.name         = "OktaClient"
-    s.version      = "2.0.1"
+    s.version      = "2.0.2"
     s.summary      = "Secure client authentication, request authorization, and user management capabilities for Swift."
     s.description  = <<-DESC
 Provides a modularized set of libraries that provide the building blocks and convenience features used to authenticate users, manage the lifecycle and storage of tokens and user credentials, and provide a base for other libraries and applications to build upon.
diff --git a/OktaDirectAuth.podspec b/OktaDirectAuth.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
     s.name             = "OktaDirectAuth"
-    s.version          = "2.0.1"
+    s.version          = "2.0.2"
     s.summary          = "Okta Direct Authentication"
     s.description      = <<-DESC
 Enables application developers to build native sign in experiences using the Okta Direct Authentication API.
diff --git a/OktaIdxAuth.podspec b/OktaIdxAuth.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
     s.name             = 'OktaIdxAuth'
-    s.version          = '2.0.1'
+    s.version          = '2.0.2'
     s.summary          = 'SDK to easily integrate the Okta Identity Engine'
     s.description      = <<-DESC
 Integrate your native app with Okta using the Okta Identity Engine library.
diff --git a/OktaOAuth2.podspec b/OktaOAuth2.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
     s.name             = "OktaOAuth2"
     s.module_name      = "OAuth2Auth"
-    s.version          = "2.0.1"
+    s.version          = "2.0.2"
     s.summary          = "Okta OAuth2 Authentication"
     s.description      = <<-DESC
 Enables application developers to authenticate users utilizing a variety of OAuth2 authentication flows.
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ The latest release can always be found on the [releases page][github-releases].
 
 If you run into problems using the SDK, you can:
 
-* Review the [API documentation](sdkdocumentation) for [AuthFoundation][authfoundation-docs], [OAuth2Auth][oauth2auth-docs], [OktaDirectAuth][oktadirectauth-docs], [OktaIdxAuth][oktaidxauth-docs], and [BrowserSignin][browsersignin-docs]
+* Review the [API documentation][sdkdocumentation] for [AuthFoundation][authfoundation-docs], [OAuth2Auth][oauth2auth-docs], [OktaDirectAuth][oktadirectauth-docs], [OktaIdxAuth][oktaidxauth-docs], and [BrowserSignin][browsersignin-docs]
 * Ask questions on the [Okta Developer Forums][devforum]
 * Post [issues][github-issues] here on GitHub (for code errors)
 
diff --git a/Samples/WebSignIn/WebSignIn (iOS)/UITests/BrowserSignInTests.swift b/Samples/WebSignIn/WebSignIn (iOS)/UITests/BrowserSignInTests.swift
@@ -41,7 +41,30 @@ class BrowserSignInUITests: XCTestCase {
         signInScreen.isVisible()
     }
 
-    func testEphemeralLoginAndSignOut() throws {
+    func testCancelAndSignIn() throws {
+        // Open sign-in screen
+        signInScreen.isVisible()
+        signInScreen.setEphemeral(true)
+        signInScreen.login()
+
+        // Cancel sign-in
+        signInScreen.cancel()
+        signInScreen.isVisible()
+
+        // Sign-in
+        signInScreen.login(username: username, password: password)
+        profileScreen.wait()
+        save(screenshot: "Profile Screen")
+
+        XCTAssertEqual(profileScreen.valueLabel(for: .username).label, username)
+        XCTAssertEqual(profileScreen.valueLabel(for: .defaultCredential).label, "Yes")
+
+        profileScreen.signOut(.endSession)
+
+        signInScreen.isVisible()
+    }
+
+    func testEphemeralSignInAndSignOut() throws {
         signInScreen.isVisible()
         signInScreen.setEphemeral(true)
         signInScreen.login(username: username, password: password)
@@ -57,7 +80,7 @@ class BrowserSignInUITests: XCTestCase {
         signInScreen.isVisible()
     }
 
-    func testSharedLoginAndSignOut() throws {
+    func testSharedSignInAndSignOut() throws {
         signInScreen.isVisible()
         signInScreen.setEphemeral(false)
         signInScreen.login(username: username, password: password)
diff --git a/Sources/AuthFoundation/Version+AuthFoundation.swift b/Sources/AuthFoundation/Version+AuthFoundation.swift
@@ -20,6 +20,6 @@ extension SDKVersion.Name {
 extension SDKVersion {
     @_documentation(visibility: private)
     public static let authFoundation: SDKVersion? = {
-        register(.authFoundation, version: "2.0.1")
+        register(.authFoundation, version: "2.0.2")
     }()
 }
diff --git a/Sources/BrowserSignin/BrowserSignin.swift b/Sources/BrowserSignin/BrowserSignin.swift
@@ -101,7 +101,7 @@ public final class BrowserSignin {
                              context: AuthorizationCodeFlow.Context = .init()) async throws -> Token
     {
         if provider != nil {
-            cancel()
+            await cancel()
         }
         
         guard let redirectUri = signInFlow.client.configuration.redirectUri
@@ -173,7 +173,7 @@ public final class BrowserSignin {
         }
         
         if provider != nil {
-            cancel()
+            await cancel()
         }
 
         async let authorizeUrl = signOutFlow.start(with: context)
@@ -193,11 +193,10 @@ public final class BrowserSignin {
     }
     
     /// Cancels the authentication session.
-    public final func cancel() {
-        withIsolationSync {
-            await self.signInFlow.reset()
-            await self.signOutFlow?.reset()
-        }
+    @MainActor
+    public final func cancel() async {
+        await self.signInFlow.reset()
+        await self.signOutFlow?.reset()
         provider?.cancel()
         provider = nil
     }
diff --git a/Sources/BrowserSignin/Version+BrowserSignin.swift b/Sources/BrowserSignin/Version+BrowserSignin.swift
@@ -21,6 +21,6 @@ extension SDKVersion.Name {
 extension SDKVersion {
     @_documentation(visibility: private)
     public static let browserSignin: SDKVersion? = {
-        register(.browserSignin, version: "2.0.1")
+        register(.browserSignin, version: "2.0.2")
     }()
 }
diff --git a/Sources/OAuth2Auth/Version+OAuth2Auth.swift b/Sources/OAuth2Auth/Version+OAuth2Auth.swift
@@ -20,6 +20,6 @@ extension SDKVersion.Name {
 extension SDKVersion {
     @_documentation(visibility: private)
     public static let oauth2: SDKVersion? = {
-        register(.oauth2, version: "2.0.1")
+        register(.oauth2, version: "2.0.2")
     }()
 }
diff --git a/Sources/OktaDirectAuth/Version+OktaDirectAuth.swift b/Sources/OktaDirectAuth/Version+OktaDirectAuth.swift
@@ -20,6 +20,6 @@ extension SDKVersion.Name {
 extension SDKVersion {
     @_documentation(visibility: private)
     public static let directAuth: SDKVersion? = {
-        register(.directAuth, version: "2.0.1")
+        register(.directAuth, version: "2.0.2")
     }()
 }
diff --git a/Sources/OktaIdxAuth/Version+OktaIdxAuth.swift b/Sources/OktaIdxAuth/Version+OktaIdxAuth.swift
@@ -22,6 +22,6 @@ extension SDKVersion.Name {
 extension SDKVersion {
     @_documentation(visibility: private)
     public static let oktaIdx: SDKVersion? = {
-        register(.oktaIdx, version: "2.0.1")
+        register(.oktaIdx, version: "2.0.2")
     }()
 }

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,6 @@ extension SDKVersion.Name {`
`20`	`20`	`extension SDKVersion {`
`21`	`21`	`@_documentation(visibility: private)`
`22`	`22`	`public static let authFoundation: SDKVersion? = {`
`23`		`- register(.authFoundation, version: "2.0.1")`
	`23`	`+ register(.authFoundation, version: "2.0.2")`
`24`	`24`	`}()`
`25`	`25`	`}`