Rewrite handleRedirectURL and handleRedirectURL functions to async

Author: DominikPalo

Sources/Base/OAuth2Base.swift

@@ -102,7 +102,7 @@ open class OAuth2Base: OAuth2Securable {
 
 	/// The receiver's id token.
 	open var idToken: String? {
-		get { return clientConfig.idToken }	
+		get { return clientConfig.idToken }
 		set { clientConfig.idToken = newValue }
 	}
 
@@ -157,6 +157,7 @@ open class OAuth2Base: OAuth2Securable {
 	*/
 	public final var internalAfterAuthorizeOrFail: ((_ wasFailure: Bool, _ error: OAuth2Error?) -> Void)?
 
+	public final var doAuthorizeContinuation: CheckedContinuation<OAuth2JSON, any Error>?
 
 	/**
 	Designated initializer.
@@ -266,7 +267,8 @@ open class OAuth2Base: OAuth2Securable {
 
 	- parameter redirect: The redirect URL returned by the server that you want to handle
 	*/
-	open func handleRedirectURL(_ redirect: URL) throws {
+	@discardableResult
+	open func handleRedirectURL(_ redirect: URL) async throws -> OAuth2JSON {
 		throw OAuth2Error.generic("Abstract class use")
 	}
 
@@ -287,6 +289,10 @@ open class OAuth2Base: OAuth2Securable {
 			self.internalAfterAuthorizeOrFail?(false, nil)
 			self.afterAuthorizeOrFail?(parameters, nil)
 		}
+		
+		// Finish `doAuthorize` call
+		self.doAuthorizeContinuation?.resume(returning: parameters)
+		self.doAuthorizeContinuation = nil
 	}
 
 	/**
@@ -310,6 +316,10 @@ open class OAuth2Base: OAuth2Securable {
 			self.internalAfterAuthorizeOrFail?(true, finalError)
 			self.afterAuthorizeOrFail?(nil, finalError)
 		}
+		
+		// Finish `doAuthorize` call
+		self.doAuthorizeContinuation?.resume(throwing: error ?? OAuth2Error.requestCancelled)
+		self.doAuthorizeContinuation = nil
 	}
 
 	/**

Sources/Flows/OAuth2.swift

@@ -186,14 +186,21 @@ open class OAuth2: OAuth2Base {
 	- parameter params: Optional key/value pairs to pass during authorization
 	*/
 	open func doAuthorize(params: OAuth2StringDict? = nil) async throws -> OAuth2JSON? {
-		if authConfig.authorizeEmbedded {
-			try await doAuthorizeEmbedded(with: authConfig, params: params)
-		}
-		else {
-			try doOpenAuthorizeURLInBrowser(params: params)
+		return try await withCheckedThrowingContinuation { continuation in
+			Task {
+				do {
+					if authConfig.authorizeEmbedded {
+						try await doAuthorizeEmbedded(with: authConfig, params: params)
+					}
+					else {
+						try doOpenAuthorizeURLInBrowser(params: params)
+					}
+					self.doAuthorizeContinuation = continuation
+				} catch {
+					continuation.resume(throwing: error)
+				}
+			}
 		}
-		
-		return nil // TODO
 	}
 
 	/**
@@ -229,7 +236,7 @@ open class OAuth2: OAuth2Base {
 	Method that creates the OAuth2AuthRequest instance used to create the authorize URL
 
 	- parameter redirect: The redirect URI string to supply. If it is nil, the first value of the settings' `redirect_uris` entries is
-	                      used. Must be present in the end!
+						  used. Must be present in the end!
 	- parameter scope:    The scope to request
 	- parameter params:   Any additional parameters as dictionary with string keys and values that will be added to the query part
 	- returns:            OAuth2AuthRequest to be used to call to the authorize endpoint
@@ -279,7 +286,7 @@ open class OAuth2: OAuth2Base {
 	Convenience method to be overridden by and used from subclasses.
 
 	- parameter redirect: The redirect URI string to supply. If it is nil, the first value of the settings' `redirect_uris` entries is
-	                      used. Must be present in the end!
+						  used. Must be present in the end!
 	- parameter scope:    The scope to request
 	- parameter params:   Any additional parameters as dictionary with string keys and values that will be added to the query part
 	- returns:            NSURL to be used to start the OAuth dance

Sources/Flows/OAuth2CodeGrant.swift

@@ -77,16 +77,15 @@ open class OAuth2CodeGrant: OAuth2 {
 	/**
 	Extracts the code from the redirect URL and exchanges it for a token.
 	*/
-	override open func handleRedirectURL(_ redirect: URL) {
+	override open func handleRedirectURL(_ redirect: URL) async throws -> OAuth2JSON {
 		logger?.debug("OAuth2", msg: "Handling redirect URL \(redirect.description)")
 		do {
 			let code = try validateRedirectURL(redirect)
-			Task {
-				await exchangeCodeForToken(code)
-			}
+			return try await exchangeCodeForToken(code)
 		}
-		catch let error {
+		catch {
 			didFail(with: error.asOAuth2Error)
+			throw error
 		}
 	}
 
@@ -95,7 +94,7 @@ open class OAuth2CodeGrant: OAuth2 {
 
 	Uses `accessTokenRequest(params:)` to create the request, which you can subclass to change implementation specifics.
 	*/
-	public func exchangeCodeForToken(_ code: String) async {
+	public func exchangeCodeForToken(_ code: String) async throws -> OAuth2JSON {
 		do {
 			guard !code.isEmpty else {
 				throw OAuth2Error.prerequisiteFailed("I don't have a code to exchange, let the user authorize first")
@@ -112,8 +111,10 @@ open class OAuth2CodeGrant: OAuth2 {
 			}
 			self.logger?.debug("OAuth2", msg: "Did exchange code for access [\(nil != self.clientConfig.accessToken)] and refresh [\(nil != self.clientConfig.refreshToken)] tokens")
 			self.didAuthorize(withParameters: params)
+			return params
 		} catch {
 			didFail(with: error.asOAuth2Error)
+			throw error
 		}
 	}
 

Sources/Flows/OAuth2ImplicitGrant.swift

@@ -38,7 +38,7 @@ open class OAuth2ImplicitGrant: OAuth2 {
 		return OAuth2ResponseTypes.token
 	}
 
-	override open func handleRedirectURL(_ redirect: URL) {
+	override open func handleRedirectURL(_ redirect: URL) async throws -> OAuth2JSON {
 		logger?.debug("OAuth2", msg: "Handling redirect URL \(redirect.description)")
 		do {
 			// token should be in the URL fragment
@@ -51,9 +51,11 @@ open class OAuth2ImplicitGrant: OAuth2 {
 			let dict = try parseAccessTokenResponse(params: params)
 			logger?.debug("OAuth2", msg: "Successfully extracted access token")
 			didAuthorize(withParameters: dict)
+			return dict
 		}
-		catch let error {
+		catch {
 			didFail(with: error.asOAuth2Error)
+			throw error
 		}
 	}
 

Sources/iOS/OAuth2Authorizer+iOS.swift

@@ -152,11 +152,13 @@ open class OAuth2Authorizer: OAuth2AuthorizerUI {
 		}
 		let completionHandler: (URL?, Error?) -> Void = { url, error in
 			if let url = url {
-				do {
-					try self.oauth2.handleRedirectURL(url as URL)
-				}
-				catch let err {
-					self.oauth2.logger?.warn("OAuth2", msg: "Cannot intercept redirect URL: \(err)")
+				Task {
+					do {
+						try await self.oauth2.handleRedirectURL(url as URL)
+					}
+					catch {
+						self.oauth2.logger?.warn("OAuth2", msg: "Cannot intercept redirect URL: \(error)")
+					}
 				}
 			} else {
 				if let authenticationSessionError = error as? ASWebAuthenticationSessionError {

Sources/macOS/OAuth2Authorizer+macOS.swift

@@ -131,10 +131,12 @@ open class OAuth2Authorizer: OAuth2AuthorizerUI {
 
 		let completionHandler: (URL?, Error?) -> Void = { url, error in
 			if let url {
-				do {
-					try self.oauth2.handleRedirectURL(url)
-				} catch let err {
-					self.oauth2.logger?.warn("OAuth2", msg: "Cannot intercept redirect URL: \(err)")
+				Task {
+					do {
+						try await self.oauth2.handleRedirectURL(url)
+					} catch let err {
+						self.oauth2.logger?.warn("OAuth2", msg: "Cannot intercept redirect URL: \(err)")
+					}
 				}
 			} else {
 				if let authenticationSessionError = error as? ASWebAuthenticationSessionError {
@@ -220,7 +222,7 @@ open class OAuth2Authorizer: OAuth2AuthorizerUI {
 
 		controller.onIntercept = { url in
 			do {
-				try self.oauth2.handleRedirectURL(url)
+				try await self.oauth2.handleRedirectURL(url)
 				return true
 			}
 			catch let error {

Sources/macOS/OAuth2WebViewController+macOS.swift

@@ -84,7 +84,7 @@ public class OAuth2WebViewController: NSViewController, WKNavigationDelegate, NS
 	/// Closure called when the web view gets asked to load the redirect URL, specified in `interceptURLString`. Return a Bool indicating
 	/// that you've intercepted the URL.
 	@OAuth2Actor
-	public var onIntercept: ((URL) -> Bool)?
+	public var onIntercept: ((URL) async -> Bool)?
 
 	/// Called when the web view is about to be dismissed manually.
 	@OAuth2Actor
@@ -264,7 +264,7 @@ public class OAuth2WebViewController: NSViewController, WKNavigationDelegate, NS
 			if let url = request.url, url.scheme == interceptComponents?.scheme && url.host == interceptComponents?.host {
 				let haveComponents = URLComponents(url: url, resolvingAgainstBaseURL: true)
 				if let hp = haveComponents?.path, let ip = interceptComponents?.path, hp == ip || ("/" == hp + ip) {
-					if onIntercept(url) {
+					if await onIntercept(url) {
 						return .cancel
 					}
 					else {
@@ -285,7 +285,7 @@ public class OAuth2WebViewController: NSViewController, WKNavigationDelegate, NS
 						oauth?.logger?.debug("OAuth2", msg: "Creating redirect URL from document.title")
 						let qry = title.replacingOccurrences(of: "Success ", with: "")
 						if let url = URL(string: "http://localhost/?\(qry)") {
-							_ = onIntercept?(url)
+							_ = await onIntercept?(url)
 							return
 						}