Fix Sync Status: Harmonize FHIR and Custom Sync Completion for 'Sync Complete'

android/engine/src/main/java/org/smartregister/fhircore/engine/configuration/ConfigurationRegistry.kt

@@ -57,6 +57,8 @@
 import org.smartregister.fhircore.engine.data.remote.fhir.resource.FhirResourceDataSource
 import org.smartregister.fhircore.engine.di.NetworkModule
 import org.smartregister.fhircore.engine.domain.model.MultiSelectViewAction
+import org.smartregister.fhircore.engine.sync.CustomSyncState
+import org.smartregister.fhircore.engine.sync.CustomWorkerState
 import org.smartregister.fhircore.engine.util.DispatcherProvider
 import org.smartregister.fhircore.engine.util.KnowledgeManagerUtil
 import org.smartregister.fhircore.engine.util.SharedPreferenceKey
@@ -526,30 +528,48 @@
   suspend fun fetchResources(
     gatewayModeHeaderValue: String? = null,
     url: String,
+    enableCustomSyncWorkerLogs: Boolean = false,
   ) {
-    val resultBundle =
-      runCatching {
-          if (gatewayModeHeaderValue.isNullOrEmpty()) {
-            fhirResourceDataSource.getResource(url)
-          } else {
-            fhirResourceDataSource.getResourceWithGatewayModeHeader(gatewayModeHeaderValue, url)
-          }
+    runCatching {
+        if (enableCustomSyncWorkerLogs) {
+          Timber.d("Posting state: InProgress")
+          CustomWorkerState.postState(CustomSyncState.InProgress)
         }
-        .onFailure { throwable ->
-          Timber.e("Error occurred while retrieving resource via URL $url", throwable)
+
+        Timber.d("Fetching page with URL: $url")
+        if (gatewayModeHeaderValue.isNullOrEmpty()) {
+          fhirResourceDataSource.getResource(url)
+        } else {
+          fhirResourceDataSource.getResourceWithGatewayModeHeader(gatewayModeHeaderValue, url)
         }
-        .getOrThrow()
+      }
+      .onFailure { throwable ->
+        Timber.e("Error occurred while retrieving resource via URL $url", throwable)
+        if (enableCustomSyncWorkerLogs) {
+          Timber.d("Posting state: Failed")
+          CustomWorkerState.postState(CustomSyncState.Failed(throwable.localizedMessage))
+        }
+        return // Exit on failure
+      }
+      .onSuccess { resultBundle ->
+        val nextPageUrl = resultBundle.getLink(PAGINATION_NEXT)?.url
 
-    val nextPageUrl = resultBundle.getLink(PAGINATION_NEXT)?.url
+        processResultBundleEntries(resultBundle.entry)
 
-    processResultBundleEntries(resultBundle.entry)
-
-    if (!nextPageUrl.isNullOrEmpty()) {
-      fetchResources(
-        gatewayModeHeaderValue = gatewayModeHeaderValue,
-        url = nextPageUrl,
-      )
-    }
+        if (!nextPageUrl.isNullOrEmpty()) {
+          fetchResources(
+            gatewayModeHeaderValue = gatewayModeHeaderValue,
+            url = nextPageUrl,
+            enableCustomSyncWorkerLogs = enableCustomSyncWorkerLogs,
+          )
+        } else {
+          Timber.d("No more pages to fetch. Fetching completed.")
+          if (enableCustomSyncWorkerLogs) {
+            Timber.d("Posting state: Success")
+            CustomWorkerState.postState(CustomSyncState.Success)
+          }
+        }
+      }
   }
 
   private suspend fun processResultBundleEntries(

android/engine/src/main/java/org/smartregister/fhircore/engine/sync/CustomSyncState.kt

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2021-2024 Ona Systems, Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.smartregister.fhircore.engine.sync
+
+sealed class CustomSyncState {
+  object InProgress : CustomSyncState()
+
+  object Success : CustomSyncState()
+
+  data class Failed(val error: String? = null) : CustomSyncState()
+
+  object Idle : CustomSyncState()
+}

android/engine/src/main/java/org/smartregister/fhircore/engine/sync/CustomSyncWorker.kt

@@ -56,6 +56,7 @@
               fetchResources(
                 gatewayModeHeaderValue = ConfigurationRegistry.FHIR_GATEWAY_MODE_HEADER_VALUE,
                 url = url,
+                enableCustomSyncWorkerLogs = true,
               )
             }
         }

android/engine/src/main/java/org/smartregister/fhircore/engine/sync/CustomWorkerState.kt

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2021-2024 Ona Systems, Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.smartregister.fhircore.engine.sync
+
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
+
+object CustomWorkerState {
+  private val _workerState = MutableStateFlow<CustomSyncState>(CustomSyncState.Idle)
+  val workerState: StateFlow<CustomSyncState> = _workerState
+
+  fun postState(state: CustomSyncState) {
+    _workerState.value = state
+  }
+}

android/engine/src/main/java/org/smartregister/fhircore/engine/sync/SyncBroadcaster.kt

@@ -17,19 +17,16 @@
 package org.smartregister.fhircore.engine.sync
 
 import android.content.Context
-import androidx.work.BackoffPolicy
 import androidx.work.Constraints
 import androidx.work.NetworkType
 import androidx.work.OneTimeWorkRequestBuilder
 import androidx.work.WorkManager
 import com.google.android.fhir.FhirEngine
-import com.google.android.fhir.sync.BackoffCriteria
 import com.google.android.fhir.sync.CurrentSyncJobStatus
 import com.google.android.fhir.sync.LastSyncJobStatus
 import com.google.android.fhir.sync.PeriodicSyncConfiguration
 import com.google.android.fhir.sync.PeriodicSyncJobStatus
 import com.google.android.fhir.sync.RepeatInterval
-import com.google.android.fhir.sync.RetryConfiguration
 import com.google.android.fhir.sync.Sync
 import com.google.android.fhir.sync.SyncJobStatus
 import com.google.android.fhir.sync.download.ResourceParamsBasedDownloadWorkManager
@@ -80,11 +77,6 @@
         .setConstraints(
           Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).build(),
         )
-        .setBackoffCriteria(
-          BackoffPolicy.LINEAR,
-          10,
-          TimeUnit.SECONDS,
-        )
         .build(),
     )
   }
@@ -103,16 +95,6 @@
             syncConstraints =
               Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).build(),
             repeat = RepeatInterval(interval = interval, timeUnit = TimeUnit.MINUTES),
-            retryConfiguration =
-              RetryConfiguration(
-                backoffCriteria =
-                  BackoffCriteria(
-                    backoffDelay = 10,
-                    timeUnit = TimeUnit.SECONDS,
-                    backoffPolicy = BackoffPolicy.EXPONENTIAL,
-                  ),
-                maxRetries = 3,
-              ),
           ),
       )
       .handlePeriodicSyncJobStatus(this)
@@ -121,14 +103,34 @@
   private fun Flow<PeriodicSyncJobStatus>.handlePeriodicSyncJobStatus(
     coroutineScope: CoroutineScope,
   ) {
-    this.onEach {
+    this.onEach { status ->
         syncListenerManager.onSyncListeners.forEach { onSyncListener ->
-          onSyncListener.onSync(
-            if (it.lastSyncJobStatus as? LastSyncJobStatus.Succeeded != null) {
-              CurrentSyncJobStatus.Succeeded((it.lastSyncJobStatus as LastSyncJobStatus).timestamp)
+          Timber.d("fhir sync worker...")
+
+          // Check if lastSyncJobStatus is not null and is of type Succeeded
+          val syncStatus =
+            if (status.lastSyncJobStatus as? LastSyncJobStatus.Succeeded != null) {
+              CurrentSyncJobStatus.Succeeded(
+                (status.lastSyncJobStatus as LastSyncJobStatus.Succeeded).timestamp,
+              )
             } else {
-              it.currentSyncJobStatus
-            },
+              status.currentSyncJobStatus
+            }
+
+          onSyncListener.onSync(syncStatus)
+        }
+
+        if (
+          status.currentSyncJobStatus is CurrentSyncJobStatus.Succeeded ||
+            status.lastSyncJobStatus is LastSyncJobStatus.Succeeded
+        ) {
+          Timber.d("Periodic sync succeeded. Triggering CustomSyncWorker...")
+          workManager.enqueue(
+            OneTimeWorkRequestBuilder<CustomSyncWorker>()
+              .setConstraints(
+                Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).build(),
+              )
+              .build(),
           )
         }
       }

android/quest/src/androidTest/java/org/smartregister/fhircore/quest/integration/ui/register/RegisterScreenTest.kt

@@ -60,6 +60,7 @@ import org.smartregister.fhircore.engine.configuration.workflow.ActionTrigger
 import org.smartregister.fhircore.engine.domain.model.ActionConfig
 import org.smartregister.fhircore.engine.domain.model.Language
 import org.smartregister.fhircore.engine.domain.model.ResourceData
+import org.smartregister.fhircore.engine.sync.CustomSyncState
 import org.smartregister.fhircore.quest.integration.Faker
 import org.smartregister.fhircore.quest.ui.main.appMainUiStateOf
 import org.smartregister.fhircore.quest.ui.register.FAB_BUTTON_REGISTER_TEST_TAG
@@ -610,6 +611,7 @@ class RegisterScreenTest {
             currentSyncJobStatus = CurrentSyncJobStatus.Succeeded(OffsetDateTime.now()),
           ),
         onAppMainEvent = {},
+        customSyncState = CustomSyncState.Success,
         searchQuery = searchText,
         currentPage = currentPage,
         pagingItems = pagingItems,

android/quest/src/main/java/org/smartregister/fhircore/quest/ui/geowidget/GeoWidgetLauncherFragment.kt

@@ -26,6 +26,7 @@
 import androidx.compose.material.Scaffold
 import androidx.compose.material.rememberScaffoldState
 import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.rememberCoroutineScope
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.platform.ComposeView
@@ -119,6 +120,7 @@
         val scaffoldState = rememberScaffoldState()
         val uiState: AppMainUiState = appMainViewModel.appMainUiState.value
         val appDrawerUIState = appMainViewModel.appDrawerUiState.value
+        val customSyncState = appMainViewModel.customSyncState.collectAsState().value
         val openDrawer: (Boolean) -> Unit = { open: Boolean ->
           coroutineScope.launch {
             if (open) scaffoldState.drawerState.open() else scaffoldState.drawerState.close()
@@ -192,6 +194,7 @@
                 appDrawerUIState = appDrawerUIState,
                 clearMapLiveData = geoWidgetLauncherViewModel.clearMapLiveData,
                 geoJsonFeatures = geoWidgetLauncherViewModel.geoJsonFeatures,
+                customSyncState = customSyncState,
                 launchQuestionnaire = geoWidgetLauncherViewModel::launchQuestionnaire,
                 decodeImage = geoWidgetLauncherViewModel::getImageBitmap,
                 onAppMainEvent = appMainViewModel::onEvent,
@@ -223,12 +226,11 @@
           )
         }
       }
-      is CurrentSyncJobStatus.Succeeded,
-      is CurrentSyncJobStatus.Failed, -> {
+      is CurrentSyncJobStatus.Succeeded -> {
+        appMainViewModel.updateAppDrawerUIState(currentSyncJobStatus = syncJobStatus)
+      }
+      is CurrentSyncJobStatus.Failed -> {
         appMainViewModel.updateAppDrawerUIState(currentSyncJobStatus = syncJobStatus)
-        if (syncJobStatus is CurrentSyncJobStatus.Succeeded) {
-          geoWidgetLauncherViewModel.onEvent(GeoWidgetEvent.ClearMap)
-        }
         geoWidgetLauncherViewModel.onEvent(
           GeoWidgetEvent.RetrieveFeatures(
             geoWidgetConfig = geoWidgetConfiguration,

android/quest/src/main/java/org/smartregister/fhircore/quest/ui/geowidget/GeoWidgetLauncherScreen.kt

@@ -44,6 +44,7 @@
 import org.smartregister.fhircore.engine.configuration.geowidget.GeoWidgetConfiguration
 import org.smartregister.fhircore.engine.domain.model.ResourceData
 import org.smartregister.fhircore.engine.domain.model.ToolBarHomeNavigation
+import org.smartregister.fhircore.engine.sync.CustomSyncState
 import org.smartregister.fhircore.engine.ui.components.register.LoaderDialog
 import org.smartregister.fhircore.engine.util.extension.showToast
 import org.smartregister.fhircore.geowidget.model.GeoJsonFeature
@@ -71,6 +72,7 @@
   appDrawerUIState: AppDrawerUIState,
   clearMapLiveData: MutableLiveData<Boolean>,
   geoJsonFeatures: MutableLiveData<List<GeoJsonFeature>>,
+  customSyncState: CustomSyncState = CustomSyncState.Idle,
   launchQuestionnaire: (QuestionnaireConfig, GeoJsonFeature, Context) -> Unit,
   decodeImage: ((String) -> Bitmap?)?,
   onAppMainEvent: (AppMainEvent) -> Unit,
@@ -126,6 +128,7 @@
         appDrawerUIState = appDrawerUIState,
         onAppMainEvent = onAppMainEvent,
         openDrawer = openDrawer,
+        customSyncState = customSyncState,
       )
     },
   ) { innerPadding ->

android/quest/src/main/java/org/smartregister/fhircore/quest/ui/main/AppMainViewModel.kt

@@ -43,6 +43,9 @@
 import javax.inject.Inject
 import kotlin.time.Duration
 import kotlinx.coroutines.async
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import org.hl7.fhir.r4.model.QuestionnaireResponse
@@ -59,7 +62,8 @@
 import org.smartregister.fhircore.engine.data.local.register.RegisterRepository
 import org.smartregister.fhircore.engine.domain.model.LauncherType
 import org.smartregister.fhircore.engine.domain.model.MultiSelectViewAction
-import org.smartregister.fhircore.engine.sync.CustomSyncWorker
+import org.smartregister.fhircore.engine.sync.CustomSyncState
+import org.smartregister.fhircore.engine.sync.CustomWorkerState
 import org.smartregister.fhircore.engine.sync.SyncBroadcaster
 import org.smartregister.fhircore.engine.task.FhirCarePlanGenerator
 import org.smartregister.fhircore.engine.task.FhirCompleteCarePlanWorker
@@ -89,6 +93,7 @@
 import org.smartregister.fhircore.quest.ui.shared.models.QuestionnaireSubmission
 import org.smartregister.fhircore.quest.util.extensions.handleClickEvent
 import org.smartregister.fhircore.quest.util.extensions.schedulePeriodically
+import timber.log.Timber
 
 @HiltViewModel
 class AppMainViewModel
@@ -134,6 +139,35 @@
     configurationRegistry.retrieveConfigurations(ConfigType.MeasureReport)
   }
 
+  private val _customSyncState = MutableStateFlow<CustomSyncState>(CustomSyncState.Idle)
+  val customSyncState: StateFlow<CustomSyncState> = _customSyncState.asStateFlow()
+
+  init {
+    observeWorkerSyncState()
+  }
+
+  private fun observeWorkerSyncState() {
+    viewModelScope.launch {
+      CustomWorkerState.workerState.collect { syncState ->
+        when (syncState) {
+          CustomSyncState.InProgress -> {
+            Timber.d("Custom Sync Worker InProgress")
+            _customSyncState.value = CustomSyncState.InProgress
+          }
+          CustomSyncState.Failed() -> {
+            Timber.d("Custom Sync Worker Failed")
+            _customSyncState.value = CustomSyncState.Failed("")
+          }
+          CustomSyncState.Success -> {
+            _customSyncState.value = CustomSyncState.Success
+            Timber.d("Custom Sync Worker Finished")
+          }
+          else -> {}
+        }
+      }
+    }
+  }
+
   fun retrieveAppMainUiState(refreshAll: Boolean = true) {
     if (refreshAll) {
       appMainUiState.value =
@@ -468,12 +502,6 @@
         initialDelay = INITIAL_DELAY,
       )
 
-      schedulePeriodically<CustomSyncWorker>(
-        workId = CustomSyncWorker.WORK_ID,
-        repeatInterval = applicationConfiguration.syncInterval,
-        initialDelay = 0,
-      )
-
       measureReportConfigurations.forEach { measureReportConfig ->
         measureReportConfig.scheduledGenerationDuration?.let { scheduledGenerationDuration ->
           schedulePeriodically<MeasureReportMonthPeriodWorker>(