Migration of Primitive Datatypes from SharedPreferences to PreferenceDataStore

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

@@ -57,12 +57,12 @@ import org.smartregister.fhircore.engine.BuildConfig
 import org.smartregister.fhircore.engine.configuration.app.ApplicationConfiguration
 import org.smartregister.fhircore.engine.configuration.app.ConfigService
 import org.smartregister.fhircore.engine.data.remote.fhir.resource.FhirResourceDataSource
+import org.smartregister.fhircore.engine.datastore.PreferenceDataStore
 import org.smartregister.fhircore.engine.di.NetworkModule
 import org.smartregister.fhircore.engine.domain.model.MultiSelectViewAction
 import org.smartregister.fhircore.engine.util.DispatcherProvider
 import org.smartregister.fhircore.engine.util.KnowledgeManagerUtil
 import org.smartregister.fhircore.engine.util.SharedPreferenceKey
-import org.smartregister.fhircore.engine.util.SharedPreferencesHelper
 import org.smartregister.fhircore.engine.util.extension.camelCase
 import org.smartregister.fhircore.engine.util.extension.decodeJson
 import org.smartregister.fhircore.engine.util.extension.decodeResourceFromString
@@ -86,7 +86,7 @@ class ConfigurationRegistry
 constructor(
   val fhirEngine: FhirEngine,
   val fhirResourceDataSource: FhirResourceDataSource,
-  val sharedPreferencesHelper: SharedPreferencesHelper,
+  val preferenceDataStore: PreferenceDataStore,
   val dispatcherProvider: DispatcherProvider,
   val configService: ConfigService,
   val json: Json,
@@ -159,10 +159,25 @@ constructor(
    * placeholders e.g. {{ placeholder }} with value retrieved from the [paramsMap] using [configKey]
    * as the key. If value is null the placeholder is returned
    */
-  fun getConfigValueWithParam(paramsMap: Map<String, String>?, configKey: String) =
-    configsJsonMap.getValue(configKey).let { jsonValue ->
-      if (paramsMap != null) jsonValue.interpolate(paramsMap) else jsonValue
+//  fun getConfigValueWithParam(paramsMap: Map<String, String>?, configKey: String) =
+//    configsJsonMap.getValue(configKey).let { jsonValue ->
+//      if (paramsMap != null) jsonValue.interpolate(paramsMap) else jsonValue
+//    }
+
+  fun getConfigValueWithParam(paramsMap: Map<String, String>?, configKey: String): String {
+    try {
+      configsJsonMap.getValue(configKey).let { jsonValue ->
+        val interpolatedValue = if (paramsMap != null) jsonValue.interpolate(paramsMap) else jsonValue
+        // Use interpolatedValue here if needed, or perform any side effects
+        return interpolatedValue
+      }
+    } catch (e: Exception) {
+      Timber.e("Error processing config key: $configKey. Exception: ${e.message}")
+      // You can log or handle the exception as needed
+      return ""
     }
+  }
+
 
   /**
    * Retrieve configuration for the provided [ConfigType]. The JSON retrieved from [configsJsonMap]
@@ -410,7 +425,7 @@ constructor(
   suspend fun fetchNonWorkflowConfigResources() {
     Timber.d("Triggered fetching application configurations remotely")
     configCacheMap.clear()
-    sharedPreferencesHelper.read(SharedPreferenceKey.APP_ID.name, null)?.let { appId ->
+    preferenceDataStore.readOnce(PreferenceDataStore.APP_ID, null)?.let { appId ->
       val parsedAppId = appId.substringBefore(TYPE_REFERENCE_DELIMITER).trim()
       val compositionResource = fetchRemoteCompositionByAppId(parsedAppId)
       compositionResource?.let { composition ->
@@ -729,7 +744,10 @@ constructor(
     val fhirResourceSearchParams = mutableMapOf<ResourceType, MutableMap<String, String>>()
     val organizationResourceTag =
       configService.defineResourceTags().find { it.type == ResourceType.Organization.name }
-    val mandatoryTags = configService.provideResourceTags(sharedPreferencesHelper)
+    val mandatoryTags =
+      configService.provideResourceTags(
+        preferenceDataStore
+      )
 
     val locationIds =
       context.retrieveRelatedEntitySyncLocationState(MultiSelectViewAction.SYNC_DATA).map {

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

@@ -16,13 +16,13 @@
 
 package org.smartregister.fhircore.engine.configuration.app
 
+import androidx.datastore.preferences.core.stringPreferencesKey
 import org.hl7.fhir.r4.model.Coding
 import org.hl7.fhir.r4.model.Enumerations
 import org.hl7.fhir.r4.model.ResourceType
 import org.hl7.fhir.r4.model.SearchParameter
+import org.smartregister.fhircore.engine.datastore.PreferenceDataStore
 import org.smartregister.fhircore.engine.sync.ResourceTag
-import org.smartregister.fhircore.engine.util.SharedPreferenceKey
-import org.smartregister.fhircore.engine.util.SharedPreferencesHelper
 import org.smartregister.fhircore.engine.util.extension.extractLogicalIdUuid
 
 /** An interface that provides the application configurations. */
@@ -38,12 +38,14 @@ interface ConfigService {
    * Provide a list of [Coding] that represents [ResourceTag]. [Coding] can be directly appended to
    * a FHIR resource.
    */
-  fun provideResourceTags(sharedPreferencesHelper: SharedPreferencesHelper): List<Coding> {
+  suspend fun provideResourceTags(
+    preferenceDataStore: PreferenceDataStore
+  ): List<Coding> {
     val tags = mutableListOf<Coding>()
     defineResourceTags().forEach { strategy ->
       when (strategy.type) {
         ResourceType.Practitioner.name -> {
-          val id = sharedPreferencesHelper.read(SharedPreferenceKey.PRACTITIONER_ID.name, null)
+          val id = preferenceDataStore.readOnce(PreferenceDataStore.PRACTITIONER_ID)
           if (id.isNullOrBlank() || id.isEmpty()) {
             strategy.tag.let { tag -> tags.add(tag.copy().apply { code = "Not defined" }) }
           } else {
@@ -54,16 +56,32 @@ interface ConfigService {
         }
         APP_VERSION -> tags.add(strategy.tag.copy())
         else -> {
-          val ids = sharedPreferencesHelper.read<List<String>>(strategy.type)
-          if (ids.isNullOrEmpty()) {
+          // ToDO: This is an object type
+          val datastoreKey = stringPreferencesKey("key")
+
+          val ids = preferenceDataStore.readOnce(datastoreKey, defaultValue = null)
+          val idList = ids?.split(",")
+
+          if (idList.isNullOrEmpty()) {
             strategy.tag.let { tag -> tags.add(tag.copy().apply { code = "Not defined" }) }
           } else {
-            ids.forEach { id ->
+            idList.forEach { id ->
               strategy.tag.let { tag ->
                 tags.add(tag.copy().apply { code = id.extractLogicalIdUuid() })
               }
             }
           }
+
+//            //sharedPreferencesHelper.read<List<String>>(strategy.type)
+//          if (ids.isNullOrEmpty()) {
+//            strategy.tag.let { tag -> tags.add(tag.copy().apply { code = "Not defined" }) }
+//          } else {
+//            ids.forEach { id ->
+//              strategy.tag.let { tag ->
+//                tags.add(tag.copy().apply { code = id.extractLogicalIdUuid() })
+//              }
+//            }
+//          }
         }
       }
     }

android/engine/src/main/java/org/smartregister/fhircore/engine/data/local/DefaultRepository.kt

@@ -73,6 +73,7 @@ import org.smartregister.fhircore.engine.configuration.app.ConfigService
 import org.smartregister.fhircore.engine.configuration.event.EventWorkflow
 import org.smartregister.fhircore.engine.configuration.profile.ManagingEntityConfig
 import org.smartregister.fhircore.engine.configuration.register.ActiveResourceFilterConfig
+import org.smartregister.fhircore.engine.datastore.PreferenceDataStore
 import org.smartregister.fhircore.engine.domain.model.Code
 import org.smartregister.fhircore.engine.domain.model.DataQuery
 import org.smartregister.fhircore.engine.domain.model.FhirResourceConfig
@@ -85,7 +86,6 @@ import org.smartregister.fhircore.engine.domain.model.RuleConfig
 import org.smartregister.fhircore.engine.domain.model.SortConfig
 import org.smartregister.fhircore.engine.rulesengine.ConfigRulesExecutor
 import org.smartregister.fhircore.engine.util.DispatcherProvider
-import org.smartregister.fhircore.engine.util.SharedPreferencesHelper
 import org.smartregister.fhircore.engine.util.extension.asReference
 import org.smartregister.fhircore.engine.util.extension.batchedSearch
 import org.smartregister.fhircore.engine.util.extension.encodeResourceToString
@@ -107,7 +107,7 @@ open class DefaultRepository
 constructor(
   open val fhirEngine: FhirEngine,
   open val dispatcherProvider: DispatcherProvider,
-  open val sharedPreferencesHelper: SharedPreferencesHelper,
+  open val preferenceDataStore: PreferenceDataStore,
   open val configurationRegistry: ConfigurationRegistry,
   open val configService: ConfigService,
   open val configRulesExecutor: ConfigRulesExecutor,
@@ -179,14 +179,17 @@ constructor(
     fhirEngine.create(*resource, isLocalOnly = true)
   }
 
-  private fun preProcessResources(addResourceTags: Boolean, vararg resource: Resource) {
+  private suspend fun preProcessResources(addResourceTags: Boolean, vararg resource: Resource) {
     resource.onEach { currentResource ->
       currentResource.apply {
         updateLastUpdated()
         generateMissingId()
       }
       if (addResourceTags) {
-        val tags = configService.provideResourceTags(sharedPreferencesHelper)
+        val tags =
+          configService.provideResourceTags(
+            preferenceDataStore = preferenceDataStore
+          )
         tags.forEach {
           val existingTag = currentResource.meta.getTag(it.system, it.code)
           if (existingTag == null) {

android/engine/src/main/java/org/smartregister/fhircore/engine/data/local/register/RegisterRepository.kt

@@ -30,14 +30,14 @@ import org.smartregister.fhircore.engine.configuration.profile.ProfileConfigurat
 import org.smartregister.fhircore.engine.configuration.register.RegisterConfiguration
 import org.smartregister.fhircore.engine.data.local.ContentCache
 import org.smartregister.fhircore.engine.data.local.DefaultRepository
+import org.smartregister.fhircore.engine.datastore.PreferenceDataStore
 import org.smartregister.fhircore.engine.domain.model.ActionParameter
 import org.smartregister.fhircore.engine.domain.model.ActionParameterType
 import org.smartregister.fhircore.engine.domain.model.FhirResourceConfig
 import org.smartregister.fhircore.engine.domain.model.RepositoryResourceData
 import org.smartregister.fhircore.engine.domain.repository.Repository
 import org.smartregister.fhircore.engine.rulesengine.ConfigRulesExecutor
 import org.smartregister.fhircore.engine.util.DispatcherProvider
-import org.smartregister.fhircore.engine.util.SharedPreferencesHelper
 import org.smartregister.fhircore.engine.util.extension.extractLogicalIdUuid
 import org.smartregister.fhircore.engine.util.fhirpath.FhirPathDataExtractor
 
@@ -46,7 +46,7 @@ class RegisterRepository
 constructor(
   override val fhirEngine: FhirEngine,
   override val dispatcherProvider: DispatcherProvider,
-  override val sharedPreferencesHelper: SharedPreferencesHelper,
+  override val preferenceDataStore: PreferenceDataStore,
   override val configurationRegistry: ConfigurationRegistry,
   override val configService: ConfigService,
   override val configRulesExecutor: ConfigRulesExecutor,
@@ -59,13 +59,13 @@ constructor(
   DefaultRepository(
     fhirEngine = fhirEngine,
     dispatcherProvider = dispatcherProvider,
-    sharedPreferencesHelper = sharedPreferencesHelper,
     configurationRegistry = configurationRegistry,
     configService = configService,
     configRulesExecutor = configRulesExecutor,
     fhirPathDataExtractor = fhirPathDataExtractor,
     parser = parser,
     context = context,
+    preferenceDataStore = preferenceDataStore,
     contentCache = contentCache,
   ) {
 

android/engine/src/main/java/org/smartregister/fhircore/engine/datastore/PreferenceDataStore.kt

@@ -18,26 +18,37 @@ package org.smartregister.fhircore.engine.datastore
 
 import android.content.Context
 import androidx.datastore.core.DataStore
+import androidx.datastore.dataStore
 import androidx.datastore.preferences.core.Preferences
 import androidx.datastore.preferences.core.edit
 import androidx.datastore.preferences.core.emptyPreferences
 import androidx.datastore.preferences.core.intPreferencesKey
+import androidx.datastore.preferences.core.longPreferencesKey
 import androidx.datastore.preferences.core.stringPreferencesKey
 import androidx.datastore.preferences.preferencesDataStore
+import com.google.android.fhir.sync.SyncJobStatus
+import com.google.gson.Gson
 import dagger.hilt.android.qualifiers.ApplicationContext
 import java.io.IOException
 import javax.inject.Inject
 import javax.inject.Singleton
 import kotlinx.coroutines.flow.catch
+import kotlinx.coroutines.flow.firstOrNull
 import kotlinx.coroutines.flow.map
-
-const val DATASTORE_NAME = "preferences_datastore"
-val Context.dataStore: DataStore<Preferences> by preferencesDataStore(name = DATASTORE_NAME)
+import kotlinx.coroutines.runBlocking
+import kotlinx.serialization.Serializable
+import org.hl7.fhir.r4.model.ResourceType
+import org.smartregister.fhircore.engine.util.SharedPreferenceKey
+import org.smartregister.fhircore.engine.util.extension.lastOffset
+import org.smartregister.model.practitioner.PractitionerDetails
+import java.util.Locale
 
 @Singleton
-class PreferenceDataStore @Inject constructor(@ApplicationContext val context: Context) {
+open class PreferenceDataStore
+@Inject
+constructor(@ApplicationContext val context: Context, val dataStore: DataStore<Preferences>) {
   fun <T> read(key: Preferences.Key<T>) =
-    context.dataStore.data
+    dataStore.data
       .catch { exception ->
         if (exception is IOException) {
           emit(emptyPreferences())
@@ -47,13 +58,82 @@ class PreferenceDataStore @Inject constructor(@ApplicationContext val context: C
       }
       .map { preferences -> preferences[key] as T }
 
-  suspend fun <T> write(key: Preferences.Key<T>, data: T) {
-    context.dataStore.edit { preferences -> preferences[key] = data }
+  fun <T> readOnce(key: Preferences.Key<T>, defaultValue: T? = null) = runBlocking {
+    dataStore.data.map { preferences -> preferences[key] ?: defaultValue }.firstOrNull()
+  }
+
+  suspend fun <T> write(key: Preferences.Key<T>, value: T) {
+    dataStore.edit { preferences -> preferences[key] = value }
+  }
+
+  suspend fun write(key: Preferences.Key<String>, value: String) {
+    dataStore.edit { preferences -> preferences[key] = value }
+  }
+
+  suspend fun <T> remove(key: Preferences.Key<T>) {
+    dataStore.edit { it.remove(key) }
+  }
+
+  suspend fun clear() {
+    dataStore.edit { it.clear() }
+  }
+
+  fun retrieveApplicationId() = read(APP_ID).toString()
+
+  fun resetPreferences() {
+    runBlocking {
+      dataStore.edit {
+        preferences ->
+          preferences.clear()
+      }
+    }
   }
 
   companion object Keys {
+    val PRACTITIONER_DETAILS by lazy { stringPreferencesKey("practitioner_details") }
     val APP_ID by lazy { stringPreferencesKey("appId") }
     val LANG by lazy { stringPreferencesKey("lang") }
     val MIGRATION_VERSION by lazy { intPreferencesKey("migrationVersion") }
+    val LAST_SYNC_TIMESTAMP by lazy { stringPreferencesKey("lastSyncTimestamp") }
+    val PRACTITIONER_ID by lazy { stringPreferencesKey("practitionerId") }
+    val PRACTITIONER_LOCATION by lazy { stringPreferencesKey("practitionerLocation") }
+    val PRACTITIONER_LOCATION_ID by lazy { stringPreferencesKey("practitionerLocationId") }
+    val REMOTE_SYNC_RESOURCES by lazy { stringPreferencesKey("remoteSyncResources") }
+    val PREFS_SYNC_PROGRESS_TOTAL by lazy { longPreferencesKey("syncProgressTotal") }
+    val CARE_TEAM_ID by lazy { stringPreferencesKey("careTeamId") }
+    val ORGANIZATION_ID by lazy { stringPreferencesKey("organizationId") }
+    val LOCATION_ID by lazy { stringPreferencesKey("locationId") }
+    val PRACTITIONER_LOCATION_NAME by lazy { stringPreferencesKey("practitionerLocationName") }
+    val CARE_TEAM_NAME by lazy { stringPreferencesKey("careTeamName") }
+    val ORGANIZATION_NAME by lazy { stringPreferencesKey("organizationName") }
+
+    val CAREPLAN_LAST_SYNC_TIMESTAMP by lazy { stringPreferencesKey("careplanLastSyncTimestamp") }
+    val COMPLETE_CAREPLAN_WORKER_LAST_OFFSET by lazy { intPreferencesKey("completeCarePlanWorkerLastOffset".lastOffset()) }
+
+    val CAREPLAN_WORK_ID by lazy { stringPreferencesKey("careplanWorkerId") }
+    val CAREPLAN_BATCH_SIZE_FACTOR by lazy { intPreferencesKey("careplanBatchSizeFactor") }
+
+    val USER_INFO by lazy { stringPreferencesKey("user_info") }
+    fun resourceTimestampKey(resourceType: ResourceType) = stringPreferencesKey(
+      "${resourceType.name.uppercase()}_${SharedPreferenceKey.LAST_SYNC_TIMESTAMP.name}"
+    )
+
+    val PRACTITIONER_LOCATION_HIERARCHIES by lazy { stringPreferencesKey("practitionerLocationHierarchies") }
+
+    fun syncProgress(progressSyncJobStatus: SyncJobStatus.InProgress) = longPreferencesKey(
+      "$PREFS_SYNC_PROGRESS_TOTAL + ${
+            progressSyncJobStatus.syncOperation.name}")
+
+    fun currentLanguage() = stringPreferencesKey(
+      "$LANG, ${Locale.ENGLISH.toLanguageTag()}")
+
+    val PREFS_NAME by lazy { stringPreferencesKey("params")  }
+
+    val Context.dataStore by preferencesDataStore(PREFS_NAME.name)
+
+    //TODO: check this vs similar one above
+    fun resetPrefs(context: Context) = runBlocking {
+      context.dataStore.edit { it.clear() }
+    }
   }
 }

android/engine/src/main/java/org/smartregister/fhircore/engine/datastore/ProtoDataStore.kt

@@ -34,6 +34,7 @@ import org.smartregister.fhircore.engine.domain.model.SyncLocationState
 import org.smartregister.fhircore.engine.rulesengine.services.LocationCoordinate
 import timber.log.Timber
 
+ // TODO : Don't use
 private const val PRACTITIONER_DETAILS_DATASTORE_JSON = "practitioner_details.json"
 private const val USER_INFO_DATASTORE_JSON = "user_info.json"
 private const val LOCATION_COORDINATES_DATASTORE_JSON = "location_coordinates.json"

android/engine/src/main/java/org/smartregister/fhircore/engine/di/NetworkModule.kt

@@ -45,7 +45,7 @@ import org.smartregister.fhircore.engine.data.remote.auth.OAuthService
 import org.smartregister.fhircore.engine.data.remote.fhir.resource.FhirConverterFactory
 import org.smartregister.fhircore.engine.data.remote.fhir.resource.FhirResourceService
 import org.smartregister.fhircore.engine.data.remote.shared.TokenAuthenticator
-import org.smartregister.fhircore.engine.util.SharedPreferencesHelper
+import org.smartregister.fhircore.engine.datastore.PreferenceDataStore
 import org.smartregister.fhircore.engine.util.TimeZoneTypeAdapter
 import org.smartregister.fhircore.engine.util.extension.getCustomJsonParser
 import retrofit2.Retrofit
@@ -82,7 +82,7 @@ class NetworkModule {
   @WithAuthorizationOkHttpClientQualifier
   fun provideOkHttpClient(
     tokenAuthenticator: TokenAuthenticator,
-    sharedPreferencesHelper: SharedPreferencesHelper,
+    preferenceDataStore: PreferenceDataStore,
     configService: ConfigService,
   ) =
     OkHttpClient.Builder()
@@ -121,7 +121,7 @@ class NetworkModule {
             val request = chain.request().newBuilder()
             if (accessToken.isNotEmpty()) {
               request.addHeader(AUTHORIZATION, "Bearer $accessToken")
-              sharedPreferencesHelper.retrieveApplicationId()?.let {
+              preferenceDataStore.retrieveApplicationId().let {
                 request.addHeader(APPLICATION_ID, it)
               }
             }