[Woo POS][Settings] i2: Card reader management design updates (#16321)

Author: iamgabrielma

Modules/Sources/Experiments/DefaultFeatureFlagService.swift

@@ -100,8 +100,6 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
             return buildConfig == .localDeveloper || buildConfig == .alpha
         case .pointOfSaleSurveys:
             return buildConfig == .localDeveloper || buildConfig == .alpha
-        case .pointOfSaleSettingsCardReaderFlow:
-            return buildConfig == .localDeveloper || buildConfig == .alpha
         case .pointOfSaleCatalogAPI:
             return false
         default:

Modules/Sources/Experiments/FeatureFlag.swift

@@ -208,10 +208,6 @@ public enum FeatureFlag: Int {
     ///
     case pointOfSaleSurveys
 
-    /// Enables card reader connection flow within POS settings
-    ///
-    case pointOfSaleSettingsCardReaderFlow
-
     /// Enables using the catalog API endpoint for Point of Sale catalog full sync
     ///
     case pointOfSaleCatalogAPI

Modules/Sources/PointOfSale/Card Present Payments/CardPresentPaymentCardReader.swift

@@ -7,8 +7,12 @@ public struct CardPresentPaymentCardReader: Equatable {
     /// This is an unformatted percentage as a float, e.g. 0.0-1.0
     let batteryLevel: Float?
 
-    public init(name: String, batteryLevel: Float?) {
+    /// The reader's software version, if available.
+    let softwareVersion: String?
+
+    public init(name: String, batteryLevel: Float?, softwareVersion: String? = "Unknown") {
         self.name = name
         self.batteryLevel = batteryLevel
+        self.softwareVersion = softwareVersion
     }
 }

Modules/Sources/PointOfSale/Card Present Payments/CardPresentPaymentFacade.swift

@@ -1,6 +1,7 @@
 import Foundation
 import enum Yosemite.PaymentChannel
 import struct Yosemite.Order
+import enum Yosemite.CardReaderSoftwareUpdateState
 import Combine
 
 public protocol CardPresentPaymentFacade {
@@ -13,6 +14,10 @@ public protocol CardPresentPaymentFacade {
     /// This is a long lasting stream, and will not finish during the life of the façade.
     var readerConnectionStatusPublisher: AnyPublisher<CardPresentPaymentReaderConnectionStatus, Never> { get }
 
+    /// `cardReaderUpdateStatePublisher` provides the latest software update state for the connected card reader.
+    /// This is a long lasting stream, and will not finish during the life of the façade.
+    var cardReaderUpdateStatePublisher: AnyPublisher<CardReaderSoftwareUpdateState, Never> { get }
+
     /// Attempts to a card reader of the specified type.
     /// If another type of reader is already connected, this will be disconnected automatically.
     /// - Parameters:
@@ -26,6 +31,11 @@ public protocol CardPresentPaymentFacade {
     /// Also cancels any in-progress payment, if possible.
     func disconnectReader() async
 
+    /// Starts a software update for the currently connected card reader, if an update is available.
+    /// - Throws: `CardPresentPaymentError` for any failures.
+    /// - Output: publishes intermediate events on the `paymentEventPublisher` as required.
+    func updateCardReaderSoftware() async throws
+
     /// Collects a card present payment for an order.
     /// If the appropriate type of reader is not already connected, this should attempt a connection before the payment.
     /// If another type of reader is already connected, this will be disconnected automatically.

Modules/Sources/PointOfSale/Card Present Payments/CardPresentPaymentPreviewService.swift

@@ -2,6 +2,7 @@ import Foundation
 import Combine
 import enum Yosemite.PaymentChannel
 import struct Yosemite.Order
+import enum Yosemite.CardReaderSoftwareUpdateState
 
 #if DEBUG
 
@@ -14,6 +15,10 @@ final class CardPresentPaymentPreviewService: CardPresentPaymentFacade {
         $readerConnectionStatus.eraseToAnyPublisher()
     }
 
+    var cardReaderUpdateStatePublisher: AnyPublisher<CardReaderSoftwareUpdateState, Never> {
+        Just(.none).eraseToAnyPublisher()
+    }
+
     init(connectionStatus: CardPresentPaymentReaderConnectionStatus = .disconnected) {
         self.readerConnectionStatus = connectionStatus
     }
@@ -35,6 +40,10 @@ final class CardPresentPaymentPreviewService: CardPresentPaymentFacade {
     func cancelPayment() {
         // no-op
     }
+
+    func updateCardReaderSoftware() async throws {
+        // no-op
+    }
 }
 
 #endif

Modules/Sources/PointOfSale/Models/PointOfSaleAggregateModel.swift

@@ -16,6 +16,7 @@ import protocol Yosemite.PointOfSaleBarcodeScanServiceProtocol
 import enum Yosemite.PointOfSaleBarcodeScanError
 import protocol Yosemite.POSCatalogSyncCoordinatorProtocol
 import class Yosemite.POSCatalogSyncCoordinator
+import enum Yosemite.CardReaderSoftwareUpdateState
 
 protocol PointOfSaleAggregateModelProtocol {
     var cart: Cart { get }
@@ -28,12 +29,20 @@ protocol PointOfSaleAggregateModelProtocol {
     private(set) var orderStage: PointOfSaleOrderStage = .building
 
     private(set) var cardReaderConnectionStatus: CardPresentPaymentReaderConnectionStatus = .disconnected
+    private(set) var cardReaderUpdateState: CardReaderSoftwareUpdateState = .none
     private(set) var paymentState: PointOfSalePaymentState
     var cardPresentPaymentAlertViewModel: PointOfSaleCardPresentPaymentAlertType?
     private(set) var cardPresentPaymentInlineMessage: PointOfSaleCardPresentPaymentMessageType?
     var cardPresentPaymentOnboardingViewContainer: CardPresentPaymentOnboardingViewContainer?
     private var onOnboardingCancellation: (() -> Void)?
 
+    var isCardReaderUpdateAvailable: Bool {
+        if case .available = cardReaderUpdateState {
+            return true
+        }
+        return false
+    }
+
     private(set) var cart: Cart = .init()
 
     var orderState: PointOfSaleOrderState { orderController.orderState.externalState }
@@ -127,6 +136,7 @@ protocol PointOfSaleAggregateModelProtocol {
         self.isLocalCatalogEligible = isLocalCatalogEligible
 
         publishCardReaderConnectionStatus()
+        publishCardReaderUpdateState()
         publishPaymentMessages()
         setupReaderReconnectionObservation()
         setupPaymentSuccessObservation()
@@ -303,6 +313,14 @@ extension PointOfSaleAggregateModel {
             .store(in: &cancellables)
     }
 
+    private func publishCardReaderUpdateState() {
+        cardPresentPaymentService.cardReaderUpdateStatePublisher
+            .sink(receiveValue: { [weak self] updateState in
+                self?.cardReaderUpdateState = updateState
+            })
+            .store(in: &cancellables)
+    }
+
     func connectCardReader() {
         analytics.track(.pointOfSaleCardReaderConnectionTapped)
         Task { @MainActor [weak self] in
@@ -317,6 +335,13 @@ extension PointOfSaleAggregateModel {
         }
     }
 
+    func updateCardReaderSoftware() {
+        //TODO: analytics.track(.cardReaderUpdateTapped)
+        Task { @MainActor [weak self] in
+            try? await self?.cardPresentPaymentService.updateCardReaderSoftware()
+        }
+    }
+
     /// Starts a payment immediately if a reader is connected.
     /// Otherwise, schedules a payment to start the next time a reader connects.
     /// Note that any scheduled payments are cancelled by `cancelReaderPreparation`

Modules/Sources/PointOfSale/Models/PointOfSaleSettingsController.swift

@@ -75,7 +75,8 @@ protocol POSSettingsControllerProtocol {
 final class POSSettingsPreviewController: POSSettingsControllerProtocol {
     var connectedCardReader: CardPresentPaymentCardReader? = CardPresentPaymentCardReader(
         name: "WisePad 3",
-        batteryLevel: 0.75
+        batteryLevel: 0.75,
+        softwareVersion: "2.0.1.23"
     )
 
     var storeViewModel: POSSettingsStoreViewModel = POSSettingsStoreViewModel(siteID: 123,

Modules/Sources/PointOfSale/Presentation/Card Present Payments/Connection Alerts/PointOfSaleCardPresentPaymentAlertType.swift

@@ -44,9 +44,8 @@ enum PointOfSaleCardPresentPaymentAlertType: Hashable, Identifiable {
             return viewModel.cancelReaderUpdate
         case .optionalReaderUpdateInProgress(let viewModel):
             return viewModel.cancelReaderUpdate
-        case .readerUpdateCompletion:
-            // We only support in-line updates at the moment, and they automatically move on to connecting the reader.
-            return nil
+        case .readerUpdateCompletion(let viewModel):
+            return viewModel.buttonViewModel.actionHandler
         case .updateFailed(let viewModel):
             return viewModel.cancelButtonViewModel.actionHandler
         case .updateFailedNonRetryable(let viewModel):

Modules/Sources/PointOfSale/Presentation/Card Present Payments/Connection Alerts/PointOfSaleCardPresentPaymentReaderUpdateCompletionAlertViewModel.swift

@@ -4,19 +4,28 @@ import SwiftUI
 struct PointOfSaleCardPresentPaymentReaderUpdateCompletionAlertViewModel {
     let title: String = Localization.title
     let progressTitle: String = .init(format: Localization.percentCompleteFormat, 100.0)
+    let buttonViewModel: CardPresentPaymentsModalButtonViewModel
+
+    init(doneAction: @escaping () -> Void) {
+        self.buttonViewModel = CardPresentPaymentsModalButtonViewModel(
+            title: "",
+            actionHandler: doneAction)
+    }
 }
 
 extension PointOfSaleCardPresentPaymentReaderUpdateCompletionAlertViewModel: Hashable, Equatable {
     func hash(into hasher: inout Hasher) {
         hasher.combine(title)
         hasher.combine(progressTitle)
+        hasher.combine(buttonViewModel)
     }
 
     /// This can be synthesised – implemented manually to ensure it matches the `hash` function.
     static func ==(lhs: PointOfSaleCardPresentPaymentReaderUpdateCompletionAlertViewModel,
                    rhs: PointOfSaleCardPresentPaymentReaderUpdateCompletionAlertViewModel) -> Bool {
         return lhs.title == rhs.title &&
-        lhs.progressTitle == rhs.progressTitle
+        lhs.progressTitle == rhs.progressTitle &&
+        lhs.buttonViewModel == rhs.buttonViewModel
     }
 }
 

Modules/Sources/PointOfSale/Presentation/Card Present Payments/PointOfSaleCardPresentPaymentEventPresentationStyle.swift

@@ -125,7 +125,8 @@ enum PointOfSaleCardPresentPaymentEventPresentationStyle {
 
         case .updateProgress(let requiredUpdate, let progress, let cancelUpdate):
             if progress == 1.0 {
-                self = .alert(.readerUpdateCompletion(viewModel: .init()))
+                self = .alert(.readerUpdateCompletion(
+                    viewModel: .init(doneAction: dependencies.dismissReaderConnectionModal)))
             } else {
                 self = requiredUpdate ?
                     .alert(.requiredReaderUpdateInProgress(