[Woo POS] Ensure auto-draft order removal on exit POS

Modules/Sources/Yosemite/Stores/Helpers/OrderStoreMethods.swift

@@ -0,0 +1,91 @@
+import Foundation
+import Networking
+import Storage
+
+/// OrderStoreMethods extracts functionality of OrderStore that needs be reused within Yosemite
+/// OrderStoreMethods is intentionally internal not to be exposed outside the module
+///
+/// periphery: ignore
+internal protocol OrderStoreMethodsProtocol {
+    func deleteOrder(siteID: Int64,
+                     order: Order,
+                     deletePermanently: Bool,
+                     onCompletion: @escaping (Result<Order, Error>) -> Void)
+}
+
+internal class OrderStoreMethods: OrderStoreMethodsProtocol {
+    private let remote: OrdersRemote
+    private let storageManager: StorageManagerType
+
+    init(
+        storageManager: StorageManagerType,
+        remote: OrdersRemote
+    ) {
+        self.remote = remote
+        self.storageManager = storageManager
+    }
+
+    /// Deletes a given order.
+    /// Extracted from OrderStore.deleteOrder() implementation.
+    ///
+    func deleteOrder(siteID: Int64, order: Order, deletePermanently: Bool, onCompletion: @escaping (Result<Order, Error>) -> Void) {
+        // Optimistically delete the order from storage
+        deleteStoredOrder(siteID: siteID, orderID: order.orderID)
+
+        remote.deleteOrder(for: siteID, orderID: order.orderID, force: deletePermanently) { [weak self] result in
+            switch result {
+            case .success:
+                onCompletion(result)
+            case .failure:
+                // Revert optimistic deletion unless the order is an auto-draft (shouldn't be stored)
+                guard order.status != .autoDraft else {
+                    return onCompletion(result)
+                }
+                self?.upsertStoredOrdersInBackground(readOnlyOrders: [order], onCompletion: {
+                    onCompletion(result)
+                })
+            }
+        }
+    }
+}
+
+// MARK: - Storage Methods
+
+private extension OrderStoreMethods {
+    /// Deletes any Storage.Order with the specified OrderID
+    /// Extracted from OrderStore.deleteStoredOrder()
+    ///
+    func deleteStoredOrder(siteID: Int64, orderID: Int64, onCompletion: (() -> Void)? = nil) {
+        storageManager.performAndSave({ storage in
+            guard let order = storage.loadOrder(siteID: siteID, orderID: orderID) else {
+                return
+            }
+            storage.deleteObject(order)
+        }, completion: onCompletion, on: .main)
+    }
+
+    /// Updates (OR Inserts) the specified ReadOnly Order Entities *in a background thread*.
+    /// Extracted from OrderStore.upsertStoredOrdersInBackground()
+    ///
+    func upsertStoredOrdersInBackground(readOnlyOrders: [Networking.Order],
+                                        removeAllStoredOrders: Bool = false,
+                                        onCompletion: (() -> Void)? = nil) {
+        storageManager.performAndSave({ [weak self] derivedStorage in
+            guard let self else { return }
+            if removeAllStoredOrders {
+                derivedStorage.deleteAllObjects(ofType: Storage.Order.self)
+            }
+            upsertStoredOrders(readOnlyOrders: readOnlyOrders, in: derivedStorage)
+        }, completion: onCompletion, on: .main)
+    }
+
+    /// Updates (OR Inserts) the specified ReadOnly Order Entities into the Storage Layer.
+    /// Extracted from OrderStore.upsertStoredOrders()
+    ///
+    func upsertStoredOrders(readOnlyOrders: [Networking.Order],
+                            insertingSearchResults: Bool = false,
+                            in storage: StorageType) {
+        let useCase = OrdersUpsertUseCase(storage: storage)
+        useCase.upsert(readOnlyOrders, insertingSearchResults: insertingSearchResults)
+    }
+}

Modules/Sources/Yosemite/Stores/OrderStore.swift

@@ -6,11 +6,23 @@ import Storage
 
 // MARK: - OrderStore
 //
+/// periphery: ignore
 public class OrderStore: Store {
     private let remote: OrdersRemote
+    private let methods: OrderStoreMethods
+
+    init(dispatcher: Dispatcher,
+         storageManager: StorageManagerType,
+         network: Network,
+         remote: OrdersRemote) {
+        self.remote = remote
+        self.methods = OrderStoreMethods(storageManager: storageManager, remote: remote)
+        super.init(dispatcher: dispatcher, storageManager: storageManager, network: network)
+    }
 
     public override init(dispatcher: Dispatcher, storageManager: StorageManagerType, network: Network) {
         self.remote = OrdersRemote(network: network)
+        self.methods = OrderStoreMethods(storageManager: storageManager, remote: self.remote)
         super.init(dispatcher: dispatcher, storageManager: storageManager, network: network)
     }
 
@@ -85,7 +97,7 @@ public class OrderStore: Store {
         case let .markOrderAsPaidLocally(siteID, orderID, datePaid, onCompletion):
             markOrderAsPaidLocally(siteID: siteID, orderID: orderID, datePaid: datePaid, onCompletion: onCompletion)
         case let .deleteOrder(siteID, order, deletePermanently, onCompletion):
-            deleteOrder(siteID: siteID, order: order, deletePermanently: deletePermanently, onCompletion: onCompletion)
+            methods.deleteOrder(siteID: siteID, order: order, deletePermanently: deletePermanently, onCompletion: onCompletion)
         case let .observeInsertedOrders(siteID, completion):
             observeInsertedOrders(siteID: siteID, completion: completion)
         case let .checkIfStoreHasOrders(siteID, completion):
@@ -97,6 +109,7 @@ public class OrderStore: Store {
 
 // MARK: - Services!
 //
+/// periphery: ignore
 private extension OrderStore {
 
     /// Nukes all of the Stored Orders.

Modules/Sources/Yosemite/Tools/POS/POSOrderManagementService.swift

@@ -0,0 +1,44 @@
+import Foundation
+import Networking
+import protocol Storage.StorageManagerType
+import struct Combine.AnyPublisher
+import struct NetworkingCore.JetpackSite
+
+public protocol POSOrderManagementServiceProtocol {
+    /// Deletes an order permanently or moves it to trash
+    /// - Parameters:
+    ///   - siteID: The site ID where the order belongs
+    ///   - order: The order to delete
+    ///   - deletePermanently: Whether to delete permanently or move to trash
+    ///   - onCompletion: Completion handler with the result
+    func deleteOrder(siteID: Int64, order: Order, deletePermanently: Bool, onCompletion: @escaping (Result<Order, Error>) -> Void)
+}
+/// periphery: ignore
+public final class POSOrderManagementService: POSOrderManagementServiceProtocol {
+    private let orderStoreMethods: OrderStoreMethodsProtocol
+
+    public convenience init?(siteID: Int64,
+                             credentials: Credentials?,
+                             selectedSite: AnyPublisher<JetpackSite?, Never>,
+                             appPasswordSupportState: AnyPublisher<Bool, Never>,
+                             storageManager: StorageManagerType) {
+        guard let credentials else {
+            DDLogError("⛔️ Could not create POSOrderManagementService due to not finding credentials")
+            return nil
+        }
+        let network = AlamofireNetwork(credentials: credentials,
+                                       selectedSite: selectedSite,
+                                       appPasswordSupportState: appPasswordSupportState)
+        let remote = OrdersRemote(network: network)
+        self.init(storageManager: storageManager, remote: remote)
+    }
+
+    public init(storageManager: StorageManagerType, remote: OrdersRemote) {
+        self.orderStoreMethods = OrderStoreMethods(storageManager: storageManager, remote: remote)
+    }
+
+    // MARK: - Protocol conformance
+    public func deleteOrder(siteID: Int64, order: Order, deletePermanently: Bool, onCompletion: @escaping (Result<Order, Error>) -> Void) {
+        orderStoreMethods.deleteOrder(siteID: siteID, order: order, deletePermanently: deletePermanently, onCompletion: onCompletion)
+    }
+}

RELEASE-NOTES.txt

@@ -4,6 +4,7 @@
 23.4
 -----
 - [*] Order details: Fixes broken country selector navigation and "Non editable banner" width. [https://github.com/woocommerce/woocommerce-ios/pull/16171]
+- [*] Point of Sale: Remove temporary orders from storage on exiting POS mode [https://github.com/woocommerce/woocommerce-ios/pull/15975]
 
 23.3
 -----

WooCommerce/Classes/POS/Adaptors/POSServiceLocatorAdaptor.swift

@@ -5,6 +5,7 @@ import Yosemite
 import protocol Experiments.FeatureFlagService
 import enum Experiments.FeatureFlag
 import protocol Storage.StorageManagerType
+
 final class POSServiceLocatorAdaptor: POSDependencyProviding {
     var analytics: POSAnalyticsProviding {
         POSAnalyticsAdaptor()
@@ -29,6 +30,10 @@ final class POSServiceLocatorAdaptor: POSDependencyProviding {
     var externalViews: POSExternalViewProviding {
         POSExternalViewAdaptor()
     }
+
+    var orderManagement: POSOrderManagementServiceProtocol {
+        POSOrderManagementServiceAdaptor()
+    }
 }
 
 // MARK: - Individual Service Adaptors
@@ -117,3 +122,12 @@ private struct POSExternalViewAdaptor: POSExternalViewProviding {
         ))
     }
 }
+
+private struct POSOrderManagementServiceAdaptor: POSOrderManagementServiceProtocol {
+    func deleteOrder(siteID: Int64, order: Order, deletePermanently: Bool, onCompletion: @escaping (Result<Order, Error>) -> Void) {
+        let action = OrderAction.deleteOrder(siteID: siteID, order: order, deletePermanently: deletePermanently, onCompletion: onCompletion)
+        Task { @MainActor in
+            ServiceLocator.stores.dispatch(action)
+        }
+    }
+}

WooCommerce/Classes/POS/Controllers/PointOfSaleOrderController.swift

@@ -20,6 +20,7 @@ import enum WooFoundation.CurrencyCode
 import protocol WooFoundation.Analytics
 import enum Alamofire.AFError
 import class Yosemite.OrderTotalsCalculator
+import protocol Yosemite.POSOrderManagementServiceProtocol
 
 enum SyncOrderState {
     case newOrder
@@ -36,7 +37,7 @@ protocol PointOfSaleOrderControllerProtocol {
     @discardableResult
     func syncOrder(for cart: Cart, retryHandler: @escaping () async -> Void) async -> Result<SyncOrderState, Error>
     func sendReceipt(recipientEmail: String) async throws
-    func clearOrder()
+    func clearOrder() async
     func collectCashPayment(changeDueAmount: String?) async throws
 }
 
@@ -45,11 +46,13 @@ protocol PointOfSaleOrderControllerProtocol {
          receiptSender: POSReceiptSending,
          currencySettingsProvider: POSCurrencySettingsProviding,
          analytics: POSAnalyticsProviding,
+         orderManagement: POSOrderManagementServiceProtocol,
          celebration: PaymentCaptureCelebrationProtocol = PaymentCaptureCelebration()) {
         self.orderService = orderService
         self.receiptSender = receiptSender
         self.currencySettingsProvider = currencySettingsProvider
         self.analytics = analytics
+        self.orderManagement = orderManagement
         self.celebration = celebration
     }
 
@@ -58,6 +61,7 @@ protocol PointOfSaleOrderControllerProtocol {
     private let currencySettingsProvider: POSCurrencySettingsProviding
     private let celebration: PaymentCaptureCelebrationProtocol
     private let analytics: POSAnalyticsProviding
+    private let orderManagement: POSOrderManagementServiceProtocol
 
     private(set) var orderState: PointOfSaleInternalOrderState = .idle
     private var order: Order? = nil
@@ -114,11 +118,24 @@ protocol PointOfSaleOrderControllerProtocol {
         try await receiptSender.sendReceipt(orderID: order.orderID, recipientEmail: recipientEmail)
     }
 
-    func clearOrder() {
+    func clearOrder() async {
+        await clearAutoDraftIfNeeded(for: order)
         order = nil
         orderState = .idle
     }
 
+    private func clearAutoDraftIfNeeded(for order: Order?) async {
+        guard let order, order.status == .autoDraft else { return }
+
+        await withCheckedContinuation { continuation in
+            Task { @MainActor in
+                orderManagement.deleteOrder(siteID: order.siteID, order: order, deletePermanently: true) { _ in
+                    continuation.resume()
+                }
+            }
+        }
+    }
+
     private func celebrate() {
         celebration.celebrate()
     }

WooCommerce/Classes/POS/Models/PointOfSaleAggregateModel.swift

@@ -172,7 +172,9 @@ extension PointOfSaleAggregateModel {
 
     func startNewCart() {
         removeAllItemsFromCart()
-        orderController.clearOrder()
+        Task {
+            await orderController.clearOrder()
+        }
         setStateForEditing()
         viewStateCoordinator.reset()
     }
@@ -613,7 +615,9 @@ extension PointOfSaleAggregateModel {
 
         // Before exiting Point of Sale, we warn the merchant about losing their in-progress order.
         // We need to clear it down as any accidental retention can cause issues especially when reconnecting card readers.
-        orderController.clearOrder()
+        Task {
+            await orderController.clearOrder()
+        }
 
         // Ideally, we could rely on the POS being deallocated to cancel all these. Since we have memory leak issues,
         // cancelling them explicitly helps reduce the risk of user-visible bugs while we work on the memory leaks.

WooCommerce/Classes/POS/Presentation/PointOfSaleEntryPointView.swift

@@ -93,7 +93,8 @@ public struct PointOfSaleEntryPointView: View {
         self.orderController = PointOfSaleOrderController(orderService: orderService,
                                                           receiptSender: receiptSender,
                                                           currencySettingsProvider: services.currency,
-                                                          analytics: services.analytics)
+                                                          analytics: services.analytics,
+                                                          orderManagement: services.orderManagement)
         self.settingsController = PointOfSaleSettingsController(siteID: siteID,
                                                                 settingsService: settingsService,
                                                                 cardPresentPaymentService: cardPresentPaymentService,

WooCommerce/Classes/POS/Protocols/POSDependencyProviding.swift

@@ -5,6 +5,7 @@ import enum Experiments.FeatureFlag
 import struct Yosemite.Coupon
 import enum Yosemite.CouponDiscountType
 import enum Yosemite.POSItem
+import protocol Yosemite.POSOrderManagementServiceProtocol
 
 /// POSDepenencyProviding is part of the POS entry point that defines the external dependencies from the Woo app that POS depends on
 
@@ -72,4 +73,5 @@ public protocol POSDependencyProviding {
     var connectivity: POSConnectivityProviding { get }
     var externalNavigation: POSExternalNavigationProviding { get }
     var externalViews: POSExternalViewProviding { get }
+    var orderManagement: POSOrderManagementServiceProtocol { get }
 }

WooCommerce/Classes/POS/Utils/PointOfSalePreviewOrderController.swift

@@ -22,7 +22,7 @@ class PointOfSalePreviewOrderController: PointOfSaleOrderControllerProtocol {
 
     func sendReceipt(recipientEmail: String) async throws { }
 
-    func clearOrder() { }
+    func clearOrder() async { }
 
     func collectCashPayment(changeDueAmount: String?) async throws {}
 }

WooCommerce/Classes/POS/Utils/PreviewHelpers.swift

@@ -45,6 +45,7 @@ import protocol Yosemite.POSItemFetchAnalyticsTracking
 import protocol Yosemite.POSOrderListFetchStrategyFactoryProtocol
 import protocol Yosemite.POSOrderListFetchStrategy
 import protocol Yosemite.PointOfSaleCouponFetchStrategyFactoryProtocol
+import protocol Yosemite.POSOrderManagementServiceProtocol
 
 // MARK: - PreviewProvider helpers
 //
@@ -537,6 +538,13 @@ final class POSPreviewServices: POSDependencyProviding {
     var connectivity: POSConnectivityProviding = EmptyPOSConnectivityProvider()
     var externalNavigation: POSExternalNavigationProviding = EmptyPOSExternalNavigation()
     var externalViews: POSExternalViewProviding = EmptyPOSExternalView()
+    var orderManagement: POSOrderManagementServiceProtocol = POSPreviewOrderManagementService()
+}
+
+final class POSPreviewOrderManagementService: POSOrderManagementServiceProtocol {
+    func deleteOrder(siteID: Int64, order: Order, deletePermanently: Bool, onCompletion: @escaping (Result<Order, Error>) -> Void) {
+        onCompletion(.success(order))
+    }
 }
 
 // MARK: - Preview Catalog Services