Set 'Change >' and sublabel to selected embedded form rows

StripePaymentSheet/StripePaymentSheet/Source/Internal/API Bindings/v1-elements-sessions/STPCardBrandChoice.swift

@@ -36,7 +36,7 @@ class STPCardBrandChoice: NSObject {
         return "<\(props.joined(separator: "; "))>"
     }
 
-    private init(
+   required init(
         eligible: Bool,
         preferredNetworks: [String],
         supportedCobrandedNetworks: [String: Bool],

StripePaymentSheet/StripePaymentSheet/Source/Internal/API Bindings/v1-elements-sessions/STPElementsSession.swift

@@ -53,7 +53,7 @@ final class STPElementsSession: NSObject {
 
     let allResponseFields: [AnyHashable: Any]
 
-    private init(
+    internal init(
         allResponseFields: [AnyHashable: Any],
         sessionID: String,
         orderedPaymentMethodTypes: [STPPaymentMethodType],

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/Embedded/EmbeddedPaymentElement+Internal.swift

@@ -331,14 +331,60 @@ extension EmbeddedPaymentElement: EmbeddedFormViewControllerDelegate {
         // If the formViewController was populated with a previous payment option don't reset
         if embeddedFormViewController.previousPaymentOption == nil {
             embeddedPaymentMethodsView.resetSelectionToLastSelection()
+            // Show change button if the newly selected row needs it
+            if let newSelectedType = embeddedPaymentMethodsView.selectedRowButton?.type {
+                let changeButtonState = getChangeButtonState(for: newSelectedType)
+                if changeButtonState.shouldShowChangeButton {
+                    embeddedPaymentMethodsView.selectedRowButton?.addChangeButton(sublabel: changeButtonState.sublabel)
+                }
+            }
         }
         embeddedFormViewController.dismiss(animated: true)
     }
 
     func embeddedFormViewControllerDidContinue(_ embeddedFormViewController: EmbeddedFormViewController) {
+        // Show change button if the selected row needs it
+        if let newSelectedType = embeddedPaymentMethodsView.selectedRowButton?.type {
+            let changeButtonState = getChangeButtonState(for: newSelectedType)
+            if changeButtonState.shouldShowChangeButton {
+                embeddedPaymentMethodsView.selectedRowButton?.addChangeButton(sublabel: changeButtonState.sublabel)
+            }
+        }
         embeddedFormViewController.dismiss(animated: true)
         informDelegateIfPaymentOptionUpdated()
     }
+
+    func getChangeButtonState(for type: RowButtonType) -> (shouldShowChangeButton: Bool, sublabel: String?) {
+        guard let _paymentOption, let displayData = paymentOption else {
+            return (false, nil)
+        }
+        // Show change button for new PMs that have a valid form
+        let shouldShowChangeButton: Bool = {
+            if case .new = type, selectedFormViewController != nil {
+               return true
+            }
+            return false
+        }()
+
+        // Add a sublabel to the selected row for cards and us bank account like "Visa 4242"
+        let sublabel: String? = {
+            switch type.paymentMethodType {
+            case .stripe(.card):
+                guard case .new(confirmParams: let params) = _paymentOption else {
+                    return nil
+                }
+                let brand = STPCardValidator.brand(for: params.paymentMethodParams.card)
+                let brandString = brand == .unknown ? nil : STPCardBrandUtilities.stringFrom(brand)
+                return [brandString, displayData.label].compactMap({ $0 }).joined(separator: " ")
+            case .stripe(.USBankAccount):
+                return displayData.label
+            default:
+                return nil
+            }
+        }()
+
+        return (shouldShowChangeButton: shouldShowChangeButton, sublabel: sublabel)
+    }
 }
 
 extension EmbeddedPaymentElement {

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/Embedded/EmbeddedPaymentElement.swift

@@ -311,7 +311,7 @@ public final class EmbeddedPaymentElement {
 
     internal private(set) lazy var paymentHandler: STPPaymentHandler = STPPaymentHandler(apiClient: configuration.apiClient)
 
-    private init(
+    internal init(
         configuration: Configuration,
         loadResult: PaymentSheetLoader.LoadResult,
         analyticsHelper: PaymentSheetAnalyticsHelper

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/Embedded/EmbeddedPaymentMethodsView.swift

@@ -38,19 +38,33 @@ class EmbeddedPaymentMethodsView: UIView {
     private let customer: PaymentSheet.CustomerConfiguration?
     private var previousSelectedRowButton: RowButton? {
         didSet {
-            previousSelectedRowButton?.isSelected = false
+            guard let previousSelectedRowButton, selectedRowButton?.type != previousSelectedRowButton.type else {
+                return
+            }
+            previousSelectedRowButton.isSelected = false
+            // Clear out the 'Change >' button and any sublabel (eg 4242) we set for new PM rows
+            switch previousSelectedRowButton.type {
+            case .new(paymentMethodType: let paymentMethodType):
+                let isCardOrUSBankAccount = paymentMethodType == .stripe(.card) || paymentMethodType == .stripe(.USBankAccount)
+                previousSelectedRowButton.removeChangeButton(shouldClearSublabel: isCardOrUSBankAccount)
+            default:
+               break
+            }
         }
     }
     private(set) var selectedRowButton: RowButton? {
         didSet {
             previousSelectedRowButton = oldValue
-            selectedRowButton?.isSelected = true
-            updateMandate()
             if oldValue?.type != selectedRowButton?.type {
                 delegate?.embeddedPaymentMethodsViewDidUpdateSelection()
             }
+            if let selectedRowButton {
+                selectedRowButton.isSelected = true
+            }
+            updateMandate()
         }
     }
+
     private let mandateProvider: MandateTextProvider
     private let shouldShowMandate: Bool
     private let analyticsHelper: PaymentSheetAnalyticsHelper
@@ -376,7 +390,7 @@ class EmbeddedPaymentMethodsView: UIView {
     func makePaymentMethodRowButton(paymentMethodType: PaymentSheet.PaymentMethodType, savedPaymentMethods: [STPPaymentMethod]) -> RowButton {
         // We always add a hidden accessory button ("Change >") so we can show/hide it easily
         let accessoryButton = RowButton.RightAccessoryButton(
-            accessoryType: appearance.embeddedPaymentElement.row.style == .flatWithCheckmark ? .changeWithChevron : .change,
+            accessoryType: appearance.embeddedPaymentElement.row.style == .flatWithCheckmark ? .change : .changeWithChevron,
             appearance: appearance,
             didTap: { [weak self] in
                 guard let self, let selectedRowButton else { return }
@@ -432,3 +446,22 @@ extension Array where Element == STPPaymentMethod {
         return !self.filter { $0.type == .card }.isEmpty
     }
 }
+
+extension RowButton {
+    func addChangeButton(sublabel: String?) {
+        rightAccessoryView?.isHidden = false
+        if let sublabel {
+            self.sublabel.text = sublabel
+            self.sublabel.isHidden = sublabel.isEmpty
+        }
+        makeSameHeightAsOtherRowButtonsIfNecessary()
+    }
+
+    func removeChangeButton(shouldClearSublabel: Bool) {
+        rightAccessoryView?.isHidden = true
+        if shouldClearSublabel {
+            sublabel.text = nil
+            sublabel.isHidden = true
+        }
+    }
+}

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/PaymentOption+Images.swift

@@ -129,16 +129,7 @@ extension STPPaymentMethod {
     func makeIcon(updateHandler: DownloadManager.UpdateImageHandler?) -> UIImage {
         switch type {
         case .card:
-            guard let card = card, let number = card.number else {
-                return STPImageLibrary.unknownCardCardImage()
-            }
-
-            var brand = STPCardValidator.brand(forNumber: number)
-            // Handle co-banded cards for flow controller
-            if let networks = card.networks {
-                brand = networks.preferred?.toCardBrand ?? .unknown
-            }
-
+            let brand = STPCardValidator.brand(for: card)
             return STPImageLibrary.cardBrandImage(for: brand)
         default:
             // If there's no image specific to this PaymentMethod (eg card network logo, bank logo), default to the PaymentMethod type's icon

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/PaymentSheetFormFactory/FormSpec/FormSpecProvider.swift

@@ -56,6 +56,14 @@ class FormSpecProvider {
             }
         }
     }
+
+    func load() async {
+        await withCheckedContinuation { continuation in
+            load { _ in
+                continuation.resume()
+            }
+        }
+    }
 
     /// Allows overwriting of formSpecs given a NSDictionary.  Typically, the specs comes
     /// from the sessions endpoint.

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/Vertical Main Screen/RightAccessoryButton.swift

@@ -42,6 +42,16 @@ extension RowButton {
                     return Image.icon_chevron_right.makeImage(template: true).withAlignmentRectInsets(UIEdgeInsets(top: -2, left: 0, bottom: 0, right: 0))
                 }
             }
+
+            var directionalLayoutMargins: NSDirectionalEdgeInsets {
+                switch self {
+                case .change, .viewMore:
+                    // Hacky - I happen to know that these are only used by the flatWithRadio style and require extra padding
+                    return .insets(top: 8)
+                default:
+                    return .zero
+                }
+            }
         }
 
         private var label: UILabel {
@@ -88,7 +98,8 @@ extension RowButton {
             self.appearance = appearance
             self.didTap = didTap
             super.init(frame: .zero)
-            addAndPinSubview(stackView)
+            directionalLayoutMargins = accessoryType.directionalLayoutMargins
+            addAndPinSubview(stackView, directionalLayoutMargins: directionalLayoutMargins)
 
             accessibilityLabel = accessoryType.text
             accessibilityIdentifier = accessoryType.text

StripePaymentSheet/StripePaymentSheet/Source/PaymentSheet/Vertical Main Screen/RowButton.swift

@@ -123,9 +123,11 @@ class RowButton: UIView {
 
         // Label and sublabel
         label.isAccessibilityElement = false
-        let labelsStackView = UIStackView(arrangedSubviews: [
-            label, sublabel, isFlatWithCheckmarkStyle ? rightAccessoryView : nil // add accessory view below labels if in checkmark style
-        ].compactMap { $0 })
+        let labelsStackView = UIStackView(arrangedSubviews: [label, sublabel])
+        // add accessory view below labels if in checkmark style
+        if let rightAccessoryView, isFlatWithCheckmarkStyle {
+            labelsStackView.addArrangedSubview(rightAccessoryView)
+        }
         labelsStackView.axis = .vertical
         labelsStackView.alignment = .leading
 
@@ -214,12 +216,6 @@ class RowButton: UIView {
         ]
 
         if isFlatWithCheckmarkStyle, let rightAccessoryView, !rightAccessoryView.isHidden {
-            // In flat_with_checkmark, we need additional vertical space around the View More / Change accessory view.
-            if sublabel.isHidden {
-                labelsStackView.setCustomSpacing(8, after: label)
-            } else {
-                labelsStackView.setCustomSpacing(8, after: sublabel)
-            }
             imageViewConstraints.append(imageView.centerYAnchor.constraint(equalTo: label.centerYAnchor))
         } else {
             imageViewConstraints.append(imageView.centerYAnchor.constraint(equalTo: centerYAnchor))
@@ -321,7 +317,7 @@ class RowButton: UIView {
     }
 
     // MARK: Tap handling
-    @objc private func handleTap() {
+    @objc func handleTap() {
         guard isEnabled else { return }
         if shouldAnimateOnPress {
             // Fade the text and icon out and back in
@@ -355,10 +351,12 @@ class RowButton: UIView {
         // Don't do this if we are flat_with_checkmark style and have an accessory view - this row button is allowed to be taller than the rest
         let isDisplayingRightAccessoryView = rightAccessoryView?.isHidden == false
         if isFlatWithCheckmarkStyle && isDisplayingRightAccessoryView {
+            heightConstraint?.isActive = false
             return
         }
         // Don't do this if we *are* the tallest variant; otherwise we'll infinite loop!
         guard sublabel.text?.isEmpty ?? true else {
+            heightConstraint?.isActive = false
             return
         }
         heightConstraint = heightAnchor.constraint(equalToConstant: Self.calculateTallestHeight(appearance: appearance, isEmbedded: isEmbedded))

StripePaymentSheet/StripePaymentSheetTests/PaymentSheet/EmbeddedPaymentElementSnapshotTests.swift

@@ -10,6 +10,7 @@ import StripeCoreTestUtils
 @_spi(EmbeddedPaymentElementPrivateBeta) @testable import StripePaymentSheet
 @testable import StripePaymentsTestUtils
 @_spi(STP) @testable import StripeUICore
+@_spi(STP) @testable import StripeCore
 import XCTest
 
 class EmbeddedPaymentElementSnapshotTests: STPSnapshotTestCase, EmbeddedPaymentElementDelegate {
@@ -60,4 +61,88 @@ class EmbeddedPaymentElementSnapshotTests: STPSnapshotTestCase, EmbeddedPaymentE
         XCTAssertEqual(sut.view.directionalLayoutMargins, .zero)
         XCTAssertFalse(sut.view.hasAmbiguousLayout)
     }
+
+    // MARK: - 'Change >' button and sublabel (eg Visa 4242)
+
+    func testShowsChangeButton_flatRadio() async throws {
+        await _testShowsChangeButton(rowStyle: .flatWithRadio)
+    }
+
+    func testShowsChangeButton_floatingButton() async throws {
+        await _testShowsChangeButton(rowStyle: .floatingButton)
+
+    }
+
+    func testShowsChangeButton_flatCheckmark() async throws {
+        await _testShowsChangeButton(rowStyle: .flatWithCheckmark)
+    }
+
+    func _testShowsChangeButton(rowStyle: PaymentSheet.Appearance.EmbeddedPaymentElement.Row.Style) async {
+        var configuration = configuration
+        configuration.appearance.embeddedPaymentElement.row.style = rowStyle
+        var paymentIntentConfig = paymentIntentConfig
+        paymentIntentConfig.paymentMethodTypes = ["card", "us_bank_account", "afterpay_clearpay"]
+        let loadResult = PaymentSheetLoader.LoadResult(
+            intent: .deferredIntent(intentConfig: paymentIntentConfig),
+            elementsSession: ._testValue(paymentMethodTypes: ["card", "us_bank_account", "afterpay_clearpay"]),
+            savedPaymentMethods: [],
+            paymentMethodTypes: [.stripe(.card), .stripe(.USBankAccount), .stripe(.afterpayClearpay)]
+        )
+        await AddressSpecProvider.shared.loadAddressSpecs()
+        await FormSpecProvider.shared.load()
+        let sut = EmbeddedPaymentElement(
+            configuration: configuration,
+            loadResult: loadResult,
+            analyticsHelper: ._testValue()
+        )
+        sut.view.autosizeHeight(width: 300)
+        sut.delegate = self
+        sut.presentingViewController = UIViewController()
+        // There are 3 variations of adding a 'Change >' button and sublabel to a selected row
+        // 1️⃣
+        // ...tapping card and filling out the form...
+        sut.embeddedPaymentMethodsView.getRowButton(accessibilityIdentifier: "Card").handleTap()
+        let cardForm = sut.formCache[.stripe(.card)]!
+        cardForm.getTextFieldElement("Card number")?.setText("4242424242424242")
+        cardForm.getTextFieldElement("MM / YY").setText("1232")
+        cardForm.getTextFieldElement("CVC").setText("123")
+        cardForm.getTextFieldElement("ZIP").setText("65432")
+        sut.selectedFormViewController?.didTapPrimaryButton()
+
+        // ...should show the card row w/ the 'Change >' + "Visa 4242"
+        STPSnapshotVerifyView(sut.view, identifier: "card")
+
+        // 2️⃣
+        // Tapping US Bank Account...
+        sut.embeddedPaymentMethodsView.getRowButton(accessibilityIdentifier: "US bank account").handleTap()
+        // ...and backing out...
+        sut.embeddedFormViewControllerDidCancel(sut.selectedFormViewController!)
+        // ...should keep the card row selected...
+        // (this tests that setting the selection back to the previous works)
+        STPSnapshotVerifyView(sut.view, identifier: "us_bank_account_canceled")
+
+        // Filling out US Bank account...
+        sut.embeddedPaymentMethodsView.getRowButton(accessibilityIdentifier: "US bank account").handleTap()
+        let bankForm = sut.formCache[.stripe(.USBankAccount)] as! USBankAccountPaymentMethodElement
+        bankForm.getTextFieldElement("Full name").setText("Name")
+        bankForm.getTextFieldElement("Email").setText("foo@bar.com")
+        bankForm.linkedBank = FinancialConnectionsLinkedBank(sessionId: "123", accountId: "123", displayName: "Success", bankName: "StripeBank", last4: "6789", instantlyVerified: true)
+        sut.selectedFormViewController?.didTapPrimaryButton()
+        // ...should show the row w/ 'Change >' + "6789" (the last bank 4)
+        STPSnapshotVerifyView(sut.view, identifier: "us_bank_account_continue")
+
+        // 3️⃣
+        // Tapping Afterpay and filling out the form...
+        sut.embeddedPaymentMethodsView.getRowButton(accessibilityIdentifier: "Afterpay").handleTap()
+        let afterpayForm = sut.formCache[.stripe(.afterpayClearpay)]!
+        afterpayForm.getTextFieldElement("Full name")?.setText("Tester")
+        afterpayForm.getTextFieldElement("Email")?.setText("f@z.c")
+        afterpayForm.getTextFieldElement("Address line 1").setText("asdf")
+        afterpayForm.getTextFieldElement("City").setText("asdf")
+        afterpayForm.getTextFieldElement("ZIP").setText("12345")
+        sut.selectedFormViewController?.didTapPrimaryButton()
+
+        // ...should show the row w/ 'Change >'
+        STPSnapshotVerifyView(sut.view, identifier: "afterpay")
+    }
 }