Improve POSCart with PointOfSaleOrderController to match coupons when checking order changes

Author: staskus

WooCommerce/Classes/POS/Controllers/PointOfSaleOrderController.swift

@@ -69,7 +69,7 @@ protocol PointOfSaleOrderControllerProtocol {
                    retryHandler: @escaping () async -> Void) async -> Result<SyncOrderState, Error> {
         let posCart = POSCart(cart: cart)
 
-        guard !orderState.isSyncing, !posCart.items.matches(order: order) else {
+        guard !orderState.isSyncing, !posCart.matches(order: order) else {
             return .success(.orderNotChanged)
         }
 

WooCommerce/WooCommerceTests/POS/Controllers/PointOfSaleOrderControllerTests.swift

@@ -5,6 +5,7 @@ import Foundation
 @testable import WooCommerce
 import struct Yosemite.Order
 import struct Yosemite.OrderItem
+import struct Yosemite.OrderCouponLine
 import enum Yosemite.OrderAction
 import class WooFoundation.CurrencySettings
 import protocol WooFoundation.Analytics
@@ -364,6 +365,72 @@ struct PointOfSaleOrderControllerTests {
         }
     }
 
+    @available(iOS 17.0, *)
+    @Test func syncOrder_with_cart_matching_order_and_coupons_doesnt_call_orderService() async throws {
+        // Given
+        let sut = PointOfSaleOrderController(orderService: mockOrderService,
+                                             receiptService: mockReceiptService)
+        let orderItem = OrderItem.fake().copy(quantity: 1)
+        let couponCode = "SAVE10"
+        let coupon = OrderCouponLine.fake().copy(code: couponCode)
+        let fakeOrder = Order.fake().copy(items: [orderItem], coupons: [coupon])
+        let cartItem = makeItem(orderItemsToMatch: [orderItem])
+        mockOrderService.orderToReturn = fakeOrder
+
+        // Initial sync to set up the order
+        await sut.syncOrder(for: .init(items: [cartItem], coupons: [.init(id: UUID(), code: couponCode)]), retryHandler: {})
+
+        // When - sync with same items and coupons
+        await sut.syncOrder(for: .init(items: [cartItem], coupons: [.init(id: UUID(), code: couponCode)]), retryHandler: {})
+
+        // Then
+        #expect(mockOrderService.syncOrderWasCalled == false)
+    }
+
+    @available(iOS 17.0, *)
+    @Test func syncOrder_with_matching_items_but_different_coupons_calls_orderService() async throws {
+        // Given
+        let sut = PointOfSaleOrderController(orderService: mockOrderService,
+                                             receiptService: mockReceiptService)
+        let orderItem = OrderItem.fake().copy(quantity: 1)
+        let initialCouponCode = "SAVE10"
+        let initialCoupon = OrderCouponLine.fake().copy(code: initialCouponCode)
+        let fakeOrder = Order.fake().copy(items: [orderItem], coupons: [initialCoupon])
+        let cartItem = makeItem(orderItemsToMatch: [orderItem])
+        mockOrderService.orderToReturn = fakeOrder
+
+        // Initial sync
+        await sut.syncOrder(for: .init(items: [cartItem], coupons: [.init(id: UUID(), code: initialCouponCode)]), retryHandler: {})
+
+        // When - sync with same items but different coupon
+        await sut.syncOrder(for: .init(items: [cartItem], coupons: [.init(id: UUID(), code: "DIFFERENT20")]), retryHandler: {})
+
+        // Then
+        #expect(mockOrderService.syncOrderWasCalled == true)
+    }
+
+    @available(iOS 17.0, *)
+    @Test func syncOrder_with_matching_items_but_removed_coupon_calls_orderService() async throws {
+        // Given
+        let sut = PointOfSaleOrderController(orderService: mockOrderService,
+                                             receiptService: mockReceiptService)
+        let orderItem = OrderItem.fake().copy(quantity: 1)
+        let couponCode = "SAVE10"
+        let coupon = OrderCouponLine.fake().copy(code: couponCode)
+        let fakeOrder = Order.fake().copy(items: [orderItem], coupons: [coupon])
+        let cartItem = makeItem(orderItemsToMatch: [orderItem])
+        mockOrderService.orderToReturn = fakeOrder
+
+        // Initial sync with coupon
+        await sut.syncOrder(for: .init(items: [cartItem], coupons: [.init(id: UUID(), code: couponCode)]), retryHandler: {})
+
+        // When - sync with same items but no coupons
+        await sut.syncOrder(for: .init(items: [cartItem], coupons: []), retryHandler: {})
+
+        // Then
+        #expect(mockOrderService.syncOrderWasCalled == true)
+    }
+
     struct AnalyticsTests {
         private let analytics: WooAnalytics
         private let analyticsProvider = MockAnalyticsProvider()

Yosemite/Yosemite/Tools/POS/POSCart.swift

@@ -31,8 +31,14 @@ public struct POSCartCouponItem {
     }
 }
 
+public extension POSCart {
+    func matches(order: Order?) -> Bool {
+        return items.matches(order: order) && coupons.matches(order: order)
+    }
+}
+
 extension [POSCartItem] {
-    public func matches(order: Order?) -> Bool {
+    func matches(order: Order?) -> Bool {
         guard let order else {
             return self.isEmpty
         }
@@ -94,3 +100,15 @@ extension [POSCartItem] {
         return output
     }
 }
+
+extension [POSCartCouponItem] {
+    func matches(order: Order?) -> Bool {
+        guard let order else {
+            return self.isEmpty
+        }
+
+        let orderCoupons = Set(order.coupons.map(\.code))
+        let cartCoupons = Set(self.map(\.code))
+        return orderCoupons == cartCoupons
+    }
+}