Merge pull request #6170 from woocommerce/issue/6128-add-product-support

Order Creation: Wire select product support to LocalOrderSynchronizer

Author: Ecarrion

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

@@ -106,7 +106,8 @@ private struct ProductsSection: View {
                 ForEach(viewModel.productRows) { productRow in
                     ProductRow(viewModel: productRow)
                         .onTapGesture {
-                            viewModel.selectOrderItem(productRow.id)
+                            // TODO: Support selecting an order item
+                            // viewModel.selectOrderItem(productRow.id)
                         }
                         .sheet(item: $viewModel.selectedOrderItem) { item in
                             createProductInOrderView(for: item)
@@ -139,12 +140,13 @@ private struct ProductsSection: View {
     }
 
     @ViewBuilder private func createProductInOrderView(for item: NewOrderViewModel.NewOrderItem) -> some View {
-        if let productRowViewModel = viewModel.createProductRowViewModel(for: item, canChangeQuantity: false) {
-            let productInOrderViewModel = ProductInOrderViewModel(productRowViewModel: productRowViewModel) {
-                viewModel.removeItemFromOrder(item)
-            }
-            ProductInOrder(viewModel: productInOrderViewModel)
-        }
+        // 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()
     }
 }

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

@@ -124,7 +124,7 @@ final class NewOrderViewModel: ObservableObject {
     /// Indicates if the Payment section should be shown
     ///
     var shouldShowPaymentSection: Bool {
-        orderDetails.items.isNotEmpty
+        orderSynchronizer.order.items.isNotEmpty
     }
 
     /// Defines if the view should be disabled.
@@ -188,21 +188,21 @@ final class NewOrderViewModel: ObservableObject {
 
     /// Creates a view model for the `ProductRow` corresponding to an order item.
     ///
-    func createProductRowViewModel(for item: NewOrderItem, canChangeQuantity: Bool) -> ProductRowViewModel? {
+    func createProductRowViewModel(for item: OrderItem, canChangeQuantity: Bool) -> ProductRowViewModel? {
         guard let product = allProducts.first(where: { $0.productID == item.productID }) else {
             return nil
         }
 
         if item.variationID != 0, let variation = allProductVariations.first(where: { $0.productVariationID == item.variationID }) {
             let attributes = ProductVariationFormatter().generateAttributes(for: variation, from: product.attributes)
-            return ProductRowViewModel(id: item.id,
+            return ProductRowViewModel(id: item.itemID,
                                        productVariation: variation,
                                        name: product.name,
                                        quantity: item.quantity,
                                        canChangeQuantity: canChangeQuantity,
                                        displayMode: .attributes(attributes))
         } else {
-            return ProductRowViewModel(id: item.id, product: product, quantity: item.quantity, canChangeQuantity: canChangeQuantity)
+            return ProductRowViewModel(id: item.itemID, product: product, quantity: item.quantity, canChangeQuantity: canChangeQuantity)
         }
     }
 
@@ -436,8 +436,8 @@ private extension NewOrderViewModel {
     /// Adds a selected product (from the product list) to the order.
     ///
     func addProductToOrder(_ product: Product) {
-        let newOrderItem = NewOrderItem(product: product, quantity: 1)
-        orderDetails.items.append(newOrderItem)
+        let input = OrderSyncProductInput(product: .product(product), quantity: 1)
+        orderSynchronizer.setProduct.send(input)
         configureProductRowViewModels()
 
         analytics.track(event: WooAnalyticsEvent.Orders.orderProductAdd(flow: .creation))
@@ -446,8 +446,8 @@ private extension NewOrderViewModel {
     /// Adds a selected product variation (from the product list) to the order.
     ///
     func addProductVariationToOrder(_ variation: ProductVariation) {
-        let newOrderItem = NewOrderItem(variation: variation, quantity: 1)
-        orderDetails.items.append(newOrderItem)
+        let input = OrderSyncProductInput(product: .variation(variation), quantity: 1)
+        orderSynchronizer.setProduct.send(input)
         configureProductRowViewModels()
 
         analytics.track(event: WooAnalyticsEvent.Orders.orderProductAdd(flow: .creation))
@@ -458,15 +458,16 @@ private extension NewOrderViewModel {
     func configureProductRowViewModels() {
         updateProductsResultsController()
         updateProductVariationsResultsController()
-        productRows = orderDetails.items.enumerated().compactMap { index, item in
+        productRows = orderSynchronizer.order.items.compactMap { item in
             guard let productRowViewModel = createProductRowViewModel(for: item, canChangeQuantity: true) else {
                 return nil
             }
 
             // Observe changes to the product quantity
             productRowViewModel.$quantity
                 .sink { [weak self] newQuantity in
-                    self?.orderDetails.items[index].quantity = newQuantity
+                    // TODO: Add update quantity support
+                    // self?.orderDetails.items[index].quantity = newQuantity
                 }
                 .store(in: &cancellables)
 
@@ -487,14 +488,14 @@ private extension NewOrderViewModel {
     /// Updates payment section view model based on items in the order.
     ///
     func configurePaymentDataViewModel() {
-        $orderDetails
-            .map { [weak self] orderDetails in
+        orderSynchronizer.orderPublisher
+            .map { [weak self] order in
                 guard let self = self else {
                     return PaymentDataViewModel()
                 }
 
-                let itemsTotal = orderDetails.items
-                    .map { $0.orderItem.subtotal }
+                let itemsTotal = order.items
+                    .map { $0.subtotal }
                     .compactMap { self.currencyFormatter.convertToDecimal(from: $0) }
                     .reduce(NSDecimalNumber(value: 0), { $0.adding($1) })
                     .stringValue
@@ -519,7 +520,7 @@ private extension NewOrderViewModel {
 
     /// Tracks when the create order button is tapped.
     ///
-    /// Warning: This methods assume that `orderDetails.items.count` is equal to the product count,
+    /// Warning: This methods assume that `orderSynchronizer.order.items.count` is equal to the product count,
     /// As the module evolves to handle more types of items, we need to update the property to something like `itemsCount`
     /// or figure out a better way to get the product count.
     ///

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

@@ -13,7 +13,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
 
     /// Unique ID for the view model.
     ///
-    let id: String
+    let id: Int64
 
     // MARK: Product properties
 
@@ -93,7 +93,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
     ///
     let numberOfVariations: Int
 
-    init(id: String? = nil,
+    init(id: Int64? = nil,
          productOrVariationID: Int64,
          name: String,
          sku: String?,
@@ -107,7 +107,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
          numberOfVariations: Int = 0,
          variationDisplayMode: VariationDisplayMode? = nil,
          currencyFormatter: CurrencyFormatter = CurrencyFormatter(currencySettings: ServiceLocator.currencySettings)) {
-        self.id = id ?? productOrVariationID.description
+        self.id = id ?? Int64(UUID().uuidString.hashValue)
         self.productOrVariationID = productOrVariationID
         self.name = name
         self.sku = sku
@@ -125,7 +125,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
 
     /// Initialize `ProductRowViewModel` with a `Product`
     ///
-    convenience init(id: String? = nil,
+    convenience init(id: Int64? = nil,
                      product: Product,
                      quantity: Decimal = 1,
                      canChangeQuantity: Bool,
@@ -155,7 +155,7 @@ final class ProductRowViewModel: ObservableObject, Identifiable {
 
     /// Initialize `ProductRowViewModel` with a `ProductVariation`
     ///
-    convenience init(id: String? = nil,
+    convenience init(id: Int64? = nil,
                      productVariation: ProductVariation,
                      name: String,
                      quantity: Decimal = 1,

WooCommerce/Classes/ViewRelated/Orders/Order Creation/Synchronizer/OrderSynchronizer.swift

@@ -19,7 +19,7 @@ struct OrderSyncProductInput {
         case product(Product)
         case variation(ProductVariation)
     }
-    var id: Int64 = Int64(UUID().uuidString.hashValue)
+    var id = Int64(UUID().uuidString.hashValue)
     let product: ProductType
     let quantity: Decimal
 }

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

@@ -163,10 +163,9 @@ class NewOrderViewModelTests: XCTestCase {
         // Then
         let expectedOrderItem = NewOrderViewModel.NewOrderItem(product: product, quantity: 1).orderItem
         XCTAssertTrue(viewModel.productRows.contains(where: { $0.productOrVariationID == sampleProductID }), "Product rows do not contain expected product")
-        XCTAssertTrue(viewModel.orderDetails.items.contains(where: { $0.orderItem == expectedOrderItem }), "Order details do not contain expected order item")
     }
 
-    func test_order_details_are_updated_when_product_quantity_changes() {
+    func test_order_details_are_updated_when_product_quantity_changes() throws {
         // Given
         let product = Product.fake().copy(siteID: sampleSiteID, productID: sampleProductID, purchasable: true)
         let storageManager = MockStorageManager()
@@ -181,12 +180,15 @@ class NewOrderViewModelTests: XCTestCase {
         viewModel.addProductViewModel.selectProduct(product.productID)
 
         // Then
+        throw XCTSkip("Test disabled while we enable update quantity support on OrderSynchronizer")
         let expectedOrderItem = NewOrderViewModel.NewOrderItem(product: product, quantity: 2).orderItem
         XCTAssertTrue(viewModel.orderDetails.items.contains(where: { $0.orderItem == expectedOrderItem }),
                       "Order details do not contain order item with updated quantity")
     }
 
-    func test_selectOrderItem_selects_expected_order_item() {
+    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()
@@ -202,7 +204,7 @@ class NewOrderViewModelTests: XCTestCase {
         XCTAssertEqual(viewModel.selectedOrderItem, expectedOrderItem)
     }
 
-    func test_view_model_is_updated_when_product_is_removed_from_order() {
+    func test_view_model_is_updated_when_product_is_removed_from_order() throws {
         // Given
         let product0 = Product.fake().copy(siteID: sampleSiteID, productID: 0, purchasable: true)
         let product1 = Product.fake().copy(siteID: sampleSiteID, productID: 1, purchasable: true)
@@ -215,6 +217,7 @@ 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])
 
@@ -231,8 +234,8 @@ class NewOrderViewModelTests: XCTestCase {
         let viewModel = NewOrderViewModel(siteID: sampleSiteID, storageManager: storageManager)
 
         // When
-        let newOrderItem = NewOrderViewModel.NewOrderItem(product: product, quantity: 1)
-        let productRow = viewModel.createProductRowViewModel(for: newOrderItem, canChangeQuantity: true)
+        let orderItem = OrderItem.fake().copy(name: product.name, productID: product.productID, quantity: 1)
+        let productRow = viewModel.createProductRowViewModel(for: orderItem, canChangeQuantity: true)
 
         // Then
         let expectedProductRow = ProductRowViewModel(product: product, canChangeQuantity: true)
@@ -254,8 +257,11 @@ class NewOrderViewModelTests: XCTestCase {
         let viewModel = NewOrderViewModel(siteID: sampleSiteID, storageManager: storageManager)
 
         // When
-        let newOrderItem = NewOrderViewModel.NewOrderItem(variation: productVariation, quantity: 2)
-        let productRow = viewModel.createProductRowViewModel(for: newOrderItem, canChangeQuantity: false)
+        let orderItem = OrderItem.fake().copy(name: product.name,
+                                              productID: product.productID,
+                                              variationID: productVariation.productVariationID,
+                                              quantity: 2)
+        let productRow = viewModel.createProductRowViewModel(for: orderItem, canChangeQuantity: false)
 
         // Then
         let expectedProductRow = ProductRowViewModel(productVariation: productVariation,
@@ -318,7 +324,7 @@ class NewOrderViewModelTests: XCTestCase {
         XCTAssertEqual(paymentDataViewModel.orderTotal, "£30.00")
     }
 
-    func test_payment_section_only_displayed_when_order_has_products() {
+    func test_payment_section_only_displayed_when_order_has_products() throws {
         // Given
         let product = Product.fake().copy(siteID: sampleSiteID, productID: sampleProductID, purchasable: true)
         let storageManager = MockStorageManager()
@@ -330,11 +336,12 @@ 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])
         XCTAssertFalse(viewModel.shouldShowPaymentSection)
     }
 
-    func test_payment_section_is_updated_when_products_update() {
+    func test_payment_section_is_updated_when_products_update() throws {
         // 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)
@@ -348,6 +355,7 @@ class NewOrderViewModelTests: XCTestCase {
         XCTAssertEqual(viewModel.paymentDataViewModel.orderTotal, "£8.50")
 
         // When & Then
+        throw XCTSkip("Test disabled while we enable update quantity support on OrderSynchronizer")
         viewModel.productRows[0].incrementQuantity()
         XCTAssertEqual(viewModel.paymentDataViewModel.itemsTotal, "£17.00")
         XCTAssertEqual(viewModel.paymentDataViewModel.orderTotal, "£17.00")

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

@@ -1,12 +1,13 @@
 import XCTest
 import Yosemite
+import Fakes
 @testable import WooCommerce
 
 class ProductRowViewModelTests: XCTestCase {
 
     func test_viewModel_is_created_with_correct_initial_values_from_product() {
         // Given
-        let rowID = "0"
+        let rowID = Int64(0)
         let imageURLString = "https://woo.com/woo.jpg"
         let product = Product.fake().copy(productID: 12,
                                           name: "Test Product",
@@ -38,7 +39,7 @@ class ProductRowViewModelTests: XCTestCase {
 
     func test_viewModel_is_created_with_correct_initial_values_from_product_variation() {
         // Given
-        let rowID = "0"
+        let rowID = Int64(0)
         let imageURLString = "https://woo.com/woo.jpg"
         let name = "Blue - Any Size"
         let productVariation = ProductVariation.fake().copy(productVariationID: 12,