8116 Show correct tap/insert/swipe reader message

joshheald · joshheald · commit 44d4e536d519 · 2022-11-16T15:13:03.000Z
Previously, we did not take account of the ReaderInputOptions returned to us by the Stripe Terminal API, instead we always displayed “Tap, insert, or swipe to pay”, even when those options were not supported, or the SDK was requesting a different method.

This change passes the ReaderInputOptions to the View Model concerned with showing this message to the merchant, and converts the various supported options into specific localized strings, along with a (currently unused) default of “Present card to pay”.

To see this in action, compare the messages shown when using a US card reader (M2 or chipper, which both support swipe reads) to a CA reader (which only supports tap or insert reads.)
diff --git a/Hardware/Hardware.xcodeproj/project.pbxproj b/Hardware/Hardware.xcodeproj/project.pbxproj
@@ -10,6 +10,7 @@
 		028C39E028255CFE0007BA25 /* Models+Copiable.generated.swift in Sources */ = {isa = PBXBuildFile; fileRef = 028C39DF28255CFE0007BA25 /* Models+Copiable.generated.swift */; };
 		02B5147A28254ED300750B71 /* Codegen in Frameworks */ = {isa = PBXBuildFile; productRef = 02B5147928254ED300750B71 /* Codegen */; };
 		030338102705F7D400764131 /* ReceiptTotalLine.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0303380F2705F7D400764131 /* ReceiptTotalLine.swift */; };
+		035DBA3929251ED6003E5125 /* CardReaderInputOptions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 035DBA3829251ED6003E5125 /* CardReaderInputOptions.swift */; };
 		039D948B2760C0660044EF38 /* NoOpCardReaderService.swift in Sources */ = {isa = PBXBuildFile; fileRef = 039D948A2760C0660044EF38 /* NoOpCardReaderService.swift */; };
 		03B440AA2754DFC400759429 /* UnderlyingError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 03B440A92754DFC400759429 /* UnderlyingError.swift */; };
 		03CF78D327C6710C00523706 /* interac.svg in Resources */ = {isa = PBXBuildFile; fileRef = 03CF78D227C6710B00523706 /* interac.svg */; };
@@ -153,6 +154,7 @@
 		02351FF56149ADCD11338B19 /* Pods-SampleReceiptPrinter.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-SampleReceiptPrinter.release.xcconfig"; path = "Target Support Files/Pods-SampleReceiptPrinter/Pods-SampleReceiptPrinter.release.xcconfig"; sourceTree = "<group>"; };
 		028C39DF28255CFE0007BA25 /* Models+Copiable.generated.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Models+Copiable.generated.swift"; sourceTree = "<group>"; };
 		0303380F2705F7D400764131 /* ReceiptTotalLine.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ReceiptTotalLine.swift; sourceTree = "<group>"; };
+		035DBA3829251ED6003E5125 /* CardReaderInputOptions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CardReaderInputOptions.swift; sourceTree = "<group>"; };
 		039D948A2760C0660044EF38 /* NoOpCardReaderService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NoOpCardReaderService.swift; sourceTree = "<group>"; };
 		03B440A92754DFC400759429 /* UnderlyingError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UnderlyingError.swift; sourceTree = "<group>"; };
 		03CF78D227C6710B00523706 /* interac.svg */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = interac.svg; sourceTree = "<group>"; };
@@ -439,6 +441,7 @@
 				D88FDB3625DD21BE00CB0DBD /* StripeCardReader */,
 				D88FDB2725DD21B000CB0DBD /* CardReader.swift */,
 				D88FDB2425DD21B000CB0DBD /* CardReaderEvent.swift */,
+				035DBA3829251ED6003E5125 /* CardReaderInputOptions.swift */,
 				D88FDB2625DD21B000CB0DBD /* CardReaderService.swift */,
 				D88FDB1F25DD21AF00CB0DBD /* CardReaderServiceDiscoveryStatus.swift */,
 				D88FDB2125DD21AF00CB0DBD /* CardReaderServiceStatus.swift */,
@@ -826,6 +829,7 @@
 				D845BE54262ED7CC00A3E40F /* PrinterService.swift in Sources */,
 				D845BDDE262DAB8300A3E40F /* PaymentMethod+Stripe.swift in Sources */,
 				D89B8F0C25DDC9D30001C726 /* ChargeStatus.swift in Sources */,
+				035DBA3929251ED6003E5125 /* CardReaderInputOptions.swift in Sources */,
 				E140F61C2668CDC900FDB5FF /* Logging.swift in Sources */,
 				03CF78D727DF9BE600523706 /* RefundParameters.swift in Sources */,
 				03B440AA2754DFC400759429 /* UnderlyingError.swift in Sources */,
diff --git a/Hardware/Hardware/CardReader/CardReaderEvent.swift b/Hardware/Hardware/CardReader/CardReaderEvent.swift
@@ -2,7 +2,7 @@
 public enum CardReaderEvent: Equatable {
     /// The reader begins waiting for input.
     /// The app should prompt the customer to present a payment method
-    case waitingForInput(String)
+    case waitingForInput(CardReaderInput)
 
     /// Request that a prompt be displayed in the app.
     /// For example, if the prompt is SwipeCard,
diff --git a/Hardware/Hardware/CardReader/CardReaderInputOptions.swift b/Hardware/Hardware/CardReader/CardReaderInputOptions.swift
@@ -0,0 +1,26 @@
+import Foundation
+
+public struct CardReaderInput: OptionSet {
+    public let rawValue: Int
+
+    public init(rawValue: Int) {
+        self.rawValue = rawValue
+    }
+
+    public static let none = CardReaderInput([])
+    public static let swipe = CardReaderInput(rawValue: 1 << 0)
+    public static let insert = CardReaderInput(rawValue: 1 << 1)
+    public static let tap = CardReaderInput(rawValue: 1 << 2)
+}
+
+
+#if !targetEnvironment(macCatalyst)
+import StripeTerminal
+
+extension CardReaderInput {
+    init(stripeReaderInputOptions: ReaderInputOptions) {
+        let value = Int(stripeReaderInputOptions.rawValue)
+        self.init(rawValue: value)
+    }
+}
+#endif
diff --git a/Hardware/Hardware/CardReader/StripeCardReader/CardReaderEvent+Stripe.swift b/Hardware/Hardware/CardReader/StripeCardReader/CardReaderEvent+Stripe.swift
@@ -4,8 +4,9 @@ import StripeTerminal
 extension CardReaderEvent {
     /// Factory method
     /// - Parameter readerInputOptions: An instance of a StripeTerminal.ReaderInputOptions
-    static func make(readerInputOptions: ReaderInputOptions) -> Self {
-        .waitingForInput(Terminal.stringFromReaderInputOptions(readerInputOptions))
+    static func make(stripeReaderInputOptions: ReaderInputOptions) -> Self {
+        let inputOptions = CardReaderInput(stripeReaderInputOptions: stripeReaderInputOptions)
+        return .waitingForInput(inputOptions)
     }
 
     /// Factory method
diff --git a/Hardware/Hardware/CardReader/StripeCardReader/StripeCardReaderService.swift b/Hardware/Hardware/CardReader/StripeCardReader/StripeCardReaderService.swift
@@ -646,7 +646,7 @@ extension StripeCardReaderService: BluetoothReaderDelegate {
     /// This method is called by the Stripe Terminal SDK when it wants client apps
     /// to request users to tap / insert / swipe a card.
     public func reader(_ reader: Reader, didRequestReaderInput inputOptions: ReaderInputOptions = []) {
-        sendReaderEvent(CardReaderEvent.make(readerInputOptions: inputOptions))
+        sendReaderEvent(CardReaderEvent.make(stripeReaderInputOptions: inputOptions))
     }
 
     /// In this case the Stripe Terminal SDK wants us to present a string on screen
diff --git a/WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentModalTapCard.swift b/WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentModalTapCard.swift
@@ -38,10 +38,26 @@ final class CardPresentModalTapCard: CardPresentPaymentsModalViewModel {
 
     let accessibilityLabel: String?
 
-    init(name: String, amount: String, transactionType: CardPresentTransactionType, onCancel: @escaping () -> Void) {
+    init(name: String,
+         amount: String,
+         transactionType: CardPresentTransactionType,
+         inputMethods: CardReaderInput,
+         onCancel: @escaping () -> Void) {
         self.name = name
         self.amount = amount
-        self.bottomSubtitle = Localization.tapInsertOrSwipe(transactionType: transactionType)
+
+        if inputMethods == CardReaderInput([.swipe, .insert, .tap]) {
+            self.bottomSubtitle = Localization.tapInsertOrSwipe(transactionType: transactionType)
+        } else if inputMethods == CardReaderInput([.tap, .insert]) {
+            self.bottomSubtitle = Localization.tapOrInsert(transactionType: transactionType)
+        } else if inputMethods.contains(.tap) {
+            self.bottomSubtitle = Localization.tap(transactionType: transactionType)
+        } else if inputMethods.contains(.insert) {
+            self.bottomSubtitle = Localization.insert(transactionType: transactionType)
+        } else {
+            self.bottomSubtitle = Localization.presentCard(transactionType: transactionType)
+        }
+
         self.accessibilityLabel = Localization.readerIsReady + Localization.tapInsertOrSwipe(transactionType: transactionType)
         self.onCancel = onCancel
     }
@@ -83,6 +99,66 @@ private extension CardPresentModalTapCard {
             }
         }
 
+        static func tapOrInsert(transactionType: CardPresentTransactionType) -> String {
+            switch transactionType {
+            case .collectPayment:
+                return NSLocalizedString(
+                    "Tap or insert card to pay",
+                    comment: "Label asking users to present a card. Presented to users when a payment is going to be collected"
+                )
+            case .refund:
+                return NSLocalizedString(
+                    "Tap or insert card to refund",
+                    comment: "Label asking users to present a card. Presented to users when an in-person refund is going to be executed"
+                )
+            }
+        }
+
+        static func tap(transactionType: CardPresentTransactionType) -> String {
+            switch transactionType {
+            case .collectPayment:
+                return NSLocalizedString(
+                    "Tap card to pay",
+                    comment: "Label asking users to present a card. Presented to users when a payment is going to be collected"
+                )
+            case .refund:
+                return NSLocalizedString(
+                    "Tap card to refund",
+                    comment: "Label asking users to present a card. Presented to users when an in-person refund is going to be executed"
+                )
+            }
+        }
+
+        static func insert(transactionType: CardPresentTransactionType) -> String {
+            switch transactionType {
+            case .collectPayment:
+                return NSLocalizedString(
+                    "Insert card to pay",
+                    comment: "Label asking users to present a card. Presented to users when a payment is going to be collected"
+                )
+            case .refund:
+                return NSLocalizedString(
+                    "Insert card to refund",
+                    comment: "Label asking users to present a card. Presented to users when an in-person refund is going to be executed"
+                )
+            }
+        }
+
+        static func presentCard(transactionType: CardPresentTransactionType) -> String {
+            switch transactionType {
+            case .collectPayment:
+                return NSLocalizedString(
+                    "Present card to pay",
+                    comment: "Label asking users to present a card. Presented to users when a payment is going to be collected"
+                )
+            case .refund:
+                return NSLocalizedString(
+                    "Present card to refund",
+                    comment: "Label asking users to present a card. Presented to users when an in-person refund is going to be executed"
+                )
+            }
+        }
+
         static let cancel = NSLocalizedString(
             "Cancel",
             comment: "Button to cancel a payment"
diff --git a/WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentRefundOrchestrator.swift b/WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentRefundOrchestrator.swift
@@ -27,7 +27,7 @@ final class CardPresentRefundOrchestrator {
     func refund(amount: Decimal,
                 charge: WCPayCharge,
                 paymentGatewayAccount: PaymentGatewayAccount,
-                onWaitingForInput: @escaping () -> Void,
+                onWaitingForInput: @escaping (CardReaderInput) -> Void,
                 onProcessingMessage: @escaping () -> Void,
                 onDisplayMessage: @escaping (String) -> Void,
                 onCompletion: @escaping (Result<Void, Error>) -> Void) {
@@ -40,8 +40,8 @@ final class CardPresentRefundOrchestrator {
         let refundAction = CardPresentPaymentAction.refundPayment(parameters: refundParameters,
                                                                   onCardReaderMessage: { event in
             switch event {
-            case .waitingForInput:
-                onWaitingForInput()
+            case .waitingForInput(let inputMethods):
+                onWaitingForInput(inputMethods)
             case .displayMessage(let message):
                 onDisplayMessage(message)
             default:
diff --git a/WooCommerce/Classes/ViewModels/CardPresentPayments/PaymentCaptureOrchestrator.swift b/WooCommerce/Classes/ViewModels/CardPresentPayments/PaymentCaptureOrchestrator.swift
@@ -39,7 +39,7 @@ final class PaymentCaptureOrchestrator {
                         paymentGatewayAccount: PaymentGatewayAccount,
                         paymentMethodTypes: [String],
                         stripeSmallestCurrencyUnitMultiplier: Decimal,
-                        onWaitingForInput: @escaping () -> Void,
+                        onWaitingForInput: @escaping (CardReaderInput) -> Void,
                         onProcessingMessage: @escaping () -> Void,
                         onDisplayMessage: @escaping (String) -> Void,
                         onProcessingCompletion: @escaping (PaymentIntent) -> Void,
@@ -68,8 +68,8 @@ final class PaymentCaptureOrchestrator {
             parameters: parameters,
             onCardReaderMessage: { event in
                 switch event {
-                case .waitingForInput:
-                    onWaitingForInput()
+                case .waitingForInput(let inputMethods):
+                    onWaitingForInput(inputMethods)
                 case .displayMessage(let message):
                     onDisplayMessage(message)
                 case .cardRemovedAfterClientSidePaymentCapture:
diff --git a/WooCommerce/Classes/ViewModels/Order Details/OrderDetailsPaymentAlerts.swift b/WooCommerce/Classes/ViewModels/Order Details/OrderDetailsPaymentAlerts.swift
@@ -1,6 +1,7 @@
 import MessageUI
 import UIKit
 import WordPressUI
+import Yosemite
 import enum Hardware.CardReaderServiceError
 import enum Hardware.UnderlyingError
 
@@ -50,13 +51,16 @@ final class OrderDetailsPaymentAlerts: OrderDetailsPaymentAlertsProtocol {
         presentViewModel(viewModel: CardPresentModalPreparingReader(cancelAction: onCancel))
     }
 
-    func tapOrInsertCard(title: String, amount: String, onCancel: @escaping () -> Void) {
+    func tapOrInsertCard(title: String,
+                         amount: String,
+                         inputMethods: CardReaderInput,
+                         onCancel: @escaping () -> Void) {
         self.name = title
         self.amount = amount
 
         // Initial presentation of the modal view controller. We need to provide
         // a customer name and an amount.
-        let viewModel = tapOrInsert(onCancel: onCancel)
+        let viewModel = tapOrInsert(readerInputMethods: inputMethods, onCancel: onCancel)
         presentViewModel(viewModel: viewModel)
     }
 
@@ -94,8 +98,12 @@ final class OrderDetailsPaymentAlerts: OrderDetailsPaymentAlertsProtocol {
 }
 
 private extension OrderDetailsPaymentAlerts {
-    func tapOrInsert(onCancel: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
-        CardPresentModalTapCard(name: name, amount: amount, transactionType: transactionType, onCancel: onCancel)
+    func tapOrInsert(readerInputMethods: CardReaderInput, onCancel: @escaping () -> Void) -> CardPresentPaymentsModalViewModel {
+        CardPresentModalTapCard(name: name,
+                                amount: amount,
+                                transactionType: transactionType,
+                                inputMethods: readerInputMethods,
+                                onCancel: onCancel)
     }
 
     func displayMessage(message: String) -> CardPresentPaymentsModalViewModel {
diff --git a/WooCommerce/Classes/ViewModels/Order Details/OrderDetailsPaymentAlertsProtocol.swift b/WooCommerce/Classes/ViewModels/Order Details/OrderDetailsPaymentAlertsProtocol.swift
@@ -1,12 +1,13 @@
 import UIKit
+import Yosemite
 
 /// Protocol for `OrderDetailsPaymentAlerts` to enable unit testing.
 protocol OrderDetailsPaymentAlertsProtocol {
     func presentViewModel(viewModel: CardPresentPaymentsModalViewModel)
 
     func preparingReader(onCancel: @escaping () -> Void)
 
-    func tapOrInsertCard(title: String, amount: String, onCancel: @escaping () -> Void)
+    func tapOrInsertCard(title: String, amount: String, inputMethods: CardReaderInput, onCancel: @escaping () -> Void)
 
     func displayReaderMessage(message: String)
 
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Collect Payments/CollectOrderPaymentUseCase.swift b/WooCommerce/Classes/ViewRelated/Orders/Collect Payments/CollectOrderPaymentUseCase.swift
@@ -286,11 +286,12 @@ private extension CollectOrderPaymentUseCase {
             paymentGatewayAccount: paymentGatewayAccount,
             paymentMethodTypes: configuration.paymentMethods.map(\.rawValue),
             stripeSmallestCurrencyUnitMultiplier: configuration.stripeSmallestCurrencyUnitMultiplier,
-            onWaitingForInput: { [weak self] in
+            onWaitingForInput: { [weak self] inputMethods in
                 guard let self = self else { return }
                 self.alerts.tapOrInsertCard(title: Localization.collectPaymentTitle(username: self.order.billingAddress?.firstName),
-                                     amount: self.formattedAmount,
-                                     onCancel: { [weak self] in
+                                            amount: self.formattedAmount,
+                                            inputMethods: inputMethods,
+                                            onCancel: { [weak self] in
                     self?.cancelPayment {
                         onCompletion(.failure(CollectOrderPaymentUseCaseError.flowCanceledByUser))
                     }
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Refund/RefundSubmissionUseCase.swift b/WooCommerce/Classes/ViewRelated/Orders/Refund/RefundSubmissionUseCase.swift
@@ -303,11 +303,12 @@ private extension RefundSubmissionUseCase {
         cardPresentRefundOrchestrator.refund(amount: refundAmount,
                                              charge: charge,
                                              paymentGatewayAccount: paymentGatewayAccount,
-                                             onWaitingForInput: { [weak self] in
+                                             onWaitingForInput: { [weak self] inputMethods in
             // Requests card input.
             guard let self = self else { return }
             self.alerts.tapOrInsertCard(title: Localization.refundPaymentTitle(username: self.order.billingAddress?.firstName),
                                         amount: self.formattedAmount,
+                                        inputMethods: inputMethods,
                                         onCancel: { [weak self] in
                 self?.cancelRefund(charge: charge, paymentGatewayAccount: paymentGatewayAccount, onCompletion: onCompletion)
             })
diff --git a/WooCommerce/WooCommerceTests/ViewModels/CardPresentPayments/PaymentCaptureOrchestratorTests.swift b/WooCommerce/WooCommerceTests/ViewModels/CardPresentPayments/PaymentCaptureOrchestratorTests.swift
@@ -45,7 +45,7 @@ final class PaymentCaptureOrchestratorTests: XCTestCase {
                 paymentGatewayAccount: account,
                 paymentMethodTypes: ["card_present"],
                 stripeSmallestCurrencyUnitMultiplier: 100,
-                onWaitingForInput: {},
+                onWaitingForInput: { _ in },
                 onProcessingMessage: {},
                 onDisplayMessage: { _ in },
                 onProcessingCompletion: { _ in },
@@ -80,7 +80,7 @@ final class PaymentCaptureOrchestratorTests: XCTestCase {
                 paymentGatewayAccount: account,
                 paymentMethodTypes: ["card_present"],
                 stripeSmallestCurrencyUnitMultiplier: 100,
-                onWaitingForInput: {},
+                onWaitingForInput: { _ in },
                 onProcessingMessage: {},
                 onDisplayMessage: { _ in },
                 onProcessingCompletion: { _ in },
diff --git a/Yosemite/Yosemite/Model/Model.swift b/Yosemite/Yosemite/Model/Model.swift
@@ -138,6 +138,7 @@ public typealias WooAPIVersion = Networking.WooAPIVersion
 public typealias StoredProductSettings = Networking.StoredProductSettings
 public typealias CardReader = Hardware.CardReader
 public typealias CardReaderEvent = Hardware.CardReaderEvent
+public typealias CardReaderInput = Hardware.CardReaderInput
 public typealias CardReaderSoftwareUpdateState = Hardware.CardReaderSoftwareUpdateState
 public typealias CardReaderServiceDiscoveryStatus = Hardware.CardReaderServiceDiscoveryStatus
 public typealias CardReaderServiceError = Hardware.CardReaderServiceError

Original file line number	Diff line number	Diff line change
`@@ -646,7 +646,7 @@ extension StripeCardReaderService: BluetoothReaderDelegate {`
`646`	`646`	`/// This method is called by the Stripe Terminal SDK when it wants client apps`
`647`	`647`	`/// to request users to tap / insert / swipe a card.`
`648`	`648`	`public func reader(_ reader: Reader, didRequestReaderInput inputOptions: ReaderInputOptions = []) {`
`649`		`- sendReaderEvent(CardReaderEvent.make(readerInputOptions: inputOptions))`
	`649`	`+ sendReaderEvent(CardReaderEvent.make(stripeReaderInputOptions: inputOptions))`
`650`	`650`	`}`
`651`	`651`
`652`	`652`	`/// In this case the Stripe Terminal SDK wants us to present a string on screen`