Conditionally save SiteSummaryStats in Storage

Author: rachelmcr

Yosemite/Yosemite/Actions/StatsActionV4.swift

@@ -49,11 +49,13 @@ public enum StatsActionV4: Action {
                                 saveInStorage: Bool,
                                 onCompletion: (Result<TopEarnerStats, Error>) -> Void)
 
-    /// Retrieves the site summary stats for the provided site ID, period(s), and date, without saving them to the Storage layer.
+    /// Retrieves the site summary stats for the provided site ID, period(s), and date.
+    /// Conditionally saves them to storage, if a single period is retrieved.
     ///
     case retrieveSiteSummaryStats(siteID: Int64,
                                   period: StatGranularity,
                                   quantity: Int,
                                   latestDateToInclude: Date,
+                                  saveInStorage: Bool,
                                   onCompletion: (Result<SiteSummaryStats, Error>) -> Void)
 }

Yosemite/Yosemite/Stores/StatsStoreV4.swift

@@ -94,11 +94,13 @@ public final class StatsStoreV4: Store {
                                        let period,
                                        let quantity,
                                        let latestDateToInclude,
+                                       let saveInStorage,
                                        let onCompletion):
             retrieveSiteSummaryStats(siteID: siteID,
                                      period: period,
                                      quantity: quantity,
                                      latestDateToInclude: latestDateToInclude,
+                                     saveInStorage: saveInStorage,
                                      onCompletion: onCompletion)
         }
     }
@@ -189,19 +191,24 @@ private extension StatsStoreV4 {
         }
     }
 
-    /// Retrieves the site summary stats for the provided site ID, period(s), and date, without saving them to the Storage layer.
+    /// Retrieves the site summary stats for the provided site ID, period(s), and date.
+    /// Conditionally saves them to storage, if a single period is retrieved.
     ///
     func retrieveSiteSummaryStats(siteID: Int64,
                                   period: StatGranularity,
                                   quantity: Int,
                                   latestDateToInclude: Date,
+                                  saveInStorage: Bool,
                                   onCompletion: @escaping (Result<SiteSummaryStats, Error>) -> Void) {
         if quantity == 1 {
             siteStatsRemote.loadSiteSummaryStats(for: siteID,
                                                  period: period,
-                                                 includingDate: latestDateToInclude) { result in
+                                                 includingDate: latestDateToInclude) { [weak self] result in
                 switch result {
                 case .success(let siteSummaryStats):
+                    if saveInStorage {
+                        self?.upsertStoredSiteSummaryStats(readOnlyStats: siteSummaryStats)
+                    }
                     onCompletion(.success(siteSummaryStats))
                 case .failure(let error):
                     onCompletion(.failure(SiteStatsStoreError(error: error)))
@@ -486,6 +493,19 @@ extension StatsStoreV4 {
     }
 }
 
+// MARK: Site summary stats
+extension StatsStoreV4 {
+    /// Updates (OR Inserts) the specified ReadOnly SiteSummaryStats Entity into the Storage Layer.
+    ///
+    func upsertStoredSiteSummaryStats(readOnlyStats: Networking.SiteSummaryStats) {
+        assert(Thread.isMainThread)
+
+        let storage = storageManager.viewStorage
+        let storageSiteSummaryStats = storage.loadSiteSummaryStats(date: readOnlyStats.date, period: readOnlyStats.period.rawValue) ?? storage.insertNewObject(ofType: Storage.SiteSummaryStats.self)
+        storageSiteSummaryStats.update(with: readOnlyStats)
+        storage.saveIfNeeded()
+    }
+}
 
 // MARK: Convert Leaderboard into TopEarnerStats
 //

Yosemite/YosemiteTests/Stores/StatsStoreV4Tests.swift

@@ -518,7 +518,8 @@ final class StatsStoreV4Tests: XCTestCase {
             let action = StatsActionV4.retrieveSiteSummaryStats(siteID: self.sampleSiteID,
                                                                 period: .day,
                                                                 quantity: 1,
-                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-09T17:06:55")) { result in
+                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-09T17:06:55"),
+                                                                saveInStorage: false) { result in
                 promise(result)
             }
             store.onAction(action)
@@ -541,7 +542,8 @@ final class StatsStoreV4Tests: XCTestCase {
             let action = StatsActionV4.retrieveSiteSummaryStats(siteID: self.sampleSiteID,
                                                                 period: .month,
                                                                 quantity: 3,
-                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-31T17:06:55")) { _ in
+                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-31T17:06:55"),
+                                                                saveInStorage: false) { _ in
                 promise(())
             }
             store.onAction(action)
@@ -567,7 +569,8 @@ final class StatsStoreV4Tests: XCTestCase {
             let action = StatsActionV4.retrieveSiteSummaryStats(siteID: self.sampleSiteID,
                                                                 period: .month,
                                                                 quantity: 3,
-                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-31T17:06:55")) { result in
+                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-31T17:06:55"),
+                                                                saveInStorage: false) { result in
                 promise(result)
             }
             store.onAction(action)
@@ -591,7 +594,8 @@ final class StatsStoreV4Tests: XCTestCase {
             let action = StatsActionV4.retrieveSiteSummaryStats(siteID: self.sampleSiteID,
                                                                 period: .day,
                                                                 quantity: 1,
-                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-09T17:06:55")) { result in
+                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-09T17:06:55"),
+                                                                saveInStorage: false) { result in
                 promise(result)
             }
             store.onAction(action)
@@ -612,7 +616,8 @@ final class StatsStoreV4Tests: XCTestCase {
             let action = StatsActionV4.retrieveSiteSummaryStats(siteID: self.sampleSiteID,
                                                                 period: .day,
                                                                 quantity: 1,
-                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-09T17:06:55")) { result in
+                                                                latestDateToInclude: DateFormatter.dateFromString(with: "2022-12-09T17:06:55"),
+                                                                saveInStorage: false) { result in
                 promise(result)
             }
             store.onAction(action)