Relink tweaks

- Don't return `.canceled` for networking relink sessions - Don't use custom success message in this case
stripe · Feb 4, 2025 · 21a9adc · 21a9adc
1 parent 4fb2a7a
commit 21a9adc
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 33 deletions.
diff --git a/...ctions/StripeFinancialConnections/Source/API Bindings/FinancialConnectionsAPIClient.swift b/...ctions/StripeFinancialConnections/Source/API Bindings/FinancialConnectionsAPIClient.swift
@@ -252,7 +252,8 @@ protocol FinancialConnectionsAPI {
         phoneNumber: String?,
         country: String?,
         consumerSessionClientSecret: String?,
-        clientSecret: String
+        clientSecret: String,
+        isRelink: Bool
     ) -> Future<SaveAccountsToNetworkAndLinkResponse>
 
     func disableNetworking(
@@ -768,7 +769,8 @@ extension FinancialConnectionsAPIClient: FinancialConnectionsAPI {
         phoneNumber: String?,
         country: String?,
         consumerSessionClientSecret: String?,
-        clientSecret: String
+        clientSecret: String,
+        isRelink: Bool
     ) -> Future<SaveAccountsToNetworkAndLinkResponse> {
         let saveAccountsToLinkHandler: () -> Future<SaveAccountsToNetworkAndLinkResponse> = {
             return self.saveAccountsToLink(
@@ -780,10 +782,11 @@ extension FinancialConnectionsAPIClient: FinancialConnectionsAPI {
                 clientSecret: clientSecret
             )
             .chained { manifest in
+                let customSuccessPaneMessage = isRelink ? nil : manifest.displayText?.successPane?.subCaption
                 return Promise(
                     value: (
                         manifest: manifest,
-                        customSuccessPaneMessage: manifest.displayText?.successPane?.subCaption
+                        customSuccessPaneMessage: customSuccessPaneMessage
                     )
                 )
             }

diff --git a/...eFinancialConnections/Source/API Bindings/FinancialConnectionsAsyncAPIClient+Legacy.swift b/...eFinancialConnections/Source/API Bindings/FinancialConnectionsAsyncAPIClient+Legacy.swift
@@ -252,7 +252,8 @@ extension FinancialConnectionsAsyncAPIClient: FinancialConnectionsAPI {
         phoneNumber: String?,
         country: String?,
         consumerSessionClientSecret: String?,
-        clientSecret: String
+        clientSecret: String,
+        isRelink: Bool
     ) -> Future<(manifest: FinancialConnectionsSessionManifest, customSuccessPaneMessage: String?)> {
         wrapAsyncToFuture {
             try await self.saveAccountsToNetworkAndLink(
@@ -262,7 +263,8 @@ extension FinancialConnectionsAsyncAPIClient: FinancialConnectionsAPI {
                 phoneNumber: phoneNumber,
                 country: country,
                 consumerSessionClientSecret: consumerSessionClientSecret,
-                clientSecret: clientSecret
+                clientSecret: clientSecret,
+                isRelink: isRelink
             )
         }
     }

diff --git a/...s/StripeFinancialConnections/Source/API Bindings/FinancialConnectionsAsyncAPIClient.swift b/...s/StripeFinancialConnections/Source/API Bindings/FinancialConnectionsAsyncAPIClient.swift
@@ -272,7 +272,8 @@ protocol FinancialConnectionsAsyncAPI {
         phoneNumber: String?,
         country: String?,
         consumerSessionClientSecret: String?,
-        clientSecret: String
+        clientSecret: String,
+        isRelink: Bool
     ) async throws -> (
         manifest: FinancialConnectionsSessionManifest,
         customSuccessPaneMessage: String?
@@ -713,7 +714,8 @@ extension FinancialConnectionsAsyncAPIClient: FinancialConnectionsAsyncAPI {
         phoneNumber: String?,
         country: String?,
         consumerSessionClientSecret: String?,
-        clientSecret: String
+        clientSecret: String,
+        isRelink: Bool
     ) async throws -> (
         manifest: FinancialConnectionsSessionManifest,
         customSuccessPaneMessage: String?
@@ -730,10 +732,12 @@ extension FinancialConnectionsAsyncAPIClient: FinancialConnectionsAsyncAPI {
                 consumerSessionClientSecret: consumerSessionClientSecret,
                 clientSecret: clientSecret
             )
+
+            let customSuccessPaneMessage = isRelink ? nil : manifest.displayText?.successPane?.subCaption
 
             return (
                 manifest: manifest,
-                customSuccessPaneMessage: manifest.displayText?.successPane?.subCaption
+                customSuccessPaneMessage: customSuccessPaneMessage
             )
         }
         if

diff --git a/...ions/StripeFinancialConnections/Source/Native/AccountPicker/AccountPickerDataSource.swift b/...ions/StripeFinancialConnections/Source/Native/AccountPicker/AccountPickerDataSource.swift
@@ -49,6 +49,7 @@ final class AccountPickerDataSourceImplementation: AccountPickerDataSource {
     let reduceManualEntryProminenceInErrors: Bool
     let dataAccessNotice: FinancialConnectionsDataAccessNotice?
     let consumerSessionClientSecret: String?
+    private let isRelink: Bool
 
     private(set) var selectedAccounts: [FinancialConnectionsPartnerAccount] = [] {
         didSet {
@@ -67,7 +68,8 @@ final class AccountPickerDataSourceImplementation: AccountPickerDataSource {
         analyticsClient: FinancialConnectionsAnalyticsClient,
         reduceManualEntryProminenceInErrors: Bool,
         dataAccessNotice: FinancialConnectionsDataAccessNotice?,
-        consumerSessionClientSecret: String?
+        consumerSessionClientSecret: String?,
+        isRelink: Bool
     ) {
         self.apiClient = apiClient
         self.clientSecret = clientSecret
@@ -79,6 +81,7 @@ final class AccountPickerDataSourceImplementation: AccountPickerDataSource {
         self.reduceManualEntryProminenceInErrors = reduceManualEntryProminenceInErrors
         self.dataAccessNotice = dataAccessNotice
         self.consumerSessionClientSecret = consumerSessionClientSecret
+        self.isRelink = isRelink
     }
 
     func pollAuthSessionAccounts() -> Future<FinancialConnectionsAuthSessionAccounts> {
@@ -117,7 +120,8 @@ final class AccountPickerDataSourceImplementation: AccountPickerDataSource {
             phoneNumber: nil,
             country: nil,
             consumerSessionClientSecret: consumerSessionClientSecret,
-            clientSecret: clientSecret
+            clientSecret: clientSecret,
+            isRelink: isRelink
         )
         .chained { (_, customSuccessPaneMessage) in
             return Promise(value: customSuccessPaneMessage)

diff --git a/...eFinancialConnections/StripeFinancialConnections/Source/Native/NativeFlowController.swift b/...eFinancialConnections/StripeFinancialConnections/Source/Native/NativeFlowController.swift
@@ -393,9 +393,7 @@ extension NativeFlowController {
                         )
                         finishAuthSession(.failed(error: FinancialConnectionsCustomManualEntryRequiredError()))
                     } else {
-                        if !session.accounts.data.isEmpty || session.paymentAccount != nil
-                            || session.bankAccountToken != nil
-                        {
+                        if session.didCompleteSuccessfully || dataManager.pendingRelinkAuthorization != nil {
                             if dataManager.manifest.isProductInstantDebits {
                                 // For Instant Debits, create a payment method and complete with it.
                                 createPaymentMethod(for: session) { result in
@@ -1176,7 +1174,7 @@ extension NativeFlowController: LinkAccountPickerViewControllerDelegate {
         forAuthorization authorization: String
     ) {
         dataManager.institution = institution
-        dataManager.pendingRepairAuthorization = authorization
+        dataManager.pendingRelinkAuthorization = authorization
         pushPane(.bankAuthRepair, animated: true, clearNavigationStack: true)
     }
 
@@ -1388,7 +1386,8 @@ private func CreatePaneViewController(
                 analyticsClient: dataManager.analyticsClient,
                 reduceManualEntryProminenceInErrors: dataManager.reduceManualEntryProminenceInErrors,
                 dataAccessNotice: dataManager.consentPaneModel?.dataAccessNotice,
-                consumerSessionClientSecret: dataManager.consumerSession?.clientSecret
+                consumerSessionClientSecret: dataManager.consumerSession?.clientSecret,
+                isRelink: dataManager.pendingRelinkAuthorization != nil
             )
             let accountPickerViewController = AccountPickerViewController(dataSource: accountPickerDataSource)
             accountPickerViewController.delegate = nativeFlowController
@@ -1422,12 +1421,12 @@ private func CreatePaneViewController(
             viewController = nil
         }
     case .bankAuthRepair:
-        if let institution = dataManager.institution, let coreAuthorization = dataManager.pendingRepairAuthorization {
+        if let institution = dataManager.institution, let relinkAuthorization = dataManager.pendingRelinkAuthorization {
             let partnerAuthDataSource = PartnerAuthDataSourceImplementation(
                 authSession: dataManager.authSession,
                 institution: institution,
                 manifest: dataManager.manifest,
-                repairSessionPayload: RelinkSessionPayload(coreAuthorization: coreAuthorization),
+                relinkAuthorization: relinkAuthorization,
                 returnURL: dataManager.returnURL,
                 apiClient: dataManager.apiClient,
                 clientSecret: dataManager.clientSecret,
@@ -1603,7 +1602,7 @@ private func CreatePaneViewController(
                 authSession: dataManager.authSession,
                 institution: institution,
                 manifest: dataManager.manifest,
-                repairSessionPayload: nil,
+                relinkAuthorization: nil,
                 returnURL: dataManager.returnURL,
                 apiClient: dataManager.apiClient,
                 clientSecret: dataManager.clientSecret,
@@ -1765,3 +1764,10 @@ private func ShouldHideLogoInNavigationBar(
         return reducedBranding
     }
 }
+
+private extension StripeAPI.FinancialConnectionsSession {
+
+    var didCompleteSuccessfully: Bool {
+        return !accounts.data.isEmpty || paymentAccount != nil || bankAccountToken != nil
+    }
+}
diff --git a/...FinancialConnections/StripeFinancialConnections/Source/Native/NativeFlowDataManager.swift b/...FinancialConnections/StripeFinancialConnections/Source/Native/NativeFlowDataManager.swift
@@ -36,7 +36,7 @@ protocol NativeFlowDataManager: AnyObject {
     var lastPaneLaunched: FinancialConnectionsSessionManifest.NextPane? { get set }
     var customSuccessPaneCaption: String? { get set }
     var customSuccessPaneSubCaption: String? { get set }
-    var pendingRepairAuthorization: String? { get set }
+    var pendingRelinkAuthorization: String? { get set }
 
     func createPaymentDetails(
         consumerSessionClientSecret: String,
@@ -99,7 +99,7 @@ class NativeFlowAPIDataManager: NativeFlowDataManager {
     var lastPaneLaunched: FinancialConnectionsSessionManifest.NextPane?
     var customSuccessPaneCaption: String?
     var customSuccessPaneSubCaption: String?
-    var pendingRepairAuthorization: String?
+    var pendingRelinkAuthorization: String?
 
     var consumerSession: ConsumerSessionData? {
         didSet {

diff --git a/...alConnections/Source/Native/NetworkingLinkSignupPane/NetworkingLinkSignupDataSource.swift b/...alConnections/Source/Native/NetworkingLinkSignupPane/NetworkingLinkSignupDataSource.swift
@@ -111,7 +111,8 @@ final class NetworkingLinkSignupDataSourceImplementation: NetworkingLinkSignupDa
                     phoneNumber: nil,
                     country: nil,
                     consumerSessionClientSecret: response.consumerSession.clientSecret,
-                    clientSecret: clientSecret
+                    clientSecret: clientSecret,
+                    isRelink: false
                 )
             }
             .chained { (_, customSuccessPaneMessage) in
@@ -125,7 +126,8 @@ final class NetworkingLinkSignupDataSourceImplementation: NetworkingLinkSignupDa
                 phoneNumber: phoneNumber,
                 country: countryCode, // ex. "US"
                 consumerSessionClientSecret: nil,
-                clientSecret: clientSecret
+                clientSecret: clientSecret,
+                isRelink: false
             ).chained { (_, customSuccessPaneMessage) in
                 return Promise(value: customSuccessPaneMessage)
             }

diff --git a/.../Native/NetworkingSaveToLinkVerification/NetworkingSaveToLinkVerificationDataSource.swift b/.../Native/NetworkingSaveToLinkVerification/NetworkingSaveToLinkVerificationDataSource.swift
@@ -70,7 +70,8 @@ final class NetworkingSaveToLinkVerificationDataSourceImplementation: Networking
             phoneNumber: nil,
             country: nil,
             consumerSessionClientSecret: consumerSession.clientSecret,
-            clientSecret: clientSecret
+            clientSecret: clientSecret,
+            isRelink: false
         )
         .chained { (_, customSuccessPaneMessage) in
             return Promise(value: customSuccessPaneMessage)

diff --git a/...nections/StripeFinancialConnections/Source/Native/PartnerAuth/PartnerAuthDataSource.swift b/...nections/StripeFinancialConnections/Source/Native/PartnerAuth/PartnerAuthDataSource.swift
@@ -25,25 +25,21 @@ protocol PartnerAuthDataSource: AnyObject {
     func retrieveAuthSession(_ authSession: FinancialConnectionsAuthSession) -> Future<FinancialConnectionsAuthSession>
 }
 
-struct RelinkSessionPayload {
-    let coreAuthorization: String
-}
-
 final class PartnerAuthDataSourceImplementation: PartnerAuthDataSource {
 
     let institution: FinancialConnectionsInstitution
     let manifest: FinancialConnectionsSessionManifest
     let returnURL: String?
     private let apiClient: any FinancialConnectionsAPI
     private let clientSecret: String
-    private let relinkSessionPayload: RelinkSessionPayload?
+    private let relinkAuthorization: String?
     let analyticsClient: FinancialConnectionsAnalyticsClient
     var disableAuthSessionRetrieval: Bool {
         return manifest.features?["bank_connections_disable_defensive_auth_session_retrieval_on_complete"] == true
     }
 
     var isNetworkingRelinkSession: Bool {
-        return relinkSessionPayload != nil
+        return relinkAuthorization != nil
     }
 
     // a "pending" auth session is a session which has started
@@ -57,7 +53,7 @@ final class PartnerAuthDataSourceImplementation: PartnerAuthDataSource {
         authSession: FinancialConnectionsAuthSession?,
         institution: FinancialConnectionsInstitution,
         manifest: FinancialConnectionsSessionManifest,
-        repairSessionPayload: RelinkSessionPayload?,
+        relinkAuthorization: String?,
         returnURL: String?,
         apiClient: any FinancialConnectionsAPI,
         clientSecret: String,
@@ -70,14 +66,14 @@ final class PartnerAuthDataSourceImplementation: PartnerAuthDataSource {
         self.apiClient = apiClient
         self.clientSecret = clientSecret
         self.analyticsClient = analyticsClient
-        self.relinkSessionPayload = repairSessionPayload
+        self.relinkAuthorization = relinkAuthorization
     }
 
     func createAuthSession() -> Future<FinancialConnectionsAuthSession> {
-        if let relinkSessionPayload {
+        if let relinkAuthorization {
             return apiClient.repairAuthSession(
                 clientSecret: clientSecret,
-                coreAuthorization: relinkSessionPayload.coreAuthorization
+                coreAuthorization: relinkAuthorization
             ).chained { [weak self] (repairSession: FinancialConnectionsRepairSession) in
                 let authSession = FinancialConnectionsAuthSession(
                     id: repairSession.id,