Added a tiny bit of logic when syncing site status on OrdersVC

Author: bummytime

WooCommerce/Classes/ViewRelated/Orders/OrdersViewController.swift

@@ -36,14 +36,13 @@ class OrdersViewController: UIViewController {
         return ResultsController<StorageOrder>(storageManager: storageManager, sectionNameKeyPath: "normalizedAgeAsString", sortedBy: [descriptor])
     }()
 
-    /// ResultsController: Surrounds us. Binds the galaxy together. And also, keeps the UITableView <> (Stored) OrderStatuses in sync.
+    /// ResultsController: Handles all things order status
     ///
     private lazy var statusResultsController: ResultsController<StorageOrderStatus> = {
         let storageManager = AppDelegate.shared.storageManager
-        let predicate = NSPredicate(format: "siteID == %lld", StoresManager.shared.sessionManager.defaultStoreID ?? Int.min)
         let descriptor = NSSortDescriptor(key: "slug", ascending: true)
 
-        return ResultsController<StorageOrderStatus>(storageManager: storageManager, matching: predicate, sortedBy: [descriptor])
+        return ResultsController<StorageOrderStatus>(storageManager: storageManager, sortedBy: [descriptor])
     }()
 
     /// SyncCoordinator: Keeps tracks of which pages have been refreshed, and encapsulates the "What should we sync now" logic.
@@ -66,6 +65,12 @@ class OrdersViewController: UIViewController {
         }
     }
 
+    /// The current list of order statuses for the default site
+    ///
+    private var currentSiteStatuses: [OrderStatus] {
+        return statusResultsController.fetchedObjects
+    }
+
     /// Keep track of the (Autosizing Cell's) Height. This helps us prevent UI flickers, due to sizing recalculations.
     ///
     private var estimatedRowHeights = [IndexPath: CGFloat]()
@@ -118,19 +123,22 @@ class OrdersViewController: UIViewController {
 
         refreshTitle()
         refreshResultsPredicate()
+        refreshStatusPredicate()
         registerTableViewCells()
 
         configureSyncingCoordinator()
         configureNavigation()
         configureTableView()
-        configureResultsController()
+        configureResultsControllers()
 
         startListeningToNotifications()
     }
 
     override func viewWillAppear(_ animated: Bool) {
         super.viewWillAppear(animated)
 
+        syncOrderStatus()
+        resetStatusFilterIfNeeded()
         syncingCoordinator.synchronizeFirstPage()
         if AppRatingManager.shared.shouldPromptForAppReview() {
             displayRatingPrompt()
@@ -164,7 +172,7 @@ private extension OrdersViewController {
         navigationItem.title = title
     }
 
-    /// Setup: Filtering
+    /// Setup: Order filtering
     ///
     func refreshResultsPredicate() {
         resultsController.predicate = {
@@ -184,6 +192,12 @@ private extension OrdersViewController {
         tableView.reloadData()
     }
 
+    /// Setup: Order status predicate
+    ///
+    func refreshStatusPredicate() {
+        statusResultsController.predicate = NSPredicate(format: "siteID == %lld", StoresManager.shared.sessionManager.defaultStoreID ?? Int.min)
+    }
+
     /// Setup: Navigation Item
     ///
     func configureNavigation() {
@@ -225,9 +239,18 @@ private extension OrdersViewController {
 
     /// Setup: Results Controller
     ///
-    func configureResultsController() {
+    func configureResultsControllers() {
+        // Orders FRC
         resultsController.startForwardingEvents(to: tableView)
         try? resultsController.performFetch()
+
+        // Order status FRC
+        statusResultsController.onDidChangeContent = { [weak self] in
+            self?.statusFilter = nil
+        }
+        statusResultsController.onDidResetContent = { [weak self] in
+            self?.statusFilter = nil
+        }
         try? statusResultsController.performFetch()
     }
 
@@ -285,6 +308,8 @@ extension OrdersViewController {
     /// Runs whenever the default Account is updated.
     ///
     @objc func defaultAccountWasUpdated() {
+        statusFilter = nil
+        refreshStatusPredicate()
         syncingCoordinator.resetInternalState()
     }
 }
@@ -316,7 +341,7 @@ extension OrdersViewController {
             self?.statusFilter = nil
         }
 
-        for orderStatus in statusResultsController.fetchedObjects {
+        for orderStatus in currentSiteStatuses {
             actionSheet.addDefaultActionWithTitle(orderStatus.name) { [weak self] _ in
                 self?.statusFilter = orderStatus
             }
@@ -331,6 +356,7 @@ extension OrdersViewController {
 
     @IBAction func pullToRefresh(sender: UIRefreshControl) {
         WooAnalytics.shared.track(.ordersListPulledToRefresh)
+        syncOrderStatus()
         syncingCoordinator.synchronizeFirstPage {
             sender.endRefreshing()
         }
@@ -373,6 +399,24 @@ private extension OrdersViewController {
         let action = OrderAction.resetStoredOrders(onCompletion: onCompletion)
         StoresManager.shared.dispatch(action)
     }
+
+    /// Reset the current status filter if needed (e.g. when changing stores and the currently
+    /// selected filter does not exist in the new store)
+    ///
+    func resetStatusFilterIfNeeded() {
+        guard let statusFilter = statusFilter else {
+            // "All" is the current filter so bail
+            return
+        }
+        guard currentSiteStatuses.isEmpty == false else {
+            self.statusFilter = nil
+            return
+        }
+
+        if currentSiteStatuses.contains(statusFilter) == false {
+            self.statusFilter = nil
+        }
+    }
 }
 
 
@@ -411,6 +455,26 @@ extension OrdersViewController: SyncingCoordinatorDelegate {
 
         StoresManager.shared.dispatch(action)
     }
+
+    func syncOrderStatus(onCompletion: ((Error?) -> Void)? = nil) {
+        guard let siteID = StoresManager.shared.sessionManager.defaultStoreID else {
+            onCompletion?(nil)
+            return
+        }
+
+        // First, let's verify our FRC predicate is up to date
+        refreshStatusPredicate()
+
+        let action = OrderStatusAction.retrieveOrderStatuses(siteID: siteID) { [weak self] (_, error) in
+            if let error = error {
+                DDLogError("⛔️ Order List — Error synchronizing order statuses: \(error)")
+            }
+            self?.resetStatusFilterIfNeeded()
+            onCompletion?(error)
+        }
+
+        StoresManager.shared.dispatch(action)
+    }
 }
 
 
@@ -472,6 +536,7 @@ private extension OrdersViewController {
         let message = NSLocalizedString("Unable to refresh list", comment: "Refresh Action Failed")
         let actionTitle = NSLocalizedString("Retry", comment: "Retry Action")
         let notice = Notice(title: message, feedbackType: .error, actionTitle: actionTitle) { [weak self] in
+            self?.syncOrderStatus()
             self?.sync(pageNumber: pageNumber, pageSize: pageSize)
         }
 
@@ -557,8 +622,7 @@ private extension OrdersViewController {
     }
 
     func lookUpOrderStatus(for order: Order) -> OrderStatus? {
-        let listAll = statusResultsController.fetchedObjects
-        for orderStatus in listAll where orderStatus.slug == order.statusKey {
+        for orderStatus in currentSiteStatuses where orderStatus.slug == order.statusKey {
             return orderStatus
         }