[Woo POS] Prevent connection success flashing during payment (#15784)

Author: joshheald

RELEASE-NOTES.txt

@@ -8,6 +8,7 @@
 - [**] POS: a POS tab in the tab bar is now available in the app for stores eligible for Point of Sale, instead of the previous entry point in the Menu tab. [https://github.com/woocommerce/woocommerce-ios/pull/15766]
 - [***] POS: Barcode scanning using Bluetooth scanners in Point of Sale (HID-based scanners are supported) [https://github.com/woocommerce/woocommerce-ios/pull/15776]
 - [*] POS: Support refreshing product list when it's empty [https://github.com/woocommerce/woocommerce-ios/pull/15782]
+- [*] POS: Prevent card reader connection success alert flashing when connecting during a payment [https://github.com/woocommerce/woocommerce-ios/pull/15784]
 
 22.6
 -----

WooCommerce/Classes/POS/Models/PointOfSaleAggregateModel.swift

@@ -399,8 +399,15 @@ extension PointOfSaleAggregateModel {
 
     private func cancelCardReaderPreparation() {
         cardPresentPaymentService.cancelPayment()
+        resetCardReaderObservation()
+    }
+
+    private func resetCardReaderObservation() {
+        // We set these to nil, so that we can check them when showing `Reader connected` on the Totals screen.
         startPaymentOnCardReaderConnection?.cancel()
+        startPaymentOnCardReaderConnection = nil
         cardReaderDisconnection?.cancel()
+        cardReaderDisconnection = nil
     }
 
     private func observeReaderReconnection() {
@@ -444,6 +451,13 @@ private extension PointOfSaleAggregateModel {
                 else {
                     return nil
                 }
+
+                // Filter connection success alerts when we're immediately starting a payment
+                if case .connectionSuccess = eventDetails,
+                   startPaymentOnCardReaderConnection != nil {
+                    return nil
+                }
+
                 return alertType
             }
             .sink(receiveValue: { [weak self] alertType in
@@ -569,17 +583,13 @@ extension PointOfSaleAggregateModel {
             try await cardPresentPaymentService.cancelPayment()
         }
 
-        // Cancels payment task
-        cardPresentPaymentService.cancelPayment()
-
         // Before exiting Point of Sale, we warn the merchant about losing their in-progress order.
         // We need to clear it down as any accidental retention can cause issues especially when reconnecting card readers.
         orderController.clearOrder()
 
         // Ideally, we could rely on the POS being deallocated to cancel all these. Since we have memory leak issues,
         // cancelling them explicitly helps reduce the risk of user-visible bugs while we work on the memory leaks.
-        startPaymentOnCardReaderConnection?.cancel()
-        cardReaderDisconnection?.cancel()
+        resetCardReaderObservation()
         cancellables.forEach { $0.cancel() }
     }
 }

WooCommerce/WooCommerceTests/POS/Models/PointOfSaleAggregateModelTests.swift

@@ -1061,6 +1061,75 @@ struct PointOfSaleAggregateModelTests {
             // Then
             #expect(sut.cardPresentPaymentOnboardingViewModel?.state == .pluginNotActivated(plugin: .stripe))
         }
+
+        @available(iOS 17.0, *)
+        @Test func connectionSuccessAlert_is_filtered_when_waiting_to_start_payment_on_card_reader_connection() async throws {
+            // Given
+            let itemsController = MockPointOfSaleItemsController()
+            let sut = PointOfSaleAggregateModel(
+                itemsController: itemsController,
+                purchasableItemsSearchController: MockPointOfSalePurchasableItemsSearchController(),
+                couponsController: MockPointOfSaleCouponsController(),
+                couponsSearchController: MockPointOfSaleCouponsController(),
+                cardPresentPaymentService: cardPresentPaymentService,
+                orderController: orderController,
+                analytics: WooAnalytics(analyticsProvider: MockAnalyticsProvider()),
+                collectOrderPaymentAnalyticsTracker: MockPOSCollectOrderPaymentAnalyticsTracker(),
+                searchHistoryService: MockPOSSearchHistoryService(),
+                popularPurchasableItemsController: MockPointOfSaleItemsController(),
+                barcodeScanService: MockPointOfSaleBarcodeScanService(),
+                soundPlayer: MockPointOfSaleSoundPlayer())
+
+            // Add item to cart and checkout to trigger payment waiting state
+            sut.addToCart(makePurchasableItem())
+            await sut.checkOut()
+
+            // Verify we're in finalizing stage and no alert is currently shown
+            try #require(sut.orderStage == .finalizing)
+            try #require(sut.cardPresentPaymentAlertViewModel == nil)
+
+            // When
+            // Simulate connection success event while waiting for payment
+            cardPresentPaymentService.paymentEvent = .show(eventDetails: .connectionSuccess(done: {}))
+
+            // Then
+            // The connection success alert should be filtered out and not shown
+            #expect(sut.cardPresentPaymentAlertViewModel == nil)
+        }
+
+        @available(iOS 17.0, *)
+        @Test func connectionSuccessAlert_is_shown_when_not_waiting_to_start_payment() async throws {
+            // Given
+            let itemsController = MockPointOfSaleItemsController()
+            let sut = PointOfSaleAggregateModel(
+                itemsController: itemsController,
+                purchasableItemsSearchController: MockPointOfSalePurchasableItemsSearchController(),
+                couponsController: MockPointOfSaleCouponsController(),
+                couponsSearchController: MockPointOfSaleCouponsController(),
+                cardPresentPaymentService: cardPresentPaymentService,
+                orderController: orderController,
+                analytics: WooAnalytics(analyticsProvider: MockAnalyticsProvider()),
+                collectOrderPaymentAnalyticsTracker: MockPOSCollectOrderPaymentAnalyticsTracker(),
+                searchHistoryService: MockPOSSearchHistoryService(),
+                popularPurchasableItemsController: MockPointOfSaleItemsController(),
+                barcodeScanService: MockPointOfSaleBarcodeScanService(),
+                soundPlayer: MockPointOfSaleSoundPlayer())
+
+            // Verify we're in building stage and no alert is currently shown
+            try #require(sut.orderStage == .building)
+            try #require(sut.cardPresentPaymentAlertViewModel == nil)
+
+            // When
+            // Simulate connection success event when not waiting for payment
+            cardPresentPaymentService.paymentEvent = .show(eventDetails: .connectionSuccess(done: {}))
+
+            // Then
+            // The connection success alert should be shown
+            guard case .connectionSuccess = sut.cardPresentPaymentAlertViewModel else {
+                Issue.record("Expected cardPresentPaymentAlertViewModel to be connectionSuccess")
+                return
+            }
+        }
     }
 
     struct AnalyticsTests {