Merge pull request #2178 from woocommerce/issue/927-refresh-app-on-foreground

Refresh Order List on app activation

Author: shiki

RELEASE-NOTES.txt

@@ -5,6 +5,7 @@
 - Products: now the keyboard pop up automatically in Edit Description (M1), in Edit Short Description (M2), Edit Slug (M2), Edit Purchase Note (M2)
 - The Processing orders list will now show upcoming (future) orders.
 - Improved stats: fixed the incorrect time range on "This Week" tab when loading improved stats on a day when daily saving time changes.
+- The Orders list are now automatically refreshed when reopening the app. 
 
 
 4.1

WooCommerce/Classes/ViewRelated/Orders/OrdersViewController.swift

@@ -137,6 +137,17 @@ private extension OrdersViewController {
     /// Initialize ViewModel operations
     ///
     func configureViewModel() {
+        viewModel.onShouldResynchronizeAfterAppActivation = { [weak self] in
+            guard let self = self,
+                  // Avoid synchronizing if the view is not visible. The refresh will be handled in
+                  // `viewWillAppear` instead.
+                  self.viewIfLoaded?.window != nil else {
+                return
+            }
+
+            self.syncingCoordinator.resynchronize()
+        }
+
         viewModel.activateAndForwardUpdates(to: tableView)
     }
 

WooCommerce/Classes/ViewRelated/Orders/OrdersViewModel.swift

@@ -24,6 +24,11 @@ final class OrdersViewModel {
     }
 
     private let storageManager: StorageManagerType
+    private let notificationCenter: NotificationCenter
+
+    /// The block called if self requests a resynchronization of the first page.
+    ///
+    var onShouldResynchronizeAfterAppActivation: (() -> ())?
 
     /// OrderStatus that must be matched by retrieved orders.
     ///
@@ -37,6 +42,9 @@ final class OrdersViewModel {
     ///
     private let includesFutureOrders: Bool
 
+    /// Used for tracking whether the app was _previously_ in the background.
+    private var isAppActive: Bool = true
+
     /// Should be bound to the UITableView to auto-update the list of Orders.
     ///
     private lazy var resultsController: ResultsController<StorageOrder> = {
@@ -76,9 +84,11 @@ final class OrdersViewModel {
     }
 
     init(storageManager: StorageManagerType = ServiceLocator.storageManager,
+         notificationCenter: NotificationCenter = .default,
          statusFilter: OrderStatus?,
          includesFutureOrders: Bool = true) {
         self.storageManager = storageManager
+        self.notificationCenter = notificationCenter
         self.statusFilter = statusFilter
         self.includesFutureOrders = includesFutureOrders
     }
@@ -91,6 +101,11 @@ final class OrdersViewModel {
     func activateAndForwardUpdates(to tableView: UITableView) {
         resultsController.startForwardingEvents(to: tableView)
         performFetch()
+
+        notificationCenter.addObserver(self, selector: #selector(handleAppDeactivation),
+                                       name: UIApplication.willResignActiveNotification, object: nil)
+        notificationCenter.addObserver(self, selector: #selector(handleAppActivation),
+                                       name: UIApplication.didBecomeActiveNotification, object: nil)
     }
 
     /// Execute the `resultsController` query, logging the error if there's any.
@@ -103,6 +118,21 @@ final class OrdersViewModel {
         }
     }
 
+    @objc private func handleAppDeactivation() {
+        isAppActive = false
+    }
+
+    /// Request a resynchornization if the app was previously in the background.
+    ///
+    @objc private func handleAppActivation() {
+        guard !isAppActive else {
+            return
+        }
+
+        isAppActive = true
+        onShouldResynchronizeAfterAppActivation?()
+    }
+
     /// Returns what `OrderAction` should be used when synchronizing.
     ///
     /// Pulling to refresh on filtered lists, like the Processing tab, will perform 2 network GET
@@ -159,9 +189,11 @@ final class OrdersViewModel {
     /// | Action           | Current Tab | Delete All | GET ?status=processing | GET ?status=any |
     /// |------------------|-------------|------------|------------------------|-----------------|
     /// | Pull-to-refresh  | Processing  | y          | y                      | y               |
+    /// | App activated    | Processing  | .          | y                      | y               |
     /// | `viewWillAppear` | Processing  | .          | y                      | y               |
     /// | Load next page   | Processing  | .          | y                      | .               |
     /// | Pull-to-refresh  | All Orders  | y          | .                      | y               |
+    /// | App activated    | All Orders  | .          | .                      | y               |
     /// | `viewWillAppear` | All Orders  | .          | .                      | y               |
     /// | Load next page   | All Orders  | .          | .                      | y               |
     ///

WooCommerce/WooCommerceTests/ViewRelated/Orders/OrdersViewModelTests.swift

@@ -35,6 +35,8 @@ final class OrdersViewModelTests: XCTestCase {
         super.tearDown()
     }
 
+    // MARK: - Synchronization Spec
+
     // Test that when pulling to refresh on a filtered list (e.g. Processing tab), the action
     // returned will be for:
     //
@@ -188,6 +190,8 @@ final class OrdersViewModelTests: XCTestCase {
         XCTAssertEqual(pageSize, self.pageSize)
     }
 
+    // MARK: - Future Orders
+
     func testGivenAFilterItLoadsTheOrdersMatchingThatFilterFromTheDB() {
         // Arrange
         let viewModel = OrdersViewModel(storageManager: storageManager,
@@ -321,6 +325,47 @@ final class OrdersViewModelTests: XCTestCase {
         XCTAssertEqual(Age(rawValue: upcomingSection.name), .upcoming)
         XCTAssertEqual(upcomingSection.numberOfObjects, expectedOrders.future.count)
     }
+
+    // MARK: - App Activation
+
+    func testItRequestsAResynchronizationWhenTheAppIsActivated() {
+        // Arrange
+        let notificationCenter = NotificationCenter()
+        let viewModel = OrdersViewModel(notificationCenter: notificationCenter, statusFilter: nil)
+
+        var resynchronizeRequested = false
+        viewModel.onShouldResynchronizeAfterAppActivation = {
+            resynchronizeRequested = true
+        }
+
+        viewModel.activateAndForwardUpdates(to: UITableView())
+
+        // Act
+        notificationCenter.post(name: UIApplication.willResignActiveNotification, object: nil)
+        notificationCenter.post(name: UIApplication.didBecomeActiveNotification, object: nil)
+
+        // Assert
+        XCTAssertTrue(resynchronizeRequested)
+    }
+
+    func testGivenNoPreviousDeactivationItDoesNotRequestAResynchronizationWhenTheAppIsActivated() {
+        // Arrange
+        let notificationCenter = NotificationCenter()
+        let viewModel = OrdersViewModel(notificationCenter: notificationCenter, statusFilter: nil)
+
+        var resynchronizeRequested = false
+        viewModel.onShouldResynchronizeAfterAppActivation = {
+            resynchronizeRequested = true
+        }
+
+        viewModel.activateAndForwardUpdates(to: UITableView())
+
+        // Act
+        notificationCenter.post(name: UIApplication.didBecomeActiveNotification, object: nil)
+
+        // Assert
+        XCTAssertFalse(resynchronizeRequested)
+    }
 }
 
 // MARK: - Helpers