OrdersVM: Request a resync if we receive a remote push notification

Author: shiki

WooCommerce/Classes/ViewRelated/Orders/OrdersViewModel.swift

@@ -24,8 +24,13 @@ final class OrdersViewModel {
     }
 
     private let storageManager: StorageManagerType
+    private let pushNotificationsManager: PushNotesManager
     private let notificationCenter: NotificationCenter
 
+    /// Used for cancelling the observer for Remote Notifications when `self` is deallocated.
+    ///
+    private var disposable: ObservationToken?
+
     /// The block called if self requests a resynchronization of the first page.
     ///
     var onShouldResynchronizeAfterAppActivation: (() -> ())?
@@ -84,15 +89,21 @@ final class OrdersViewModel {
     }
 
     init(storageManager: StorageManagerType = ServiceLocator.storageManager,
+         pushNotificationsManager: PushNotesManager = ServiceLocator.pushNotesManager,
          notificationCenter: NotificationCenter = .default,
          statusFilter: OrderStatus?,
          includesFutureOrders: Bool = true) {
         self.storageManager = storageManager
+        self.pushNotificationsManager = pushNotificationsManager
         self.notificationCenter = notificationCenter
         self.statusFilter = statusFilter
         self.includesFutureOrders = includesFutureOrders
     }
 
+    deinit {
+        stopObservingForegroundRemoteNotifications()
+    }
+
     /// Start fetching DB results and forward new changes to the given `tableView`.
     ///
     /// This is the main activation method for this ViewModel. This should only be called once.
@@ -106,6 +117,8 @@ final class OrdersViewModel {
                                        name: UIApplication.willResignActiveNotification, object: nil)
         notificationCenter.addObserver(self, selector: #selector(handleAppActivation),
                                        name: UIApplication.didBecomeActiveNotification, object: nil)
+
+        observeForegroundRemoteNotifications()
     }
 
     /// Execute the `resultsController` query, logging the error if there's any.
@@ -230,6 +243,29 @@ final class OrdersViewModel {
     }
 }
 
+// MARK: - Remote Notifications Observation
+
+private extension OrdersViewModel {
+    /// Watch for "new order" Remote Notifications that are received while the app is in the
+    /// foreground.
+    ///
+    /// A refresh will be requested when receiving them.
+    ///
+    func observeForegroundRemoteNotifications() {
+        disposable = pushNotificationsManager.foregroundNotifications.subscribe { [weak self] notification in
+            guard notification.kind == .storeOrder else {
+                return
+            }
+
+            self?.onShouldResynchronizeAfterAppActivation?()
+        }
+    }
+
+    func stopObservingForegroundRemoteNotifications() {
+        disposable?.cancel()
+    }
+}
+
 // MARK: - TableView Support
 
 extension OrdersViewModel {

WooCommerce/WooCommerce.xcodeproj/project.pbxproj

@@ -324,6 +324,7 @@
 		57F34AA12423D45A00E38AFB /* OrdersViewModelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57F34AA02423D45A00E38AFB /* OrdersViewModelTests.swift */; };
 		6856D2A5C2076F5BF14F2C11 /* KeyboardStateProviderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6856DCE1638958DA296D690F /* KeyboardStateProviderTests.swift */; };
 		6856D31F941A33BAE66F394D /* KeyboardFrameAdjustmentProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6856D3846BBF078CB5D955B9 /* KeyboardFrameAdjustmentProvider.swift */; };
+		6856D49DB7DCF4D87745C0B1 /* MockPushNotificationsManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6856D249FD1702FE3864950A /* MockPushNotificationsManager.swift */; };
 		6856D806DE7DB61522D54044 /* NSMutableAttributedStringHelperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6856D7981E11F85D5E4EFED7 /* NSMutableAttributedStringHelperTests.swift */; };
 		6856DB2E741639716E149967 /* KeyboardStateProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6856D02484A69911F2B91714 /* KeyboardStateProvider.swift */; };
 		6856DE479EC3B2265AC1F775 /* Calendar+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6856D66A1963092C34D20674 /* Calendar+Extensions.swift */; };
@@ -1145,6 +1146,7 @@
 		57F34AA02423D45A00E38AFB /* OrdersViewModelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OrdersViewModelTests.swift; sourceTree = "<group>"; };
 		6856D02484A69911F2B91714 /* KeyboardStateProvider.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = KeyboardStateProvider.swift; sourceTree = "<group>"; };
 		6856D1A5F72A36AB3704D19D /* AgeTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AgeTests.swift; sourceTree = "<group>"; };
+		6856D249FD1702FE3864950A /* MockPushNotificationsManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MockPushNotificationsManager.swift; sourceTree = "<group>"; };
 		6856D3846BBF078CB5D955B9 /* KeyboardFrameAdjustmentProvider.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = KeyboardFrameAdjustmentProvider.swift; sourceTree = "<group>"; };
 		6856D66A1963092C34D20674 /* Calendar+Extensions.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Calendar+Extensions.swift"; sourceTree = "<group>"; };
 		6856D7981E11F85D5E4EFED7 /* NSMutableAttributedStringHelperTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = NSMutableAttributedStringHelperTests.swift; sourceTree = "<group>"; };
@@ -2452,6 +2454,7 @@
 				02A275C523FE9EFC005C560F /* MockFeatureFlagService.swift */,
 				02B653AB2429F7BF00A9C839 /* MockTaxClassStoresManager.swift */,
 				02EA6BFB2435EC3500FFF90A /* MockImageDownloader.swift */,
+				6856D249FD1702FE3864950A /* MockPushNotificationsManager.swift */,
 			);
 			path = Mockups;
 			sourceTree = "<group>";
@@ -4872,6 +4875,7 @@
 				6856D806DE7DB61522D54044 /* NSMutableAttributedStringHelperTests.swift in Sources */,
 				6856DF20E1BDCC391635F707 /* AgeTests.swift in Sources */,
 				6856DE479EC3B2265AC1F775 /* Calendar+Extensions.swift in Sources */,
+				6856D49DB7DCF4D87745C0B1 /* MockPushNotificationsManager.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

WooCommerce/WooCommerceTests/Mockups/MockPushNotificationsManager.swift

@@ -0,0 +1,48 @@
+
+import Foundation
+import UIKit
+@testable import WooCommerce
+
+final class MockPushNotificationsManager: PushNotesManager {
+
+    var foregroundNotifications: Observable<ForegroundNotification> {
+        foregroundNotificationsSubject
+    }
+
+    private let foregroundNotificationsSubject = PublishSubject<ForegroundNotification>()
+
+    func resetBadgeCount() {
+
+    }
+
+    func registerForRemoteNotifications() {
+
+    }
+
+    func unregisterForRemoteNotifications() {
+
+    }
+
+    func ensureAuthorizationIsRequested(onCompletion: ((Bool) -> ())?) {
+
+    }
+
+    func registrationDidFail(with error: Error) {
+
+    }
+
+    func registerDeviceToken(with tokenData: Data, defaultStoreID: Int64) {
+
+    }
+
+    func handleNotification(_ userInfo: [AnyHashable: Any], completionHandler: @escaping (UIKit.UIBackgroundFetchResult) -> ()) {
+
+    }
+}
+
+extension MockPushNotificationsManager {
+    func sendForegroundNotification(_ notification: ForegroundNotification) {
+        foregroundNotificationsSubject.send(notification)
+    }
+}
+

WooCommerce/WooCommerceTests/ViewRelated/Orders/OrdersViewModelTests.swift

@@ -366,6 +366,48 @@ final class OrdersViewModelTests: XCTestCase {
         // Assert
         XCTAssertFalse(resynchronizeRequested)
     }
+
+    // MARK: - Foreground Notifications
+
+    func testGivenANewOrderNotificationItRequestsAResynchronization() {
+        // Arrange
+        let pushNotificationsManager = MockPushNotificationsManager()
+        let viewModel = OrdersViewModel(pushNotificationsManager: pushNotificationsManager, statusFilter: nil)
+
+        var resynchronizeRequested = false
+        viewModel.onShouldResynchronizeAfterAppActivation = {
+            resynchronizeRequested = true
+        }
+
+        viewModel.activateAndForwardUpdates(to: UITableView())
+
+        // Act
+        let notification = ForegroundNotification(noteID: 1, kind: .storeOrder, message: "")
+        pushNotificationsManager.sendForegroundNotification(notification)
+
+        // Assert
+        XCTAssertTrue(resynchronizeRequested)
+    }
+
+    func testGivenANonOrderNotificationItDoesNotRequestAResynchronization() {
+        // Arrange
+        let pushNotificationsManager = MockPushNotificationsManager()
+        let viewModel = OrdersViewModel(pushNotificationsManager: pushNotificationsManager, statusFilter: nil)
+
+        var resynchronizeRequested = false
+        viewModel.onShouldResynchronizeAfterAppActivation = {
+            resynchronizeRequested = true
+        }
+
+        viewModel.activateAndForwardUpdates(to: UITableView())
+
+        // Act
+        let notification = ForegroundNotification(noteID: 1, kind: .comment, message: "")
+        pushNotificationsManager.sendForegroundNotification(notification)
+
+        // Assert
+        XCTAssertFalse(resynchronizeRequested)
+    }
 }
 
 // MARK: - Helpers