Merge pull request #8196 from woocommerce/issue/8080-ask-user-for-discovery-method

[Mobile Payments] Ask user to choose a reader type to connect to

Author: joshheald

WooCommerce/Classes/ViewModels/CardPresentPayments/CardPresentModalSelectSearchType.swift

@@ -0,0 +1,90 @@
+import UIKit
+import Yosemite
+
+final class CardPresentModalSelectSearchType: CardPresentPaymentsModalViewModel {
+    var textMode: PaymentsModalTextMode
+
+    var actionsMode: PaymentsModalActionsMode
+
+    var topTitle: String = Localization.title
+
+    var topSubtitle: String? = nil
+
+    var image: UIImage = .paymentsLoading
+
+    var primaryButtonTitle: String?
+
+    var secondaryButtonTitle: String?
+
+    var auxiliaryButtonTitle: String? = nil
+
+    var bottomTitle: String? = Localization.description
+
+    var bottomSubtitle: String? = nil
+
+    var accessibilityLabel: String? = nil
+
+    private var tapOnIphoneAction: (() -> Void)
+
+    private var bluetoothProximityAction: (() -> Void)
+
+    private var cancelAction: (() -> Void)
+
+    func didTapPrimaryButton(in viewController: UIViewController?) {
+        tapOnIphoneAction()
+    }
+
+    func didTapSecondaryButton(in viewController: UIViewController?) {
+        bluetoothProximityAction()
+    }
+
+    func didTapAuxiliaryButton(in viewController: UIViewController?) {
+        cancelAction()
+    }
+
+    init(tapOnIPhoneAction: @escaping () -> Void,
+         bluetoothAction: @escaping () -> Void,
+         cancelAction: @escaping () -> Void) {
+        textMode = .fullInfo
+        actionsMode = .twoActionAndAuxiliary
+        primaryButtonTitle = CardReaderDiscoveryMethod.localMobile.name
+        self.tapOnIphoneAction = tapOnIPhoneAction
+        secondaryButtonTitle = CardReaderDiscoveryMethod.bluetoothProximity.name
+        self.bluetoothProximityAction = bluetoothAction
+        auxiliaryButtonTitle = Localization.cancel
+        self.cancelAction = cancelAction
+    }
+}
+
+private extension CardPresentModalSelectSearchType {
+    enum Localization {
+        static let title = NSLocalizedString(
+            "Select reader type",
+            comment: "The title for the alert shown when connecting a card reader, asking the user to choose a " +
+            "reader type. Only shown when supported on their device.")
+
+        static let description = NSLocalizedString(
+            "Your iPhone can be used as a card reader, or you can connect to an external reader via bluetooth.",
+            comment: "The description on the alert shown when connecting a card reader, asking the user to choose a " +
+            "reader type. Only shown when supported on their device.")
+
+        static let cancel = NSLocalizedString(
+            "Cancel",
+            comment: "Cancel button title")
+    }
+}
+
+private extension CardReaderDiscoveryMethod {
+    var name: String {
+        switch self {
+        case .bluetoothProximity:
+            return NSLocalizedString(
+                "Bluetooth Reader",
+                comment: "The button title on the reader type alert, for the user to choose a bluetooth reader.")
+        case .localMobile:
+            return NSLocalizedString(
+                "Tap to Pay on iPhone",
+                comment: "The button title on the reader type alert, for the user to choose the built-in reader.")
+        }
+    }
+}

WooCommerce/Classes/ViewRelated/CardPresentPayments/CardPresentPaymentPreflightController.swift

@@ -1,6 +1,9 @@
 import Foundation
 import Yosemite
 import Combine
+#if !targetEnvironment(simulator)
+import ProximityReader
+#endif
 
 enum CardReaderConnectionResult {
     case connected(CardReader)
@@ -40,6 +43,10 @@ final class CardPresentPaymentPreflightController {
     ///
     private var connectionController: CardReaderConnectionController
 
+    /// Controller to connect a card reader.
+    ///
+    private var builtInConnectionController: CardReaderConnectionController
+
 
     private(set) var readerConnection = CurrentValueSubject<CardReaderConnectionResult?, Never>(nil)
 
@@ -62,6 +69,15 @@ final class CardPresentPaymentPreflightController {
         // TODO: Replace this with a refactored (New)LegacyCardReaderConnectionController
         self.connectionController = CardReaderConnectionController(
             forSiteID: siteID,
+            discoveryMethod: .bluetoothProximity,
+            knownReaderProvider: CardReaderSettingsKnownReaderStorage(),
+            alertsPresenter: alertsPresenter,
+            configuration: configuration,
+            analyticsTracker: analyticsTracker)
+
+        self.builtInConnectionController = CardReaderConnectionController(
+            forSiteID: siteID,
+            discoveryMethod: .localMobile,
             knownReaderProvider: CardReaderSettingsKnownReaderStorage(),
             alertsPresenter: alertsPresenter,
             configuration: configuration,
@@ -78,31 +94,63 @@ final class CardPresentPaymentPreflightController {
 
         // TODO: Run onboarding if needed
 
-        // TODO: Ask for a Reader type if supported by device
-
-        // Attempt to find a reader and connect
-        connectionController.searchAndConnect { result in
-            let connectionResult = result.map { connection in
-                switch connection {
-                case .connected:
-                    // TODO: pass the reader from the (New)CardReaderConnectionController
-                    guard let connectedReader = self.connectedReader else { return CardReaderConnectionResult.canceled }
-                    return CardReaderConnectionResult.connected(connectedReader)
-                case .canceled:
-                    return CardReaderConnectionResult.canceled
-                }
-            }
+        // Ask for a Reader type if supported by device/in country
+        guard localMobileReaderSupported(),
+              configuration.supportedReaders.contains(.appleBuiltIn)
+        else {
+            // Attempt to find a bluetooth reader and connect
+            connectionController.searchAndConnect(onCompletion: handleConnectionResult)
+            return
+        }
 
-            switch connectionResult {
-            case .success(let unwrapped):
-                self.readerConnection.send(unwrapped)
-            default:
-                break
-            }
+        alertsPresenter.present(viewModel: CardPresentModalSelectSearchType(
+            tapOnIPhoneAction: { [weak self] in
+                guard let self = self else { return }
+                self.builtInConnectionController.searchAndConnect(
+                    onCompletion: self.handleConnectionResult)
+            },
+            bluetoothAction: { [weak self] in
+                guard let self = self else { return }
+                self.connectionController.searchAndConnect(
+                    onCompletion: self.handleConnectionResult)
+            },
+            cancelAction: { [weak self] in
+                guard let self = self else { return }
+                self.alertsPresenter.dismiss()
+                self.handleConnectionResult(.success(.canceled))
+            }))
+    }
+
+    private func localMobileReaderSupported() -> Bool {
+        #if !targetEnvironment(simulator)
+        if #available(iOS 15.4, *) {
+            return PaymentCardReader.isSupported
+        } else {
+            return false
         }
+        #endif
+        return true
     }
 
+    private func handleConnectionResult(_ result: Result<CardReaderConnectionController.ConnectionResult, Error>) {
+        let connectionResult = result.map { connection in
+            switch connection {
+            case .connected:
+                // TODO: pass the reader from the (New)CardReaderConnectionController
+                guard let connectedReader = self.connectedReader else { return CardReaderConnectionResult.canceled }
+                return CardReaderConnectionResult.connected(connectedReader)
+            case .canceled:
+                return CardReaderConnectionResult.canceled
+            }
+        }
 
+        switch connectionResult {
+        case .success(let unwrapped):
+            self.readerConnection.send(unwrapped)
+        default:
+            break
+        }
+    }
 
     /// Configure the CardPresentPaymentStore to use the appropriate backend
     ///

WooCommerce/Classes/ViewRelated/CardPresentPayments/CardReaderConnectionController.swift

@@ -134,8 +134,11 @@ final class CardReaderConnectionController {
         }
     }
 
+    private let discoveryMethod: CardReaderDiscoveryMethod
+
     init(
         forSiteID: Int64,
+        discoveryMethod: CardReaderDiscoveryMethod,
         storageManager: StorageManagerType = ServiceLocator.storageManager,
         stores: StoresManager = ServiceLocator.stores,
         knownReaderProvider: CardReaderSettingsKnownReaderProvider,
@@ -144,6 +147,7 @@ final class CardReaderConnectionController {
         analyticsTracker: CardReaderConnectionAnalyticsTracker
     ) {
         siteID = forSiteID
+        self.discoveryMethod = discoveryMethod
         self.storageManager = storageManager
         self.stores = stores
         state = .idle
@@ -316,10 +320,6 @@ private extension CardReaderConnectionController {
         self.state = .searching
         var didAutoAdvance = false
 
-        // TODO: make this a choice for the user, when the switch is enabled
-        let tapOnIphoneEnabled = ServiceLocator.generalAppSettings.settings.isTapToPayOnIPhoneSwitchEnabled
-        let discoveryMethod: CardReaderDiscoveryMethod = tapOnIphoneEnabled ? .localMobile : .bluetoothProximity
-
         let action = CardPresentPaymentAction.startCardReaderDiscovery(
             siteID: siteID,
             discoveryMethod: discoveryMethod,

WooCommerce/Classes/ViewRelated/Orders/Collect Payments/CollectOrderPaymentUseCase.swift

@@ -92,6 +92,8 @@ final class CollectOrderPaymentUseCase: NSObject, CollectOrderPaymentProtocol {
     /// Coordinates emailing a receipt after payment success.
     private var receiptEmailCoordinator: CardPresentPaymentReceiptEmailCoordinator?
 
+    private var preflightController: CardPresentPaymentPreflightController?
+
     private var cancellables: Set<AnyCancellable> = []
 
     init(siteID: Int64,
@@ -137,11 +139,11 @@ final class CollectOrderPaymentUseCase: NSObject, CollectOrderPaymentProtocol {
             return handleTotalAmountInvalidError(totalAmountInvalidError(), onCompleted: onCompleted)
         }
 
-        let preflightController = CardPresentPaymentPreflightController(siteID: siteID,
-                                                                        paymentGatewayAccount: paymentGatewayAccount,
-                                                                        configuration: configuration,
-                                                                        alertsPresenter: alertsPresenter)
-        preflightController.readerConnection.sink { [weak self] connectionResult in
+        preflightController = CardPresentPaymentPreflightController(siteID: siteID,
+                                                                    paymentGatewayAccount: paymentGatewayAccount,
+                                                                    configuration: configuration,
+                                                                    alertsPresenter: alertsPresenter)
+        preflightController?.readerConnection.sink { [weak self] connectionResult in
             guard let self = self else { return }
             switch connectionResult {
             case .connected(let reader):
@@ -171,7 +173,7 @@ final class CollectOrderPaymentUseCase: NSObject, CollectOrderPaymentProtocol {
         }
         .store(in: &cancellables)
 
-        preflightController.start()
+        preflightController?.start()
     }
 }
 

WooCommerce/WooCommerce.xcodeproj/project.pbxproj

@@ -492,6 +492,7 @@
 		03AA16602719B83D005CCB7B /* ReceiptActionCoordinatorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 03AA165F2719B83D005CCB7B /* ReceiptActionCoordinatorTests.swift */; };
 		03AFDE02282C0B82003B67CD /* InPersonPaymentsCompletedView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 03AFDE01282C0B82003B67CD /* InPersonPaymentsCompletedView.swift */; };
 		03BB9EA5292E2D0C00251E9E /* CardReaderConnectionController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 03BB9EA4292E2D0C00251E9E /* CardReaderConnectionController.swift */; };
+		03BB9EA7292E50B600251E9E /* CardPresentModalSelectSearchType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 03BB9EA6292E50B600251E9E /* CardPresentModalSelectSearchType.swift */; };
 		03CF78D127C3DBC000523706 /* WCPayCardBrand+IconsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 03CF78D027C3DBC000523706 /* WCPayCardBrand+IconsTests.swift */; };
 		03EF24FA28BF5D21006A033E /* InPersonPaymentsCashOnDeliveryToggleRowViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 03EF24F928BF5D21006A033E /* InPersonPaymentsCashOnDeliveryToggleRowViewModel.swift */; };
 		03EF24FC28BF996F006A033E /* InPersonPaymentsCashOnDeliveryPaymentGatewayHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 03EF24FB28BF996F006A033E /* InPersonPaymentsCashOnDeliveryPaymentGatewayHelpers.swift */; };
@@ -2487,6 +2488,7 @@
 		03AA165F2719B83D005CCB7B /* ReceiptActionCoordinatorTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ReceiptActionCoordinatorTests.swift; sourceTree = "<group>"; };
 		03AFDE01282C0B82003B67CD /* InPersonPaymentsCompletedView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InPersonPaymentsCompletedView.swift; sourceTree = "<group>"; };
 		03BB9EA4292E2D0C00251E9E /* CardReaderConnectionController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CardReaderConnectionController.swift; sourceTree = "<group>"; };
+		03BB9EA6292E50B600251E9E /* CardPresentModalSelectSearchType.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CardPresentModalSelectSearchType.swift; sourceTree = "<group>"; };
 		03CF78D027C3DBC000523706 /* WCPayCardBrand+IconsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "WCPayCardBrand+IconsTests.swift"; sourceTree = "<group>"; };
 		03EF24F928BF5D21006A033E /* InPersonPaymentsCashOnDeliveryToggleRowViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InPersonPaymentsCashOnDeliveryToggleRowViewModel.swift; sourceTree = "<group>"; };
 		03EF24FB28BF996F006A033E /* InPersonPaymentsCashOnDeliveryPaymentGatewayHelpers.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InPersonPaymentsCashOnDeliveryPaymentGatewayHelpers.swift; sourceTree = "<group>"; };
@@ -8525,6 +8527,7 @@
 				318477E427A33C650058C7E9 /* CardPresentModalConnectingFailedChargeReader.swift */,
 				031B10E2274FE2AE007390BA /* CardPresentModalConnectionFailedUpdateAddress.swift */,
 				036CA6B8291E8D4B00E4DF4F /* CardPresentModalPreparingReader.swift */,
+				03BB9EA6292E50B600251E9E /* CardPresentModalSelectSearchType.swift */,
 				D8EE9697264D3CCB0033B2F9 /* ReceiptViewModel.swift */,
 				D8752EF6265E60F4008ACC80 /* PaymentCaptureCelebration.swift */,
 				03AA165D2719B7EF005CCB7B /* ReceiptActionCoordinator.swift */,
@@ -10153,6 +10156,7 @@
 				DEC6C51A2747758D006832D3 /* JetpackInstallView.swift in Sources */,
 				DE37517C28DC5FC6000163CB /* Authenticator.swift in Sources */,
 				AED089F227C794BC0020AE10 /* View+CurrencySymbol.swift in Sources */,
+				03BB9EA7292E50B600251E9E /* CardPresentModalSelectSearchType.swift in Sources */,
 				D85806292642BA5400A8AB6C /* PaymentCaptureOrchestrator.swift in Sources */,
 				E1E636BB26FB467A00C9D0D7 /* Comparable+Woo.swift in Sources */,
 				450C2CB024CF006A00D570DD /* ProductTagsDataSource.swift in Sources */,

Yosemite/Yosemite/Model/Payments/CardPresentPaymentsConfiguration.swift

@@ -38,7 +38,7 @@ public struct CardPresentPaymentsConfiguration {
                 paymentMethods: [.cardPresent],
                 currencies: [.USD],
                 paymentGateways: [WCPayAccount.gatewayID, StripeAccount.gatewayID],
-                supportedReaders: [.chipper, .stripeM2],
+                supportedReaders: [.chipper, .stripeM2, .appleBuiltIn],
                 supportedPluginVersions: [
                     .init(plugin: .wcPay, minimumVersion: "3.2.1"),
                     .init(plugin: .stripe, minimumVersion: "6.2.0")

Yosemite/YosemiteTests/Mocks/CardPresentPayments/MockCardReaderService.swift

@@ -35,7 +35,7 @@ final class MockCardReaderService: CardReaderService {
     /// Boolean flag Indicates that clients have provided a CardReaderConfigProvider
     var didReceiveAConfigurationProvider = false
 
-    /// DiscoveryMethod recieved on starting a payment
+    /// DiscoveryMethod received on starting a payment
     var spyStartDiscoveryMethod: CardReaderDiscoveryMethod? = nil
 
     /// Boolean flag Indicates that clients have called the cancel payment method