[Local Catalog] Incremental sync: persist incrementally changed products/variations to storage (#16106)

jaclync · web-flow · commit 3914fc53f2f7 · 2025-09-10T14:28:50.000+08:00
diff --git a/Modules/Sources/Storage/GRDB/Model/PersistedProductAttribute.swift b/Modules/Sources/Storage/GRDB/Model/PersistedProductAttribute.swift
@@ -34,7 +34,7 @@ extension PersistedProductAttribute: FetchableRecord, MutablePersistableRecord {
 
     public enum Columns {
         static let id = Column(CodingKeys.id)
-        static let productID = Column(CodingKeys.productID)
+        public static let productID = Column(CodingKeys.productID)
         static let name = Column(CodingKeys.name)
         static let position = Column(CodingKeys.position)
         static let visible = Column(CodingKeys.visible)
diff --git a/Modules/Sources/Storage/GRDB/Model/PersistedProductImage.swift b/Modules/Sources/Storage/GRDB/Model/PersistedProductImage.swift
@@ -34,7 +34,7 @@ extension PersistedProductImage: FetchableRecord, PersistableRecord {
 
     public enum Columns {
         static let id = Column(CodingKeys.id)
-        static let productID = Column(CodingKeys.productID)
+        public static let productID = Column(CodingKeys.productID)
         static let dateCreated = Column(CodingKeys.dateCreated)
         static let dateModified = Column(CodingKeys.dateModified)
         static let src = Column(CodingKeys.src)
diff --git a/Modules/Sources/Storage/GRDB/Model/PersistedProductVariationAttribute.swift b/Modules/Sources/Storage/GRDB/Model/PersistedProductVariationAttribute.swift
@@ -26,7 +26,7 @@ extension PersistedProductVariationAttribute: FetchableRecord, MutablePersistabl
 
     public enum Columns {
         static let id = Column(CodingKeys.id)
-        static let productVariationID = Column(CodingKeys.productVariationID)
+        public static let productVariationID = Column(CodingKeys.productVariationID)
         static let name = Column(CodingKeys.name)
         static let option = Column(CodingKeys.option)
     }
diff --git a/Modules/Sources/Storage/GRDB/Model/PersistedProductVariationImage.swift b/Modules/Sources/Storage/GRDB/Model/PersistedProductVariationImage.swift
@@ -34,7 +34,7 @@ extension PersistedProductVariationImage: FetchableRecord, PersistableRecord {
 
     public enum Columns {
         static let id = Column(CodingKeys.id)
-        static let productVariationID = Column(CodingKeys.productVariationID)
+        public static let productVariationID = Column(CodingKeys.productVariationID)
         static let dateCreated = Column(CodingKeys.dateCreated)
         static let dateModified = Column(CodingKeys.dateModified)
         static let src = Column(CodingKeys.src)
diff --git a/Modules/Sources/Yosemite/Tools/POS/POSCatalogIncrementalSyncService.swift b/Modules/Sources/Yosemite/Tools/POS/POSCatalogIncrementalSyncService.swift
@@ -20,22 +20,25 @@ public protocol POSCatalogIncrementalSyncServiceProtocol {
 public final class POSCatalogIncrementalSyncService: POSCatalogIncrementalSyncServiceProtocol {
     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) {
+    public convenience init?(credentials: Credentials?, batchSize: Int = 1, grdbManager: GRDBManagerProtocol) {
         guard let credentials else {
             DDLogError("⛔️ Could not create POSCatalogIncrementalSyncService due missing credentials")
             return nil
         }
         let network = AlamofireNetwork(credentials: credentials, ensuresSessionManagerIsInitialized: true)
         let syncRemote = POSCatalogSyncRemote(network: network)
-        self.init(syncRemote: syncRemote, batchSize: batchSize)
+        let persistenceService = POSCatalogPersistenceService(grdbManager: grdbManager)
+        self.init(syncRemote: syncRemote, batchSize: batchSize, persistenceService: persistenceService)
     }
 
-    init(syncRemote: POSCatalogSyncRemoteProtocol, batchSize: Int) {
+    init(syncRemote: POSCatalogSyncRemoteProtocol, batchSize: Int, persistenceService: POSCatalogPersistenceServiceProtocol) {
         self.syncRemote = syncRemote
         self.batchSize = batchSize
+        self.persistenceService = persistenceService
         self.batchedLoader = BatchedRequestLoader(batchSize: batchSize)
     }
 
@@ -51,7 +54,8 @@ public final class POSCatalogIncrementalSyncService: POSCatalogIncrementalSyncSe
             let catalog = try await loadCatalog(for: siteID, modifiedAfter: modifiedAfter, syncRemote: syncRemote)
             DDLogInfo("✅ Loaded \(catalog.products.count) products and \(catalog.variations.count) variations for siteID \(siteID)")
 
-            // TODO: WOOMOB-1298 - persist to database
+            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
diff --git a/Modules/Sources/Yosemite/Tools/POS/POSCatalogPersistenceService.swift b/Modules/Sources/Yosemite/Tools/POS/POSCatalogPersistenceService.swift
@@ -1,13 +1,20 @@
 // periphery:ignore:all
 import Foundation
 import Storage
+import GRDB
 
 protocol POSCatalogPersistenceServiceProtocol {
     /// Clears existing data and persists new catalog data
     /// - Parameters:
     ///   - catalog: The catalog to persist
     ///   - siteID: The site ID to associate the catalog with
     func replaceAllCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws
+
+    /// Persists incremental catalog data (insert/update)
+    /// - Parameters:
+    ///   - catalog: The catalog difference to persist
+    ///   - siteID: The site ID to associate the catalog with
+    func persistIncrementalCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws
 }
 
 final class POSCatalogPersistenceService: POSCatalogPersistenceServiceProtocol {
@@ -29,23 +36,23 @@ final class POSCatalogPersistenceService: POSCatalogPersistenceServiceProtocol {
             try site.insert(db)
 
             for product in catalog.productsToPersist {
-                try product.insert(db, onConflict: .ignore)
+                try product.insert(db, onConflict: .replace)
             }
 
             for image in catalog.productImagesToPersist {
-                try image.insert(db, onConflict: .ignore)
+                try image.insert(db, onConflict: .replace)
             }
 
             for var attribute in catalog.productAttributesToPersist {
                 try attribute.insert(db)
             }
 
             for variation in catalog.variationsToPersist {
-                try variation.insert(db, onConflict: .ignore)
+                try variation.insert(db, onConflict: .replace)
             }
 
             for image in catalog.variationImagesToPersist {
-                try image.insert(db, onConflict: .ignore)
+                try image.insert(db, onConflict: .replace)
             }
 
             for var attribute in catalog.variationAttributesToPersist {
@@ -68,6 +75,67 @@ final class POSCatalogPersistenceService: POSCatalogPersistenceServiceProtocol {
                       "\(variationImageCount) variation images, \(variationAttributeCount) variation attributes")
         }
     }
+
+    func persistIncrementalCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws {
+        DDLogInfo("💾 Persisting incremental catalog with \(catalog.products.count) products and \(catalog.variations.count) variations")
+
+        try await grdbManager.databaseConnection.write { db in
+            for product in catalog.productsToPersist {
+                try product.insert(db, onConflict: .replace)
+
+                try PersistedProductImage
+                    .filter { $0.productID == product.id }
+                    .deleteAll(db)
+
+                try PersistedProductAttribute
+                    .filter { $0.productID == product.id }
+                    .deleteAll(db)
+            }
+
+            for image in catalog.productImagesToPersist {
+                try image.insert(db, onConflict: .replace)
+            }
+
+            for var attribute in catalog.productAttributesToPersist {
+                try attribute.insert(db, onConflict: .replace)
+            }
+
+            for variation in catalog.variationsToPersist {
+                try variation.insert(db, onConflict: .replace)
+
+                try PersistedProductVariationImage
+                    .filter { $0.productVariationID == variation.id }
+                    .deleteAll(db)
+
+                try PersistedProductVariationAttribute
+                    .filter { $0.productVariationID == variation.id }
+                    .deleteAll(db)
+            }
+
+            for image in catalog.variationImagesToPersist {
+                try image.insert(db, onConflict: .replace)
+            }
+
+            for var attribute in catalog.variationAttributesToPersist {
+                try attribute.insert(db, onConflict: .replace)
+            }
+        }
+
+        DDLogInfo("✅ Incremental catalog persistence complete")
+
+        try await grdbManager.databaseConnection.read { db in
+            let productCount = try PersistedProduct.fetchCount(db)
+            let productImageCount = try PersistedProductImage.fetchCount(db)
+            let productAttributeCount = try PersistedProductAttribute.fetchCount(db)
+            let variationCount = try PersistedProductVariation.fetchCount(db)
+            let variationImageCount = try PersistedProductVariationImage.fetchCount(db)
+            let variationAttributeCount = try PersistedProductVariationAttribute.fetchCount(db)
+
+            DDLogInfo("Total after incremental update: \(productCount) products, \(productImageCount) product images, " +
+                      "\(productAttributeCount) product attributes, \(variationCount) variations, " +
+                      "\(variationImageCount) variation images, \(variationAttributeCount) variation attributes")
+        }
+    }
 }
 
 private extension POSCatalog {
diff --git a/Modules/Tests/YosemiteTests/Tools/POS/POSCatalogIncrementalSyncServiceTests.swift b/Modules/Tests/YosemiteTests/Tools/POS/POSCatalogIncrementalSyncServiceTests.swift
@@ -2,15 +2,18 @@ import Foundation
 import Testing
 @testable import Networking
 @testable import Yosemite
+@testable import Storage
 
 struct POSCatalogIncrementalSyncServiceTests {
     private let sut: POSCatalogIncrementalSyncService
     private let mockSyncRemote: MockPOSCatalogSyncRemote
+    private let mockPersistenceService: MockPOSCatalogPersistenceService
     private let sampleSiteID: Int64 = 134
 
     init() {
         self.mockSyncRemote = MockPOSCatalogSyncRemote()
-        self.sut = POSCatalogIncrementalSyncService(syncRemote: mockSyncRemote, batchSize: 2)
+        self.mockPersistenceService = MockPOSCatalogPersistenceService()
+        self.sut = POSCatalogIncrementalSyncService(syncRemote: mockSyncRemote, batchSize: 2, persistenceService: mockPersistenceService)
     }
 
     // MARK: - Basic Incremental Sync Tests
@@ -32,6 +35,7 @@ struct POSCatalogIncrementalSyncServiceTests {
         #expect(mockSyncRemote.loadIncrementalProductVariationsCallCount == 2)
         #expect(mockSyncRemote.lastIncrementalProductsModifiedAfter == lastFullSyncDate)
         #expect(mockSyncRemote.lastIncrementalVariationsModifiedAfter == lastFullSyncDate)
+        #expect(mockPersistenceService.persistIncrementalCatalogDataCallCount == 1)
     }
 
     @Test func startIncrementalSync_uses_last_incremental_sync_date_as_modifiedAfter_date_when_available() async throws {
@@ -73,6 +77,8 @@ struct POSCatalogIncrementalSyncServiceTests {
 
         // Then
         #expect(mockSyncRemote.loadIncrementalProductsCallCount == 4)
+        let persistedCatalog = try #require(mockPersistenceService.persistIncrementalCatalogDataLastPersistedCatalog)
+        #expect(persistedCatalog.products.count == 3)
     }
 
     @Test func startIncrementalSync_handles_paginated_variations_correctly() async throws {
@@ -92,6 +98,8 @@ struct POSCatalogIncrementalSyncServiceTests {
 
         // Then
         #expect(mockSyncRemote.loadIncrementalProductVariationsCallCount == 2)
+        let persistedCatalog = try #require(mockPersistenceService.persistIncrementalCatalogDataLastPersistedCatalog)
+        #expect(persistedCatalog.variations.count == 2)
     }
 
     // MARK: - Error Handling Tests
@@ -108,13 +116,39 @@ struct POSCatalogIncrementalSyncServiceTests {
         await #expect(throws: expectedError) {
             try await sut.startIncrementalSync(for: sampleSiteID, lastFullSyncDate: lastFullSyncDate)
         }
+        #expect(mockPersistenceService.persistIncrementalCatalogDataCallCount == 0)
 
         // When attempting a second sync
         mockSyncRemote.setIncrementalProductResult(pageNumber: 1, result: .success(PagedItems(items: [], hasMorePages: false, totalItems: 0)))
         try await sut.startIncrementalSync(for: sampleSiteID, lastFullSyncDate: lastFullSyncDate)
 
         // Then it uses lastFullSyncDate since no incremental date was stored due to previous failure
         #expect(mockSyncRemote.lastIncrementalProductsModifiedAfter == lastFullSyncDate)
+        #expect(mockPersistenceService.persistIncrementalCatalogDataCallCount == 1)
+    }
+
+    @Test func startIncrementalSync_throws_error_when_persistence_fails() async throws {
+        // Given
+        let lastFullSyncDate = Date(timeIntervalSince1970: 1000)
+        let expectedError = NSError(domain: "persistence", code: 500, userInfo: nil)
+
+        mockSyncRemote.setIncrementalProductResult(pageNumber: 1, result: .success(PagedItems(items: [], hasMorePages: false, totalItems: 0)))
+        mockSyncRemote.setIncrementalVariationResult(pageNumber: 1, result: .success(PagedItems(items: [], hasMorePages: false, totalItems: 0)))
+        mockPersistenceService.persistIncrementalCatalogDataError = expectedError
+
+        // When/Then
+        await #expect(throws: Error.self) {
+            try await sut.startIncrementalSync(for: sampleSiteID, lastFullSyncDate: lastFullSyncDate)
+        }
+        #expect(mockPersistenceService.persistIncrementalCatalogDataCallCount == 1)
+
+        // When attempting a second sync
+        mockPersistenceService.persistIncrementalCatalogDataError = nil  // Clear the error
+        try await sut.startIncrementalSync(for: sampleSiteID, lastFullSyncDate: lastFullSyncDate)
+
+        // Then it uses lastFullSyncDate since no incremental date was stored due to previous persistence failure
+        #expect(mockSyncRemote.lastIncrementalProductsModifiedAfter == lastFullSyncDate)
+        #expect(mockPersistenceService.persistIncrementalCatalogDataCallCount == 2)
     }
 
     // MARK: - Per-Site Behavior Tests
@@ -140,3 +174,23 @@ struct POSCatalogIncrementalSyncServiceTests {
         #expect(site2ModifiedAfter == lastFullSyncDate)
     }
 }
+
+// MARK: - Mock Classes
+
+private final class MockPOSCatalogPersistenceService: POSCatalogPersistenceServiceProtocol {
+    private(set) var persistIncrementalCatalogDataCallCount = 0
+    private(set) var persistIncrementalCatalogDataLastPersistedCatalog: POSCatalog?
+    private(set) var persistIncrementalCatalogDataLastPersistedSiteID: Int64?
+    var persistIncrementalCatalogDataError: Error?
+
+    func replaceAllCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws {}
+
+    func persistIncrementalCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws {
+        persistIncrementalCatalogDataCallCount += 1
+        persistIncrementalCatalogDataLastPersistedSiteID = siteID
+        persistIncrementalCatalogDataLastPersistedCatalog = catalog
+        if let error = persistIncrementalCatalogDataError {
+            throw error
+        }
+    }
+}
diff --git a/Modules/Tests/YosemiteTests/Tools/POS/POSCatalogPersistenceServiceTests.swift b/Modules/Tests/YosemiteTests/Tools/POS/POSCatalogPersistenceServiceTests.swift

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ extension PersistedProductVariationAttribute: FetchableRecord, MutablePersistabl`
`26`	`26`
`27`	`27`	`public enum Columns {`
`28`	`28`	`static let id = Column(CodingKeys.id)`
`29`		`- static let productVariationID = Column(CodingKeys.productVariationID)`
	`29`	`+ public static let productVariationID = Column(CodingKeys.productVariationID)`
`30`	`30`	`static let name = Column(CodingKeys.name)`
`31`	`31`	`static let option = Column(CodingKeys.option)`
`32`	`32`	`}`