Merge pull request #7665 from woocommerce/feat/6966-reset-stats-sync-ts-after-orders

jaclync · web-flow · commit f378109fbe59 · 2022-09-15T17:43:41.000+08:00
Dashboard: reset the last sync timestamp after new orders
diff --git a/WooCommerce/Classes/Notifications/PushNotificationsManager.swift b/WooCommerce/Classes/Notifications/PushNotificationsManager.swift
@@ -45,6 +45,16 @@ final class PushNotificationsManager: PushNotesManager {
     /// Mutable reference to `inactiveNotifications`
     private let inactiveNotificationsSubject = PassthroughSubject<PushNotification, Never>()
 
+    /// An observable that emits values when a Remote Notification is received while the app is
+    /// in the background.
+    ///
+    var backgroundNotifications: AnyPublisher<PushNotification, Never> {
+        backgroundNotificationsSubject.eraseToAnyPublisher()
+    }
+
+    /// Mutable reference to `backgroundNotifications`
+    private let backgroundNotificationsSubject = PassthroughSubject<PushNotification, Never>()
+
     /// An observable that emits values when a local notification is received.
     ///
     var localNotificationUserResponses: AnyPublisher<UNNotificationResponse, Never> {
@@ -292,6 +302,10 @@ extension PushNotificationsManager {
 
         handleRemoteNotificationInAllAppStates(userInfo)
 
+        if let notification = PushNotification.from(userInfo: userInfo) {
+            backgroundNotificationsSubject.send(notification)
+        }
+
         return await synchronizeNotifications()
     }
 
@@ -598,6 +612,7 @@ private extension PushNotificationsManager {
 private extension PushNotification {
     static func from(userInfo: [AnyHashable: Any]) -> PushNotification? {
         guard let noteID = userInfo.integer(forKey: APNSKey.identifier),
+              let siteID = userInfo.integer(forKey: APNSKey.siteID),
               let alert = userInfo.dictionary(forKey: APNSKey.aps)?.dictionary(forKey: APNSKey.alert),
               let title = alert.string(forKey: APNSKey.alertTitle),
               let type = userInfo.string(forKey: APNSKey.type),
@@ -606,7 +621,7 @@ private extension PushNotification {
               }
         let subtitle = alert.string(forKey: APNSKey.alertSubtitle)
         let message = alert.string(forKey: APNSKey.alertMessage)
-        return PushNotification(noteID: noteID, kind: noteKind, title: title, subtitle: subtitle, message: message)
+        return PushNotification(noteID: noteID, siteID: siteID, kind: noteKind, title: title, subtitle: subtitle, message: message)
     }
 }
 
diff --git a/WooCommerce/Classes/ServiceLocator/PushNotesManager.swift b/WooCommerce/Classes/ServiceLocator/PushNotesManager.swift
@@ -20,6 +20,11 @@ protocol PushNotesManager {
     ///
     var inactiveNotifications: AnyPublisher<PushNotification, Never> { get }
 
+    /// An observable that emits values when a Remote Notification is received while the app is
+    /// in the background.
+    ///
+    var backgroundNotifications: AnyPublisher<PushNotification, Never> { get }
+
     /// An observable that emits values when a local notification response is received.
     ///
     var localNotificationUserResponses: AnyPublisher<UNNotificationResponse, Never> { get }
diff --git a/WooCommerce/Classes/ServiceLocator/PushNotification.swift b/WooCommerce/Classes/ServiceLocator/PushNotification.swift
@@ -9,6 +9,9 @@ struct PushNotification {
     /// The `note_id` value received from the Remote Notification's `userInfo`.
     ///
     let noteID: Int
+    /// The `blog` value received from the Remote Notification's `userInfo`.
+    ///
+    let siteID: Int
     /// The `type` value received from the Remote Notification's `userInfo`.
     ///
     let kind: Note.Kind
diff --git a/WooCommerce/Classes/ViewRelated/Dashboard/Stats v4/StoreStatsAndTopPerformersViewController.swift b/WooCommerce/Classes/ViewRelated/Dashboard/Stats v4/StoreStatsAndTopPerformersViewController.swift
@@ -47,11 +47,18 @@ final class StoreStatsAndTopPerformersViewController: ButtonBarPagerTabStripView
     private var selectedTimeRangeIndexSubscription: AnyCancellable?
     private var reloadDataAfterSelectedTimeRangeSubscriptions: Set<AnyCancellable> = []
 
+    private let pushNotificationsManager: PushNotesManager
+    private var localOrdersSubscription: AnyCancellable?
+    private var remoteOrdersSubscription: AnyCancellable?
+
     // MARK: - View Lifecycle
 
-    init(siteID: Int64, dashboardViewModel: DashboardViewModel) {
+    init(siteID: Int64,
+         dashboardViewModel: DashboardViewModel,
+         pushNotificationsManager: PushNotesManager = ServiceLocator.pushNotesManager) {
         self.siteID = siteID
         self.dashboardViewModel = dashboardViewModel
+        self.pushNotificationsManager = pushNotificationsManager
         super.init(nibName: nil, bundle: nil)
     }
 
@@ -82,6 +89,8 @@ final class StoreStatsAndTopPerformersViewController: ButtonBarPagerTabStripView
         super.viewDidLoad()
         configureView()
         observeSelectedTimeRangeIndex()
+        observeRemotelyCreatedOrdersToResetLastSyncTimestamp()
+        observeLocallyCreatedOrdersToResetLastSyncTimestamp()
     }
 
     override func viewWillAppear(_ animated: Bool) {
@@ -322,6 +331,35 @@ private extension StoreStatsAndTopPerformersViewController {
             periodViewController.refreshControl.endRefreshing()
         }
     }
+
+    func observeRemotelyCreatedOrdersToResetLastSyncTimestamp() {
+        let siteID = self.siteID
+        remoteOrdersSubscription = Publishers
+            .Merge(pushNotificationsManager.backgroundNotifications, pushNotificationsManager.foregroundNotifications)
+            .filter { $0.kind == .storeOrder && $0.siteID == siteID }
+            .sink { [weak self] _ in
+                self?.resetLastSyncTimestamp()
+            }
+    }
+
+    func observeLocallyCreatedOrdersToResetLastSyncTimestamp() {
+        let action = OrderAction.observeInsertedOrders(siteID: siteID) { [weak self] observableInsertedOrders in
+            guard let self = self else { return }
+            self.localOrdersSubscription = observableInsertedOrders
+                .filter { $0.isNotEmpty }
+                .sink { [weak self] _ in
+                    guard let self = self else { return }
+                    self.resetLastSyncTimestamp()
+                }
+        }
+        ServiceLocator.stores.dispatch(action)
+    }
+
+    func resetLastSyncTimestamp() {
+        periodVCs.forEach { periodVC in
+            periodVC.lastFullSyncTimestamp = nil
+        }
+    }
 }
 
 // MARK: - Placeholders
diff --git a/WooCommerce/WooCommerceTests/Mocks/MockPushNotificationsManager.swift b/WooCommerce/WooCommerceTests/Mocks/MockPushNotificationsManager.swift
@@ -24,6 +24,12 @@ final class MockPushNotificationsManager: PushNotesManager {
 
     private let inactiveNotificationsSubject = PassthroughSubject<PushNotification, Never>()
 
+    var backgroundNotifications: AnyPublisher<PushNotification, Never> {
+        backgroundNotificationsSubject.eraseToAnyPublisher()
+    }
+
+    private let backgroundNotificationsSubject = PassthroughSubject<PushNotification, Never>()
+
     var localNotificationUserResponses: AnyPublisher<UNNotificationResponse, Never> {
         localNotificationResponsesSubject.eraseToAnyPublisher()
     }
diff --git a/WooCommerce/WooCommerceTests/Notifications/PushNotificationsManagerTests.swift b/WooCommerce/WooCommerceTests/Notifications/PushNotificationsManagerTests.swift
@@ -470,6 +470,48 @@ final class PushNotificationsManagerTests: XCTestCase {
         XCTAssertNil(emittedNotification.message)
     }
 
+    // MARK: - Background Notification Observable
+
+    func test_it_emits_background_notifications_when_it_receives_a_notification_while_app_is_in_the_background() async throws {
+        // Given
+        application.applicationState = .background
+
+        manager = {
+            let configuration = PushNotificationsConfiguration(application: self.application,
+                                                               defaults: self.defaults,
+                                                               storesManager: self.storesManager,
+                                                               supportManager: self.supportManager,
+                                                               userNotificationsCenter: self.userNotificationCenter)
+            return PushNotificationsManager(configuration: configuration)
+        }()
+
+        var emittedNotifications = [PushNotification]()
+        manager.backgroundNotifications.sink { notification in
+            emittedNotifications.append(notification)
+        }.store(in: &subscriptions)
+
+        let userinfo = notificationPayload(noteID: 9_981,
+                                           type: .storeOrder,
+                                           siteID: 606,
+                                           title: Sample.defaultTitle,
+                                           subtitle: Sample.defaultSubtitle,
+                                           message: Sample.defaultMessage)
+
+        // When
+        _ = await manager.handleRemoteNotificationInTheBackground(userInfo: userinfo)
+
+        // Then
+        XCTAssertEqual(emittedNotifications.count, 1)
+
+        let emittedNotification = try XCTUnwrap(emittedNotifications.first)
+        XCTAssertEqual(emittedNotification.kind, .storeOrder)
+        XCTAssertEqual(emittedNotification.noteID, 9_981)
+        XCTAssertEqual(emittedNotification.siteID, 606)
+        XCTAssertEqual(emittedNotification.title, Sample.defaultTitle)
+        XCTAssertEqual(emittedNotification.subtitle, Sample.defaultSubtitle)
+        XCTAssertEqual(emittedNotification.message, Sample.defaultMessage)
+    }
+
     // MARK: - App Badge Number
 
     /// Verifies that `handleNotification` updates app badge number to 1 when the notification is from the same site.
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/HubMenu/HubMenuCoordinatorTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/HubMenu/HubMenuCoordinatorTests.swift
@@ -43,7 +43,7 @@ final class HubMenuCoordinatorTests: XCTestCase {
     func test_when_receiving_a_non_review_notification_then_it_will_not_do_anything() throws {
         // Given
         let coordinator = makeHubMenuCoordinator()
-        let pushNotification = PushNotification(noteID: 1_234, kind: .storeOrder, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .storeOrder, title: "", subtitle: "", message: "")
 
         coordinator.start()
         coordinator.activate(siteID: siteID)
@@ -64,7 +64,7 @@ final class HubMenuCoordinatorTests: XCTestCase {
     func test_when_receiving_a_notification_while_in_foreground_then_it_will_not_do_anything() throws {
         // Given
         let coordinator = makeHubMenuCoordinator()
-        let pushNotification = PushNotification(noteID: 1_234, kind: .comment, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .comment, title: "", subtitle: "", message: "")
 
         coordinator.start()
         coordinator.activate(siteID: siteID)
@@ -83,7 +83,7 @@ final class HubMenuCoordinatorTests: XCTestCase {
     func test_when_failing_to_retrieve_ProductReview_details_then_it_will_present_a_notice() throws {
         // Given
         let coordinator = makeHubMenuCoordinator()
-        let pushNotification = PushNotification(noteID: 1_234, kind: .comment, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .comment, title: "", subtitle: "", message: "")
 
         coordinator.start()
         coordinator.activate(siteID: siteID)
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/MainTabBarControllerTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/MainTabBarControllerTests.swift
@@ -238,7 +238,7 @@ final class MainTabBarControllerTests: XCTestCase {
 
         // Action
         // Send push notification in inactive state
-        let pushNotification = PushNotification(noteID: 1_234, kind: .comment, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .comment, title: "", subtitle: "", message: "")
         pushNotificationsManager.sendInactiveNotification(pushNotification)
 
         // Simulate that the network call returns a parcel
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Notifications/ReviewsCoordinatorTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Notifications/ReviewsCoordinatorTests.swift
@@ -43,7 +43,7 @@ final class ReviewsCoordinatorTests: XCTestCase {
     func test_when_receiving_a_non_review_notification_then_it_will_not_do_anything() throws {
         // Given
         let coordinator = makeReviewsCoordinator()
-        let pushNotification = PushNotification(noteID: 1_234, kind: .storeOrder, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .storeOrder, title: "", subtitle: "", message: "")
 
         coordinator.start()
         coordinator.activate(siteID: siteID)
@@ -64,7 +64,7 @@ final class ReviewsCoordinatorTests: XCTestCase {
     func test_when_receiving_a_notification_while_in_foreground_then_it_will_not_do_anything() throws {
         // Given
         let coordinator = makeReviewsCoordinator()
-        let pushNotification = PushNotification(noteID: 1_234, kind: .comment, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .comment, title: "", subtitle: "", message: "")
 
         coordinator.start()
         coordinator.activate(siteID: siteID)
@@ -82,7 +82,7 @@ final class ReviewsCoordinatorTests: XCTestCase {
 
     func test_when_receiving_a_foreground_notification_to_view_then_it_will_present_the_review_details() throws {
         // Given
-        let pushNotification = PushNotification(noteID: 1_234, kind: .comment, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .comment, title: "", subtitle: "", message: "")
 
         var willPresentReviewDetailsFromPushNotificationCallCount: Int = 0
         let coordinator = makeReviewsCoordinator(willPresentReviewDetailsFromPushNotification: {
@@ -114,7 +114,7 @@ final class ReviewsCoordinatorTests: XCTestCase {
 
     func test_when_receiving_a_review_notification_while_inactive_then_it_will_present_the_review_details() throws {
         // Given
-        let pushNotification = PushNotification(noteID: 1_234, kind: .comment, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .comment, title: "", subtitle: "", message: "")
 
         var willPresentReviewDetailsFromPushNotificationCallCount: Int = 0
         let coordinator = makeReviewsCoordinator(willPresentReviewDetailsFromPushNotification: {
@@ -147,7 +147,7 @@ final class ReviewsCoordinatorTests: XCTestCase {
     func test_when_failing_to_retrieve_ProductReview_details_then_it_will_present_a_notice() throws {
         // Given
         let coordinator = makeReviewsCoordinator()
-        let pushNotification = PushNotification(noteID: 1_234, kind: .comment, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .comment, title: "", subtitle: "", message: "")
 
         coordinator.start()
         coordinator.activate(siteID: siteID)
@@ -185,7 +185,7 @@ final class ReviewsCoordinatorTests: XCTestCase {
         sessionManager.setStoreId(1_000)
 
         let coordinator = makeReviewsCoordinator()
-        let pushNotification = PushNotification(noteID: 1_234, kind: .comment, title: "", subtitle: "", message: "")
+        let pushNotification = PushNotification(noteID: 1_234, siteID: 1, kind: .comment, title: "", subtitle: "", message: "")
         let differentSiteID: Int64 = 2_000_111
 
         coordinator.start()
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Orders/OrderListViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Orders/OrderListViewModelTests.swift
@@ -204,7 +204,7 @@ final class OrderListViewModelTests: XCTestCase {
         viewModel.activate()
 
         // Act
-        let notification = PushNotification(noteID: 1, kind: .storeOrder, title: "", subtitle: "", message: "")
+        let notification = PushNotification(noteID: 1, siteID: 1, kind: .storeOrder, title: "", subtitle: "", message: "")
         pushNotificationsManager.sendForegroundNotification(notification)
 
         // Assert
@@ -224,7 +224,7 @@ final class OrderListViewModelTests: XCTestCase {
         viewModel.activate()
 
         // Act
-        let notification = PushNotification(noteID: 1, kind: .comment, title: "", subtitle: "", message: "")
+        let notification = PushNotification(noteID: 1, siteID: 1, kind: .comment, title: "", subtitle: "", message: "")
         pushNotificationsManager.sendForegroundNotification(notification)
 
         // Assert
diff --git a/Yosemite/Yosemite/Actions/OrderAction.swift b/Yosemite/Yosemite/Actions/OrderAction.swift
@@ -1,3 +1,4 @@
+import Combine
 import Foundation
 import Networking
 
@@ -98,4 +99,8 @@ public enum OrderAction: Action {
     /// Deletes a given order.
     ///
     case deleteOrder(siteID: Int64, order: Order, deletePermanently: Bool, onCompletion: (Result<Order, Error>) -> Void)
+
+    /// Returns a publisher that emits inserted orders on the view storage context.
+    ///
+    case observeInsertedOrders(siteID: Int64, completion: (AnyPublisher<[Order], Never>) -> Void)
 }
diff --git a/Yosemite/Yosemite/Stores/OrderStore.swift b/Yosemite/Yosemite/Stores/OrderStore.swift
@@ -1,3 +1,4 @@
+import Combine
 import Foundation
 import Networking
 import Storage
@@ -82,6 +83,8 @@ public class OrderStore: Store {
             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)
+        case let .observeInsertedOrders(siteID, completion):
+            observeInsertedOrders(siteID: siteID, completion: completion)
         }
     }
 }
@@ -451,6 +454,26 @@ private extension OrderStore {
             }
         }
     }
+
+    func observeInsertedOrders(siteID: Int64, completion: (AnyPublisher<[Order], Never>) -> Void) {
+        completion(
+            NotificationCenter.default
+                .publisher(for: .NSManagedObjectContextObjectsDidChange, object: storageManager.viewStorage)
+                .map { notification -> [Order] in
+                    guard let note = ManagedObjectsDidChangeNotification(notification: notification) else {
+                        return []
+                    }
+
+                    return note.insertedObjects.compactMap { ($0 as? StorageOrder)?.toReadOnly() }
+                }
+                .map { orders in
+                    orders.filter { $0.siteID == siteID }
+                }
+                .filter { $0.isEmpty == false }
+                .removeDuplicates()
+                .eraseToAnyPublisher()
+        )
+    }
 }
 
 
diff --git a/Yosemite/YosemiteTests/Stores/OrderStoreTests.swift b/Yosemite/YosemiteTests/Stores/OrderStoreTests.swift
