Prevent saving first sync date if it doesn’t happen

Author: joshheald

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

@@ -57,6 +57,7 @@ public enum POSCatalogSyncError: Error, Equatable {
     case syncAlreadyInProgress(siteID: Int64)
     case negativeMaxAge
     case requestCancelled
+    case shouldNotSync
 }
 
 public actor POSCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {
@@ -90,7 +91,7 @@ public actor POSCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {
         }
 
         guard try await shouldPerformFullSync(for: siteID, maxAge: maxAge) else {
-            return
+            throw POSCatalogSyncError.shouldNotSync
         }
 
         if case .syncStarted = fullSyncStateModel.state[siteID] {

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

@@ -111,10 +111,11 @@ struct POSCatalogSyncCoordinatorTests {
         let thirtyMinutesAgo = Date().addingTimeInterval(-30 * 60)
         try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: thirtyMinutesAgo)
 
-        // When - max age is 1 hour
-        let _ = try await sut.performFullSyncIfApplicable(for: sampleSiteID, maxAge: sampleMaxAge)
+        // When - max age is 1 hour / Then
+        await #expect(throws: POSCatalogSyncError.shouldNotSync) {
+            try await sut.performFullSyncIfApplicable(for: sampleSiteID, maxAge: sampleMaxAge)
+        }
 
-        // Then
         #expect(mockSyncService.startFullSyncCallCount == 0)
     }
 
@@ -128,11 +129,12 @@ struct POSCatalogSyncCoordinatorTests {
         try createSiteInDatabase(siteID: siteA, lastFullSyncDate: oneHourAgo)
         try createSiteInDatabase(siteID: siteB, lastFullSyncDate: nil)
 
-        // When
-        let _ = try await sut.performFullSyncIfApplicable(for: siteA, maxAge: 2 * sampleMaxAge)
+        // When / Then
+        await #expect(throws: POSCatalogSyncError.shouldNotSync) {
+            let _ = try await sut.performFullSyncIfApplicable(for: siteA, maxAge: 2 * sampleMaxAge)
+        }
         let _ = try await sut.performFullSyncIfApplicable(for: siteB, maxAge: 2 * sampleMaxAge)
 
-        // Then
         #expect(mockSyncService.startFullSyncCallCount == 1)
         #expect(mockSyncService.lastSyncSiteID == siteB)
     }
@@ -168,9 +170,11 @@ struct POSCatalogSyncCoordinatorTests {
         try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: recentSyncDate)
 
         // When - max age is 1 hour
-        let _ = try await sut.performFullSyncIfApplicable(for: sampleSiteID, maxAge: sampleMaxAge)
-
         // Then - should not sync because site exists and time hasn't passed
+        await #expect(throws: POSCatalogSyncError.shouldNotSync) {
+            let _ = try await sut.performFullSyncIfApplicable(for: sampleSiteID, maxAge: sampleMaxAge)
+        }
+
         #expect(mockSyncService.startFullSyncCallCount == 0)
     }
 
@@ -639,10 +643,11 @@ extension POSCatalogSyncCoordinatorTests {
         )
         try createSiteInDatabase(siteID: sampleSiteID, lastFullSyncDate: nil)
 
-        // When
-        try await coordinator.performSmartSync(for: sampleSiteID)
+        // When / Then - sync should be skipped
+        await #expect(throws: POSCatalogSyncError.shouldNotSync) {
+            try await coordinator.performSmartSync(for: sampleSiteID)
+        }
 
-        // Then - sync should be skipped
         #expect(mockSyncService.startFullSyncCallCount == 0)
         #expect(mockIncrementalSyncService.startIncrementalSyncCallCount == 0)
     }

WooCommerce/Classes/Tools/BackgroundTasks/ForegroundPOSCatalogSyncDispatcher.swift

@@ -161,6 +161,8 @@ final actor ForegroundPOSCatalogSyncDispatcher {
                     DDLogError("⛔️ ForegroundPOSCatalogSyncDispatcher: Invalid max age for site \(siteID)")
                 case .requestCancelled:
                     DDLogInfo("ℹ️ ForegroundPOSCatalogSyncDispatcher: Sync request was cancelled for site \(siteID)")
+                case .shouldNotSync:
+                    DDLogInfo("ℹ️ ForegroundPOSCatalogSyncDispatcher: Should not sync site \(siteID) at this time")
                 }
             } catch {
                 DDLogError("⛔️ ForegroundPOSCatalogSyncDispatcher: Sync failed for site \(siteID): \(error)")