Fix handling sync status by harmonizing SDK and custom sync statuses

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

@@ -25,17 +25,23 @@
 import com.google.android.fhir.db.ResourceNotFoundException
 import com.google.android.fhir.get
 import com.google.android.fhir.knowledge.KnowledgeManager
+import com.google.android.fhir.sync.CurrentSyncJobStatus
+import com.google.android.fhir.sync.SyncJobStatus
+import com.google.android.fhir.sync.SyncOperation
 import com.google.android.fhir.sync.SyncDataParams.LAST_UPDATED_KEY
 import com.google.android.fhir.sync.download.ResourceSearchParams
 import dagger.hilt.android.qualifiers.ApplicationContext
 import java.io.FileNotFoundException
 import java.io.InputStreamReader
 import java.net.UnknownHostException
+import java.time.OffsetDateTime
 import java.util.Locale
 import java.util.PropertyResourceBundle
 import java.util.ResourceBundle
 import javax.inject.Inject
 import javax.inject.Singleton
+import kotlinx.coroutines.flow.MutableSharedFlow
+import kotlinx.coroutines.flow.SharedFlow
 import kotlinx.coroutines.withContext
 import kotlinx.serialization.json.Json
 import okhttp3.RequestBody.Companion.toRequestBody
@@ -102,6 +108,10 @@
   val localizationHelper: LocalizationHelper by lazy { LocalizationHelper(this) }
   private val supportedFileExtensions = listOf("json", "properties")
   private var _isNonProxy = BuildConfig.IS_NON_PROXY_APK
+  private val _syncState = MutableSharedFlow<CurrentSyncJobStatus>()
+  val syncState: SharedFlow<CurrentSyncJobStatus> = _syncState
+
+  suspend fun setSyncState(state: CurrentSyncJobStatus) = _syncState.emit(state)
 
   /**
    * Retrieve configuration for the provided [ConfigType]. The JSON retrieved from [configsJsonMap]
@@ -565,7 +575,82 @@
     return resultBundle
   }
 
-  suspend fun fetchResources(
+  suspend fun fetchCustomResources(
+    gatewayModeHeaderValue: String? = null,
+    url: String,
+    totalCustomRecords: Int = 0,
+    completedRecords: Int = 0,
+  ) {
+    if (completedRecords == 0) {
+      Timber.d("Setting state: Started")
+      setSyncState(
+        CurrentSyncJobStatus.Running(
+          SyncJobStatus.Started(),
+        ),
+      )
+    }
+
+    runCatching {
+        Timber.d("Setting state: Running")
+        setSyncState(
+          CurrentSyncJobStatus.Running(
+            SyncJobStatus.InProgress(
+              syncOperation = SyncOperation.DOWNLOAD,
+              total = totalCustomRecords,
+              completed = completedRecords,
+            ),
+          ),
+        )
+        Timber.d("Fetching page with URL: $url")
+        if (gatewayModeHeaderValue.isNullOrEmpty()) {
+          fhirResourceDataSource.getResource(url)
+        } else {
+          fhirResourceDataSource.getResourceWithGatewayModeHeader(gatewayModeHeaderValue, url)
+        }
+      }
+      .onFailure { throwable ->
+        Timber.e("Error occurred while retrieving resource via URL $url", throwable)
+        Timber.d("Setting state: Failed")
+        setSyncState(
+          CurrentSyncJobStatus.Failed(OffsetDateTime.now()),
+        )
+        return
+      }
+      .onSuccess { resultBundle ->
+        processResultBundleEntries(resultBundle.entry)
+        val newCompletedRecords = completedRecords + resultBundle.entry.size
+
+        Timber.d("Updating state: Running")
+        setSyncState(
+          CurrentSyncJobStatus.Running(
+            SyncJobStatus.InProgress(
+              syncOperation = SyncOperation.DOWNLOAD,
+              total = totalCustomRecords,
+              completed = newCompletedRecords,
+            ),
+          ),
+        )
+
+        val nextPageUrl = resultBundle.getLink(PAGINATION_NEXT)?.url
+
+        if (!nextPageUrl.isNullOrEmpty()) {
+          fetchCustomResources(
+            gatewayModeHeaderValue = gatewayModeHeaderValue,
+            url = nextPageUrl,
+            totalCustomRecords = totalCustomRecords,
+            completedRecords = newCompletedRecords, // Pass the new value
+          )
+        } else {
+          Timber.d("No more pages to fetch. Fetching completed.")
+          Timber.d("Setting state: Succeeded")
+          setSyncState(
+            CurrentSyncJobStatus.Succeeded(OffsetDateTime.now()),
+          )
+        }
+      }
+  }
+
+  private suspend fun fetchResources(
     gatewayModeHeaderValue: String? = null,
     url: String,
   ) {
@@ -581,11 +666,8 @@
           Timber.e("Error occurred while retrieving resource via URL $url", throwable)
         }
         .getOrThrow()
-
     val nextPageUrl = resultBundle.getLink(PAGINATION_NEXT)?.url
-
     processResultBundleEntries(resultBundle.entry)
-
     if (!nextPageUrl.isNullOrEmpty()) {
       fetchResources(
         gatewayModeHeaderValue = gatewayModeHeaderValue,

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

@@ -20,10 +20,12 @@
 import androidx.hilt.work.HiltWorker
 import androidx.work.CoroutineWorker
 import androidx.work.WorkerParameters
+import com.google.android.fhir.sync.CurrentSyncJobStatus
 import com.google.android.fhir.sync.concatParams
 import dagger.assisted.Assisted
 import dagger.assisted.AssistedInject
 import java.net.UnknownHostException
+import java.time.OffsetDateTime
 import kotlinx.coroutines.withContext
 import org.smartregister.fhircore.engine.configuration.ConfigurationRegistry
 import org.smartregister.fhircore.engine.data.remote.fhir.resource.FhirResourceDataSource
@@ -42,22 +44,34 @@
   val dispatcherProvider: DispatcherProvider,
   val fhirResourceDataSource: FhirResourceDataSource,
 ) : CoroutineWorker(appContext, workerParams) {
+
   override suspend fun doWork(): Result {
     return withContext(dispatcherProvider.io()) {
       try {
         with(configurationRegistry) {
           val (resourceSearchParams, _) = loadResourceSearchParams()
           Timber.i("Custom resource sync parameters $resourceSearchParams")
-          resourceSearchParams
-            .asIterable()
-            .filter { it.value.isNotEmpty() }
-            .map { "${it.key}?${it.value.concatParams()}" }
-            .forEach { url ->
-              fetchResources(
-                gatewayModeHeaderValue = ConfigurationRegistry.FHIR_GATEWAY_MODE_HEADER_VALUE,
-                url = url,
-              )
-            }
+
+          // Process resource URLs
+          val resourceUrls =
+            resourceSearchParams
+              .asIterable()
+              .filter { it.value.isNotEmpty() }
+              .map { "${it.key}?${it.value.concatParams()}" }
+
+          // Fetch summary count first
+
+          val summaryCount = fetchSummaryCount(resourceUrls).values.sumOf { it ?: 0 }
+          Timber.d("Fetched summary count: $summaryCount")
+
+          // Fetch resources
+          resourceUrls.forEach { url ->
+            fetchCustomResources(
+              gatewayModeHeaderValue = ConfigurationRegistry.FHIR_GATEWAY_MODE_HEADER_VALUE,
+              url = url,
+              totalCustomRecords = summaryCount,
+            )
+          }
         }
         Result.success()
       } catch (httpException: HttpException) {
@@ -72,11 +86,32 @@
         Result.failure()
       } catch (exception: Exception) {
         Timber.e(exception)
+        configurationRegistry.setSyncState(
+          CurrentSyncJobStatus.Failed(OffsetDateTime.now()),
+        )
         Result.failure()
       }
     }
   }
 
+  /** Fetch summary counts for the provided URLs with summary=count query added. */
+  private suspend fun fetchSummaryCount(resourceUrls: List<String>): Map<String, Int?> =
+    resourceUrls
+      .associate { url ->
+        // Modify URL to include 'summary=count'
+        val summaryUrl = "$url&summary=count"
+        val total: Int? =
+          runCatching {
+              // Explicitly fetch resource and ensure result can be cast to Bundle
+              fhirResourceDataSource.getResource(summaryUrl)
+            }
+            .onFailure { Timber.e(it, "Failed to fetch summary for $summaryUrl") }
+            .getOrNull()
+            ?.total
+        summaryUrl to total
+      }
+      .also { summaries -> Timber.i("Summary fetch results: $summaries") }
+
   companion object {
     const val WORK_ID = "CustomResourceSyncWorker"
   }

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

@@ -51,6 +51,7 @@
 import org.smartregister.fhircore.engine.configuration.ConfigType
 import org.smartregister.fhircore.engine.configuration.ConfigurationRegistry
 import org.smartregister.fhircore.engine.configuration.geowidget.GeoWidgetConfiguration
+import org.smartregister.fhircore.engine.domain.model.SnackBarMessageConfig
 import org.smartregister.fhircore.engine.sync.OnSyncListener
 import org.smartregister.fhircore.engine.sync.SyncListenerManager
 import org.smartregister.fhircore.engine.ui.base.AlertDialogButton
@@ -210,9 +211,21 @@
   }
 
   override fun onSync(syncJobStatus: CurrentSyncJobStatus) {
+    onSync(syncJobStatus, isCustomSync = false)
+  }
+
+  private fun onSync(syncJobStatus: CurrentSyncJobStatus, isCustomSync: Boolean) {
     when (syncJobStatus) {
       is CurrentSyncJobStatus.Running -> {
-        if (syncJobStatus.inProgressSyncJob is SyncJobStatus.InProgress) {
+        if (syncJobStatus.inProgressSyncJob is SyncJobStatus.Started) {
+          lifecycleScope.launch {
+            if (isCustomSync) {
+              geoWidgetLauncherViewModel.emitSnackBarState(
+                SnackBarMessageConfig(message = getString(R.string.syncing_custom_resources_toast)),
+              )
+            }
+          }
+        } else {
           val inProgressSyncJob = syncJobStatus.inProgressSyncJob as SyncJobStatus.InProgress
           val isSyncUpload = inProgressSyncJob.syncOperation == SyncOperation.UPLOAD
           val progressPercentage = appMainViewModel.calculatePercentageProgress(inProgressSyncJob)
@@ -223,12 +236,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,
@@ -244,26 +256,33 @@
     super.onViewCreated(view, savedInstanceState)
     viewLifecycleOwner.lifecycleScope.launch {
       viewLifecycleOwner.repeatOnLifecycle(Lifecycle.State.CREATED) {
-        eventBus.events
-          .getFor(MainNavigationScreen.GeoWidgetLauncher.eventId(navArgs.geoWidgetId))
-          .onEach { appEvent ->
-            when (appEvent) {
-              is AppEvent.RefreshData,
-              is AppEvent.OnSubmitQuestionnaire, -> {
-                appMainViewModel.countRegisterData()
-                geoWidgetLauncherViewModel.run {
-                  onEvent(GeoWidgetEvent.ClearMap)
-                  onEvent(
-                    GeoWidgetEvent.RetrieveFeatures(
-                      geoWidgetConfig = geoWidgetConfiguration,
-                      searchQuery = searchViewModel.searchQuery.value,
-                    ),
-                  )
+        launch {
+          configurationRegistry.syncState
+            .onEach { syncJobStatus -> onSync(syncJobStatus, true) }
+            .launchIn(this)
+        }
+        launch {
+          eventBus.events
+            .getFor(MainNavigationScreen.GeoWidgetLauncher.eventId(navArgs.geoWidgetId))
+            .onEach { appEvent ->
+              when (appEvent) {
+                is AppEvent.RefreshData,
+                is AppEvent.OnSubmitQuestionnaire, -> {
+                  appMainViewModel.countRegisterData()
+                  geoWidgetLauncherViewModel.run {
+                    onEvent(GeoWidgetEvent.ClearMap)
+                    onEvent(
+                      GeoWidgetEvent.RetrieveFeatures(
+                        geoWidgetConfig = geoWidgetConfiguration,
+                        searchQuery = searchViewModel.searchQuery.value,
+                      ),
+                    )
+                  }
                 }
               }
             }
-          }
-          .launchIn(lifecycleScope)
+            .launchIn(this)
+        }
       }
     }
     geoWidgetLauncherViewModel.noLocationFoundDialog.observe(viewLifecycleOwner) { show ->