[Local Catalog] Incremental sync: persist incremental sync date in Site storage entity (#16108)

Author: jaclync

Modules/Sources/Fakes/Yosemite.generated.swift

@@ -52,6 +52,16 @@ extension Yosemite.POSSimpleProduct {
         )
     }
 }
+extension Yosemite.POSSite {
+    /// Returns a "ready to use" type filled with fake values.
+    ///
+    public static func fake() -> Yosemite.POSSite {
+        .init(
+            siteID: .fake(),
+            lastIncrementalSyncDate: .fake()
+        )
+    }
+}
 extension Yosemite.ProductReviewFromNoteParcel {
     /// Returns a "ready to use" type filled with fake values.
     ///

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

@@ -19,6 +19,7 @@ struct V001InitialSchema {
     static func createSiteTable(_ db: Database) throws {
         try db.create(table: "site") { siteTable in
             siteTable.primaryKey("id", .integer).notNull()
+            siteTable.column("lastCatalogIncrementalSyncDate", .datetime)
         }
     }
 

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

@@ -5,10 +5,13 @@ import GRDB
 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?
 
     // periphery:ignore - TODO: remove ignore when populating database
-    public init(id: Int64) {
+    public init(id: Int64, lastCatalogIncrementalSyncDate: Date? = nil) {
         self.id = id
+        self.lastCatalogIncrementalSyncDate = lastCatalogIncrementalSyncDate
     }
 }
 
@@ -19,12 +22,15 @@ extension PersistedSite: FetchableRecord, PersistableRecord {
     public enum Columns {
         // periphery:ignore - TODO: remove ignore when populating database
         static let id = Column(CodingKeys.id)
+        // periphery:ignore - TODO: remove ignore when populating database
+        static let lastCatalogIncrementalSyncDate = Column(CodingKeys.lastCatalogIncrementalSyncDate)
     }
 }
 
 // periphery:ignore - TODO: remove ignore when populating database
 private extension PersistedSite {
     enum CodingKeys: String, CodingKey {
         case id
+        case lastCatalogIncrementalSyncDate
     }
 }

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

@@ -93,6 +93,21 @@ extension Yosemite.POSSimpleProduct {
     }
 }
 
+extension Yosemite.POSSite {
+    public func copy(
+        siteID: CopiableProp<Int64> = .copy,
+        lastIncrementalSyncDate: NullableCopiableProp<Date> = .copy
+    ) -> Yosemite.POSSite {
+        let siteID = siteID ?? self.siteID
+        let lastIncrementalSyncDate = lastIncrementalSyncDate ?? self.lastIncrementalSyncDate
+
+        return Yosemite.POSSite(
+            siteID: siteID,
+            lastIncrementalSyncDate: lastIncrementalSyncDate
+        )
+    }
+}
+
 extension Yosemite.ProductReviewFromNoteParcel {
     public func copy(
         note: CopiableProp<Note> = .copy,

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

@@ -0,0 +1,18 @@
+import Foundation
+import Storage
+
+extension PersistedSite {
+    init(from posSite: POSSite) {
+        self.init(
+            id: posSite.siteID,
+            lastCatalogIncrementalSyncDate: posSite.lastIncrementalSyncDate
+        )
+    }
+
+    func toPOSSite() -> POSSite {
+        POSSite(
+            siteID: id,
+            lastIncrementalSyncDate: lastCatalogIncrementalSyncDate
+        )
+    }
+}

Modules/Sources/Yosemite/PointOfSale/POSSite.swift

@@ -0,0 +1,13 @@
+// periphery:ignore:all
+import Codegen
+import Foundation
+
+public struct POSSite: Equatable, GeneratedCopiable, GeneratedFakeable {
+    public let siteID: Int64
+    public let lastIncrementalSyncDate: Date?
+
+    public init(siteID: Int64, lastIncrementalSyncDate: Date? = nil) {
+        self.siteID = siteID
+        self.lastIncrementalSyncDate = lastIncrementalSyncDate
+    }
+}

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

@@ -21,7 +21,6 @@ public final class POSCatalogIncrementalSyncService: POSCatalogIncrementalSyncSe
     private let syncRemote: POSCatalogSyncRemoteProtocol
     private let batchSize: Int
     private let persistenceService: POSCatalogPersistenceServiceProtocol
-    private var lastIncrementalSyncDates: [Int64: Date] = [:]
     private let batchedLoader: BatchedRequestLoader
 
     public convenience init?(credentials: Credentials?, batchSize: Int = 1, grdbManager: GRDBManagerProtocol) {
@@ -45,7 +44,7 @@ public final class POSCatalogIncrementalSyncService: POSCatalogIncrementalSyncSe
     // MARK: - Protocol Conformance
 
     public func startIncrementalSync(for siteID: Int64, lastFullSyncDate: Date) async throws {
-        let modifiedAfter = lastIncrementalSyncDates[siteID] ?? lastFullSyncDate
+        let modifiedAfter = try await latestSyncDate(siteID: siteID, lastFullSyncDate: lastFullSyncDate)
 
         DDLogInfo("🔄 Starting incremental catalog sync for site ID: \(siteID), modifiedAfter: \(modifiedAfter)")
 
@@ -57,8 +56,7 @@ public final class POSCatalogIncrementalSyncService: POSCatalogIncrementalSyncSe
             try await persistenceService.persistIncrementalCatalogData(catalog, siteID: siteID)
             DDLogInfo("✅ Persisted \(catalog.products.count) products and \(catalog.variations.count) variations to database for siteID \(siteID)")
 
-            // TODO: WOOMOB-1289 - replace with store settings persistence
-            lastIncrementalSyncDates[siteID] = syncStartDate
+            try await persistenceService.updateSite(.init(siteID: siteID, lastIncrementalSyncDate: syncStartDate))
             DDLogInfo("✅ Updated last incremental sync date to \(syncStartDate) for siteID \(siteID)")
         } catch {
             DDLogError("❌ Failed to sync and persist catalog incrementally: \(error)")
@@ -86,3 +84,11 @@ private extension POSCatalogIncrementalSyncService {
         return POSCatalog(products: products, variations: variations)
     }
 }
+
+// MARK: - Sync date
+
+private extension POSCatalogIncrementalSyncService {
+    func latestSyncDate(siteID: Int64, lastFullSyncDate: Date) async throws -> Date {
+        try await persistenceService.loadSite(siteID: siteID)?.lastIncrementalSyncDate ?? lastFullSyncDate
+    }
+}

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

@@ -3,6 +3,10 @@ import Foundation
 import Storage
 import GRDB
 
+enum POSCatalogPersistenceError: Error, Equatable {
+    case siteNotFound(siteID: Int64)
+}
+
 protocol POSCatalogPersistenceServiceProtocol {
     /// Clears existing data and persists new catalog data
     /// - Parameters:
@@ -15,6 +19,15 @@ protocol POSCatalogPersistenceServiceProtocol {
     ///   - catalog: The catalog difference to persist
     ///   - siteID: The site ID to associate the catalog with
     func persistIncrementalCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws
+
+    /// Loads the POS site for the given site ID
+    /// - Parameter siteID: The site ID to load the POSSite for
+    /// - Returns: The loaded POSSite or nil if not found in storage
+    func loadSite(siteID: Int64) async throws -> POSSite?
+
+    /// Updates the PersistedSite based on POSSite data
+    /// - Parameter site: The POSSite containing the updated data
+    func updateSite(_ site: POSSite) async throws
 }
 
 final class POSCatalogPersistenceService: POSCatalogPersistenceServiceProtocol {
@@ -136,6 +149,23 @@ final class POSCatalogPersistenceService: POSCatalogPersistenceServiceProtocol {
                       "\(variationImageCount) variation images, \(variationAttributeCount) variation attributes")
         }
     }
+
+    func loadSite(siteID: Int64) async throws -> POSSite? {
+        try await grdbManager.databaseConnection.read { db in
+            try PersistedSite.filter(key: siteID).fetchOne(db)?.toPOSSite()
+        }
+    }
+
+    func updateSite(_ site: POSSite) async throws {
+        try await grdbManager.databaseConnection.write { db in
+            guard try PersistedSite.filter(key: site.siteID).fetchOne(db) != nil else {
+                throw POSCatalogPersistenceError.siteNotFound(siteID: site.siteID)
+            }
+
+            let persistedSite = PersistedSite(from: site)
+            try persistedSite.update(db)
+        }
+    }
 }
 
 private extension POSCatalog {

Modules/Tests/YosemiteTests/Tools/POS/POSCatalogFullSyncServiceTests.swift

@@ -184,4 +184,8 @@ private final class MockPOSCatalogPersistenceService: POSCatalogPersistenceServi
     }
 
     func persistIncrementalCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws {}
+
+    func loadSite(siteID: Int64) async throws -> POSSite? { nil }
+
+    func updateSite(_ site: POSSite) async throws {}
 }

Modules/Tests/YosemiteTests/Tools/POS/POSCatalogIncrementalSyncServiceTests.swift

@@ -183,6 +183,8 @@ private final class MockPOSCatalogPersistenceService: POSCatalogPersistenceServi
     private(set) var persistIncrementalCatalogDataLastPersistedSiteID: Int64?
     var persistIncrementalCatalogDataError: Error?
 
+    private var storedSites: [Int64: POSSite] = [:]
+
     func replaceAllCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws {}
 
     func persistIncrementalCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws {
@@ -193,4 +195,12 @@ private final class MockPOSCatalogPersistenceService: POSCatalogPersistenceServi
             throw error
         }
     }
+
+    func loadSite(siteID: Int64) async throws -> POSSite? {
+        storedSites[siteID]
+    }
+
+    func updateSite(_ site: POSSite) async throws {
+        storedSites[site.siteID] = site
+    }
 }