Skip to content

[Local catalog] Ignore time based sync eligibility inside POS #16423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from
+70 −13
Open

[Local catalog] Ignore time based sync eligibility inside POS #16423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b919c3e
Ignore time based sync eligibility inside POS
joshheald Dec 2, 2025
f062cb2
Add sync fix to 23.9 release notes
joshheald Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions Modules/Sources/Yosemite/Tools/POS/POSCatalogSyncCoordinator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ public actor POSCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {
/// - maxAge: Maximum age before a sync is considered stale
/// - Returns: True if a sync should be performed
private func shouldPerformFullSync(for siteID: Int64, maxAge: TimeInterval) async throws -> Bool {
guard try await checkSyncEligibility(for: siteID) else {
guard try await checkSyncEligibility(for: siteID, ignoreTemporalCriteria: maxAge == .zero) else {
DDLogInfo("📋 POSCatalogSyncCoordinator: Full sync skipped - site \(siteID) is not eligible")
return false
}
Expand Down Expand Up @@ -402,7 +402,7 @@ public actor POSCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {
}

private func shouldPerformIncrementalSync(for siteID: Int64, maxAge: TimeInterval) async throws -> Bool {
guard try await checkSyncEligibility(for: siteID) else {
guard try await checkSyncEligibility(for: siteID, ignoreTemporalCriteria: maxAge == .zero) else {
DDLogInfo("📋 POSCatalogSyncCoordinator: Incremental sync skipped - site \(siteID) is not eligible")
return false
}
Expand Down Expand Up @@ -600,7 +600,7 @@ public actor POSCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {

// Check sync eligibility
do {
let eligibility = try await syncEligibility(for: siteID)
let eligibility = try await syncEligibility(for: siteID, ignoreTemporalCriteria: maxAge == .zero)
if case .ineligible(let reason) = eligibility {
return reason.skipReason
}
Expand Down Expand Up @@ -634,7 +634,7 @@ public actor POSCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {

// Check sync eligibility
do {
let eligibility = try await syncEligibility(for: siteID)
let eligibility = try await syncEligibility(for: siteID, ignoreTemporalCriteria: maxAge == .zero)
if case .ineligible(let reason) = eligibility {
return reason.skipReason
}
Expand Down Expand Up @@ -724,16 +724,19 @@ private extension POSCatalogSyncCoordinator {
// MARK: - Sync Eligibility

/// Checks if sync is eligible for the given site based on catalog eligibility and temporal criteria
func checkSyncEligibility(for siteID: Int64) async throws -> Bool {
switch try await syncEligibility(for: siteID) {
func checkSyncEligibility(for siteID: Int64, ignoreTemporalCriteria: Bool = false) async throws -> Bool {
switch try await syncEligibility(for: siteID, ignoreTemporalCriteria: ignoreTemporalCriteria) {
case .eligible(reason: let reason):
switch reason {
case .neverSynced:
DDLogInfo("📋 POSCatalogSyncCoordinator: Site \(siteID) eligible (no first sync date recorded)")
case .openedRecently(daysSinceOpened: let daysSinceOpened):
DDLogInfo("📋 POSCatalogSyncCoordinator: Site \(siteID) eligible (last opened \(daysSinceOpened) days ago)")
case .recentFirstSync(daysSinceFirstSync: let daysSinceFirstSync):
DDLogInfo("📋 POSCatalogSyncCoordinator: Site \(siteID) eligible (within grace period: \(daysSinceFirstSync) days since first sync)")
DDLogInfo("📋 POSCatalogSyncCoordinator: Site \(siteID) eligible (within grace period: " +
"\(daysSinceFirstSync) days since first sync)")
case .ignoredTemporalEligibilityCheck:
DDLogInfo("📋 POSCatalogSyncCoordinator: Site \(siteID) eligible (ignored temporal criteria check)")
}
return true
case .ineligible(reason: let reason):
Expand All @@ -750,11 +753,15 @@ private extension POSCatalogSyncCoordinator {
}
}

func syncEligibility(for siteID: Int64) async throws -> SyncEligibility {
func syncEligibility(for siteID: Int64, ignoreTemporalCriteria: Bool) async throws -> SyncEligibility {
guard try await catalogEligibilityChecker.catalogEligibility(for: siteID) == .eligible else {
return .ineligible(reason: .notEligibleForLocalCatalog)
}

guard !ignoreTemporalCriteria else {
return .eligible(reason: .ignoredTemporalEligibilityCheck)
}

// Then check temporal eligibility (30-day criteria)
let firstSyncDate = siteSettings.getFirstPOSCatalogSyncDate(siteID: siteID)
let lastOpenedDate = siteSettings.getPOSLastOpenedDate(siteID: siteID)
Expand Down Expand Up @@ -794,6 +801,7 @@ private extension POSCatalogSyncCoordinator {
case neverSynced
case openedRecently(daysSinceOpened: Int)
case recentFirstSync(daysSinceFirstSync: Int)
case ignoredTemporalEligibilityCheck
}

enum IneligibleReason {
Expand Down
57 changes: 53 additions & 4 deletions Modules/Tests/YosemiteTests/Tools/POS/POSCatalogSyncCoordinatorTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,6 +884,53 @@ extension POSCatalogSyncCoordinatorTests {
#expect(mockIncrementalSyncService.startIncrementalSyncCallCount == 1)
}

@Test func performFullSyncIfApplicable_with_zero_maxAge_ignores_temporal_eligibility() async throws {
// Given - user past 30-day grace period with no recent open (normally ineligible)
let fortyDaysAgo = Date().addingTimeInterval(-40 * 24 * 60 * 60)
mockSiteSettings.mockFirstPOSCatalogSyncDate = fortyDaysAgo
// No lastPOSOpenedDate set (never opened recently)

let coordinator = POSCatalogSyncCoordinator(
fullSyncService: mockSyncService,
incrementalSyncService: mockIncrementalSyncService,
grdbManager: grdbManager,
catalogEligibilityChecker: MockPOSLocalCatalogEligibilityService(),
siteSettings: mockSiteSettings
)
try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: fortyDaysAgo)
mockSyncService.startFullSyncResult = .success(POSCatalog(products: [], variations: [], syncDate: .now))

// When - maxAge is zero (forced sync, e.g. pull to refresh)
try await coordinator.performFullSyncIfApplicable(for: sampleSiteID, maxAge: .zero)

// Then - sync should proceed despite temporal ineligibility
#expect(mockSyncService.startFullSyncCallCount == 1)
}

@Test func performIncrementalSyncIfApplicable_with_zero_maxAge_ignores_temporal_eligibility() async throws {
// Given - user past 30-day grace period with no recent open (normally ineligible)
let fortyDaysAgo = Date().addingTimeInterval(-40 * 24 * 60 * 60)
mockSiteSettings.mockFirstPOSCatalogSyncDate = fortyDaysAgo
// No lastPOSOpenedDate set (never opened recently)

let coordinator = POSCatalogSyncCoordinator(
fullSyncService: mockSyncService,
incrementalSyncService: mockIncrementalSyncService,
grdbManager: grdbManager,
catalogEligibilityChecker: MockPOSLocalCatalogEligibilityService(),
siteSettings: mockSiteSettings
)
// Set up database with full sync date (required for incremental sync)
try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: fortyDaysAgo)
mockIncrementalSyncService.startIncrementalSyncResult = .success(POSCatalog(products: [], variations: [], syncDate: .now))

// When - maxAge is zero (forced sync, e.g. after a purchase)
try await coordinator.performIncrementalSyncIfApplicable(for: sampleSiteID, maxAge: .zero)

// Then - sync should proceed despite temporal ineligibility
#expect(mockIncrementalSyncService.startIncrementalSyncCallCount == 1)
}

// MARK: - isSyncStale Tests

@Test func isSyncStale_returns_true_when_no_full_sync_performed() async throws {
Expand Down Expand Up @@ -1394,8 +1441,9 @@ extension POSCatalogSyncCoordinatorTests {
connectivityObserver: nil
)

// When - Try to perform sync
try? await sut.performFullSyncIfApplicable(for: sampleSiteID, maxAge: .zero)
// When - Try to perform sync with non-zero maxAge (temporal criteria are checked)
// Note: maxAge of .zero would bypass temporal eligibility checks
try? await sut.performFullSyncIfApplicable(for: sampleSiteID, maxAge: sampleMaxAge)

// Then - Should track pos_not_opened_30_days
let syncSkipped = mockAnalytics.trackedEvents.first { $0.eventName == "local_catalog_sync_skipped" }
Expand Down Expand Up @@ -1428,8 +1476,9 @@ extension POSCatalogSyncCoordinatorTests {
connectivityObserver: nil
)

// When - Try to perform incremental sync
try await sut.performIncrementalSyncIfApplicable(for: sampleSiteID, maxAge: .zero)
// When - Try to perform incremental sync with non-zero maxAge (temporal criteria are checked)
// Note: maxAge of .zero would bypass temporal eligibility checks
try await sut.performIncrementalSyncIfApplicable(for: sampleSiteID, maxAge: sampleMaxAge)

// Then - Should track pos_not_opened_30_days
let syncSkipped = mockAnalytics.trackedEvents.first { $0.eventName == "local_catalog_sync_skipped" }
Expand Down
2 changes: 1 addition & 1 deletion RELEASE-NOTES.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

23.9
-----

- [*] Fixed possible sync issue in POS (https://github.com/woocommerce/woocommerce-ios/pull/16423)

23.8
-----
Expand Down