[Woo POS][Local Catalog] Trigger sync periodically in the system background (#16244)

staskus · web-flow · commit f5bca54e8384 · 2025-10-16T13:35:15.000+03:00
diff --git a/Modules/Sources/PointOfSale/Presentation/Barcode Scanning/GameControllerBarcodeParser.swift b/Modules/Sources/PointOfSale/Presentation/Barcode Scanning/GameControllerBarcodeParser.swift
@@ -1,5 +1,6 @@
 import Foundation
 import GameController
+import WooFoundation
 
 /// Parses GameController keyboard input into barcode scans.
 /// This class handles the core logic for interpreting GameController GCKeyCode input as barcode data,
diff --git a/Modules/Sources/PointOfSale/Presentation/Barcode Scanning/UIKitBarcodeObserver.swift b/Modules/Sources/PointOfSale/Presentation/Barcode Scanning/UIKitBarcodeObserver.swift
@@ -1,6 +1,7 @@
 import Foundation
 import GameController
 import UIKit
+import WooFoundation
 
 /// An observer that processes UIKit UIPress events for barcode scanner input.
 /// This class serves as a fallback for VoiceOver scenarios where GameController framework
diff --git a/Modules/Sources/PointOfSale/Utils/PreviewHelpers.swift b/Modules/Sources/PointOfSale/Utils/PreviewHelpers.swift
@@ -618,6 +618,11 @@ final class POSPreviewCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol
         // Simulates an incremental sync operation with a 0.5 second delay.
         try await Task.sleep(nanoseconds: 500_000_000)
     }
+
+    func performSmartSync(for siteID: Int64, fullSyncMaxAge: TimeInterval) async throws {
+        // Simulates a smart sync operation with a 1 second delay.
+        try await Task.sleep(nanoseconds: 1_000_000_000)
+    }
 }
 
 #endif
diff --git a/Modules/Sources/WooFoundation/Utilities/TimeProvider.swift b/Modules/Sources/WooFoundation/Utilities/TimeProvider.swift
@@ -1,16 +1,18 @@
 import Foundation
 
-protocol TimeProvider {
+public protocol TimeProvider {
     func now() -> Date
     func scheduleTimer(timeInterval: TimeInterval, target: Any, selector: Selector) -> Timer
 }
 
-struct DefaultTimeProvider: TimeProvider {
-    func now() -> Date {
+public struct DefaultTimeProvider: TimeProvider {
+    public init() {}
+
+    public func now() -> Date {
         Date()
     }
 
-    func scheduleTimer(timeInterval: TimeInterval, target: Any, selector: Selector) -> Timer {
+    public func scheduleTimer(timeInterval: TimeInterval, target: Any, selector: Selector) -> Timer {
         return Timer.scheduledTimer(timeInterval: timeInterval, target: target, selector: selector, userInfo: nil, repeats: false)
     }
 }
diff --git a/Modules/Sources/Yosemite/Tools/POS/POSCatalogIncrementalSyncService.swift b/Modules/Sources/Yosemite/Tools/POS/POSCatalogIncrementalSyncService.swift
@@ -60,10 +60,10 @@ public final class POSCatalogIncrementalSyncService: POSCatalogIncrementalSyncSe
 
         do {
             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)")
+            DDLogInfo("✅ Loaded \(catalog.products.count) updated products and \(catalog.variations.count) updated variations for siteID \(siteID)")
 
             try await persistenceService.persistIncrementalCatalogData(catalog, siteID: siteID)
-            DDLogInfo("✅ Persisted \(catalog.products.count) products and \(catalog.variations.count) variations to database for siteID \(siteID)")
+            DDLogInfo("✅ Persisted \(catalog.products.count) updated products and \(catalog.variations.count) updated variations to database for siteID \(siteID)")
 
         } catch {
             DDLogError("❌ Failed to sync and persist catalog incrementally: \(error)")
diff --git a/Modules/Sources/Yosemite/Tools/POS/POSCatalogPersistenceService.swift b/Modules/Sources/Yosemite/Tools/POS/POSCatalogPersistenceService.swift
@@ -68,12 +68,12 @@ final class POSCatalogPersistenceService: POSCatalogPersistenceServiceProtocol {
         DDLogInfo("✅ 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)
+            let productCount = try PersistedProduct.filter { $0.siteID == siteID }.fetchCount(db)
+            let productImageCount = try PersistedProductImage.filter { $0.siteID == siteID }.fetchCount(db)
+            let productAttributeCount = try PersistedProductAttribute.filter { $0.siteID == siteID }.fetchCount(db)
+            let variationCount = try PersistedProductVariation.filter { $0.siteID == siteID }.fetchCount(db)
+            let variationImageCount = try PersistedProductVariationImage.filter { $0.siteID == siteID }.fetchCount(db)
+            let variationAttributeCount = try PersistedProductVariationAttribute.filter { $0.siteID == siteID }.fetchCount(db)
 
             DDLogInfo("Persisted \(productCount) products, \(productImageCount) product images, " +
                       "\(productAttributeCount) product attributes, \(variationCount) variations, " +
@@ -82,7 +82,7 @@ final class POSCatalogPersistenceService: POSCatalogPersistenceServiceProtocol {
     }
 
     func persistIncrementalCatalogData(_ catalog: POSCatalog, siteID: Int64) async throws {
-        DDLogInfo("💾 Persisting incremental catalog with \(catalog.products.count) products and \(catalog.variations.count) variations")
+        DDLogInfo("💾 Persisting incremental catalog with \(catalog.products.count) updated products and \(catalog.variations.count) updated variations")
 
         try await grdbManager.databaseConnection.write { db in
             for product in catalog.productsToPersist {
@@ -140,12 +140,12 @@ final class POSCatalogPersistenceService: POSCatalogPersistenceServiceProtocol {
         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)
+            let productCount = try PersistedProduct.filter { $0.siteID == siteID }.fetchCount(db)
+            let productImageCount = try PersistedProductImage.filter { $0.siteID == siteID }.fetchCount(db)
+            let productAttributeCount = try PersistedProductAttribute.filter { $0.siteID == siteID }.fetchCount(db)
+            let variationCount = try PersistedProductVariation.filter { $0.siteID == siteID }.fetchCount(db)
+            let variationImageCount = try PersistedProductVariationImage.filter { $0.siteID == siteID }.fetchCount(db)
+            let variationAttributeCount = try PersistedProductVariationAttribute.filter { $0.siteID == siteID }.fetchCount(db)
 
             DDLogInfo("Total after incremental update: \(productCount) products, \(productImageCount) product images, " +
                       "\(productAttributeCount) product attributes, \(variationCount) variations, " +
diff --git a/Modules/Sources/Yosemite/Tools/POS/POSCatalogSyncCoordinator.swift b/Modules/Sources/Yosemite/Tools/POS/POSCatalogSyncCoordinator.swift
@@ -18,6 +18,14 @@ public protocol POSCatalogSyncCoordinatorProtocol {
     /// - Throws: POSCatalogSyncError.syncAlreadyInProgress if a sync is already running for this site
     //periphery:ignore - remove ignore comment when incremental sync is integrated with POS
     func performIncrementalSyncIfApplicable(for siteID: Int64, maxAge: TimeInterval) async throws
+
+    /// Performs a smart sync that decides between full and incremental sync based on the last full sync date
+    /// - Parameters:
+    ///   - siteID: The site ID to sync catalog for
+    ///   - fullSyncMaxAge: Maximum age before a full sync is triggered. If the last full sync is older than this,
+    ///                     performs full sync; otherwise, performs incremental sync
+    /// - Throws: POSCatalogSyncError.syncAlreadyInProgress if a sync is already running for this site
+    func performSmartSync(for siteID: Int64, fullSyncMaxAge: TimeInterval) async throws
 }
 
 public extension POSCatalogSyncCoordinatorProtocol {
@@ -28,6 +36,12 @@ public extension POSCatalogSyncCoordinatorProtocol {
     func performIncrementalSync(for siteID: Int64) async throws {
         try await performIncrementalSyncIfApplicable(for: siteID, maxAge: .zero)
     }
+
+    /// Performs a smart sync with a default 24-hour threshold for full sync
+    func performSmartSync(for siteID: Int64) async throws {
+        let twentyFourHours: TimeInterval = 24 * 60 * 60
+        try await performSmartSync(for: siteID, fullSyncMaxAge: twentyFourHours)
+    }
 }
 
 public enum POSCatalogSyncError: Error, Equatable {
@@ -88,6 +102,19 @@ public actor POSCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {
         DDLogInfo("✅ POSCatalogSyncCoordinator completed full sync for site \(siteID)")
     }
 
+    public func performSmartSync(for siteID: Int64, fullSyncMaxAge: TimeInterval) async throws {
+        let lastFullSync = await lastFullSyncDate(for: siteID) ?? Date(timeIntervalSince1970: 0)
+        let lastFullSyncUTC = ISO8601DateFormatter().string(from: lastFullSync)
+
+        if Date().timeIntervalSince(lastFullSync) >= fullSyncMaxAge {
+            DDLogInfo("🔄 POSCatalogSyncCoordinator: Performing full sync for site \(siteID) (last full sync: \(lastFullSyncUTC) UTC)")
+            try await performFullSync(for: siteID)
+        } else {
+            DDLogInfo("🔄 POSCatalogSyncCoordinator: Performing incremental sync for site \(siteID) (last full sync: \(lastFullSyncUTC) UTC)")
+            try await performIncrementalSync(for: siteID)
+        }
+    }
+
     /// Determines if a full sync should be performed based on the age of the last sync
     /// - Parameters:
     ///   - siteID: The site ID to check
diff --git a/Modules/Tests/PointOfSaleTests/Mocks/MockPOSCatalogSyncCoordinator.swift b/Modules/Tests/PointOfSaleTests/Mocks/MockPOSCatalogSyncCoordinator.swift
@@ -5,6 +5,12 @@ final class MockPOSCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {
     var performFullSyncInvocationCount = 0
     var performFullSyncSiteID: Int64?
     var performFullSyncResult: Result<Void, Error> = .success(())
+    var lastSyncDate: Date?
+
+    var performSmartSyncInvocationCount = 0
+    var performSmartSyncSiteID: Int64?
+    var performSmartSyncFullSyncMaxAge: TimeInterval?
+    var performSmartSyncResult: Result<Void, Error> = .success(())
 
     var onPerformFullSyncCalled: (() -> Void)?
 
@@ -23,4 +29,17 @@ final class MockPOSCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {
     }
 
     func performIncrementalSyncIfApplicable(for siteID: Int64, maxAge: TimeInterval) async throws {}
+
+    func performSmartSync(for siteID: Int64, fullSyncMaxAge: TimeInterval) async throws {
+        performSmartSyncInvocationCount += 1
+        performSmartSyncSiteID = siteID
+        performSmartSyncFullSyncMaxAge = fullSyncMaxAge
+
+        switch performSmartSyncResult {
+        case .success:
+            return
+        case .failure(let error):
+            throw error
+        }
+    }
 }
diff --git a/Modules/Tests/PointOfSaleTests/Presentation/Barcode Scanning/GameControllerBarcodeParserTests.swift b/Modules/Tests/PointOfSaleTests/Presentation/Barcode Scanning/GameControllerBarcodeParserTests.swift
@@ -1,6 +1,7 @@
 import Testing
 import GameController
 @testable import PointOfSale
+import WooFoundation
 
 struct GameControllerBarcodeParserTests {
 
diff --git a/Modules/Tests/PointOfSaleTests/Presentation/Barcode Scanning/MockTimeProvider.swift b/Modules/Tests/PointOfSaleTests/Presentation/Barcode Scanning/MockTimeProvider.swift
@@ -1,5 +1,6 @@
 import Foundation
 @testable import PointOfSale
+import WooFoundation
 
 final class MockTimer: Timer {
     var isCancelled = false
diff --git a/Modules/Tests/PointOfSaleTests/Presentation/Barcode Scanning/UIKitBarcodeObserverTests.swift b/Modules/Tests/PointOfSaleTests/Presentation/Barcode Scanning/UIKitBarcodeObserverTests.swift
@@ -2,6 +2,7 @@ import Testing
 import GameController
 import UIKit
 @testable import PointOfSale
+import WooFoundation
 
 @MainActor
 struct UIKitBarcodeObserverTests {
diff --git a/Modules/Tests/YosemiteTests/Tools/POS/POSCatalogSyncCoordinatorTests.swift b/Modules/Tests/YosemiteTests/Tools/POS/POSCatalogSyncCoordinatorTests.swift
@@ -590,6 +590,102 @@ struct POSCatalogSyncCoordinatorTests {
         #expect(mockCatalogSizeChecker.lastCheckedSiteID == sampleSiteID)
     }
 
+    // MARK: - Smart Sync Tests
+
+    @Test func performSmartSync_performs_full_sync_when_last_full_sync_older_than_threshold() async throws {
+        // Given - last full sync was 25 hours ago (older than 24 hour threshold)
+        let twentyFiveHoursAgo = Date().addingTimeInterval(-25 * 60 * 60)
+        try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: twentyFiveHoursAgo)
+
+        // When
+        try await sut.performSmartSync(for: sampleSiteID)
+
+        // Then - should perform full sync
+        #expect(mockSyncService.startFullSyncCallCount == 1)
+        #expect(mockIncrementalSyncService.startIncrementalSyncCallCount == 0)
+    }
+
+    @Test func performSmartSync_performs_incremental_sync_when_last_full_sync_within_threshold() async throws {
+        // Given - last full sync was 12 hours ago (within 24 hour threshold)
+        let twelveHoursAgo = Date().addingTimeInterval(-12 * 60 * 60)
+        try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: twelveHoursAgo)
+
+        // When
+        try await sut.performSmartSync(for: sampleSiteID)
+
+        // Then - should perform incremental sync
+        #expect(mockSyncService.startFullSyncCallCount == 0)
+        #expect(mockIncrementalSyncService.startIncrementalSyncCallCount == 1)
+    }
+
+    @Test func performSmartSync_performs_full_sync_when_no_previous_sync() async throws {
+        // Given - no previous sync exists
+        try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: nil)
+
+        // When
+        try await sut.performSmartSync(for: sampleSiteID)
+
+        // Then - should perform full sync
+        #expect(mockSyncService.startFullSyncCallCount == 1)
+        #expect(mockIncrementalSyncService.startIncrementalSyncCallCount == 0)
+    }
+
+    @Test func performSmartSync_respects_custom_fullSyncMaxAge() async throws {
+        // Given - last full sync was 2 hours ago
+        let twoHoursAgo = Date().addingTimeInterval(-2 * 60 * 60)
+        try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: twoHoursAgo)
+
+        // When - using custom threshold of 1 hour
+        let oneHour: TimeInterval = 60 * 60
+        try await sut.performSmartSync(for: sampleSiteID, fullSyncMaxAge: oneHour)
+
+        // Then - should perform full sync because last sync is older than 1 hour
+        #expect(mockSyncService.startFullSyncCallCount == 1)
+        #expect(mockIncrementalSyncService.startIncrementalSyncCallCount == 0)
+    }
+
+    @Test func performSmartSync_performs_incremental_sync_with_custom_threshold() async throws {
+        // Given - last full sync was 30 minutes ago
+        let thirtyMinutesAgo = Date().addingTimeInterval(-30 * 60)
+        try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: thirtyMinutesAgo)
+
+        // When - using custom threshold of 1 hour
+        let oneHour: TimeInterval = 60 * 60
+        try await sut.performSmartSync(for: sampleSiteID, fullSyncMaxAge: oneHour)
+
+        // Then - should perform incremental sync because last sync is within 1 hour
+        #expect(mockSyncService.startFullSyncCallCount == 0)
+        #expect(mockIncrementalSyncService.startIncrementalSyncCallCount == 1)
+    }
+
+    @Test func performSmartSync_propagates_full_sync_errors() async throws {
+        // Given - last full sync was 25 hours ago (should trigger full sync)
+        let twentyFiveHoursAgo = Date().addingTimeInterval(-25 * 60 * 60)
+        try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: twentyFiveHoursAgo)
+
+        let expectedError = NSError(domain: "full_sync", code: 500, userInfo: [NSLocalizedDescriptionKey: "Full sync failed"])
+        mockSyncService.startFullSyncResult = .failure(expectedError)
+
+        // When/Then
+        await #expect(throws: expectedError) {
+            try await sut.performSmartSync(for: sampleSiteID)
+        }
+    }
+
+    @Test func performSmartSync_propagates_incremental_sync_errors() async throws {
+        // Given - last full sync was 12 hours ago (should trigger incremental sync)
+        let twelveHoursAgo = Date().addingTimeInterval(-12 * 60 * 60)
+        try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: twelveHoursAgo)
+
+        let expectedError = NSError(domain: "incremental_sync", code: 500, userInfo: [NSLocalizedDescriptionKey: "Incremental sync failed"])
+        mockIncrementalSyncService.startIncrementalSyncResult = .failure(expectedError)
+
+        // When/Then
+        await #expect(throws: expectedError) {
+            try await sut.performSmartSync(for: sampleSiteID)
+        }
+    }
+
     // MARK: - Helper Methods
 
     private func createSiteInDatabase(siteID: Int64, lastFullSyncDate: Date? = nil, lastIncrementalSyncDate: Date? = nil) throws {
diff --git a/WooCommerce/Classes/Tools/BackgroundTasks/BackgroundTaskRefreshDispatcher.swift b/WooCommerce/Classes/Tools/BackgroundTasks/BackgroundTaskRefreshDispatcher.swift
diff --git a/WooCommerce/Classes/Tools/BackgroundTasks/BackgroundTaskSchedule.swift b/WooCommerce/Classes/Tools/BackgroundTasks/BackgroundTaskSchedule.swift
diff --git a/WooCommerce/Resources/Info.plist b/WooCommerce/Resources/Info.plist
diff --git a/WooCommerce/WooCommerce.xcodeproj/project.pbxproj b/WooCommerce/WooCommerce.xcodeproj/project.pbxproj
diff --git a/WooCommerce/WooCommerceTests/Tools/BackgroundTaskScheduleTests.swift b/WooCommerce/WooCommerceTests/Tools/BackgroundTaskScheduleTests.swift

Original file line number	Diff line number	Diff line change
`@@ -618,6 +618,11 @@ final class POSPreviewCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol`
`618`	`618`	`// Simulates an incremental sync operation with a 0.5 second delay.`
`619`	`619`	`try await Task.sleep(nanoseconds: 500_000_000)`
`620`	`620`	`}`
	`621`	`+`
	`622`	`+ func performSmartSync(for siteID: Int64, fullSyncMaxAge: TimeInterval) async throws {`
	`623`	`+ // Simulates a smart sync operation with a 1 second delay.`
	`624`	`+ try await Task.sleep(nanoseconds: 1_000_000_000)`
	`625`	`+ }`
`621`	`626`	`}`
`622`	`627`
`623`	`628`	`#endif`
Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,18 @@`
`1`	`1`	`import Foundation`
`2`	`2`
`3`		`-protocol TimeProvider {`
	`3`	`+public protocol TimeProvider {`
`4`	`4`	`func now() -> Date`
`5`	`5`	`func scheduleTimer(timeInterval: TimeInterval, target: Any, selector: Selector) -> Timer`
`6`	`6`	`}`
`7`	`7`
`8`		`-struct DefaultTimeProvider: TimeProvider {`
`9`		`- func now() -> Date {`
	`8`	`+public struct DefaultTimeProvider: TimeProvider {`
	`9`	`+ public init() {}`
	`10`	`+`
	`11`	`+ public func now() -> Date {`
`10`	`12`	`Date()`
`11`	`13`	`}`
`12`	`14`
`13`		`- func scheduleTimer(timeInterval: TimeInterval, target: Any, selector: Selector) -> Timer {`
	`15`	`+ public func scheduleTimer(timeInterval: TimeInterval, target: Any, selector: Selector) -> Timer {`
`14`	`16`	`return Timer.scheduledTimer(timeInterval: timeInterval, target: target, selector: selector, userInfo: nil, repeats: false)`
`15`	`17`	`}`
`16`	`18`	`}`