[Connect] Using FinancialConnections SDK in Connect #4159
There are no files selected for viewing
This file contains 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 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,34 @@ | ||
| // | ||
| // FinancialConnectionsPresenter.swift | ||
| // StripeConnect | ||
| // | ||
| // Created by Mel Ludowise on 10/18/24. | ||
| // | ||
|
|
||
| @_spi(STP) import StripeCore | ||
| import StripeFinancialConnections | ||
| import UIKit | ||
|
|
||
| /// Wraps `FinancialConnectionsSheet` for easy dependency injection in tests | ||
| class FinancialConnectionsPresenter { | ||
| @MainActor | ||
| func presentForToken( | ||
| apiClient: STPAPIClient, | ||
| clientSecret: String, | ||
| connectedAccountId: String, | ||
| from presentingViewController: UIViewController | ||
| ) async -> FinancialConnectionsSheet.TokenResult { | ||
| let financialConnectionsSheet = FinancialConnectionsSheet( | ||
| financialConnectionsSessionClientSecret: clientSecret | ||
| ) | ||
| // FC needs the connected account ID to be configured on the API Client | ||
| // Make a copy before modifying so we don't unexpectedly modify the shared API client | ||
| financialConnectionsSheet.apiClient = apiClient.makeCopy() | ||
| financialConnectionsSheet.apiClient.stripeAccount = connectedAccountId | ||
| return await withCheckedContinuation { continuation in | ||
| financialConnectionsSheet.presentForToken(from: presentingViewController) { result in | ||
| continuation.resume(returning: result) | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains 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 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,25 @@ | ||
| // | ||
| // OpenFinancialConnectionsMessageHandler.swift | ||
| // StripeConnect | ||
| // | ||
| // Created by Mel Ludowise on 10/17/24. | ||
| // | ||
|
|
||
| /// Indicates to open the FinancialConnections flow | ||
| class OpenFinancialConnectionsMessageHandler: ScriptMessageHandler<OpenFinancialConnectionsMessageHandler.Payload> { | ||
| struct Payload: Codable, Equatable { | ||
| /// The Financial Connections Session client secret used to open the FinancialConnectionsSheet | ||
| let clientSecret: String | ||
| /// Unique identifier (UUID) returned to the web view with the FinancialConnections | ||
| /// result in `returnedFromFinancialConnections` message | ||
| let id: String | ||
| // The id of the Connected Account that requested the Financial Connections Session client secret | ||
| let connectedAccountId: String | ||
| } | ||
| init(analyticsClient: ComponentAnalyticsClient, | ||
| didReceiveMessage: @escaping (Payload) -> Void) { | ||
| super.init(name: "openFinancialConnections", | ||
| analyticsClient: analyticsClient, | ||
| didReceiveMessage: didReceiveMessage) | ||
| } | ||
| } |
This file contains 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,19 @@ | ||
| // | ||
| // ReturnedFromFinancialConnectionsSender.swift | ||
| // StripeConnect | ||
| // | ||
| // Created by Mel Ludowise on 10/17/24. | ||
| // | ||
|
|
||
| /// Notifies that the user finished the FinancialConnections flow | ||
| struct ReturnedFromFinancialConnectionsSender: MessageSender { | ||
| struct Payload: Codable, Equatable { | ||
| /// The linked bank account token. | ||
| /// This value will be nil if the user canceled the flow or an error occurred. | ||
| let bankToken: String? | ||
| /// Unique identifier (UUID) originally passed from the web layer in `openFinancialConnections` | ||
| let id: String | ||
| } | ||
| let name: String = "returnedFromFinancialConnections" | ||
| let payload: Payload | ||
| } |
This file contains 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 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,23 @@ | ||
| // | ||
| // OpenFinancialConnectionsMessageHandlerTests.swift | ||
| // StripeConnect | ||
| // | ||
| // Created by Mel Ludowise on 10/18/24. | ||
| // | ||
|
|
||
| @testable import StripeConnect | ||
| import XCTest | ||
|
|
||
| class OpenFinancialConnectionsMessageHandlerTests: ScriptWebTestBase { | ||
| func testMessageSend() { | ||
| let expectation = self.expectation(description: "Message received") | ||
| webView.addMessageHandler(messageHandler: OpenFinancialConnectionsMessageHandler(analyticsClient: MockComponentAnalyticsClient(commonFields: .mock)) { payload in | ||
| XCTAssertEqual(payload, .init(clientSecret: "secret_123", id: "1234", connectedAccountId: "acct_1234")) | ||
| expectation.fulfill() | ||
| }) | ||
|
|
||
| webView.evaluateOpenFinancialConnectionsWebView(clientSecret: "secret_123", id: "1234", connectedAccountId: "acct_1234") | ||
|
|
||
| waitForExpectations(timeout: TestHelpers.defaultTimeout, handler: nil) | ||
| } | ||
| } |
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.
Just wanted to check to see if we have weighed the pros and cons of checked vs unchecked continuation here. If we stick with checked then this will cause a crash if resume is called more than once. It shouldn't get called more than once in this instance, but maybe we can add some extra protections here to ensure we don't call resume more than once and instead of crashing we log an error.
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.
I didn't spend too much time thinking about it in this instance since it shouldn't be possible for it to get called more than once. I don't think we have a strong opinion as to which to use the SDK.
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.
Ok that's ok, I don't think this should be a blocker or anything. Just wanted to call out that we have been bitten by this before. Especially within an SDK it would be ideal to not crash on a programmer error like this.