Update currentSyncJobStatus for oneTimeSync when syncJobStatus is null (

google#2511) * currentSyncJobStatus when sync state in workmanager is null. * unit tests. * update kdoc * address review comments. --------- Co-authored-by: Santosh Pingle <[email protected]>
santosh-pingle · Jul 8, 2024 · f3e2842 · f3e2842
1 parent f363237
commit f3e2842
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 14 deletions.
diff --git a/engine/src/androidTest/java/com/google/android/fhir/sync/SyncInstrumentedTest.kt b/engine/src/androidTest/java/com/google/android/fhir/sync/SyncInstrumentedTest.kt
@@ -106,7 +106,7 @@ class SyncInstrumentedTest {
   }
 
   @Test
-  fun oneTime_worker_nextExecutionAfterSucceeded() {
+  fun oneTimeSync_currentSyncJobStatusSucceeded_nextCurrentSyncJobStatusShouldBeRunning() {
     WorkManagerTestInitHelper.initializeTestWorkManager(context)
     val states = mutableListOf<CurrentSyncJobStatus>()
     val nextExecutionStates = mutableListOf<CurrentSyncJobStatus>()
@@ -160,7 +160,7 @@ class SyncInstrumentedTest {
   }
 
   @Test
-  fun oneTime_worker_nextExecutionAfterFailed() {
+  fun oneTimeSync_currentSyncJobStatusFailed_nextCurrentSyncJobStatusShouldBeRunning() {
     WorkManagerTestInitHelper.initializeTestWorkManager(context)
     val states = mutableListOf<CurrentSyncJobStatus>()
     val nextExecutionStates = mutableListOf<CurrentSyncJobStatus>()

diff --git a/engine/src/main/java/com/google/android/fhir/sync/Sync.kt b/engine/src/main/java/com/google/android/fhir/sync/Sync.kt
@@ -110,7 +110,16 @@ object Sync {
     return combineSyncStateForPeriodicSync(context, uniqueWorkName, flow)
   }
 
-  /** Gets the worker info for the [FhirSyncWorker] */
+  /**
+   * Retrieves the work information for a specific unique work name as a flow of pairs containing
+   * the work state and the corresponding progress data if available.
+   *
+   * @param context The application context.
+   * @param workName The unique name of the work to retrieve information for.
+   * @return A flow emitting pairs of [WorkInfo.State] and [SyncJobStatus]. The flow will emit only
+   *   when the progress data contains a non-empty key-value map and includes a key of type [String]
+   *   with the name "StateType".
+   */
   @PublishedApi
   internal fun getWorkerInfo(context: Context, workName: String) =
     WorkManager.getInstance(context)
@@ -306,20 +315,10 @@ object Sync {
     }
 
   /**
-   * Only call this API when syncJobStatusFromWorkManager is null. Create a [CurrentSyncJobStatus]
+   * Only call this API when syncJobStatus From WorkManager is null. Create a [CurrentSyncJobStatus]
    * from [WorkInfo.State]. (Note: syncJobStatusFromDataStore is updated as lastSynJobStatus, which
    * is the terminalSyncJobStatus.)
    */
-  private fun handleNullWorkManagerStatusForPeriodicSync(
-    workInfoState: WorkInfo.State,
-  ): CurrentSyncJobStatus =
-    when (workInfoState) {
-      RUNNING -> Running(SyncJobStatus.Started())
-      ENQUEUED -> Enqueued
-      CANCELLED -> Cancelled
-      else -> error("Inconsistent WorkInfo.State in periodic sync : $workInfoState.")
-    }
-
   private fun handleNullWorkManagerStatusForPeriodicSync(
     workInfoState: WorkInfo.State,
     syncJobStatusFromDataStore: SyncJobStatus?,