@W-17964653 Discovery endpoint to postpone OAuth flow #3892
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| import Foundation | ||
| import WebKit | ||
|
|
||
| enum DomainDiscovery: String { | ||
| /// The callback URL used for domain discovery. | ||
| case callbackURL = "sfdc://discocallback" | ||
|
|
||
| enum URLComponent: String { | ||
| case path = "/discovery" | ||
| case scheme = "https" | ||
|
|
||
| enum QueryItem: String { | ||
| case clientID = "client_id" | ||
| case clientVersion = "client_version" | ||
| case callbackURL = "callback_url" | ||
| } | ||
| } | ||
|
|
||
| /* TODO: Keep this list of client ids up to date with those | ||
| * supported by Salesforce Welcome Discovery or remove it | ||
| * when no longer required. | ||
| */ | ||
| static let supportedClientIds: Set<String> = [ | ||
|
Crebs marked this conversation as resolved.
|
||
| "SfdcMobileChatterAndroid", | ||
| "SfdcMobileChatteriOS" | ||
| ] | ||
| } | ||
|
|
||
| /// Represents the result of a domain discovery operation. | ||
| @objc(SFDomainDiscoveryResult) | ||
| public class DomainDiscoveryResult: NSObject { | ||
| /// The login hint returned from domain discovery. | ||
| @objc public let loginHint: String | ||
| /// The discovered My Domain value. | ||
| @objc public let myDomain: String | ||
|
|
||
| init(loginHint: String, myDomain: String) { | ||
| self.loginHint = loginHint | ||
| self.myDomain = myDomain | ||
| } | ||
| } | ||
|
|
||
| /// Coordinator for My Domain discovery via WKWebView before OAuth login. | ||
| /// | ||
| /// This class loads a discovery URL in a WKWebView and waits for a callback URL to be hit, returning the discovered domain and login hint. | ||
| @objc(SFDomainDiscoveryCoordinator) | ||
| public class DomainDiscoveryCoordinator: NSObject { | ||
| /// Starts the domain discovery process by loading the discovery URL in the provided WKWebView. | ||
| /// | ||
| /// - Parameters: | ||
| /// - webview: The WKWebView in which to load the discovery URL for domain discovery. | ||
| /// - credentials: The OAuth credentials containing clientId and domain. | ||
| /// | ||
| /// This method loads the discovery URL in the given webview. The result of the discovery should be handled by monitoring navigation actions and calling `handle(webAction:)`. | ||
| @MainActor | ||
| @objc public func runMyDomainsDiscovery(on webview: WKWebView, | ||
| with credentials: OAuthCredentials) { | ||
| guard let clientId = credentials.clientId, | ||
| let clientVersion = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String, | ||
| let domain = credentials.domain else { | ||
| SFSDKCoreLogger.e(classForCoder, message: "Missing required credentials") | ||
| return | ||
| } | ||
| guard let url = Self.buildDiscoveryURL(clientId: clientId, clientVersion: clientVersion, domain: domain) as URL? else { | ||
| SFSDKCoreLogger.e(classForCoder, message: "Failed to construct discovery URL") | ||
| return | ||
| } | ||
| webview.load(URLRequest(url: url)) | ||
| } | ||
|
|
||
| /// Handles a navigation action and checks if it matches the domain discovery callback URL. | ||
| /// | ||
| /// - Parameter action: The action to inspect. | ||
| /// - Returns: A `DomainDiscoveryResult` if the callback URL is detected and parsed; otherwise, `nil`. | ||
| /// | ||
| /// Call this from your WKNavigationDelegate when a navigation action occurs to detect and extract the result from the domain discovery callback URL. | ||
| @objc(handleWithWebAction:) | ||
| public func handle(action: WKNavigationAction) -> DomainDiscoveryResult? { | ||
| guard let url = action.request.url else { | ||
| return nil | ||
| } | ||
| if isDomainDiscoveryCallbackURL(url) { | ||
| let result = parseDiscoveryCallbackURL(url) | ||
| return result | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| @objc | ||
| public func isDiscoveryDomain(_ domain: String?, clientId: String?) -> Bool { | ||
| guard let domain = domain, let clientId = clientId else { return false } | ||
| let isDiscovery = domain.lowercased().contains(DomainDiscovery.URLComponent.path.rawValue) | ||
| let isSupportedClient = DomainDiscovery.supportedClientIds.contains(clientId) | ||
| if isDiscovery && !isSupportedClient { | ||
| SFSDKCoreLogger.e(classForCoder, message: "\(domain) is a discovery domain, but client ID '\(clientId)' is not supported.") | ||
| } | ||
| return isDiscovery && isSupportedClient | ||
| } | ||
| } | ||
|
|
||
| extension DomainDiscoveryCoordinator { | ||
| private static func buildDiscoveryURL(clientId: String, clientVersion: String, domain: String, callbackURL: String = DomainDiscovery.callbackURL.rawValue) -> NSURL? { | ||
| var components = URLComponents() | ||
| components.scheme = DomainDiscovery.URLComponent.scheme.rawValue | ||
| components.host = domain.components(separatedBy: "/").first | ||
| components.path = DomainDiscovery.URLComponent.path.rawValue | ||
| components.queryItems = [ | ||
| URLQueryItem(name: DomainDiscovery.URLComponent.QueryItem.clientID.rawValue, value: clientId), | ||
| URLQueryItem(name: DomainDiscovery.URLComponent.QueryItem.clientVersion.rawValue, value: clientVersion), | ||
| URLQueryItem(name: DomainDiscovery.URLComponent.QueryItem.callbackURL.rawValue, value: callbackURL) | ||
| ] | ||
| return components.url as NSURL? | ||
| } | ||
|
|
||
| private func isDomainDiscoveryCallbackURL(_ url: URL?) -> Bool { | ||
|
Contributor
There was a problem hiding this comment. That will not work with test environment.
Contributor
Author
There was a problem hiding this comment. @wmathurin do you mean the "isDisoveryDomain" method, not the "isDomainDiscoveryCallbackURL" right? I'm pretty sure that's what you mean there. But want to make sure I'm not missing something. |
||
| guard let url = url as URL? else { return false } | ||
| return url.absoluteString.lowercased().hasPrefix(DomainDiscovery.callbackURL.rawValue.lowercased()) | ||
| } | ||
|
|
||
| private func parseDiscoveryCallbackURL(_ url: URL?) -> DomainDiscoveryResult? { | ||
| guard let url = url else { return nil } | ||
| let components = URLComponents(url: url, resolvingAgainstBaseURL: false) | ||
| guard let loginHint = components?.queryItems?.first(where: { $0.name == "login_hint" })?.value, | ||
| let myDomainRaw = components?.queryItems?.first(where: { $0.name == "my_domain" })?.value else { | ||
| SFSDKCoreLogger.e(classForCoder, message: "Domain discovery callback URL is missing required parameter(s): login_hint and/or my_domain.") | ||
| return nil | ||
| } | ||
| let myDomain = myDomainRaw.hasPrefix("https://") ? String(myDomainRaw.dropFirst("https://".count)) : myDomainRaw | ||
| return DomainDiscoveryResult(loginHint: loginHint, myDomain: myDomain) | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wmathurin This what you hand in mind for the disco comain?