Merge pull request #7463 from woocommerce/issue/fix-adding-products-bug

Urgent: Fix adding products on orders

Author: Ecarrion

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

@@ -171,9 +171,9 @@ final class EditableOrderViewModel: ObservableObject {
         ProductSelectorViewModel(siteID: siteID, purchasableItemsOnly: true, storageManager: storageManager, stores: stores) { [weak self] product in
             guard let self = self else { return }
             self.addProductToOrder(product)
-        } onVariationSelected: { [weak self] variation in
+        } onVariationSelected: { [weak self] variation, parentProduct in
             guard let self = self else { return }
-            self.addProductVariationToOrder(variation)
+            self.addProductVariationToOrder(variation, parent: parentProduct)
         }
     }()
 
@@ -654,6 +654,7 @@ private extension EditableOrderViewModel {
     /// Adds a selected product (from the product list) to the order.
     ///
     func addProductToOrder(_ product: Product) {
+        // Needed because `allProducts` is only updated at start, so product from new pages are not synced.
         if !allProducts.contains(product) {
             allProducts.append(product)
         }
@@ -666,7 +667,12 @@ private extension EditableOrderViewModel {
 
     /// Adds a selected product variation (from the product list) to the order.
     ///
-    func addProductVariationToOrder(_ variation: ProductVariation) {
+    func addProductVariationToOrder(_ variation: ProductVariation, parent product: Product) {
+        // Needed because `allProducts` is only updated at start, so product from new pages are not synced.
+        if !allProducts.contains(product) {
+            allProducts.append(product)
+        }
+
         if !allProductVariations.contains(variation) {
             allProductVariations.append(variation)
         }

WooCommerce/Classes/ViewRelated/Products/ProductSelector/ProductSelectorViewModel.swift

@@ -71,7 +71,7 @@ final class ProductSelectorViewModel: ObservableObject {
 
     /// Closure to be invoked when a product variation is selected
     ///
-    private let onVariationSelected: ((ProductVariation) -> Void)?
+    private let onVariationSelected: ((ProductVariation, Product) -> Void)?
 
     /// Closure to be invoked when multiple selection is completed
     ///
@@ -146,7 +146,7 @@ final class ProductSelectorViewModel: ObservableObject {
          storageManager: StorageManagerType = ServiceLocator.storageManager,
          stores: StoresManager = ServiceLocator.stores,
          onProductSelected: ((Product) -> Void)? = nil,
-         onVariationSelected: ((ProductVariation) -> Void)? = nil) {
+         onVariationSelected: ((ProductVariation, Product) -> Void)? = nil) {
         self.siteID = siteID
         self.storageManager = storageManager
         self.stores = stores

WooCommerce/Classes/ViewRelated/Products/ProductSelector/ProductVariationSelectorViewModel.swift

@@ -51,7 +51,7 @@ final class ProductVariationSelectorViewModel: ObservableObject {
 
     /// Closure to be invoked when a product variation is selected
     ///
-    let onVariationSelected: ((ProductVariation) -> Void)?
+    let onVariationSelected: ((ProductVariation, Product) -> Void)?
 
     /// All selected product variations if the selector supports multiple selections.
     ///
@@ -79,6 +79,15 @@ final class ProductVariationSelectorViewModel: ObservableObject {
         }
     }
 
+    /// Product Result Controller.
+    /// Used the retrieve the parent product upon selecting a variation.
+    ///
+    private lazy var productResultsController: ResultsController<StorageProduct> = {
+        let predicate = NSPredicate(format: "siteID == %lld AND productID == %lld", siteID, productID)
+        let resultsController = ResultsController<StorageProduct>(storageManager: storageManager, matching: predicate, sortedBy: [])
+        return resultsController
+    }()
+
     /// Product Variations Results Controller.
     ///
     private lazy var productVariationsResultsController: ResultsController<StorageProductVariation> = {
@@ -103,7 +112,7 @@ final class ProductVariationSelectorViewModel: ObservableObject {
          purchasableItemsOnly: Bool = false,
          storageManager: StorageManagerType = ServiceLocator.storageManager,
          stores: StoresManager = ServiceLocator.stores,
-         onVariationSelected: ((ProductVariation) -> Void)? = nil) {
+         onVariationSelected: ((ProductVariation, Product) -> Void)? = nil) {
         self.siteID = siteID
         self.productID = productID
         self.productName = productName
@@ -125,7 +134,7 @@ final class ProductVariationSelectorViewModel: ObservableObject {
                      purchasableItemsOnly: Bool = false,
                      storageManager: StorageManagerType = ServiceLocator.storageManager,
                      stores: StoresManager = ServiceLocator.stores,
-                     onVariationSelected: ((ProductVariation) -> Void)? = nil) {
+                     onVariationSelected: ((ProductVariation, Product) -> Void)? = nil) {
         self.init(siteID: siteID,
                   productID: product.productID,
                   productName: product.name,
@@ -140,11 +149,18 @@ final class ProductVariationSelectorViewModel: ObservableObject {
     /// Select a product variation to add to the order
     ///
     func selectVariation(_ variationID: Int64) {
-        guard let selectedVariation = productVariations.first(where: { $0.productVariationID == variationID }) else {
+
+        // Fetch parent product
+        // Needed because the parent product contains the product name & attributes.
+        try? productResultsController.performFetch()
+
+        guard let parentProduct = productResultsController.fetchedObjects.first,
+              let selectedVariation = productVariations.first(where: { $0.productVariationID == variationID }) else {
             return
         }
+
         if let onVariationSelected = onVariationSelected {
-            onVariationSelected(selectedVariation)
+            onVariationSelected(selectedVariation, parentProduct)
         } else {
             toggleSelection(productVariationID: variationID)
         }

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

@@ -208,26 +208,35 @@ final class ProductVariationSelectorViewModelTests: XCTestCase {
     func test_selectVariation_invokes_onVariationSelected_closure_for_existing_variation() {
         // Given
         var selectedVariationID: Int64?
-        let product = Product.fake().copy(productID: sampleProductID)
+        var selectedProductID: Int64?
+
+        let product = Product.fake().copy(siteID: sampleSiteID, productID: sampleProductID)
         let productVariation = sampleProductVariation.copy(productVariationID: 1)
         insert(productVariation)
+        insert(product)
+
         let viewModel = ProductVariationSelectorViewModel(siteID: sampleSiteID,
                                                             product: product,
                                                             storageManager: storageManager,
-                                                            onVariationSelected: { selectedVariationID = $0.productVariationID })
+                                                            onVariationSelected: { variation, product in
+            selectedVariationID = variation.productVariationID
+            selectedProductID = product.productID
+        })
 
         // When
         viewModel.selectVariation(productVariation.productVariationID)
 
         // Then
         XCTAssertEqual(selectedVariationID, productVariation.productVariationID)
+        XCTAssertEqual(selectedProductID, product.productID)
     }
 
     func test_selecting_a_variation_set_its_row_to_selected() {
         // Given
-        let product = Product.fake().copy(productID: sampleProductID)
+        let product = Product.fake().copy(siteID: sampleSiteID, productID: sampleProductID)
         let productVariation = sampleProductVariation.copy(productVariationID: 1)
         insert(productVariation)
+        insert(product)
         let viewModel = ProductVariationSelectorViewModel(siteID: sampleSiteID,
                                                           product: product,
                                                           storageManager: storageManager)
@@ -243,9 +252,10 @@ final class ProductVariationSelectorViewModelTests: XCTestCase {
 
     func test_clearSelection_unselects_previously_selected_rows() {
         // Given
-        let product = Product.fake().copy(productID: sampleProductID)
+        let product = Product.fake().copy(siteID: sampleSiteID, productID: sampleProductID)
         let productVariation = sampleProductVariation.copy(productVariationID: 1)
         insert(productVariation)
+        insert(product)
         let viewModel = ProductVariationSelectorViewModel(siteID: sampleSiteID,
                                                           product: product,
                                                           storageManager: storageManager)
@@ -280,6 +290,12 @@ private extension ProductVariationSelectorViewModelTests {
         productVariation.attributes = NSOrderedSet(array: storageAttributes)
     }
 
+    /// Insert a `Product` into storage.
+    func insert(_ readOnlyProduct: Yosemite.Product) {
+        let product = storage.insertNewObject(ofType: StorageProduct.self)
+        product.update(with: readOnlyProduct)
+    }
+
     /// Insert an array of `ProductVariation`s into storage
     func insert(_ readOnlyVariations: [Yosemite.ProductVariation]) {
         for readOnlyVariation in readOnlyVariations {