Merge pull request #7727 from woocommerce/issue/7255-duplicate-product

itsmeichigo · web-flow · commit 43cbf2672ba3 · 2022-09-19T15:11:57.000+07:00
Products: Add duplicate product feature
diff --git a/WooCommerce/Classes/Analytics/WooAnalyticsStat.swift b/WooCommerce/Classes/Analytics/WooAnalyticsStat.swift
@@ -407,6 +407,10 @@ public enum WooAnalyticsStat: String {
     case addProductSuccess = "add_product_success"
     case addProductFailed = "add_product_failed"
 
+    // MARK: Duplicate Product events
+    case duplicateProductSuccess = "duplicate_product_success"
+    case duplicateProductFailed = "duplicate_product_failed"
+
     // MARK: Edit Product Events
     //
     case productDetailLoaded = "product_detail_loaded"
@@ -512,6 +516,7 @@ public enum WooAnalyticsStat: String {
     // MARK: Product Settings
     //
     case productDetailViewSettingsButtonTapped = "product_detail_view_settings_button_tapped"
+    case productDetailDuplicateButtonTapped = "product_detail_duplicate_button_tapped"
     case productSettingsDoneButtonTapped = "product_settings_done_button_tapped"
     case productSettingsStatusTapped = "product_settings_status_tapped"
     case productSettingsVisibilityTapped = "product_settings_visibility_tapped"
diff --git a/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormRemoteActionUseCase.swift b/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormRemoteActionUseCase.swift
@@ -10,6 +10,7 @@ final class ProductFormRemoteActionUseCase {
     }
     typealias AddProductCompletion = (_ result: Result<ResultData, ProductUpdateError>) -> Void
     typealias EditProductCompletion = (_ productResult: Result<ResultData, ProductUpdateError>) -> Void
+    typealias DuplicateProductCompletion = (_ result: Result<ResultData, ProductUpdateError>) -> Void
 
     private let stores: StoresManager
 
@@ -24,28 +25,80 @@ final class ProductFormRemoteActionUseCase {
     ///   - onCompletion: Called when the remote process finishes.
     func addProduct(product: EditableProductModel,
                     password: String?,
+                    successEventName: WooAnalyticsStat = .addProductSuccess,
+                    failureEventName: WooAnalyticsStat = .addProductFailed,
                     onCompletion: @escaping AddProductCompletion) {
         addProductRemotely(product: product) { productResult in
             switch productResult {
             case .failure(let error):
-                ServiceLocator.analytics.track(.addProductFailed, withError: error)
+                ServiceLocator.analytics.track(failureEventName, withError: error)
                 onCompletion(.failure(error))
             case .success(let product):
                 // `self` is retained because the use case is not usually strongly held.
                 self.updatePasswordRemotely(product: product, password: password) { passwordResult in
                     switch passwordResult {
                     case .failure(let error):
-                        ServiceLocator.analytics.track(.addProductFailed, withError: error)
+                        ServiceLocator.analytics.track(failureEventName, withError: error)
                         onCompletion(.failure(.passwordCannotBeUpdated))
                     case .success(let password):
-                        ServiceLocator.analytics.track(.addProductSuccess)
+                        ServiceLocator.analytics.track(successEventName)
                         onCompletion(.success(ResultData(product: product, password: password)))
                     }
                 }
             }
         }
     }
 
+    /// Adds a copy of the input product remotely. The new product will have an updated name, no SKU and its status will be Draft.
+    /// - Parameters:
+    ///   - originalProduct: The product to be duplicated remotely.
+    ///   - onCompletion: Called when the remote process finishes.
+    func duplicateProduct(originalProduct: EditableProductModel,
+                          password: String?,
+                          onCompletion: @escaping DuplicateProductCompletion) {
+        let productModelToSave: EditableProductModel = {
+            let newName = String(format: Localization.copyProductName, originalProduct.name)
+            let copiedProduct = originalProduct.product.copy(
+                productID: 0,
+                name: newName,
+                statusKey: ProductStatus.draft.rawValue,
+                sku: .some(nil) // just resetting SKU to nil for simplicity
+            )
+            return EditableProductModel(product: copiedProduct)
+        }()
+
+        let successEventName: WooAnalyticsStat = .duplicateProductSuccess
+        let failureEventName: WooAnalyticsStat = .duplicateProductFailed
+
+        addProduct(product: productModelToSave,
+                   password: password,
+                   successEventName: successEventName,
+                   failureEventName: failureEventName) { result in
+            switch result {
+            case .success(let data):
+                guard data.product.productType == .variable else {
+                    return onCompletion(.success(data))
+                }
+                // `self` is retained because the use case is not usually strongly held.
+                self.duplicateVariations(originalProduct.product.variations,
+                                         from: originalProduct.productID,
+                                         to: data.product,
+                                         onCompletion: { result in
+                    switch result {
+                    case .success(let product):
+                        ServiceLocator.analytics.track(successEventName)
+                        onCompletion(.success(ResultData(product: product, password: data.password)))
+                    case .failure(let error):
+                        ServiceLocator.analytics.track(failureEventName, withError: error)
+                        onCompletion(.failure(error))
+                    }
+                })
+            case .failure(let error):
+                onCompletion(.failure(error))
+            }
+        }
+    }
+
     /// Edits a product and its password remotely.
     /// - Parameters:
     ///   - product: The product to be updated remotely.
@@ -205,4 +258,96 @@ private extension ProductFormRemoteActionUseCase {
         }
         stores.dispatch(passwordUpdateAction)
     }
+
+    func duplicateVariations(_ variationIDs: [Int64],
+                             from oldProductID: Int64,
+                             to newProduct: EditableProductModel,
+                             onCompletion: @escaping (Result<EditableProductModel, ProductUpdateError>) -> Void) {
+        Task { [weak self] in
+            guard let self = self else { return }
+            // Retrieves and duplicate product variations
+            await withTaskGroup(of: Void.self, body: { group in
+                for id in variationIDs {
+                    group.addTask {
+                        guard let variation = await self.retrieveProductVariation(variationID: id, siteID: newProduct.siteID, productID: oldProductID) else {
+                            return
+                        }
+                        let newVariation = CreateProductVariation(regularPrice: variation.regularPrice ?? "", attributes: variation.attributes)
+                        await self.duplicateProductVariation(newVariation, parent: newProduct)
+                    }
+                }
+            })
+
+            // Fetches the updated product and return
+            do {
+                let productModel = try await retrieveProduct(id: newProduct.productID, siteID: newProduct.siteID)
+                await MainActor.run {
+                    let updatedProduct = EditableProductModel(product: productModel)
+                    onCompletion(.success(updatedProduct))
+                }
+            } catch let error {
+                await MainActor.run {
+                    onCompletion(.failure(.unknown(error: AnyError(error))))
+                }
+            }
+        }
+    }
+
+    func retrieveProduct(id: Int64, siteID: Int64) async throws -> Product {
+        try await withCheckedThrowingContinuation { [weak self] continuation in
+            let action = ProductAction.retrieveProduct(siteID: siteID, productID: id) { result in
+                switch result {
+                case .success(let product):
+                    continuation.resume(returning: product)
+                case .failure(let error):
+                    continuation.resume(throwing: error)
+                }
+            }
+            DispatchQueue.main.async { [weak self] in
+                self?.stores.dispatch(action)
+            }
+        } as Product
+    }
+
+    func retrieveProductVariation(variationID: Int64, siteID: Int64, productID: Int64) async -> ProductVariation? {
+        await withCheckedContinuation { [weak self] continuation in
+            let action = ProductVariationAction.retrieveProductVariation(siteID: siteID,
+                                                                         productID: productID,
+                                                                         variationID: variationID,
+                                                                         onCompletion: { result in
+                switch result {
+                case .success(let variation):
+                    continuation.resume(returning: variation)
+                case .failure:
+                    continuation.resume(returning: nil)
+                }
+            })
+            DispatchQueue.main.async { [weak self] in
+                self?.stores.dispatch(action)
+            }
+        } as ProductVariation?
+    }
+
+    func duplicateProductVariation(_ newVariation: CreateProductVariation, parent: EditableProductModel) async {
+        await withCheckedContinuation { [weak self] continuation in
+            let createAction = ProductVariationAction.createProductVariation(
+                siteID: parent.siteID,
+                productID: parent.productID,
+                newVariation: newVariation) { result in
+                continuation.resume(returning: ())
+            }
+            DispatchQueue.main.async { [weak self] in
+                self?.stores.dispatch(createAction)
+            }
+        } as Void
+    }
+}
+
+private extension ProductFormRemoteActionUseCase {
+    enum Localization {
+        static let copyProductName = NSLocalizedString(
+            "%1$@ Copy",
+            comment: "The default name for a duplicated product, with %1$@ being the original name. Reads like: Ramen Copy"
+        )
+    }
 }
diff --git a/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewController+Helpers.swift b/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewController+Helpers.swift
@@ -35,14 +35,15 @@ extension ProductFormViewController {
     }
     /// Product Confirmation Save alert
     ///
-    func presentProductConfirmationSaveAlert() {
+    func presentProductConfirmationSaveAlert(title: String = Localization.Alert.presentProductConfirmationSaveAlert) {
         let contextNoticePresenter: NoticePresenter = {
             let noticePresenter = DefaultNoticePresenter()
             noticePresenter.presentingViewController = self
             return noticePresenter
         }()
-        contextNoticePresenter.enqueue(notice: .init(title: Localization.Alert.presentProductConfirmationSaveAlert))
+        contextNoticePresenter.enqueue(notice: .init(title: title))
     }
+
     /// Product Confirmation Delete alert
     ///
     func presentProductConfirmationDeleteAlert(completion: @escaping (_ isConfirmed: Bool) -> ()) {
@@ -93,6 +94,8 @@ extension ProductFormViewController {
             displayInProgressView(title: Localization.ProgressView.productSavingTitle, message: Localization.ProgressView.productSavingMessage)
         case .saveVariation:
             displayInProgressView(title: Localization.ProgressView.productVariationTitle, message: Localization.ProgressView.productVariationMessage)
+        case .duplicate:
+            displayInProgressView(title: Localization.ProgressView.productDuplicatingTitle, message: Localization.ProgressView.productDuplicatingMessage)
         }
     }
 
@@ -124,6 +127,7 @@ private enum Localization {
         // Product saved or updated
         static let presentProductConfirmationSaveAlert = NSLocalizedString("Product saved",
                                                                            comment: "Title of the alert when a user is saving a product")
+
         // Product type change
         static let productTypeChangeTitle = NSLocalizedString("Are you sure you want to change the product type?",
                                                               comment: "Title of the alert when a user is changing the product type")
@@ -170,6 +174,11 @@ private enum Localization {
         static let productSavingMessage = NSLocalizedString("Please wait while we save this product to your store",
                                                             comment: "Message of the in-progress UI while saving a Product as draft remotely")
 
+        static let productDuplicatingTitle = NSLocalizedString("Duplicating your product...",
+                                                               comment: "Title of the in-progress UI while duplicating a Product remotely")
+        static let productDuplicatingMessage = NSLocalizedString("Please wait while we save a copy of this product to your store",
+                                                                 comment: "Message of the in-progress UI while duplicating a Product as draft remotely")
+
         static let productDeletionTitle = NSLocalizedString("Placing your product in the trash...",
                                                             comment: "Title of the in-progress UI while deleting the Product remotely")
         static let productDeletionMessage = NSLocalizedString("Please wait while we update your store details",
diff --git a/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewController.swift b/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewController.swift
@@ -251,6 +251,13 @@ final class ProductFormViewController<ViewModel: ProductFormViewModelProtocol>:
             }
         }
 
+        if viewModel.canDuplicateProduct() {
+            actionSheet.addDefaultActionWithTitle(ActionSheetStrings.duplicate) { [weak self] _ in
+                ServiceLocator.analytics.track(.productDetailDuplicateButtonTapped)
+                self?.duplicateProduct()
+            }
+        }
+
         if viewModel.canDeleteProduct() {
             actionSheet.addDestructiveActionWithTitle(ActionSheetStrings.delete) { [weak self] _ in
                 self?.displayDeleteProductAlert()
@@ -738,11 +745,8 @@ private extension ProductFormViewController {
         }
     }
 
-    func displayError(error: ProductUpdateError?) {
-        let title = NSLocalizedString("Cannot update product", comment: "The title of the alert when there is an error updating the product")
-
+    func displayError(error: ProductUpdateError?, title: String = Localization.updateProductError) {
         let message = error?.errorDescription
-
         displayErrorAlert(title: title, message: message)
     }
 
@@ -774,6 +778,27 @@ private extension ProductFormViewController {
         SharingHelper.shareURL(url: url, title: product.name, from: view, in: self)
     }
 
+    func duplicateProduct() {
+        showSavingProgress(.duplicate)
+        viewModel.duplicateProduct(onCompletion: { [weak self] result in
+            switch result {
+            case .failure(let error):
+                DDLogError("⛔️ Error duplicating Product: \(error)")
+
+                // Dismisses the in-progress UI then presents the error alert.
+                self?.navigationController?.dismiss(animated: true) {
+                    self?.displayError(error: error, title: Localization.duplicateProductError)
+                }
+            case .success:
+                // Dismisses the in-progress UI, then presents the confirmation alert.
+                self?.navigationController?.dismiss(animated: true) {
+                    let alertTitle =  Localization.presentProductCopiedAlert
+                    self?.presentProductConfirmationSaveAlert(title: alertTitle)
+                }
+            }
+        })
+    }
+
     func displayDeleteProductAlert() {
         let showVariationsText = viewModel is ProductVariationFormViewModel
         if showVariationsText {
@@ -1519,6 +1544,12 @@ private enum Localization {
         let titleFormat = NSLocalizedString("Variation #%1$@", comment: "Navigation bar title for variation. Parameters: %1$@ - Product variation ID")
         return String.localizedStringWithFormat(titleFormat, variationID)
     }
+    static let updateProductError = NSLocalizedString("Cannot update product", comment: "The title of the alert when there is an error updating the product")
+    static let duplicateProductError = NSLocalizedString(
+        "Cannot duplicate product",
+        comment: "The title of the alert when there is an error duplicating the product"
+    )
+    static let presentProductCopiedAlert = NSLocalizedString("Product copied", comment: "Title of the alert when a user has copied a product")
 }
 
 private enum ActionSheetStrings {
@@ -1530,6 +1561,7 @@ private enum ActionSheetStrings {
     static let delete = NSLocalizedString("Delete", comment: "Button title Delete in Edit Product More Options Action Sheet")
     static let productSettings = NSLocalizedString("Product Settings", comment: "Button title Product Settings in Edit Product More Options Action Sheet")
     static let cancel = NSLocalizedString("Cancel", comment: "Button title Cancel in Edit Product More Options Action Sheet")
+    static let duplicate = NSLocalizedString("Duplicate", comment: "Button title to duplicate a product in Product More Options Action Sheet")
 }
 
 private enum Constants {
diff --git a/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewModel.swift b/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewModel.swift
@@ -246,6 +246,10 @@ extension ProductFormViewModel {
     func canDeleteProduct() -> Bool {
         formType == .edit
     }
+
+    func canDuplicateProduct() -> Bool {
+        formType == .edit
+    }
 }
 
 // MARK: Action handling
@@ -457,6 +461,22 @@ extension ProductFormViewModel {
         }
     }
 
+    func duplicateProduct(onCompletion: @escaping (Result<ProductModel, ProductUpdateError>) -> Void) {
+        let remoteActionUseCase = ProductFormRemoteActionUseCase()
+        remoteActionUseCase.duplicateProduct(originalProduct: product,
+                                             password: password) { [weak self] result in
+            guard let self = self else { return }
+            switch result {
+            case .failure(let error):
+                onCompletion(.failure(error))
+            case .success(let data):
+                self.resetProduct(data.product)
+                self.resetPassword(data.password)
+                onCompletion(.success(data.product))
+            }
+        }
+    }
+
     func deleteProductRemotely(onCompletion: @escaping (Result<Void, ProductUpdateError>) -> Void) {
         let remoteActionUseCase = ProductFormRemoteActionUseCase()
         remoteActionUseCase.deleteProduct(product: product) { result in
diff --git a/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewModelProtocol.swift b/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductFormViewModelProtocol.swift
@@ -20,6 +20,7 @@ enum SaveMessageType {
     case publish
     case save
     case saveVariation
+    case duplicate
 }
 
 
@@ -79,6 +80,8 @@ protocol ProductFormViewModelProtocol {
 
     func canDeleteProduct() -> Bool
 
+    func canDuplicateProduct() -> Bool
+
     // Update actions
 
     func updateName(_ name: String)
@@ -137,6 +140,8 @@ protocol ProductFormViewModelProtocol {
 
     func deleteProductRemotely(onCompletion: @escaping (Result<Void, ProductUpdateError>) -> Void)
 
+    func duplicateProduct(onCompletion: @escaping (Result<ProductModel, ProductUpdateError>) -> Void)
+
     // Reset action
 
     func resetPassword(_ password: String?)
diff --git a/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductVariationFormViewModel.swift b/WooCommerce/Classes/ViewRelated/Products/Edit Product/ProductVariationFormViewModel.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Products/Edit Product/ProductFormRemoteActionUseCaseTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Products/Edit Product/ProductFormRemoteActionUseCaseTests.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Products/Edit Product/ProductFormViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Products/Edit Product/ProductFormViewModelTests.swift
