Extract details that need to be persisted (email, phone, etc.) into LinkSignupDetails, and put it on the IntentConfirmParams

Author: yuki-stripe

Stripe/StripeiOSTests/LinkSignupViewModelTests.swift

@@ -12,7 +12,6 @@ import StripeCoreTestUtils
 import XCTest
 
 @testable@_spi(STP) import Stripe
-@testable@_spi(STP) import StripeCore
 @testable@_spi(STP) import StripePayments
 @testable@_spi(STP) import StripePaymentSheet
 import StripePaymentsTestUtils

StripePaymentSheet/StripePaymentSheet/Source/Internal/Link/Elements/InlineSignup/LinkInlineSignupElement.swift

@@ -11,6 +11,7 @@ import UIKit
 
 // TODO: Refactor this to be a ContainerElement and contain its sub-elements.
 final class LinkInlineSignupElement: Element {
+
     let collectsUserInput: Bool = true
 
     let signupView: LinkInlineSignupView
@@ -55,13 +56,11 @@ final class LinkInlineSignupElement: Element {
         self.signupView = LinkInlineSignupView(viewModel: viewModel)
         self.signupView.delegate = self
     }
-
 }
 
 extension LinkInlineSignupElement: LinkInlineSignupViewDelegate {
 
     func inlineSignupViewDidUpdate(_ view: LinkInlineSignupView) {
         delegate?.didUpdate(element: self)
     }
-
 }

StripePaymentSheet/StripePaymentSheet/Source/Internal/Link/Services/LinkAccountService.swift

@@ -48,6 +48,7 @@ final class LinkAccountService: LinkAccountServiceProtocol {
             for: email,
             with: apiClient
         ) { [apiClient] result in
+            sleep(10)
             switch result {
             case .success(let lookupResponse):
                 STPAnalyticsClient.sharedClient.logLinkAccountLookupComplete(lookupResult: lookupResponse.responseType)

StripePaymentSheet/StripePaymentSheet/Source/Internal/Link/ViewModels/LinkInlineSignupViewModel.swift

@@ -15,9 +15,16 @@ protocol LinkInlineSignupViewModelDelegate: AnyObject {
     func signupViewModelDidUpdate(_ viewModel: LinkInlineSignupViewModel)
 }
 
+struct LinkSignupDetails: Equatable {
+    let account: PaymentSheetLinkAccount
+    let phoneNumber: PhoneNumber
+    let legalName: String?
+    let consentAction: PaymentSheetLinkAccount.ConsentAction
+}
+
 final class LinkInlineSignupViewModel {
     enum Action: Equatable {
-        case signupAndPay(account: PaymentSheetLinkAccount, phoneNumber: PhoneNumber, legalName: String?)
+        case signupAndPay(LinkSignupDetails)
         case continueWithoutLink
     }
 
@@ -227,9 +234,12 @@ final class LinkInlineSignupViewModel {
             }
 
             return .signupAndPay(
-                account: linkAccount,
-                phoneNumber: phoneNumber,
-                legalName: requiresNameCollection ? legalName : nil
+                .init(
+                    account: linkAccount,
+                    phoneNumber: phoneNumber,
+                    legalName: requiresNameCollection ? legalName : nil,
+                    consentAction: consentAction
+                )
             )
         case .verified, .requiresVerification:
             // This should never happen: The session should only be verified as part of the signup request,

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/IntentConfirmParams.swift

@@ -34,6 +34,8 @@ final class IntentConfirmParams {
     /// If `true`, a mandate (e.g. "By continuing you authorize Foo Corp to use your payment details for recurring payments...") was displayed to the customer.
     var didDisplayMandate: Bool = false
 
+    /// Populated when Link signup is filled out in the form.
+    var linkSignupDetails: LinkSignupDetails?
     var financialConnectionsLinkedBank: FinancialConnectionsLinkedBank?
     var instantDebitsLinkedBank: InstantDebitsLinkedBank?
 

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/Link/PaymentSheet-LinkConfirmOption.swift

@@ -18,10 +18,11 @@ extension PaymentSheet {
 
         /// Signup for Link then pay.
         case signUp(
-            account: PaymentSheetLinkAccount,
-            phoneNumber: PhoneNumber,
-            consentAction: PaymentSheetLinkAccount.ConsentAction,
-            legalName: String?,
+            details: LinkSignupDetails,
+//            account: PaymentSheetLinkAccount,
+//            phoneNumber: PhoneNumber,
+//            consentAction: PaymentSheetLinkAccount.ConsentAction,
+//            legalName: String?,
             intentConfirmParams: IntentConfirmParams
         )
 
@@ -37,12 +38,13 @@ extension PaymentSheet {
 
 extension PaymentSheet.LinkConfirmOption {
 
+    // TODO: Can we get rid of this? Can we remove details from the signup case assoc val?
     var account: PaymentSheetLinkAccount? {
         switch self {
         case .wallet:
             return nil
-        case .signUp(let account, _, _, _, _):
-            return account
+        case .signUp(let details, _):
+            return details.account
         case .withPaymentMethod:
             return nil
         }
@@ -52,7 +54,7 @@ extension PaymentSheet.LinkConfirmOption {
         switch self {
         case .wallet:
             return STPPaymentMethodType.link.displayName
-        case .signUp(_, _, _, _, let intentConfirmParams):
+        case .signUp(_, let intentConfirmParams):
             return intentConfirmParams.paymentMethodParams.paymentSheetLabel
         case .withPaymentMethod(let paymentMethod):
             return paymentMethod.paymentSheetLabel
@@ -63,7 +65,7 @@ extension PaymentSheet.LinkConfirmOption {
         switch self {
         case .wallet:
             return nil
-        case .signUp(_, _, _, _, let intentConfirmParams):
+        case .signUp(_, let intentConfirmParams):
             return intentConfirmParams.paymentMethodParams.billingDetails
         case .withPaymentMethod(let paymentMethod):
             return paymentMethod.billingDetails

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/PaymentSheet+API.swift

@@ -438,17 +438,17 @@ extension PaymentSheet {
                 let linkController = PayWithLinkController(intent: intent, elementsSession: elementsSession, configuration: configuration)
                 linkController.present(from: authenticationContext.authenticationPresentingViewController(),
                                        completion: completion)
-            case .signUp(let linkAccount, let phoneNumber, let consentAction, let legalName, let intentConfirmParams):
-                linkAccount.signUp(with: phoneNumber, legalName: legalName, consentAction: consentAction) { result in
+            case let .signUp(details: details, intentConfirmParams: intentConfirmParams):
+                details.account.signUp(with: details.phoneNumber, legalName: details.legalName, consentAction: details.consentAction) { result in
                     UserDefaults.standard.markLinkAsUsed()
                     switch result {
                     case .success:
                         STPAnalyticsClient.sharedClient.logLinkSignupComplete()
-                        createPaymentDetailsAndConfirm(linkAccount, intentConfirmParams.paymentMethodParams, intentConfirmParams.saveForFutureUseCheckboxState == .selected)
+                        createPaymentDetailsAndConfirm(details.account, intentConfirmParams.paymentMethodParams, intentConfirmParams.saveForFutureUseCheckboxState == .selected)
                     case .failure(let error as NSError):
                         STPAnalyticsClient.sharedClient.logLinkSignupFailure(error: error)
                         // Attempt to confirm directly with params as a fallback.
-                        confirmWithPaymentMethodParams(intentConfirmParams.paymentMethodParams, linkAccount, intentConfirmParams.saveForFutureUseCheckboxState == .selected)
+                        confirmWithPaymentMethodParams(intentConfirmParams.paymentMethodParams, details.account, intentConfirmParams.saveForFutureUseCheckboxState == .selected)
                     }
                 }
             case .withPaymentMethod(let paymentMethod):

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/ViewControllers/PaymentMethodFormViewController.swift

@@ -28,18 +28,12 @@ class PaymentMethodFormViewController: UIViewController {
         params.setDefaultBillingDetailsIfNecessary(for: configuration)
 
         if let params = form.updateParams(params: params) {
+            // Hack: determine this is a Link signup by looking for the LinkInlineSignupElement
             if let linkInlineSignupElement = form.getAllUnwrappedSubElements().compactMap({ $0 as? LinkInlineSignupElement }).first {
                 switch linkInlineSignupElement.action {
-                case .signupAndPay(let account, let phoneNumber, let legalName):
-                    return .link(
-                        option: .signUp(
-                            account: account,
-                            phoneNumber: phoneNumber,
-                            consentAction: linkInlineSignupElement.viewModel.consentAction,
-                            legalName: legalName,
-                            intentConfirmParams: params
-                        )
-                    )
+                case .signupAndPay(let signupDetails):
+                    params.linkSignupDetails = signupDetails // Hack: instead of this, the LinkInlineSignupElement should update its params with these details
+                    return .link(option: .signUp(details: signupDetails, intentConfirmParams: params))
                 case .continueWithoutLink:
                     return .new(confirmParams: params)
                 case .none:

StripePaymentSheet/StripePaymentSheetTests/PaymentSheet/CardSectionElementTest.swift

@@ -5,13 +5,13 @@
 //  Created by Yuki Tokuhiro on 10/2/24.
 //
 
-import XCTest
 @testable@_spi(STP) import StripeCore
 @testable@_spi(STP) import StripePayments
 @testable@_spi(STP) import StripePaymentSheet
 @testable@_spi(STP) import StripePaymentsTestUtils
 @testable@_spi(STP) import StripePaymentsUI
 @testable@_spi(STP) import StripeUICore
+import XCTest
 
 @MainActor
 final class CardSectionElementTest: XCTestCase {
@@ -46,19 +46,18 @@ final class CardSectionElementTest: XCTestCase {
         let checkbox = form.getCheckboxElement(startingWith: "Save payment details")!
         let linkInlineSignupElement: LinkInlineSignupElement = form.getElement()!
         let linkInlineView = linkInlineSignupElement.signupView
-        
+
         XCTAssertNotNil(checkbox) // Checkbox should appear since this is a PI w/ customer
         form.getTextFieldElement("Card number")?.setText("4242424242424242")
         form.getTextFieldElement("MM / YY").setText("1232")
         form.getTextFieldElement("CVC").setText("123")
         form.getTextFieldElement("ZIP").setText("65432")
-        
+
         XCTAssertEqual(form.getAllUnwrappedSubElements().count, 14)
-//        XCTAssertNotNil(form.mandateString)
         // Simulate selecting checkbox
         checkbox.isSelected = true
         checkbox.didToggleCheckbox()
-        
+
         // Set the email & phone number
         linkInlineView.emailElement.emailAddressElement.setText("\(UUID().uuidString)@foo.com")
         linkInlineView.phoneNumberElement.countryDropdownElement.setRawData("GB")
@@ -79,10 +78,10 @@ final class CardSectionElementTest: XCTestCase {
         // Ensure checkbox remains selected
         XCTAssertTrue(regeneratedForm.getCheckboxElement(startingWith: "Save payment details")!.isSelected)
         XCTAssertEqual(regeneratedIntentConfirmParams, intentConfirmParams)
-        let linkInlineSignupElement2: LinkInlineSignupElement = regeneratedForm.getElement()!
-        let linkInlineView2 = linkInlineSignupElement2.signupView
-        print(linkInlineView2)
-
+        let regeneratedLinkInlineSignupElement: LinkInlineSignupElement = regeneratedForm.getElement()!
+        let regeneratedLinkInlineView = regeneratedLinkInlineSignupElement.signupView
+        XCTAssertEqual(regeneratedLinkInlineView.phoneNumberElement.phoneNumber, PhoneNumber(number: "1234567890", countryCode: "GB"))
+//        print(linkInlineView2)
     }
 }
 

StripePaymentSheet/StripePaymentSheetTests/PaymentSheet/PaymentSheetLPMConfirmFlowTests.swift

@@ -980,6 +980,11 @@ extension IntentConfirmParams: Equatable {
             return false
         }
 
+        if lhs.linkSignupDetails != rhs.linkSignupDetails {
+            print("Link signup details not equal: \(lhs.linkSignupDetails.debugDescription) vs \(rhs.linkSignupDetails.debugDescription)")
+            return false
+        }
+
         // Sanity check to make sure when we add new properties, we check them here
         let mirror = Mirror(reflecting: lhs)
         let propertyCount = mirror.children.count