Merge pull request #5616 from corona-warn-app/feature/13208_refactor_datastore_3

Datastore refactoring (EXPOSUREAPP-13208)

Author: schauersbergern

Corona-Warn-App/src/androidTest/java/de/rki/coronawarnapp/ui/statistics/Statistics.kt

@@ -24,11 +24,11 @@ import de.rki.coronawarnapp.util.security.SignatureValidation
 import de.rki.coronawarnapp.util.serialization.SerializationModule
 import io.mockk.every
 import io.mockk.mockk
+import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.runBlocking
 import okhttp3.Cache
 import java.time.Instant
 import retrofit2.converter.gson.GsonConverterFactory
-import testhelpers.mockFlowPreference
 import timber.log.Timber
 
 object Statistics {
@@ -58,7 +58,7 @@ object Statistics {
 
         every { preferences.getString(any(), any()) } returns null
         every { context.getSharedPreferences(any(), any()) } returns preferences
-        every { localStatisticsConfigStorage.activeSelections } returns mockFlowPreference(
+        every { localStatisticsConfigStorage.activeSelections } returns flowOf(
             SelectedLocations(
                 setOf(
                     SelectedStatisticsLocation.SelectedDistrict(

Corona-Warn-App/src/androidTest/java/testhelpers/TestAndroidModule.kt

@@ -6,9 +6,16 @@ import androidx.datastore.preferences.core.Preferences
 import androidx.test.platform.app.InstrumentationRegistry
 import dagger.Module
 import dagger.Provides
+import de.rki.coronawarnapp.covidcertificate.CovidCertificateSettingsDataStore
+import de.rki.coronawarnapp.datadonation.analytics.AnalyticsSettingsDataStore
+import de.rki.coronawarnapp.datadonation.analytics.modules.keysubmission.AnalyticsKeySubmissionDataStore
+import de.rki.coronawarnapp.datadonation.analytics.modules.testresult.AnalyticsExposureWindowsDataStore
 import de.rki.coronawarnapp.datadonation.survey.SurveySettingsDataStore
 import de.rki.coronawarnapp.main.CwaSettingsDataStore
+import de.rki.coronawarnapp.presencetracing.LocationPreferencesDataStore
+import de.rki.coronawarnapp.presencetracing.LocationSettingsDataStore
 import de.rki.coronawarnapp.risk.RiskLevelSettingsDataStore
+import de.rki.coronawarnapp.statistics.LocalStatisticsConfigDataStore
 import de.rki.coronawarnapp.storage.OnboardingSettingsDataStore
 import de.rki.coronawarnapp.storage.TestSettingsDataStore
 import de.rki.coronawarnapp.storage.TracingSettingsDataStore
@@ -52,4 +59,32 @@ class TestAndroidModule {
     @CwaSettingsDataStore
     @Provides
     fun provideCwaSettingsDataStore(): DataStore<Preferences> = mockk(relaxed = true)
+
+    @AnalyticsSettingsDataStore
+    @Provides
+    fun provideAnalyticsSettingsDataStore(): DataStore<Preferences> = mockk(relaxed = true)
+
+    @CovidCertificateSettingsDataStore
+    @Provides
+    fun provideCovidCertificateSettingsDataStore(): DataStore<Preferences> = mockk(relaxed = true)
+
+    @LocationSettingsDataStore
+    @Provides
+    fun provideLocationSettingsDataStore(): DataStore<Preferences> = mockk(relaxed = true)
+
+    @LocationPreferencesDataStore
+    @Provides
+    fun provideLocationPreferencesDataStore(): DataStore<Preferences> = mockk(relaxed = true)
+
+    @AnalyticsKeySubmissionDataStore
+    @Provides
+    fun provideAnalyticsKeySubmissionDataStore(): DataStore<Preferences> = mockk(relaxed = true)
+
+    @AnalyticsExposureWindowsDataStore
+    @Provides
+    fun provideAnalyticsExposureWindowsDataStore(): DataStore<Preferences> = mockk(relaxed = true)
+
+    @LocalStatisticsConfigDataStore
+    @Provides
+    fun provideLocalStatisticsConfigDataStore(): DataStore<Preferences> = mockk(relaxed = true)
 }

Corona-Warn-App/src/deviceForTesters/java/de/rki/coronawarnapp/test/deltaonboarding/ui/DeltaOnboardingFragment.kt

@@ -6,6 +6,7 @@ import android.view.View
 import androidx.fragment.app.Fragment
 import de.rki.coronawarnapp.R
 import de.rki.coronawarnapp.databinding.FragmentTestDeltaonboardingBinding
+import de.rki.coronawarnapp.presencetracing.TraceLocationSettings
 import de.rki.coronawarnapp.test.menu.ui.TestMenuItem
 import de.rki.coronawarnapp.util.di.AutoInject
 import de.rki.coronawarnapp.util.ui.viewBinding
@@ -24,9 +25,17 @@ class DeltaOnboardingFragment : Fragment(R.layout.fragment_test_deltaonboarding)
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
 
-        binding.switchAttendeeOnboarding.isChecked = viewModel.isAttendeeOnboardingDone()
-        binding.switchVaccinationOnboarding.isChecked = viewModel.isVaccinationRegistrationOnboardingDone()
-        binding.switchAnalyticsDeltaOnboarding.isChecked = viewModel.isAnalyticsOnboardingDone()
+        viewModel.isAttendeeOnboardingDone.observe(viewLifecycleOwner) {
+            binding.switchAttendeeOnboarding.isChecked = it == TraceLocationSettings.OnboardingStatus.ONBOARDED_2_0
+        }
+
+        viewModel.isVaccinationRegistrationOnboardingDone.observe(viewLifecycleOwner) {
+            binding.switchVaccinationOnboarding.isChecked = it
+        }
+
+        viewModel.isAnalyticsOnboardingDone.observe(viewLifecycleOwner) {
+            binding.switchAnalyticsDeltaOnboarding.isChecked = it != 0L
+        }
 
         viewModel.isDeltaOnboardingDone.observe(viewLifecycleOwner) {
             binding.switchDeltaOnboarding.isChecked = it

Corona-Warn-App/src/deviceForTesters/java/de/rki/coronawarnapp/test/deltaonboarding/ui/DeltaOnboardingFragmentViewModel.kt

@@ -1,6 +1,5 @@
 package de.rki.coronawarnapp.test.deltaonboarding.ui
 
-import androidx.lifecycle.LiveData
 import dagger.assisted.AssistedFactory
 import dagger.assisted.AssistedInject
 import de.rki.coronawarnapp.contactdiary.storage.settings.ContactDiarySettings
@@ -23,12 +22,12 @@ class DeltaOnboardingFragmentViewModel @AssistedInject constructor(
     dispatcherProvider: DispatcherProvider
 ) : CWAViewModel(dispatcherProvider = dispatcherProvider) {
 
-    val changelogVersion: LiveData<Long> = settings.lastChangelogVersion.asLiveData2()
-
-    val isContactJournalOnboardingDone: LiveData<Boolean> = contactDiaryUiSettings.isOnboardingDone
-        .asLiveData2()
-
-    val lastNotificationsOnboardingVersionCode: LiveData<Long> = settings.lastNotificationsOnboardingVersionCode.asLiveData2()
+    val changelogVersion = settings.lastChangelogVersion.asLiveData2()
+    val isContactJournalOnboardingDone = contactDiaryUiSettings.isOnboardingDone.asLiveData2()
+    val lastNotificationsOnboardingVersionCode = settings.lastNotificationsOnboardingVersionCode.asLiveData2()
+    val isAnalyticsOnboardingDone = analyticsSettings.lastOnboardingVersionCode.asLiveData2()
+    val isVaccinationRegistrationOnboardingDone = covidCertificateSettings.isOnboarded.asLiveData2()
+    val isAttendeeOnboardingDone = traceLocationSettings.onboardingStatus.asLiveData2()
 
     fun updateChangelogVersion(value: Long) {
         launch { settings.updateLastChangelogVersion(value) }
@@ -55,33 +54,24 @@ class DeltaOnboardingFragmentViewModel @AssistedInject constructor(
         launch { settings.updateWasInteroperabilityShownAtLeastOnce(value) }
     }
 
-    fun isAttendeeOnboardingDone() =
-        traceLocationSettings.onboardingStatus.value == TraceLocationSettings.OnboardingStatus.ONBOARDED_2_0
-
-    fun setAttendeeOnboardingDone(value: Boolean) {
-        traceLocationSettings.onboardingStatus.update {
+    fun setAttendeeOnboardingDone(value: Boolean) = launch {
+        traceLocationSettings.updateOnboardingStatus(
             if (value) TraceLocationSettings.OnboardingStatus.ONBOARDED_2_0
             else TraceLocationSettings.OnboardingStatus.NOT_ONBOARDED
-        }
+        )
     }
 
-    fun isVaccinationRegistrationOnboardingDone() = covidCertificateSettings.isOnboarded.value
-
-    fun setVaccinationRegistrationOnboardingDone(value: Boolean) {
-        covidCertificateSettings.isOnboarded.update { value }
+    fun setVaccinationRegistrationOnboardingDone(value: Boolean) = launch {
+        covidCertificateSettings.updateIsOnboarded(value)
     }
 
-    fun setNotificationsOnboardingDone(value: Boolean) {
-        launch {
-            val version = if (value) BuildConfigWrap.VERSION_CODE else 0L
-            settings.updateLastNotificationsOnboardingVersionCode(version)
-        }
+    fun setNotificationsOnboardingDone(value: Boolean) = launch {
+        val version = if (value) BuildConfigWrap.VERSION_CODE else 0L
+        settings.updateLastNotificationsOnboardingVersionCode(version)
     }
 
-    fun isAnalyticsOnboardingDone() = analyticsSettings.lastOnboardingVersionCode.value != 0L
-
-    fun setAnalyticsOnboardingDone(value: Boolean) {
-        analyticsSettings.lastOnboardingVersionCode.update { if (value) BuildConfigWrap.VERSION_CODE else 0L }
+    fun setAnalyticsOnboardingDone(value: Boolean) = launch {
+        analyticsSettings.updateLastOnboardingVersionCode(if (value) BuildConfigWrap.VERSION_CODE else 0L)
     }
 
     @AssistedFactory

Corona-Warn-App/src/deviceForTesters/java/de/rki/coronawarnapp/test/dsc/ui/DccStateValidationTestViewModel.kt

@@ -63,12 +63,12 @@ class DccStateValidationTestViewModel @AssistedInject constructor(
         }
     }
 
-    fun resetLastCheckTime() {
-        covidCertificateSettings.lastDccStateBackgroundCheck.update { Instant.EPOCH }
+    fun resetLastCheckTime() = launch {
+        covidCertificateSettings.updateLastDccStateBackgroundCheck(Instant.EPOCH)
     }
 
     fun checkValidityNotifications() = launch {
-        covidCertificateSettings.lastDccStateBackgroundCheck.update { Instant.EPOCH }
+        covidCertificateSettings.updateLastDccStateBackgroundCheck(Instant.EPOCH)
         dccValidityStateNotificationService.showNotificationIfStateChanged()
     }
 

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/coronatest/CoronaTestModule.kt

@@ -1,17 +1,36 @@
 package de.rki.coronawarnapp.coronatest
 
+import android.content.Context
+import androidx.datastore.core.DataStore
+import androidx.datastore.preferences.SharedPreferencesMigration
+import androidx.datastore.preferences.core.PreferenceDataStoreFactory
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.preferencesDataStoreFile
 import dagger.Binds
 import dagger.Module
+import dagger.Provides
 import dagger.multibindings.IntoSet
 import de.rki.coronawarnapp.coronatest.server.VerificationModule
 import de.rki.coronawarnapp.coronatest.type.PersonalCoronaTestProcessor
 import de.rki.coronawarnapp.coronatest.type.pcr.PCRTestProcessor
 import de.rki.coronawarnapp.coronatest.type.rapidantigen.RATestProcessor
 import de.rki.coronawarnapp.profile.ProfileModule
+import de.rki.coronawarnapp.util.coroutine.AppScope
+import de.rki.coronawarnapp.util.coroutine.DispatcherProvider
+import de.rki.coronawarnapp.util.di.AppContext
 import de.rki.coronawarnapp.util.reset.Resettable
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.plus
+import javax.inject.Qualifier
+import javax.inject.Singleton
 
 @Module(
-    includes = [CoronaTestModule.ResetModule::class, VerificationModule::class, ProfileModule::class]
+    includes = [
+        CoronaTestModule.ResetModule::class,
+        CoronaTestModule.CoronaTestStorageModule::class,
+        VerificationModule::class,
+        ProfileModule::class
+    ]
 )
 interface CoronaTestModule {
 
@@ -27,6 +46,27 @@ interface CoronaTestModule {
         processor: RATestProcessor
     ): PersonalCoronaTestProcessor
 
+    @Module
+    object CoronaTestStorageModule {
+        @Singleton
+        @CoronaTestStorageDataStore
+        @Provides
+        fun provideCoronaTestStorageDataStore(
+            @AppContext context: Context,
+            @AppScope appScope: CoroutineScope,
+            dispatcherProvider: DispatcherProvider
+        ): DataStore<Preferences> = PreferenceDataStoreFactory.create(
+            scope = appScope + dispatcherProvider.IO,
+            produceFile = { context.preferencesDataStoreFile(STORAGE_DATASTORE_CORONA_TEST_STORAGE_SETTINGS_NAME) },
+            migrations = listOf(
+                SharedPreferencesMigration(
+                    context,
+                    LEGACY_SHARED_PREFS_CORONA_TEST_STORAGE_SETTINGS_NAME
+                )
+            )
+        )
+    }
+
     @Module
     interface ResetModule {
 
@@ -35,3 +75,11 @@ interface CoronaTestModule {
         fun bindResettableCoronaTestRepository(resettable: CoronaTestRepository): Resettable
     }
 }
+
+@Qualifier
+@MustBeDocumented
+@Retention(AnnotationRetention.RUNTIME)
+annotation class CoronaTestStorageDataStore
+
+private const val LEGACY_SHARED_PREFS_CORONA_TEST_STORAGE_SETTINGS_NAME = "coronatest_localdata"
+private const val STORAGE_DATASTORE_CORONA_TEST_STORAGE_SETTINGS_NAME = "corona_test_storage"

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/coronatest/CoronaTestRepository.kt

@@ -51,7 +51,7 @@ class CoronaTestRepository @Inject constructor(
         sharingBehavior = SharingStarted.Eagerly,
     ) {
         val legacyTests = legacyMigration.startMigration()
-        val persistedTests = storage.coronaTests
+        val persistedTests = storage.getCoronaTests()
         legacyTests.plus(persistedTests)
             .associateBy { it.identifier }
             .also {
@@ -83,7 +83,7 @@ class CoronaTestRepository @Inject constructor(
             .onStart { Timber.tag(TAG).d("Observing test data.") }
             .onEach {
                 Timber.tag(TAG).v("CoronaTest data changed: %s", it)
-                storage.coronaTests = it.values.toSet()
+                storage.updateCoronaTests(it.values.toSet())
                 legacyMigration.finishMigration()
                 contactDiaryRepository.updateTests(it)
             }

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/coronatest/migration/PCRTestMigration.kt

@@ -8,6 +8,7 @@ import de.rki.coronawarnapp.coronatest.type.pcr.PCRCoronaTest
 import de.rki.coronawarnapp.storage.TracingSettings
 import de.rki.coronawarnapp.submission.SubmissionSettings
 import de.rki.coronawarnapp.util.CWADebug
+import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
 import timber.log.Timber
@@ -28,15 +29,15 @@ class PCRTestMigration @Inject constructor(
         isMigrating = true
         Timber.tag(TAG).i("startMigration()")
 
-        val token: RegistrationToken? = submissionSettings.registrationTokenMigration
+        val token: RegistrationToken? = submissionSettings.registrationTokenMigration.first()
         if (token == null) {
             Timber.tag(TAG).d("Nothing to migrate, token was null.")
             return emptySet()
         } else {
             Timber.tag(TAG).i("Migrating token %s", token)
         }
 
-        val devicePairingSuccessfulAt = submissionSettings.devicePairingSuccessfulAtMigration
+        val devicePairingSuccessfulAt = submissionSettings.devicePairingSuccessfulAtMigration.first()
         Timber.tag(TAG).v("devicePairingSuccessfulAt=%s", devicePairingSuccessfulAt)
         if (devicePairingSuccessfulAt == null) {
             if (CWADebug.isDeviceForTestersBuild) {
@@ -45,16 +46,16 @@ class PCRTestMigration @Inject constructor(
             return emptySet()
         }
 
-        val isAllowedToSubmitKeys = submissionSettings.isAllowedToSubmitKeysMigration
+        val isAllowedToSubmitKeys = submissionSettings.isAllowedToSubmitKeysMigration.first()
         Timber.tag(TAG).v("isAllowedToSubmitKeys=%s", isAllowedToSubmitKeys)
 
-        val isSubmissionSuccessful = submissionSettings.isSubmissionSuccessfulMigration
+        val isSubmissionSuccessful = submissionSettings.isSubmissionSuccessfulMigration.first()
         Timber.tag(TAG).v("isSubmissionSuccessful=%s", isSubmissionSuccessful)
 
-        val hasViewedTestResult = submissionSettings.hasViewedTestResultMigration
+        val hasViewedTestResult = submissionSettings.hasViewedTestResultMigration.first()
         Timber.tag(TAG).v("hasViewedTestResult=%s", hasViewedTestResult)
 
-        val hasGivenConsent = submissionSettings.hasGivenConsentMigration
+        val hasGivenConsent = submissionSettings.hasGivenConsentMigration.first()
         Timber.tag(TAG).v("hasGivenConsent=%s", hasGivenConsent)
 
         val testResultNotificationSent = tracingSettings.isTestResultAvailableNotificationSentMigration()