Merge branch 'trunk' into woomob-1136-woo-poshistorical-orders-order-list-empty-loading-and-error

Author: staskus

Modules/Sources/NetworkingCore/Remote/OrdersRemote.swift

@@ -598,6 +598,24 @@ public extension OrdersRemote {
         case customerID
         case currency
     }
+
+    /// Loads a single order asynchronously for POS
+    /// - Parameters:
+    ///   - siteID: Site for which we'll fetch the order.
+    ///   - orderID: ID of the order to load.
+    /// - Returns: The loaded Order.
+    /// - Throws: Network or parsing errors.
+    func loadPOSOrder(siteID: Int64, orderID: Int64) async throws -> Order {
+        let path = "\(Constants.ordersPath)/\(orderID)"
+        let request = JetpackRequest(wooApiVersion: .mark3,
+                                   method: .get,
+                                   siteID: siteID,
+                                   path: path,
+                                   availableAsRESTRequest: true)
+        let mapper = OrderMapper(siteID: siteID)
+
+        return try await enqueue(request, mapper: mapper)
+    }
 }
 
 private extension OrdersRemote.OrderCreationSource {

Modules/Sources/NetworkingCore/Remote/POSOrdersRemoteProtocol.swift

@@ -19,6 +19,8 @@ public protocol POSOrdersRemoteProtocol {
                         order: Order,
                         fields: [OrdersRemote.CreateOrderField]) async throws -> Order
 
+    func loadPOSOrder(siteID: Int64, orderID: Int64) async throws -> Order
+
     func loadPOSOrders(siteID: Int64,
                        pageNumber: Int,
                        pageSize: Int) async throws -> PagedItems<Order>

Modules/Sources/Yosemite/Model/Copiable/Models+Copiable.generated.swift

@@ -4,6 +4,12 @@ import Codegen
 import Foundation
 import Networking
 import WooFoundation
+import enum NetworkingCore.OrderStatusEnum
+import struct NetworkingCore.Address
+import struct NetworkingCore.MetaData
+import struct NetworkingCore.Order
+import struct NetworkingCore.OrderItem
+import struct NetworkingCore.OrderRefundCondensed
 
 
 extension Yosemite.JustInTimeMessage {
@@ -51,6 +57,60 @@ extension Yosemite.JustInTimeMessage {
     }
 }
 
+extension Yosemite.POSOrder {
+    public func copy(
+        id: CopiableProp<Int64> = .copy,
+        number: CopiableProp<String> = .copy,
+        dateCreated: CopiableProp<Date> = .copy,
+        status: CopiableProp<OrderStatusEnum> = .copy,
+        formattedTotal: CopiableProp<String> = .copy,
+        formattedSubtotal: CopiableProp<String> = .copy,
+        customerEmail: NullableCopiableProp<String> = .copy,
+        paymentMethodID: CopiableProp<String> = .copy,
+        paymentMethodTitle: CopiableProp<String> = .copy,
+        lineItems: CopiableProp<[POSOrderItem]> = .copy,
+        refunds: CopiableProp<[POSOrderRefund]> = .copy,
+        formattedDiscountTotal: NullableCopiableProp<String> = .copy,
+        formattedTotalTax: CopiableProp<String> = .copy,
+        formattedPaymentTotal: CopiableProp<String> = .copy,
+        formattedNetAmount: NullableCopiableProp<String> = .copy
+    ) -> Yosemite.POSOrder {
+        let id = id ?? self.id
+        let number = number ?? self.number
+        let dateCreated = dateCreated ?? self.dateCreated
+        let status = status ?? self.status
+        let formattedTotal = formattedTotal ?? self.formattedTotal
+        let formattedSubtotal = formattedSubtotal ?? self.formattedSubtotal
+        let customerEmail = customerEmail ?? self.customerEmail
+        let paymentMethodID = paymentMethodID ?? self.paymentMethodID
+        let paymentMethodTitle = paymentMethodTitle ?? self.paymentMethodTitle
+        let lineItems = lineItems ?? self.lineItems
+        let refunds = refunds ?? self.refunds
+        let formattedDiscountTotal = formattedDiscountTotal ?? self.formattedDiscountTotal
+        let formattedTotalTax = formattedTotalTax ?? self.formattedTotalTax
+        let formattedPaymentTotal = formattedPaymentTotal ?? self.formattedPaymentTotal
+        let formattedNetAmount = formattedNetAmount ?? self.formattedNetAmount
+
+        return Yosemite.POSOrder(
+            id: id,
+            number: number,
+            dateCreated: dateCreated,
+            status: status,
+            formattedTotal: formattedTotal,
+            formattedSubtotal: formattedSubtotal,
+            customerEmail: customerEmail,
+            paymentMethodID: paymentMethodID,
+            paymentMethodTitle: paymentMethodTitle,
+            lineItems: lineItems,
+            refunds: refunds,
+            formattedDiscountTotal: formattedDiscountTotal,
+            formattedTotalTax: formattedTotalTax,
+            formattedPaymentTotal: formattedPaymentTotal,
+            formattedNetAmount: formattedNetAmount
+        )
+    }
+}
+
 extension Yosemite.POSSimpleProduct {
     public func copy(
         id: CopiableProp<UUID> = .copy,

Modules/Sources/Yosemite/PointOfSale/OrderList/POSOrder.swift

@@ -1,12 +1,13 @@
 import Foundation
+import Codegen
 import struct NetworkingCore.Address
 import struct NetworkingCore.OrderItem
 import struct NetworkingCore.OrderRefundCondensed
 import struct NetworkingCore.MetaData
 import enum NetworkingCore.OrderStatusEnum
 import struct NetworkingCore.Order
 
-public struct POSOrder: Equatable, Hashable {
+public struct POSOrder: Equatable, Hashable, GeneratedCopiable {
     public let id: Int64
     public let number: String
     public let dateCreated: Date
@@ -34,8 +35,8 @@ public struct POSOrder: Equatable, Hashable {
                 paymentMethodTitle: String,
                 lineItems: [POSOrderItem] = [],
                 refunds: [POSOrderRefund] = [],
-                formattedTotalTax: String,
                 formattedDiscountTotal: String?,
+                formattedTotalTax: String,
                 formattedPaymentTotal: String,
                 formattedNetAmount: String? = nil) {
         self.id = id
@@ -49,8 +50,8 @@ public struct POSOrder: Equatable, Hashable {
         self.paymentMethodTitle = paymentMethodTitle
         self.lineItems = lineItems
         self.refunds = refunds
-        self.formattedTotalTax = formattedTotalTax
         self.formattedDiscountTotal = formattedDiscountTotal
+        self.formattedTotalTax = formattedTotalTax
         self.formattedPaymentTotal = formattedPaymentTotal
         self.formattedNetAmount = formattedNetAmount
     }

Modules/Sources/Yosemite/PointOfSale/OrderList/POSOrderMapper.swift

@@ -45,8 +45,8 @@ struct POSOrderMapper {
             paymentMethodTitle: order.paymentMethodTitle,
             lineItems: posLineItems,
             refunds: posRefunds,
-            formattedTotalTax: currencyFormatter.formatAmount(order.totalTax, with: order.currency) ?? "",
             formattedDiscountTotal: formattedDiscountTotal,
+            formattedTotalTax: currencyFormatter.formatAmount(order.totalTax, with: order.currency) ?? "",
             formattedPaymentTotal: order.paymentTotal(currencyFormatter: currencyFormatter),
             formattedNetAmount: formattedNetAmount
         )

Modules/Sources/Yosemite/PointOfSale/OrderList/PointOfSaleOrderListFetchStrategy.swift

@@ -3,6 +3,7 @@ import struct NetworkingCore.PagedItems
 
 public protocol PointOfSaleOrderListFetchStrategy {
     func fetchOrders(pageNumber: Int) async throws -> PagedItems<POSOrder>
+    func loadOrder(orderID: Int64) async throws -> POSOrder
     var supportsCaching: Bool { get }
     var showsLoadingWithItems: Bool { get }
     var id: String { get }
@@ -26,6 +27,10 @@ struct PointOfSaleDefaultOrderListFetchStrategy: PointOfSaleOrderListFetchStrate
     func fetchOrders(pageNumber: Int) async throws -> PagedItems<POSOrder> {
         try await orderListService.providePointOfSaleOrders(pageNumber: pageNumber)
     }
+
+    func loadOrder(orderID: Int64) async throws -> POSOrder {
+        try await orderListService.loadOrder(orderID: orderID)
+    }
 }
 
 struct PointOfSaleSearchOrderListFetchStrategy: PointOfSaleOrderListFetchStrategy {
@@ -43,4 +48,8 @@ struct PointOfSaleSearchOrderListFetchStrategy: PointOfSaleOrderListFetchStrateg
     func fetchOrders(pageNumber: Int) async throws -> PagedItems<POSOrder> {
         try await orderListService.searchPointOfSaleOrders(searchTerm: searchTerm, pageNumber: pageNumber)
     }
+
+    func loadOrder(orderID: Int64) async throws -> POSOrder {
+        try await orderListService.loadOrder(orderID: orderID)
+    }
 }

Modules/Sources/Yosemite/PointOfSale/OrderList/PointOfSaleOrderListService.swift

@@ -70,4 +70,15 @@ public final class PointOfSaleOrderListService: PointOfSaleOrderListServiceProto
             throw PointOfSaleOrderListServiceError.requestFailed
         }
     }
+
+    public func loadOrder(orderID: Int64) async throws -> POSOrder {
+        do {
+            let order = try await ordersRemote.loadPOSOrder(siteID: siteID, orderID: orderID)
+            return mapper.map(order: order)
+        } catch AFError.explicitlyCancelled {
+            throw PointOfSaleOrderListServiceError.requestCancelled
+        } catch {
+            throw PointOfSaleOrderListServiceError.requestFailed
+        }
+    }
 }

Modules/Sources/Yosemite/PointOfSale/OrderList/PointOfSaleOrderListServiceProtocol.swift

@@ -9,4 +9,5 @@ public enum PointOfSaleOrderListServiceError: Error, Equatable {
 public protocol PointOfSaleOrderListServiceProtocol {
     func providePointOfSaleOrders(pageNumber: Int) async throws -> PagedItems<POSOrder>
     func searchPointOfSaleOrders(searchTerm: String, pageNumber: Int) async throws -> PagedItems<POSOrder>
+    func loadOrder(orderID: Int64) async throws -> POSOrder
 }

Modules/Tests/YosemiteTests/Mocks/MockPOSOrdersRemote.swift

@@ -91,4 +91,21 @@ final class MockPOSOrdersRemote: POSOrdersRemoteProtocol {
             throw error
         }
     }
+
+    var loadPOSOrderCalled = false
+    var spyLoadPOSOrderID: Int64?
+    var loadPOSOrderResult: Result<Order, Error> = .success(Order.fake())
+
+    func loadPOSOrder(siteID: Int64, orderID: Int64) async throws -> Order {
+        loadPOSOrderCalled = true
+        spySiteID = siteID
+        spyLoadPOSOrderID = orderID
+
+        switch loadPOSOrderResult {
+        case .success(let order):
+            return order
+        case .failure(let error):
+            throw error
+        }
+    }
 }

WooCommerce/Classes/POS/Controllers/PointOfSaleOrderListController.swift

@@ -16,6 +16,7 @@ protocol PointOfSaleOrderListControllerProtocol {
     func refreshOrders() async
     func loadNextOrders() async
     func selectOrder(_ order: POSOrder?)
+    func updateOrder(orderID: Int64) async throws
 }
 
 protocol PointOfSaleSearchingOrderListControllerProtocol: PointOfSaleOrderListControllerProtocol {
@@ -122,6 +123,11 @@ protocol PointOfSaleSearchingOrderListControllerProtocol: PointOfSaleOrderListCo
 
             ordersViewState = allOrders.isEmpty ? .empty : .loaded(allOrders, hasMoreItems: pagedOrders.hasMorePages)
 
+            if let selectedOrderID = selectedOrder?.id,
+               let updatedSelectedOrder = allOrders.first(where: { $0.id == selectedOrderID }) {
+                selectedOrder = updatedSelectedOrder
+            }
+
             if fetchStrategy.supportsCaching {
                 cachedOrders = allOrders
             }
@@ -169,4 +175,21 @@ protocol PointOfSaleSearchingOrderListControllerProtocol: PointOfSaleOrderListCo
             }
         }
     }
+
+    @MainActor
+    func updateOrder(orderID: Int64) async throws {
+        let updatedOrder = try await fetchStrategy.loadOrder(orderID: orderID)
+        let updatedOrders = ordersViewState.orders.map { order in
+            order.id == orderID ? updatedOrder : order
+        }
+
+        ordersViewState = ordersViewState.updatingOrders(with: updatedOrders)
+        cachedOrders = cachedOrders.map { order in
+            order.id == orderID ? updatedOrder : order
+        }
+
+        if selectedOrder?.id == orderID {
+            selectedOrder = updatedOrder
+        }
+    }
 }