Merge pull request #7138 from woocommerce/issue/6961-refactor-new-order-flow-2

[Unified Order Editing] Refactor Order Creation form

Author: ealeksandrov

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

@@ -3,10 +3,10 @@ import SwiftUI
 struct CustomerNoteSection: View {
 
     /// Parent view model to access all data
-    @ObservedObject var viewModel: NewOrderViewModel
+    @ObservedObject var viewModel: EditableOrderViewModel
 
     /// View model to drive the view content
-    private var notesDataViewModel: NewOrderViewModel.CustomerNoteDataViewModel {
+    private var notesDataViewModel: EditableOrderViewModel.CustomerNoteDataViewModel {
         viewModel.customerNoteDataViewModel
     }
 
@@ -35,7 +35,7 @@ struct CustomerNoteSection: View {
 
 private struct CustomerNoteSectionContent: View {
     /// View model to drive the view content
-    var viewModel: NewOrderViewModel.CustomerNoteDataViewModel
+    var viewModel: EditableOrderViewModel.CustomerNoteDataViewModel
 
     @Binding var showEditNotesView: Bool
 
@@ -117,8 +117,8 @@ private extension CustomerNoteSectionContent {
 
 struct CustomerNoteSection_Previews: PreviewProvider {
     static var previews: some View {
-        let emptyViewModel = NewOrderViewModel.CustomerNoteDataViewModel(customerNote: "")
-        let notesViewModel = NewOrderViewModel.CustomerNoteDataViewModel(customerNote: "some notes")
+        let emptyViewModel = EditableOrderViewModel.CustomerNoteDataViewModel(customerNote: "")
+        let notesViewModel = EditableOrderViewModel.CustomerNoteDataViewModel(customerNote: "some notes")
 
         ScrollView {
             CustomerNoteSectionContent(viewModel: emptyViewModel, showEditNotesView: .constant(false))

…tion/NewOrderCustomerNoteViewModel.swift …ion/OrderFormCustomerNoteViewModel.swiftWooCommerce/Classes/ViewRelated/Orders/Order Creation/CustomerNoteSection/NewOrderCustomerNoteViewModel.swift renamed to WooCommerce/Classes/ViewRelated/Orders/Order Creation/CustomerNoteSection/OrderFormCustomerNoteViewModel.swift WooCommerce/Classes/ViewRelated/Orders/Order Creation/CustomerNoteSection/NewOrderCustomerNoteViewModel.swift renamed to WooCommerce/Classes/ViewRelated/Orders/Order Creation/CustomerNoteSection/OrderFormCustomerNoteViewModel.swift

@@ -1,7 +1,7 @@
 import Foundation
 import Combine
 
-class NewOrderCustomerNoteViewModel: EditCustomerNoteViewModelProtocol {
+class OrderFormCustomerNoteViewModel: EditCustomerNoteViewModelProtocol {
     /// Store for the edited content
     ///
     @Published var newNote: String

WooCommerce/Classes/ViewRelated/Orders/Order Creation/CustomerSection/OrderCustomerSection.swift

@@ -5,7 +5,7 @@ import SwiftUI
 struct OrderCustomerSection: View {
 
     /// Parent view model to access all data
-    @ObservedObject var viewModel: NewOrderViewModel
+    @ObservedObject var viewModel: EditableOrderViewModel
 
     /// View model for the address form.
     ///
@@ -33,7 +33,7 @@ struct OrderCustomerSection: View {
 private struct OrderCustomerSectionContent: View {
 
     /// View model to drive the view content
-    var viewModel: NewOrderViewModel.CustomerDataViewModel
+    var viewModel: EditableOrderViewModel.CustomerDataViewModel
 
     @Binding var showAddressForm: Bool
 
@@ -138,8 +138,8 @@ private extension OrderCustomerSectionContent {
 @available(iOS 15.0, *)
 struct OrderCustomerSection_Previews: PreviewProvider {
     static var previews: some View {
-        let emptyViewModel = NewOrderViewModel.CustomerDataViewModel(billingAddress: nil, shippingAddress: nil)
-        let addressViewModel = NewOrderViewModel.CustomerDataViewModel(fullName: "Johnny Appleseed",
+        let emptyViewModel = EditableOrderViewModel.CustomerDataViewModel(billingAddress: nil, shippingAddress: nil)
+        let addressViewModel = EditableOrderViewModel.CustomerDataViewModel(fullName: "Johnny Appleseed",
                                                                        billingAddressFormatted: nil,
                                                                        shippingAddressFormatted: """
                                                                             Johnny Appleseed

…s/Order Creation/NewOrderViewModel.swift …er Creation/EditableOrderViewModel.swiftWooCommerce/Classes/ViewRelated/Orders/Order Creation/NewOrderViewModel.swift renamed to WooCommerce/Classes/ViewRelated/Orders/Order Creation/EditableOrderViewModel.swift WooCommerce/Classes/ViewRelated/Orders/Order Creation/NewOrderViewModel.swift renamed to WooCommerce/Classes/ViewRelated/Orders/Order Creation/EditableOrderViewModel.swift

@@ -5,9 +5,9 @@ import Experiments
 import WooFoundation
 import enum Networking.DotcomError
 
-/// View model for `NewOrder`.
+/// View model used in Order Creation and Editing flows.
 ///
-final class NewOrderViewModel: ObservableObject {
+final class EditableOrderViewModel: ObservableObject {
     let siteID: Int64
     private let stores: StoresManager
     private let storageManager: StorageManagerType
@@ -188,7 +188,7 @@ final class NewOrderViewModel: ObservableObject {
 
     /// View model for the customer note section.
     ///
-    lazy private(set) var noteViewModel = { NewOrderCustomerNoteViewModel(originalNote: "") }()
+    lazy private(set) var noteViewModel = { OrderFormCustomerNoteViewModel(originalNote: "") }()
 
     // MARK: Payment properties
 
@@ -357,6 +357,12 @@ final class NewOrderViewModel: ObservableObject {
         trackCreateButtonTapped()
     }
 
+    /// Action triggered on `Done` button tap in order editing flow.
+    ///
+    func finishEditing() {
+        self.onFinished(orderSynchronizer.order)
+    }
+
     /// Assign this closure to be notified when the flow has finished.
     /// For creation it means that the order has been created.
     /// For edition it means that the merchant has finished editing the order.
@@ -392,7 +398,7 @@ final class NewOrderViewModel: ObservableObject {
 }
 
 // MARK: - Types
-extension NewOrderViewModel {
+extension EditableOrderViewModel {
     /// Representation of possible navigation bar trailing buttons
     ///
     enum NavigationItem: Equatable {
@@ -528,7 +534,7 @@ extension NewOrderViewModel {
 }
 
 // MARK: - Helpers
-private extension NewOrderViewModel {
+private extension EditableOrderViewModel {
 
     /// Sets the view to be `disabled` when `performingNetworkRequest` or when `statePublisher` is `.syncing(blocking: true)`
     ///
@@ -573,9 +579,9 @@ private extension NewOrderViewModel {
                 guard let self = self else { return nil }
                 switch state {
                 case .error(let error):
-                    DDLogError("⛔️ Error syncing new order remotely: \(error)")
+                    DDLogError("⛔️ Error syncing order remotely: \(error)")
                     self.trackSyncOrderFailure(error: error)
-                    return NoticeFactory.syncOrderErrorNotice(error, with: self.orderSynchronizer)
+                    return NoticeFactory.syncOrderErrorNotice(error, flow: self.flow, with: self.orderSynchronizer)
                 default:
                     return nil
                 }
@@ -829,15 +835,15 @@ private extension NewOrderViewModel {
     }
 }
 
-private extension NewOrderViewModel {
+private extension EditableOrderViewModel {
     /// Fetches products from storage.
     ///
     func updateProductsResultsController() {
         do {
             try productsResultsController.performFetch()
             allProducts = productsResultsController.fetchedObjects
         } catch {
-            DDLogError("⛔️ Error fetching products for new order: \(error)")
+            DDLogError("⛔️ Error fetching products for order: \(error)")
         }
     }
 
@@ -848,16 +854,15 @@ private extension NewOrderViewModel {
             try productVariationsResultsController.performFetch()
             allProductVariations = productVariationsResultsController.fetchedObjects
         } catch {
-            DDLogError("⛔️ Error fetching product variations for new order: \(error)")
+            DDLogError("⛔️ Error fetching product variations for order: \(error)")
         }
     }
 }
 
 // MARK: Constants
 
-extension NewOrderViewModel {
-    /// New Order notices
-    ///
+extension EditableOrderViewModel {
+
     enum NoticeFactory {
         /// Returns a default order creation error notice.
         ///
@@ -870,11 +875,20 @@ extension NewOrderViewModel {
 
         /// Returns an order sync error notice.
         ///
-        static func syncOrderErrorNotice(_ error: Error, with orderSynchronizer: OrderSynchronizer) -> Notice {
+        static func syncOrderErrorNotice(_ error: Error, flow: Flow, with orderSynchronizer: OrderSynchronizer) -> Notice {
             guard !isEmailError(error, order: orderSynchronizer.order) else {
                 return Notice(title: Localization.invalidBillingParameters, message: Localization.invalidBillingSuggestion, feedbackType: .error)
             }
-            return Notice(title: Localization.errorMessageOrderSync, feedbackType: .error, actionTitle: Localization.retryOrderSync) {
+
+            let errorMessage: String
+            switch flow {
+            case .creation:
+                errorMessage = Localization.errorMessageNewOrderSync
+            case .editing:
+                errorMessage = Localization.errorMessageEditOrderSync
+            }
+
+            return Notice(title: errorMessage, feedbackType: .error, actionTitle: Localization.retryOrderSync) {
                 orderSynchronizer.retryTrigger.send()
             }
         }
@@ -893,18 +907,24 @@ extension NewOrderViewModel {
     }
 }
 
-private extension NewOrderViewModel {
+private extension EditableOrderViewModel {
     enum Localization {
         static let titleForNewOrder = NSLocalizedString("New Order", comment: "Title for the order creation screen")
         static let titleWithOrderNumber = NSLocalizedString("Order #%1$@", comment: "Order number title. Parameters: %1$@ - order number")
-        static let errorMessageOrderCreation = NSLocalizedString("Unable to create new order", comment: "Notice displayed when order creation fails")
-        static let errorMessageOrderSync = NSLocalizedString("Unable to load taxes for order",
-                                                             comment: "Notice displayed when taxes cannot be synced for new order")
+        static let errorMessageOrderCreation = NSLocalizedString("Unable to create new order",
+                                                                 comment: "Notice displayed when order creation fails")
+        static let errorMessageNewOrderSync = NSLocalizedString("Unable to load taxes for order",
+                                                                comment: "Notice displayed when data cannot be synced for new order")
+        static let errorMessageEditOrderSync = NSLocalizedString("Unable to save changes. Please try again.",
+                                                                 comment: "Notice displayed when data cannot be synced for edited order")
+
         static let retryOrderSync = NSLocalizedString("Retry", comment: "Action button to retry syncing the draft order")
 
-        static let invalidBillingParameters = NSLocalizedString("Unable to set customer details.",
-                                                                comment: "Error notice title when we fail to update an address when creating an order.")
-        static let invalidBillingSuggestion = NSLocalizedString("Please make sure you are running the latest version of WooCommerce and try again later.",
-                                                                comment: "Recovery suggestion when we fail to update an address when creating an order")
+        static let invalidBillingParameters =
+        NSLocalizedString("Unable to set customer details.",
+                          comment: "Error notice title when we fail to update an address when creating or editing an order.")
+        static let invalidBillingSuggestion =
+        NSLocalizedString("Please make sure you are running the latest version of WooCommerce and try again later.",
+                          comment: "Recovery suggestion when we fail to update an address when creating or editing an order")
     }
 }

WooCommerce/Classes/ViewRelated/Orders/Order Creation/FlowCoordinator/AddOrderCoordinator.swift

@@ -75,13 +75,13 @@ private extension AddOrderCoordinator {
         ServiceLocator.analytics.track(event: WooAnalyticsEvent.SimplePayments.simplePaymentsFlowStarted())
     }
 
-    /// Presents `NewOrderHostingController`.
+    /// Presents `OrderFormHostingController`.
     ///
     func presentNewOrderController() {
-        let viewModel = NewOrderViewModel(siteID: siteID)
+        let viewModel = EditableOrderViewModel(siteID: siteID)
         viewModel.onFinished = onOrderCreated
 
-        let viewController = NewOrderHostingController(viewModel: viewModel)
+        let viewController = OrderFormHostingController(viewModel: viewModel)
         if ServiceLocator.featureFlagService.isFeatureFlagEnabled(.splitViewInOrdersTab) {
             let newOrderNC = WooNavigationController(rootViewController: viewController)
             navigationController.present(newOrderNC, animated: true)