Merge pull request #6890 from woocommerce/td/6865-fetch-stats-api-for-selected-tab

Dashboard: fetch stats data only for the visible time range tab

Author: jaclync

WooCommerce/Classes/ViewRelated/Dashboard/DashboardUI.swift

@@ -0,0 +1,26 @@
+import UIKit
+
+/// Contains all UI content to show on Dashboard
+///
+protocol DashboardUI: UIViewController {
+    /// For navigation bar large title workaround.
+    var scrollDelegate: DashboardUIScrollDelegate? { get set }
+
+    /// Called when the Dashboard should display syncing error
+    var displaySyncingError: () -> Void { get set }
+
+    /// Called when the user pulls to refresh
+    var onPullToRefresh: @MainActor () async -> Void { get set }
+
+    /// Reloads data in Dashboard
+    ///
+    /// - Parameter forced: pass `true` to override sync throttling
+    @MainActor
+    func reloadData(forced: Bool) async
+}
+
+/// Relays the scroll events to a delegate for navigation bar large title workaround.
+protocol DashboardUIScrollDelegate: AnyObject {
+    /// Called when a dashboard tab `UIScrollView`'s `scrollViewDidScroll` event is triggered from the user.
+    func dashboardUIScrollViewDidScroll(_ scrollView: UIScrollView)
+}

WooCommerce/Classes/ViewRelated/Dashboard/DashboardViewController.swift

@@ -12,9 +12,11 @@ final class DashboardViewController: UIViewController {
 
     private let siteID: Int64
 
-    private let dashboardUIFactory: DashboardUIFactory
     @Published private var dashboardUI: DashboardUI?
 
+    private lazy var deprecatedStatsViewController = DeprecatedDashboardStatsViewController()
+    private lazy var storeStatsAndTopPerformersViewController = StoreStatsAndTopPerformersViewController(siteID: siteID, dashboardViewModel: viewModel)
+
     // Used to enable subtitle with store name
     private var shouldShowStoreNameAsSubtitle: Bool = false
 
@@ -88,13 +90,14 @@ final class DashboardViewController: UIViewController {
         return view
     }()
 
+    private let viewModel: DashboardViewModel = .init()
+
     private var subscriptions = Set<AnyCancellable>()
 
     // MARK: View Lifecycle
 
     init(siteID: Int64) {
         self.siteID = siteID
-        dashboardUIFactory = DashboardUIFactory(siteID: siteID)
         super.init(nibName: nil, bundle: nil)
         configureTabBarItem()
     }
@@ -112,13 +115,16 @@ final class DashboardViewController: UIViewController {
         observeSiteForUIUpdates()
         observeBottomJetpackBenefitsBannerVisibilityUpdates()
         observeNavigationBarHeightForStoreNameLabelVisibility()
+        observeStatsVersionForDashboardUIUpdates()
+        Task { @MainActor in
+            await reloadDashboardUIStatsVersion(forced: true)
+        }
     }
 
     override func viewWillAppear(_ animated: Bool) {
         super.viewWillAppear(animated)
         // Reset title to prevent it from being empty right after login
         configureTitle()
-        reloadDashboardUIStatsVersion(forced: false)
     }
 
     override func viewDidLayoutSubviews() {
@@ -256,11 +262,23 @@ private extension DashboardViewController {
         }
     }
 
-    func reloadDashboardUIStatsVersion(forced: Bool) {
-        dashboardUIFactory.reloadDashboardUI(onUIUpdate: { [weak self] dashboardUI in
+    func reloadDashboardUIStatsVersion(forced: Bool) async {
+        await storeStatsAndTopPerformersViewController.reloadData(forced: forced)
+    }
+
+    func observeStatsVersionForDashboardUIUpdates() {
+        viewModel.$statsVersion.removeDuplicates().sink { [weak self] statsVersion in
+            guard let self = self else { return }
+            let dashboardUI: DashboardUI
+            switch statsVersion {
+            case .v3:
+                dashboardUI = self.deprecatedStatsViewController
+            case .v4:
+                dashboardUI = self.storeStatsAndTopPerformersViewController
+            }
             dashboardUI.scrollDelegate = self
-            self?.onDashboardUIUpdate(forced: forced, updatedDashboardUI: dashboardUI)
-        })
+            self.onDashboardUIUpdate(forced: false, updatedDashboardUI: dashboardUI)
+        }.store(in: &subscriptions)
     }
 
     /// Display the error banner at the top of the dashboard content (below the site title)
@@ -300,8 +318,10 @@ extension DashboardViewController: DashboardUIScrollDelegate {
 private extension DashboardViewController {
     func onDashboardUIUpdate(forced: Bool, updatedDashboardUI: DashboardUI) {
         defer {
-            // Reloads data of the updated dashboard UI at the end.
-            reloadData(forced: forced)
+            Task { @MainActor [weak self] in
+                // Reloads data of the updated dashboard UI at the end.
+                await self?.reloadData(forced: true)
+            }
         }
 
         // Optimistically hide the error banner any time the dashboard UI updates (not just pull to refresh)
@@ -327,7 +347,7 @@ private extension DashboardViewController {
         dashboardUI = updatedDashboardUI
 
         updatedDashboardUI.onPullToRefresh = { [weak self] in
-            self?.pullToRefresh()
+            await self?.pullToRefresh()
         }
         updatedDashboardUI.displaySyncingError = { [weak self] in
             self?.showTopBannerView()
@@ -399,20 +419,20 @@ private extension DashboardViewController {
         show(settingsViewController, sender: self)
     }
 
-    func pullToRefresh() {
+    func pullToRefresh() async {
         ServiceLocator.analytics.track(.dashboardPulledToRefresh)
-        reloadDashboardUIStatsVersion(forced: true)
+        await reloadDashboardUIStatsVersion(forced: true)
     }
 }
 
 // MARK: - Private Helpers
 //
 private extension DashboardViewController {
-    func reloadData(forced: Bool) {
+    @MainActor
+    func reloadData(forced: Bool) async {
         DDLogInfo("♻️ Requesting dashboard data be reloaded...")
-        dashboardUI?.reloadData(forced: forced, completion: { [weak self] in
-            self?.configureTitle()
-        })
+        await dashboardUI?.reloadData(forced: forced)
+        configureTitle()
     }
 
     func observeSiteForUIUpdates() {
@@ -424,7 +444,9 @@ private extension DashboardViewController {
                 return
             }
             self.updateUI(site: site)
-            self.reloadData(forced: true)
+            Task { @MainActor [weak self] in
+                await self?.reloadData(forced: true)
+            }
         }.store(in: &subscriptions)
     }
 

WooCommerce/Classes/ViewRelated/Dashboard/DashboardViewModel.swift

@@ -0,0 +1,97 @@
+import Yosemite
+import enum Networking.DotcomError
+import enum Storage.StatsVersion
+
+/// Syncs data for dashboard stats UI and determines the state of the dashboard UI based on stats version.
+final class DashboardViewModel {
+    /// Stats v4 is shown by default, then falls back to v3 if store stats are unavailable.
+    @Published private(set) var statsVersion: StatsVersion = .v4
+
+    private let stores: StoresManager
+
+    init(stores: StoresManager = ServiceLocator.stores) {
+        self.stores = stores
+    }
+
+    /// Syncs store stats for dashboard UI.
+    func syncStats(for siteID: Int64,
+                   siteTimezone: TimeZone,
+                   timeRange: StatsTimeRangeV4,
+                   latestDateToInclude: Date,
+                   onCompletion: ((Result<Void, Error>) -> Void)? = nil) {
+        let earliestDateToInclude = timeRange.earliestDate(latestDate: latestDateToInclude, siteTimezone: siteTimezone)
+        let action = StatsActionV4.retrieveStats(siteID: siteID,
+                                                 timeRange: timeRange,
+                                                 earliestDateToInclude: earliestDateToInclude,
+                                                 latestDateToInclude: latestDateToInclude,
+                                                 quantity: timeRange.maxNumberOfIntervals,
+                                                 onCompletion: { [weak self] result in
+            guard let self = self else { return }
+            switch result {
+            case .success:
+                self.statsVersion = .v4
+            case .failure(let error):
+                DDLogError("⛔️ Dashboard (Order Stats) — Error synchronizing order stats v4: \(error)")
+                if error as? DotcomError == .noRestRoute {
+                    self.statsVersion = .v3
+                } else {
+                    self.statsVersion = .v4
+                }
+            }
+            onCompletion?(result)
+        })
+        stores.dispatch(action)
+    }
+
+    /// Syncs visitor stats for dashboard UI.
+    func syncSiteVisitStats(for siteID: Int64,
+                            siteTimezone: TimeZone,
+                            timeRange: StatsTimeRangeV4,
+                            latestDateToInclude: Date,
+                            onCompletion: ((Result<Void, Error>) -> Void)? = nil) {
+        let action = StatsActionV4.retrieveSiteVisitStats(siteID: siteID,
+                                                          siteTimezone: siteTimezone,
+                                                          timeRange: timeRange,
+                                                          latestDateToInclude: latestDateToInclude,
+                                                          onCompletion: { result in
+            if case let .failure(error) = result {
+                DDLogError("⛔️ Error synchronizing visitor stats: \(error)")
+            }
+            onCompletion?(result)
+        })
+        stores.dispatch(action)
+    }
+
+    /// Syncs top performers data for dashboard UI.
+    func syncTopEarnersStats(for siteID: Int64,
+                             siteTimezone: TimeZone,
+                             timeRange: StatsTimeRangeV4,
+                             latestDateToInclude: Date,
+                             onCompletion: ((Result<Void, Error>) -> Void)? = nil) {
+        let earliestDateToInclude = timeRange.earliestDate(latestDate: latestDateToInclude, siteTimezone: siteTimezone)
+        let action = StatsActionV4.retrieveTopEarnerStats(siteID: siteID,
+                                                          timeRange: timeRange,
+                                                          earliestDateToInclude: earliestDateToInclude,
+                                                          latestDateToInclude: latestDateToInclude,
+                                                          quantity: Constants.topEarnerStatsLimit,
+                                                          onCompletion: { result in
+            switch result {
+            case .success:
+                ServiceLocator.analytics.track(event:
+                        .Dashboard.dashboardTopPerformersLoaded(timeRange: timeRange))
+            case .failure(let error):
+                DDLogError("⛔️ Dashboard (Top Performers) — Error synchronizing top earner stats: \(error)")
+            }
+            onCompletion?(result)
+        })
+        stores.dispatch(action)
+    }
+}
+
+// MARK: - Constants
+//
+private extension DashboardViewModel {
+    enum Constants {
+        static let topEarnerStatsLimit: Int = 5
+    }
+}