Improve state observation for refresh control

Author: joshheald

Modules/Sources/PointOfSale/Presentation/Settings/POSSettingsLocalCatalogViewModel.swift

@@ -96,37 +96,44 @@ final class POSSettingsLocalCatalogViewModel {
             var previousState = currentSyncState
 
             while !Task.isCancelled {
-                // Use withObservationTracking to detect changes
-                await withCheckedContinuation { (continuation: CheckedContinuation<Void, Never>) in
-                    withObservationTracking {
-                        // Access the observed property to register observation
-                        _ = currentSyncState
-                    } onChange: {
-                        // When state changes, resume the continuation
-                        continuation.resume()
-                    }
-                }
+                // Wait for the next state change
+                await observeNextStateChange()
 
-                // Check if state actually changed
+                // Read the new state after change is detected
                 let newState = currentSyncState
-                if newState != previousState {
-                    switch newState {
-                    case .syncCompleted, .syncFailed, .initialSyncFailed:
-                        // Sync finished - clear the refreshing state if it was set
-                        if isRefreshingCatalog {
-                            isRefreshingCatalog = false
-                            // Reload catalog data to show updated info
-                            await loadCatalogData()
-                        }
-                    case .syncStarted, .initialSyncStarted:
-                        // Sync is running - keep spinner active
-                        break
-                    case .syncNeverDone:
-                        // No sync has been done
-                        break
+                guard newState != previousState else { continue }
+
+                // Handle terminal states when user initiated refresh
+                switch newState {
+                case .syncCompleted, .syncFailed, .initialSyncFailed:
+                    // Sync finished - clear the refreshing state if it was set
+                    if isRefreshingCatalog {
+                        isRefreshingCatalog = false
+                        // Reload catalog data to show updated info
+                        await loadCatalogData()
                     }
-                    previousState = newState
+                case .syncStarted, .initialSyncStarted:
+                    // Sync is running - keep spinner active
+                    break
+                case .syncNeverDone:
+                    // No sync has been done
+                    break
                 }
+                previousState = newState
+            }
+        }
+    }
+
+    /// Waits for the next change to the observed sync state.
+    /// Re-registers observation each time it's called.
+    private func observeNextStateChange() async {
+        await withCheckedContinuation { (continuation: CheckedContinuation<Void, Never>) in
+            withObservationTracking {
+                // Access the observed property to register observation
+                _ = currentSyncState
+            } onChange: {
+                // When state changes, resume the continuation
+                continuation.resume()
             }
         }
     }

Modules/Tests/NetworkingTests/Network/BackgroundCatalogDownloadCoordinatorTests.swift

@@ -45,7 +45,6 @@ struct BackgroundCatalogDownloadCoordinatorTests {
 
     @Test func handleBackgroundSessionEvent_calls_completion_handler_when_no_state() async {
         // Given
-        BackgroundDownloadState.clear() // Ensure no saved state
         let sessionIdentifier = "com.woocommerce.pos.catalog.download.999"
         let mockDownloader = MockBackgroundDownloader()
         let coordinator = BackgroundCatalogDownloadCoordinator(backgroundDownloader: mockDownloader)

Modules/Tests/NetworkingTests/Network/BackgroundDownloadStateTests.swift

@@ -25,15 +25,9 @@ struct BackgroundDownloadStateTests {
         let loaded = BackgroundDownloadState.load(for: "test.session.123")
         #expect(loaded?.sessionIdentifier == "test.session.123")
         #expect(loaded?.siteID == 456)
-
-        // Cleanup
-        BackgroundDownloadState.clear()
     }
 
     @Test func load_returns_nil_for_nonexistent_session() {
-        // Given
-        BackgroundDownloadState.clear()
-
         // When
         let loaded = BackgroundDownloadState.load(for: "nonexistent.session")
 
@@ -54,9 +48,6 @@ struct BackgroundDownloadStateTests {
 
         // Then
         #expect(loaded == nil)
-
-        // Cleanup
-        BackgroundDownloadState.clear()
     }
 
     @Test func clear_removes_saved_state() {
@@ -98,8 +89,5 @@ struct BackgroundDownloadStateTests {
         #expect(loadedFirst == nil) // First session is overwritten
         #expect(loadedSecond?.sessionIdentifier == "session.2")
         #expect(loadedSecond?.siteID == 200)
-
-        // Cleanup
-        BackgroundDownloadState.clear()
     }
 }

Modules/Tests/NetworkingTests/Remote/POSCatalogSyncRemoteTests.swift

@@ -993,7 +993,6 @@ extension POSCatalogSyncRemoteTests {
         // Given
         let remote = createRemote()
         let downloadURL = "https://example.com/catalog.json"
-        BackgroundDownloadState.clear() // Start clean
 
         let mockFileURL = mockBackgroundDownloader.createMockDownloadFile(withContent: "[]")
         mockBackgroundDownloader.mockSuccessfulDownload(fileURL: mockFileURL)
@@ -1023,14 +1022,12 @@ extension POSCatalogSyncRemoteTests {
 
         // Cleanup
         try? FileManager.default.removeItem(at: mockFileURL)
-        BackgroundDownloadState.clear()
     }
 
     @Test func downloadCatalog_clears_state_on_success() async throws {
         // Given
         let remote = createRemote()
         let downloadURL = "https://example.com/catalog.json"
-        BackgroundDownloadState.clear() // Start clean
 
         // When
         let mockFileURL = mockBackgroundDownloader.createMockDownloadFile(withContent: "[]")