[Woo POS][Local Catalog] Store full sync date on site entity (#16115)

Author: joshheald

Modules/Sources/Fakes/Yosemite.generated.swift

@@ -58,7 +58,8 @@ extension Yosemite.POSSite {
     public static func fake() -> Yosemite.POSSite {
         .init(
             siteID: .fake(),
-            lastIncrementalSyncDate: .fake()
+            lastIncrementalSyncDate: .fake(),
+            lastFullSyncDate: .fake()
         )
     }
 }

Modules/Sources/Storage/GRDB/Migrations/V001InitialSchema.swift

@@ -20,6 +20,7 @@ struct V001InitialSchema {
         try db.create(table: "site") { siteTable in
             siteTable.primaryKey("id", .integer).notNull()
             siteTable.column("lastCatalogIncrementalSyncDate", .datetime)
+            siteTable.column("lastCatalogFullSyncDate", .datetime)
         }
     }
 

Modules/Sources/Storage/GRDB/Model/PersistedSite.swift

@@ -6,12 +6,15 @@ public struct PersistedSite: Codable {
     // periphery:ignore - TODO: remove ignore when populating database
     public let id: Int64
     // periphery:ignore - TODO: remove ignore when populating database
-    public let lastCatalogIncrementalSyncDate: Date?
+    public var lastCatalogIncrementalSyncDate: Date?
+    // periphery:ignore - TODO: remove ignore when populating database
+    public var lastCatalogFullSyncDate: Date?
 
     // periphery:ignore - TODO: remove ignore when populating database
-    public init(id: Int64, lastCatalogIncrementalSyncDate: Date? = nil) {
+    public init(id: Int64, lastCatalogIncrementalSyncDate: Date? = nil, lastCatalogFullSyncDate: Date? = nil) {
         self.id = id
         self.lastCatalogIncrementalSyncDate = lastCatalogIncrementalSyncDate
+        self.lastCatalogFullSyncDate = lastCatalogFullSyncDate
     }
 }
 
@@ -21,9 +24,11 @@ extension PersistedSite: FetchableRecord, PersistableRecord {
 
     public enum Columns {
         // periphery:ignore - TODO: remove ignore when populating database
-        static let id = Column(CodingKeys.id)
+        public static let id = Column(CodingKeys.id)
+        // periphery:ignore - TODO: remove ignore when populating database
+        public static let lastCatalogIncrementalSyncDate = Column(CodingKeys.lastCatalogIncrementalSyncDate)
         // periphery:ignore - TODO: remove ignore when populating database
-        static let lastCatalogIncrementalSyncDate = Column(CodingKeys.lastCatalogIncrementalSyncDate)
+        public static let lastCatalogFullSyncDate = Column(CodingKeys.lastCatalogFullSyncDate)
     }
 }
 
@@ -32,5 +37,6 @@ private extension PersistedSite {
     enum CodingKeys: String, CodingKey {
         case id
         case lastCatalogIncrementalSyncDate
+        case lastCatalogFullSyncDate
     }
 }

Modules/Sources/Storage/Model/Copiable/Models+Copiable.generated.swift

@@ -115,8 +115,7 @@ extension Storage.GeneralStoreSettings {
         lastSelectedOrderStatus: NullableCopiableProp<String> = .copy,
         favoriteProductIDs: CopiableProp<[Int64]> = .copy,
         searchTermsByKey: CopiableProp<[String: [String]]> = .copy,
-        isPOSTabVisible: NullableCopiableProp<Bool> = .copy,
-        posLastFullSyncDate: NullableCopiableProp<Date> = .copy
+        isPOSTabVisible: NullableCopiableProp<Bool> = .copy
     ) -> Storage.GeneralStoreSettings {
         let storeID = storeID ?? self.storeID
         let isTelemetryAvailable = isTelemetryAvailable ?? self.isTelemetryAvailable
@@ -138,7 +137,6 @@ extension Storage.GeneralStoreSettings {
         let favoriteProductIDs = favoriteProductIDs ?? self.favoriteProductIDs
         let searchTermsByKey = searchTermsByKey ?? self.searchTermsByKey
         let isPOSTabVisible = isPOSTabVisible ?? self.isPOSTabVisible
-        let posLastFullSyncDate = posLastFullSyncDate ?? self.posLastFullSyncDate
 
         return Storage.GeneralStoreSettings(
             storeID: storeID,
@@ -160,8 +158,7 @@ extension Storage.GeneralStoreSettings {
             lastSelectedOrderStatus: lastSelectedOrderStatus,
             favoriteProductIDs: favoriteProductIDs,
             searchTermsByKey: searchTermsByKey,
-            isPOSTabVisible: isPOSTabVisible,
-            posLastFullSyncDate: posLastFullSyncDate
+            isPOSTabVisible: isPOSTabVisible
         )
     }
 }

Modules/Sources/Storage/Model/GeneralStoreSettings.swift

@@ -86,9 +86,6 @@ public struct GeneralStoreSettings: Codable, Equatable, GeneratedCopiable {
     ///
     public var isPOSTabVisible: Bool?
 
-    /// Last time a POS catalog full sync was completed for this store.
-    ///
-    public var posLastFullSyncDate: Date?
 
     public init(storeID: String? = nil,
                 isTelemetryAvailable: Bool = false,
@@ -109,8 +106,7 @@ public struct GeneralStoreSettings: Codable, Equatable, GeneratedCopiable {
                 lastSelectedOrderStatus: String? = nil,
                 favoriteProductIDs: [Int64] = [],
                 searchTermsByKey: [String: [String]] = [:],
-                isPOSTabVisible: Bool? = nil,
-                posLastFullSyncDate: Date? = nil) {
+                isPOSTabVisible: Bool? = nil) {
         self.storeID = storeID
         self.isTelemetryAvailable = isTelemetryAvailable
         self.telemetryLastReportedTime = telemetryLastReportedTime
@@ -131,7 +127,6 @@ public struct GeneralStoreSettings: Codable, Equatable, GeneratedCopiable {
         self.favoriteProductIDs = favoriteProductIDs
         self.searchTermsByKey = searchTermsByKey
         self.isPOSTabVisible = isPOSTabVisible
-        self.posLastFullSyncDate = posLastFullSyncDate
     }
 
     public func erasingSelectedTaxRateID() -> GeneralStoreSettings {
@@ -153,8 +148,7 @@ public struct GeneralStoreSettings: Codable, Equatable, GeneratedCopiable {
                              lastSelectedOrderStatus: lastSelectedOrderStatus,
                              favoriteProductIDs: favoriteProductIDs,
                              searchTermsByKey: searchTermsByKey,
-                             isPOSTabVisible: isPOSTabVisible,
-                             posLastFullSyncDate: posLastFullSyncDate)
+                             isPOSTabVisible: isPOSTabVisible)
     }
 }
 
@@ -189,7 +183,6 @@ extension GeneralStoreSettings {
         self.searchTermsByKey = try container.decodeIfPresent([String: [String]].self, forKey: .searchTermsByKey) ?? [:]
 
         self.isPOSTabVisible = try container.decodeIfPresent(Bool.self, forKey: .isPOSTabVisible)
-        self.posLastFullSyncDate = try container.decodeIfPresent(Date.self, forKey: .posLastFullSyncDate)
 
         // Decode new properties with `decodeIfPresent` and provide a default value if necessary.
     }

Modules/Sources/Yosemite/Model/Copiable/Models+Copiable.generated.swift

@@ -96,14 +96,17 @@ extension Yosemite.POSSimpleProduct {
 extension Yosemite.POSSite {
     public func copy(
         siteID: CopiableProp<Int64> = .copy,
-        lastIncrementalSyncDate: NullableCopiableProp<Date> = .copy
+        lastIncrementalSyncDate: NullableCopiableProp<Date> = .copy,
+        lastFullSyncDate: NullableCopiableProp<Date> = .copy
     ) -> Yosemite.POSSite {
         let siteID = siteID ?? self.siteID
         let lastIncrementalSyncDate = lastIncrementalSyncDate ?? self.lastIncrementalSyncDate
+        let lastFullSyncDate = lastFullSyncDate ?? self.lastFullSyncDate
 
         return Yosemite.POSSite(
             siteID: siteID,
-            lastIncrementalSyncDate: lastIncrementalSyncDate
+            lastIncrementalSyncDate: lastIncrementalSyncDate,
+            lastFullSyncDate: lastFullSyncDate
         )
     }
 }

Modules/Sources/Yosemite/Model/Storage/PersistedSite+Conversions.swift

@@ -1,18 +1,21 @@
+// periphery:ignore:all
 import Foundation
 import Storage
 
 extension PersistedSite {
     init(from posSite: POSSite) {
         self.init(
             id: posSite.siteID,
-            lastCatalogIncrementalSyncDate: posSite.lastIncrementalSyncDate
+            lastCatalogIncrementalSyncDate: posSite.lastIncrementalSyncDate,
+            lastCatalogFullSyncDate: posSite.lastFullSyncDate
         )
     }
 
     func toPOSSite() -> POSSite {
         POSSite(
             siteID: id,
-            lastIncrementalSyncDate: lastCatalogIncrementalSyncDate
+            lastIncrementalSyncDate: lastCatalogIncrementalSyncDate,
+            lastFullSyncDate: lastCatalogFullSyncDate
         )
     }
 }

Modules/Sources/Yosemite/PointOfSale/POSSite.swift

@@ -5,9 +5,11 @@ import Foundation
 public struct POSSite: Equatable, GeneratedCopiable, GeneratedFakeable {
     public let siteID: Int64
     public let lastIncrementalSyncDate: Date?
+    public let lastFullSyncDate: Date?
 
-    public init(siteID: Int64, lastIncrementalSyncDate: Date? = nil) {
+    public init(siteID: Int64, lastIncrementalSyncDate: Date? = nil, lastFullSyncDate: Date? = nil) {
         self.siteID = siteID
         self.lastIncrementalSyncDate = lastIncrementalSyncDate
+        self.lastFullSyncDate = lastFullSyncDate
     }
 }

Modules/Sources/Yosemite/Stores/Helpers/SiteSpecificAppSettingsStoreMethods.swift

@@ -11,10 +11,6 @@ public protocol SiteSpecificAppSettingsStoreMethodsProtocol {
     // Search history methods
     func getSearchTerms(for itemType: POSItemType, siteID: Int64) -> [String]
     func setSearchTerms(_ terms: [String], for itemType: POSItemType, siteID: Int64)
-
-    // POS catalog sync timestamp methods
-    func getPOSLastFullSyncDate(for siteID: Int64) -> Date?
-    func setPOSLastFullSyncDate(_ date: Date?, for siteID: Int64)
 }
 
 /// Methods for managing site-specific app settings
@@ -102,20 +98,6 @@ extension SiteSpecificAppSettingsStoreMethods {
     }
 }
 
-// MARK: - POS Catalog Sync Timestamps
-extension SiteSpecificAppSettingsStoreMethods {
-    func getPOSLastFullSyncDate(for siteID: Int64) -> Date? {
-        let storeSettings = getStoreSettings(for: siteID)
-        return storeSettings.posLastFullSyncDate
-    }
-
-    func setPOSLastFullSyncDate(_ date: Date?, for siteID: Int64) {
-        let storeSettings = getStoreSettings(for: siteID)
-        let updatedSettings = storeSettings.copy(posLastFullSyncDate: date)
-        setStoreSettings(settings: updatedSettings, for: siteID)
-    }
-}
-
 // MARK: - Constants
 private enum Constants {
     static let generalStoreSettingsFileName = "general-store-settings.plist"

Modules/Sources/Yosemite/Tools/POS/POSCatalogFullSyncService.swift

@@ -2,7 +2,6 @@ import Foundation
 import protocol Networking.POSCatalogSyncRemoteProtocol
 import class Networking.AlamofireNetwork
 import class Networking.POSCatalogSyncRemote
-import CocoaLumberjackSwift
 import Storage
 
 // TODO - remove the periphery ignore comment when the catalog is integrated with POS.
@@ -20,6 +19,7 @@ public protocol POSCatalogFullSyncServiceProtocol {
 public struct POSCatalog {
     public let products: [POSProduct]
     public let variations: [POSProductVariation]
+    public let syncDate: Date
 }
 
 // TODO - remove the periphery ignore comment when the service is integrated with POS.
@@ -74,6 +74,7 @@ public final class POSCatalogFullSyncService: POSCatalogFullSyncServiceProtocol
 
 private extension POSCatalogFullSyncService {
     func loadCatalog(for siteID: Int64, syncRemote: POSCatalogSyncRemoteProtocol) async throws -> POSCatalog {
+        let syncStartDate = Date.now
         // Loads products and variations in batches in parallel.
         async let productsTask = batchedLoader.loadAll(
             makeRequest: { pageNumber in
@@ -87,7 +88,7 @@ private extension POSCatalogFullSyncService {
         )
 
         let (products, variations) = try await (productsTask, variationsTask)
-        return POSCatalog(products: products, variations: variations)
+        return POSCatalog(products: products, variations: variations, syncDate: syncStartDate)
     }
 
 }