fix(sync): refactor SyncWorker for robust background sync (#909)

* feat(sync): sync feeds concurrently * fix(sync): refactor `SyncWorker` for robust background sync
Ashinch · Nov 27, 2024 · 133f196 · 133f196
1 parent 4caca8d
commit 133f196
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 41 deletions.
diff --git a/app/src/main/java/me/ash/reader/domain/service/AbstractRssRepository.kt b/app/src/main/java/me/ash/reader/domain/service/AbstractRssRepository.kt
@@ -201,39 +201,29 @@ abstract class AbstractRssRepository(
     }
 
     fun cancelSync() {
-        workManager.cancelAllWork()
+        SyncWorker.cancelPeriodicWork(workManager)
+        SyncWorker.cancelOneTimeWork(workManager)
     }
 
     fun doSyncOneTime() {
-        workManager.cancelAllWork()
         SyncWorker.enqueueOneTimeWork(workManager)
     }
 
-    suspend fun doSync(isOnStart: Boolean = false) {
-        workManager.cancelAllWork()
+    suspend fun initSync() {
         accountDao.queryById(context.currentAccountId)?.let {
-            if (isOnStart) {
-                if (it.syncOnStart.value) {
-                    SyncWorker.enqueueOneTimeWork(workManager)
-                }
-                if (it.syncInterval.value != SyncIntervalPreference.Manually.value) {
-                    SyncWorker.enqueuePeriodicWork(
-                        workManager = workManager,
-                        syncInterval = it.syncInterval,
-                        syncOnlyWhenCharging = it.syncOnlyWhenCharging,
-                        syncOnlyOnWiFi = it.syncOnlyOnWiFi,
-                    )
-                }
+            val syncOnStart = it.syncOnStart.value
+            if (syncOnStart) {
+                doSyncOneTime()
+            }
+            if (it.syncInterval.value != SyncIntervalPreference.Manually.value) {
+                SyncWorker.enqueuePeriodicWork(
+                    workManager = workManager,
+                    syncInterval = it.syncInterval,
+                    syncOnlyWhenCharging = it.syncOnlyWhenCharging,
+                    syncOnlyOnWiFi = it.syncOnlyOnWiFi,
+                )
             } else {
-                SyncWorker.enqueueOneTimeWork(workManager)
-                if (it.syncInterval.value != SyncIntervalPreference.Manually.value) {
-                    SyncWorker.enqueuePeriodicWork(
-                        workManager = workManager,
-                        syncInterval = it.syncInterval,
-                        syncOnlyWhenCharging = it.syncOnlyWhenCharging,
-                        syncOnlyOnWiFi = it.syncOnlyOnWiFi,
-                    )
-                }
+                SyncWorker.cancelPeriodicWork(workManager)
             }
         }
     }

diff --git a/app/src/main/java/me/ash/reader/domain/service/SyncWorker.kt b/app/src/main/java/me/ash/reader/domain/service/SyncWorker.kt
@@ -33,15 +33,25 @@ class SyncWorker @AssistedInject constructor(
     companion object {
 
         private const val IS_SYNCING = "isSyncing"
-        const val WORK_NAME = "ReadYou"
-        lateinit var uuid: UUID
+        private const val WORK_NAME_PERIODIC = "ReadYou"
+        private const val WORK_NAME_ONETIME = "SYNC_ONETIME"
+        const val WORK_TAG = "SYNC_TAG"
+
+        fun cancelOneTimeWork(workManager: WorkManager) {
+            workManager.cancelUniqueWork(WORK_NAME_ONETIME)
+        }
+
+        fun cancelPeriodicWork(workManager: WorkManager) {
+            workManager.cancelUniqueWork(WORK_NAME_PERIODIC)
+        }
 
         fun enqueueOneTimeWork(
             workManager: WorkManager,
         ) {
-            workManager.enqueue(OneTimeWorkRequestBuilder<SyncWorker>()
-                .addTag(WORK_NAME)
-                .build()
+            workManager.enqueueUniqueWork(
+                WORK_NAME_ONETIME,
+                ExistingWorkPolicy.KEEP,
+                OneTimeWorkRequestBuilder<SyncWorker>().addTag(WORK_TAG).build()
             )
         }
 
@@ -52,15 +62,16 @@ class SyncWorker @AssistedInject constructor(
             syncOnlyOnWiFi: SyncOnlyOnWiFiPreference,
         ) {
             workManager.enqueueUniquePeriodicWork(
-                WORK_NAME,
+                WORK_NAME_PERIODIC,
                 ExistingPeriodicWorkPolicy.UPDATE,
                 PeriodicWorkRequestBuilder<SyncWorker>(syncInterval.value, TimeUnit.MINUTES)
-                    .setConstraints(Constraints.Builder()
-                        .setRequiresCharging(syncOnlyWhenCharging.value)
-                        .setRequiredNetworkType(if (syncOnlyOnWiFi.value) NetworkType.UNMETERED else NetworkType.CONNECTED)
-                        .build()
+                    .setConstraints(
+                        Constraints.Builder()
+                            .setRequiresCharging(syncOnlyWhenCharging.value)
+                            .setRequiredNetworkType(if (syncOnlyOnWiFi.value) NetworkType.UNMETERED else NetworkType.CONNECTED)
+                            .build()
                     )
-                    .addTag(WORK_NAME)
+                    .addTag(WORK_TAG)
                     .setInitialDelay(syncInterval.value, TimeUnit.MINUTES)
                     .build()
             )

diff --git a/app/src/main/java/me/ash/reader/infrastructure/android/AndroidApp.kt b/app/src/main/java/me/ash/reader/infrastructure/android/AndroidApp.kt
@@ -133,7 +133,7 @@ class AndroidApp : Application(), Configuration.Provider {
     }
 
     private suspend fun workerInit() {
-        rssService.get().doSync(isOnStart = true)
+        rssService.get().initSync()
     }
 
     private suspend fun checkUpdate() {

diff --git a/app/src/main/java/me/ash/reader/ui/page/home/HomeViewModel.kt b/app/src/main/java/me/ash/reader/ui/page/home/HomeViewModel.kt
@@ -46,11 +46,11 @@ class HomeViewModel @Inject constructor(
     private val _filterUiState = MutableStateFlow(FilterState())
     val filterUiState = _filterUiState.asStateFlow()
 
-    val syncWorkLiveData = workManager.getWorkInfosByTagLiveData(SyncWorker.WORK_NAME)
+    val syncWorkLiveData = workManager.getWorkInfosByTagLiveData(SyncWorker.WORK_TAG)
 
     fun sync() {
         applicationScope.launch(ioDispatcher) {
-            rssService.get().doSync()
+            rssService.get().doSyncOneTime()
         }
     }
 

diff --git a/app/src/main/java/me/ash/reader/ui/page/home/feeds/subscribe/SubscribeViewModel.kt b/app/src/main/java/me/ash/reader/ui/page/home/feeds/subscribe/SubscribeViewModel.kt
@@ -59,7 +59,7 @@ class SubscribeViewModel @Inject constructor(
     fun importFromInputStream(inputStream: InputStream) {
         applicationScope.launch {
             opmlService.saveToDatabase(inputStream)
-            rssService.get().doSync()
+            rssService.get().doSyncOneTime()
         }
     }
 

diff --git a/app/src/main/java/me/ash/reader/ui/page/home/flow/FlowViewModel.kt b/app/src/main/java/me/ash/reader/ui/page/home/flow/FlowViewModel.kt
@@ -34,7 +34,7 @@ class FlowViewModel @Inject constructor(
 
     fun sync() {
         applicationScope.launch(ioDispatcher) {
-            rssService.get().doSync()
+            rssService.get().doSyncOneTime()
         }
     }