Merge pull request #6183 from woocommerce/issue/6128-select-support

Order Creation: Wire remove product support to LocalOrderSynchronizer

Author: Ecarrion

WooCommerce/Classes/ViewRelated/Orders/Order Creation/NewOrder.swift

@@ -106,11 +106,10 @@ private struct ProductsSection: View {
                 ForEach(viewModel.productRows) { productRow in
                     ProductRow(viewModel: productRow)
                         .onTapGesture {
-                            // TODO: Support selecting an order item
-                            // viewModel.selectOrderItem(productRow.id)
+                            viewModel.selectOrderItem(productRow.id)
                         }
-                        .sheet(item: $viewModel.selectedOrderItem) { item in
-                            createProductInOrderView(for: item)
+                        .sheet(item: $viewModel.selectedProductViewModel) { productViewModel in
+                            ProductInOrder(viewModel: productViewModel)
                         }
 
                     Divider()
@@ -138,17 +137,6 @@ private struct ProductsSection: View {
             Divider()
         }
     }
-
-    @ViewBuilder private func createProductInOrderView(for item: NewOrderViewModel.NewOrderItem) -> some View {
-        // TODO: Support selecting an order item
-//        if let productRowViewModel = viewModel.createProductRowViewModel(for: item, canChangeQuantity: false) {
-//            let productInOrderViewModel = ProductInOrderViewModel(productRowViewModel: productRowViewModel) {
-//                viewModel.removeItemFromOrder(item)
-//            }
-//            ProductInOrder(viewModel: productInOrderViewModel)
-//        }
-        EmptyView()
-    }
 }
 
 // MARK: Constants

WooCommerce/Classes/ViewRelated/Orders/Order Creation/NewOrderViewModel.swift

@@ -12,10 +12,6 @@ final class NewOrderViewModel: ObservableObject {
 
     private var cancellables: Set<AnyCancellable> = []
 
-    /// Order details used to create the order
-    ///
-    @Published var orderDetails = OrderDetails()
-
     /// Active navigation bar trailing item.
     /// Defaults to no visible button.
     ///
@@ -114,10 +110,10 @@ final class NewOrderViewModel: ObservableObject {
     ///
     @Published private(set) var productRows: [ProductRowViewModel] = []
 
-    /// Item selected from the list of products in the order.
+    /// Selected product view model to render.
     /// Used to open the product details in `ProductInOrder`.
     ///
-    @Published var selectedOrderItem: NewOrderItem? = nil
+    @Published var selectedProductViewModel: ProductInOrderViewModel? = nil
 
     // MARK: Payment properties
 
@@ -171,18 +167,19 @@ final class NewOrderViewModel: ObservableObject {
         configurePaymentDataViewModel()
     }
 
-    /// Selects an order item.
+    /// Selects an order item by setting the `selectedProductViewModel`.
     ///
     /// - Parameter id: ID of the order item to select
-    func selectOrderItem(_ id: String) {
-        selectedOrderItem = orderDetails.items.first(where: { $0.id == id })
+    func selectOrderItem(_ id: Int64) {
+        selectedProductViewModel = createSelectedProductViewModel(itemID: id)
     }
 
     /// Removes an item from the order.
     ///
     /// - Parameter item: Item to remove from the order
-    func removeItemFromOrder(_ item: NewOrderItem) {
-        orderDetails.items.removeAll(where: { $0 == item })
+    func removeItemFromOrder(_ item: OrderItem) {
+        guard let input = createUpdateProductInput(item: item, quantity: 0) else { return }
+        orderSynchronizer.setProduct.send(input)
         configureProductRowViewModels()
     }
 
@@ -271,19 +268,6 @@ extension NewOrderViewModel {
         case loading
     }
 
-    /// Type to hold all order detail values
-    ///
-    struct OrderDetails {
-        var items: [NewOrderItem] = []
-
-        func toOrder() -> Order {
-            OrderFactory.emptyNewOrder.copy(status: .pending,
-                                            items: items.map { $0.orderItem },
-                                            billingAddress: nil,
-                                            shippingAddress: nil)
-        }
-    }
-
     /// Representation of order status display properties
     ///
     struct StatusBadgeViewModel {
@@ -312,52 +296,6 @@ extension NewOrderViewModel {
         }
     }
 
-    /// Representation of new items in an order.
-    ///
-    struct NewOrderItem: Equatable, Identifiable {
-        let id: String
-        let productID: Int64
-        let variationID: Int64
-        var quantity: Decimal
-        let price: NSDecimalNumber
-        var subtotal: String {
-            String(describing: quantity * price.decimalValue)
-        }
-
-        var orderItem: OrderItem {
-            OrderItem(itemID: 0,
-                      name: "",
-                      productID: productID,
-                      variationID: variationID,
-                      quantity: quantity,
-                      price: price,
-                      sku: nil,
-                      subtotal: subtotal,
-                      subtotalTax: "",
-                      taxClass: "",
-                      taxes: [],
-                      total: "",
-                      totalTax: "",
-                      attributes: [])
-        }
-
-        init(product: Product, quantity: Decimal) {
-            self.id = UUID().uuidString
-            self.productID = product.productID
-            self.variationID = 0 // Products in an order are represented in Core with a variation ID of 0
-            self.quantity = quantity
-            self.price = NSDecimalNumber(string: product.price)
-        }
-
-        init(variation: ProductVariation, quantity: Decimal) {
-            self.id = UUID().uuidString
-            self.productID = variation.productID
-            self.variationID = variation.productVariationID
-            self.quantity = quantity
-            self.price = NSDecimalNumber(string: variation.price)
-        }
-    }
-
     /// Representation of customer data display properties
     ///
     struct CustomerDataViewModel {
@@ -581,6 +519,23 @@ private extension NewOrderViewModel {
         // Return a new input with the new quantity but with the same item id to properly reference the update.
         return OrderSyncProductInput(id: item.itemID, product: product, quantity: quantity)
     }
+
+    /// Creates a `ProductInOrderViewModel` based on the provided order item id.
+    ///
+    func createSelectedProductViewModel(itemID: Int64) -> ProductInOrderViewModel? {
+        // Find order item based on the provided id.
+        // Creates the product row view model needed for `ProductInOrderViewModel`.
+        guard
+            let orderItem = orderSynchronizer.order.items.first(where: { $0.itemID == itemID }),
+            let rowViewModel = createProductRowViewModel(for: orderItem, canChangeQuantity: false)
+        else {
+            return nil
+        }
+
+        return ProductInOrderViewModel(productRowViewModel: rowViewModel) { [weak self] in
+            self?.removeItemFromOrder(orderItem)
+        }
+    }
 }
 
 private extension NewOrderViewModel {

WooCommerce/Classes/ViewRelated/Orders/Order Creation/ProductsSection/ProductInOrderViewModel.swift

@@ -2,8 +2,7 @@ import Yosemite
 
 /// View model for `ProductInOrder`.
 ///
-final class ProductInOrderViewModel {
-
+final class ProductInOrderViewModel: Identifiable {
     /// The product being edited.
     ///
     let productRowViewModel: ProductRowViewModel

WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Creation/NewOrderViewModelTests.swift

@@ -164,7 +164,7 @@ class NewOrderViewModelTests: XCTestCase {
         XCTAssertTrue(viewModel.productRows.contains(where: { $0.productOrVariationID == sampleProductID }), "Product rows do not contain expected product")
     }
 
-    func test_order_details_are_updated_when_product_quantity_changes() throws {
+    func test_order_details_are_updated_when_product_quantity_changes() {
         // Given
         let product = Product.fake().copy(siteID: sampleSiteID, productID: sampleProductID, purchasable: true)
         let storageManager = MockStorageManager()
@@ -184,8 +184,6 @@ class NewOrderViewModelTests: XCTestCase {
     }
 
     func test_selectOrderItem_selects_expected_order_item() throws {
-        throw XCTSkip("Test disabled while we enable select order support on OrderSynchronizer")
-
         // Given
         let product = Product.fake().copy(siteID: sampleSiteID, productID: sampleProductID, purchasable: true)
         let storageManager = MockStorageManager()
@@ -194,14 +192,15 @@ class NewOrderViewModelTests: XCTestCase {
         viewModel.addProductViewModel.selectProduct(product.productID)
 
         // When
-        let expectedOrderItem = viewModel.orderDetails.items[0]
-        viewModel.selectOrderItem(expectedOrderItem.id)
+        let expectedRow = viewModel.productRows[0]
+        viewModel.selectOrderItem(expectedRow.id)
 
         // Then
-        XCTAssertEqual(viewModel.selectedOrderItem, expectedOrderItem)
+        XCTAssertNotNil(viewModel.selectedProductViewModel)
+        XCTAssertEqual(viewModel.selectedProductViewModel?.productRowViewModel.id, expectedRow.id)
     }
 
-    func test_view_model_is_updated_when_product_is_removed_from_order() throws {
+    func test_view_model_is_updated_when_product_is_removed_from_order() {
         // Given
         let product0 = Product.fake().copy(siteID: sampleSiteID, productID: 0, purchasable: true)
         let product1 = Product.fake().copy(siteID: sampleSiteID, productID: 1, purchasable: true)
@@ -214,13 +213,13 @@ class NewOrderViewModelTests: XCTestCase {
         viewModel.addProductViewModel.selectProduct(product1.productID)
 
         // When
-        throw XCTSkip("Test disabled while we enable remove item support on OrderSynchronizer")
-        let expectedRemainingItem = viewModel.orderDetails.items[1]
-        viewModel.removeItemFromOrder(viewModel.orderDetails.items[0])
+        let expectedRemainingRow = viewModel.productRows[1]
+        let itemToRemove = OrderItem.fake().copy(itemID: viewModel.productRows[0].id)
+        viewModel.removeItemFromOrder(itemToRemove)
 
         // Then
         XCTAssertFalse(viewModel.productRows.contains(where: { $0.productOrVariationID == product0.productID }))
-        XCTAssertEqual(viewModel.orderDetails.items, [expectedRemainingItem])
+        XCTAssertEqual(viewModel.productRows.map { $0.id }, [expectedRemainingRow].map { $0.id })
     }
 
     func test_createProductRowViewModel_creates_expected_row_for_product() {
@@ -321,7 +320,7 @@ class NewOrderViewModelTests: XCTestCase {
         XCTAssertEqual(paymentDataViewModel.orderTotal, "£30.00")
     }
 
-    func test_payment_section_only_displayed_when_order_has_products() throws {
+    func test_payment_section_only_displayed_when_order_has_products() {
         // Given
         let product = Product.fake().copy(siteID: sampleSiteID, productID: sampleProductID, purchasable: true)
         let storageManager = MockStorageManager()
@@ -333,12 +332,13 @@ class NewOrderViewModelTests: XCTestCase {
         XCTAssertTrue(viewModel.shouldShowPaymentSection)
 
         // When & Then
-        throw XCTSkip("This unit test needs to be reenabled when the remove item method is migrated")
-        viewModel.removeItemFromOrder(viewModel.orderDetails.items[0])
+        let itemToRemove = OrderItem.fake().copy(itemID: viewModel.productRows[0].id, productID: product.productID)
+        viewModel.removeItemFromOrder(itemToRemove)
+
         XCTAssertFalse(viewModel.shouldShowPaymentSection)
     }
 
-    func test_payment_section_is_updated_when_products_update() throws {
+    func test_payment_section_is_updated_when_products_update() {
         // Given
         let currencySettings = CurrencySettings(currencyCode: .GBP, currencyPosition: .left, thousandSeparator: "", decimalSeparator: ".", numberOfDecimals: 2)
         let product = Product.fake().copy(siteID: sampleSiteID, productID: sampleProductID, price: "8.50", purchasable: true)