Dismiss optimistic order update/complete notification right away if an error occur

WooCommerce/Classes/ServiceLocator/NoticePresenter.swift

@@ -8,6 +8,10 @@ protocol NoticePresenter {
     ///
     func enqueue(notice: Notice)
 
+    /// It dismisses the provided `Notice` if it is currenly presented in the foreground, or removes it from the queue
+    ///
+    func cancel(notice: Notice)
+
     /// UIViewController to be used as Notice(s) Presenter
     ///
     var presentingViewController: UIViewController? { get set }

WooCommerce/Classes/Tools/Notices/DefaultNoticePresenter.swift

@@ -20,6 +20,10 @@ class DefaultNoticePresenter: NoticePresenter {
     ///
     private var noticeOnScreen: Notice?
 
+    /// Dismiss the current onScreen notice
+    ///
+    private var dismissNoticeOnScreen: (() -> Void)?
+
     /// UIViewController to be used as Notice(s) Presenter
     ///
     weak var presentingViewController: UIViewController?
@@ -40,6 +44,15 @@ class DefaultNoticePresenter: NoticePresenter {
         notices.append(notice)
         presentNextNoticeIfPossible()
     }
+
+    /// It dismisses the provided `Notice` if it is currenly presented in the foreground, or removes it from the queue
+    ///
+    func cancel(notice: Notice) {
+        notices.removeAll(where: { $0 == notice })
+        if notice == noticeOnScreen {
+            dismissNoticeOnScreen?()
+        }
+    }
 }
 
 
@@ -161,7 +174,7 @@ private extension DefaultNoticePresenter {
         }
 
         let dismiss = { [weak noticeContainerView] in
-            guard let noticeContainerView = noticeContainerView, noticeContainerView.superview != nil else {
+            guard let noticeContainerView = noticeContainerView, noticeContainerView.superview != nil, notice == self.noticeOnScreen else {
                 return
             }
 
@@ -171,18 +184,22 @@ private extension DefaultNoticePresenter {
             })
         }
 
+        dismissNoticeOnScreen = dismiss
         noticeView.dismissHandler = dismiss
 
         if let feedbackType = notice.feedbackType {
             generator.notificationOccurred(feedbackType)
         }
 
         animatePresentation(fromState: offScreenState, toState: onScreenState, completion: {
-            DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + Animations.dismissDelay, execute: dismiss)
+            DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + Animations.dismissDelay) { [weak self] in
+                self?.dismissNoticeOnScreen?()
+            }
         })
     }
 
     func dismiss() {
+        dismissNoticeOnScreen = nil
         noticeOnScreen = nil
         keyboardFrameObserver = nil
         presentNextNoticeIfPossible()

WooCommerce/Classes/ViewModels/Order Details/OrderDetailsNotices.swift

@@ -2,6 +2,10 @@ import Foundation
 import Yosemite
 
 final class OrderDetailsNotices {
+
+    /// Contains the latest  order update notice
+    var orderUpdateNotice: Notice?
+
     /// Displays the `Unable to delete tracking` Notice.
     ///
     func displayDeleteErrorNotice(order: Order, tracking: ShipmentTracking, onAction: @escaping () -> Void) {
@@ -20,6 +24,10 @@ final class OrderDetailsNotices {
                                 onAction()
         }
 
+        if let orderUpdateNotice = orderUpdateNotice {
+            ServiceLocator.noticePresenter.cancel(notice: orderUpdateNotice)
+        }
+
         ServiceLocator.noticePresenter.enqueue(notice: notice)
     }
 }

WooCommerce/Classes/ViewRelated/Orders/Order Details/OrderDetailsViewController.swift

@@ -844,9 +844,11 @@ private extension OrderDetailsViewController {
         ServiceLocator.stores.dispatch(done)
         ServiceLocator.analytics.track(event: WooAnalyticsEvent.Orders.orderStatusChange(flow: .editing, orderID: orderID, from: undoStatus, to: newStatus))
 
-        displayOrderStatusUpdatedNotice {
+        notices.orderUpdateNotice = displayOrderStatusUpdatedNotice { [weak self] in
+            guard let self = self else { return }
             ServiceLocator.stores.dispatch(undo)
             ServiceLocator.analytics.track(event: WooAnalyticsEvent.Orders.orderStatusChange(flow: .editing, orderID: orderID, from: newStatus, to: undoStatus))
+            self.notices.orderUpdateNotice = nil
         }
     }
 
@@ -870,12 +872,13 @@ private extension OrderDetailsViewController {
 
     /// Enqueues the `Order Updated` Notice. Whenever the `Undo` button gets pressed, we'll execute the `onUndoAction` closure.
     ///
-    private func displayOrderStatusUpdatedNotice(onUndoAction: @escaping () -> Void) {
+    private func displayOrderStatusUpdatedNotice(onUndoAction: @escaping () -> Void) -> Notice {
         let message = NSLocalizedString("Order status updated", comment: "Order status update success notice")
         let actionTitle = NSLocalizedString("Undo", comment: "Undo Action")
         let notice = Notice(title: message, feedbackType: .success, actionTitle: actionTitle, actionHandler: onUndoAction)
 
         ServiceLocator.noticePresenter.enqueue(notice: notice)
+        return notice
     }
 
     /// Enqueues the `Unable to Change Status of Order` Notice.
@@ -893,6 +896,10 @@ private extension OrderDetailsViewController {
             self?.setOrderStatus(to: status)
         }
 
+        if let orderUpdateNotice = notices.orderUpdateNotice {
+            ServiceLocator.noticePresenter.cancel(notice: orderUpdateNotice)
+        }
+
         ServiceLocator.noticePresenter.enqueue(notice: notice)
     }
 }

WooCommerce/Classes/ViewRelated/Orders/Order Details/OrderFulfillmentNoticePresenter.swift

@@ -16,6 +16,7 @@ final class OrderFulfillmentNoticePresenter {
     private let analytics: Analytics = ServiceLocator.analytics
 
     private var cancellables = Set<AnyCancellable>()
+    private var optimisticFulfillmentNotice: Notice?
 
     /// Start presenting notices for the given fulfillment process.
     ///
@@ -50,13 +51,16 @@ final class OrderFulfillmentNoticePresenter {
     private func displayOptimisticFulfillmentNotice(_ fulfillmentProcess: OrderFulfillmentUseCase.FulfillmentProcess) {
         let message = NSLocalizedString("🎉 Order Completed", comment: "Success notice when tapping Mark Order Complete on Review Order screen")
         let actionTitle = NSLocalizedString("Undo", comment: "Undo Action")
-        let notice = Notice(title: message, feedbackType: .success, actionTitle: actionTitle) {
+        let notice = Notice(title: message, feedbackType: .success, actionTitle: actionTitle) { [weak self] in
+            guard let self = self else { return }
             self.analytics.track(.orderMarkedCompleteUndoButtonTapped)
 
             self.observe(fulfillmentProcess: fulfillmentProcess.undo())
+            self.optimisticFulfillmentNotice = nil
         }
 
         noticePresenter.enqueue(notice: notice)
+        optimisticFulfillmentNotice = notice
     }
 
     private func displayFulfillmentErrorNotice(error: OrderFulfillmentUseCase.FulfillmentError) {
@@ -65,6 +69,10 @@ final class OrderFulfillmentNoticePresenter {
             self.observe(fulfillmentProcess: error.retry())
         }
 
+        // Cancel the optimistic fulfillment notice (if any) in order to display immediately the most relevant error message
+        if let optimisticFulfillmentNotice = optimisticFulfillmentNotice {
+            noticePresenter.cancel(notice: optimisticFulfillmentNotice)
+        }
         noticePresenter.enqueue(notice: notice)
     }
 }

WooCommerce/WooCommerceTests/Mocks/MockNoticePresenter.swift

@@ -14,4 +14,8 @@ final class MockNoticePresenter: NoticePresenter {
     func enqueue(notice: Notice) {
         queuedNotices.append(notice)
     }
+
+    func cancel(notice: Notice) {
+        queuedNotices.removeAll(where: {$0 == notice})
+    }
 }