Use DataStore Approach - Part #1 (EXPOSUREAPP-13157)

Corona-Warn-App/build.gradle

@@ -403,6 +403,7 @@ dependencies {
     implementation("org.boofcv:boofcv-android:$boofCV_version") {
         exclude group: 'com.google.protobuf'
     }
+
     constraints {
         implementation('net.lingala.zip4j:zip4j:2.10.0') {
             because 'fixing zip4j vulnerability'
@@ -487,7 +488,11 @@ dependencies {
     implementation 'com.google.code.gson:gson:2.8.9'
     implementation 'com.google.guava:guava:30.0-android'
     implementation "joda-time:joda-time:2.10.13"
-    implementation "com.fasterxml.jackson.datatype:jackson-datatype-joda:2.13.2"
+
+    // Jackson
+    def jackson = "2.13.2"
+    implementation "com.fasterxml.jackson.datatype:jackson-datatype-joda:$jackson"
+    implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:$jackson"
 
     implementation 'com.networknt:json-schema-validator:1.0.69'
     implementation 'net.swiftzer.semver:semver:1.2.0'

Corona-Warn-App/src/androidTest/java/de/rki/coronawarnapp/bugreporting/DebugLogFragmentTest.kt

@@ -8,6 +8,7 @@ import de.rki.coronawarnapp.bugreporting.debuglog.DebugLogger
 import de.rki.coronawarnapp.bugreporting.debuglog.internal.LogSnapshotter
 import de.rki.coronawarnapp.bugreporting.debuglog.ui.DebugLogFragment
 import de.rki.coronawarnapp.bugreporting.debuglog.ui.DebugLogViewModel
+import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.storage.UploadHistoryStorage
 import de.rki.coronawarnapp.nearby.ENFClient
 import io.mockk.MockKAnnotations
 import io.mockk.every
@@ -29,7 +30,7 @@ class DebugLogFragmentTest : BaseUITest() {
 
     @MockK lateinit var debugLogger: DebugLogger
     @MockK lateinit var enfClient: ENFClient
-    @MockK lateinit var bugReportingSettings: BugReportingSettings
+    @MockK lateinit var uploadHistoryStorage: UploadHistoryStorage
     @MockK lateinit var logSnapshotter: LogSnapshotter
 
     private lateinit var inactiveViewModel: DebugLogViewModel
@@ -85,11 +86,11 @@ class DebugLogFragmentTest : BaseUITest() {
     ): DebugLogViewModel {
         val vm = spyk(
             DebugLogViewModel(
-                debugLogger,
-                TestDispatcherProvider(),
-                enfClient,
-                bugReportingSettings,
-                logSnapshotter
+                debugLogger = debugLogger,
+                dispatcherProvider = TestDispatcherProvider(),
+                enfClient = enfClient,
+                uploadHistoryStorage = uploadHistoryStorage,
+                logSnapshotter = logSnapshotter
             )
         )
         with(vm) {

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/bugreporting/BugReportingSharedModule.kt

@@ -26,14 +26,14 @@ import de.rki.coronawarnapp.bugreporting.censors.submission.RACoronaTestCensor
 import de.rki.coronawarnapp.bugreporting.censors.submission.RapidQrCodeCensor
 import de.rki.coronawarnapp.bugreporting.debuglog.internal.DebugLoggerScope
 import de.rki.coronawarnapp.bugreporting.debuglog.internal.DebuggerScope
+import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.storage.UploadHistoryStorageModule
 import de.rki.coronawarnapp.bugreporting.debuglog.upload.server.LogUploadApiV1
 import de.rki.coronawarnapp.bugreporting.debuglog.upload.server.auth.LogUploadAuthApiV1
 import de.rki.coronawarnapp.environment.bugreporting.LogUploadHttpClient
 import de.rki.coronawarnapp.environment.bugreporting.LogUploadServerUrl
 import de.rki.coronawarnapp.environment.datadonation.DataDonationCDNHttpClient
 import de.rki.coronawarnapp.environment.datadonation.DataDonationCDNServerUrl
 import de.rki.coronawarnapp.util.CWADebug
-import de.rki.coronawarnapp.util.reset.Resettable
 import kotlinx.coroutines.CoroutineScope
 import okhttp3.OkHttpClient
 import retrofit2.Retrofit
@@ -42,7 +42,12 @@ import retrofit2.converter.protobuf.ProtoConverterFactory
 import javax.inject.Singleton
 
 @Suppress("TooManyFunctions")
-@Module(includes = [BugReportingSharedModule.BindsModule::class, BugReportingSharedModule.ResetModule::class])
+@Module(
+    includes = [
+        BugReportingSharedModule.BindsModule::class,
+        UploadHistoryStorageModule::class
+    ]
+)
 object BugReportingSharedModule {
 
     @Reusable
@@ -84,14 +89,6 @@ object BugReportingSharedModule {
     @Provides
     fun scope(): CoroutineScope = DebugLoggerScope
 
-    @Module
-    internal interface ResetModule {
-
-        @Binds
-        @IntoSet
-        fun bindResettableBugReportingSettings(resettable: BugReportingSettings): Resettable
-    }
-
     @Module
     internal interface BindsModule {
 

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/bugreporting/debuglog/ui/DebugLogViewModel.kt

@@ -4,9 +4,9 @@ import androidx.lifecycle.LiveData
 import androidx.lifecycle.asLiveData
 import dagger.assisted.AssistedFactory
 import dagger.assisted.AssistedInject
-import de.rki.coronawarnapp.bugreporting.BugReportingSettings
 import de.rki.coronawarnapp.bugreporting.debuglog.DebugLogger
 import de.rki.coronawarnapp.bugreporting.debuglog.internal.LogSnapshotter
+import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.storage.UploadHistoryStorage
 import de.rki.coronawarnapp.nearby.ENFClient
 import de.rki.coronawarnapp.util.CWADebug
 import de.rki.coronawarnapp.util.coroutine.DispatcherProvider
@@ -22,13 +22,13 @@ class DebugLogViewModel @AssistedInject constructor(
     private val debugLogger: DebugLogger,
     dispatcherProvider: DispatcherProvider,
     private val enfClient: ENFClient,
-    bugReportingSettings: BugReportingSettings,
+    uploadHistoryStorage: UploadHistoryStorage,
     private val logSnapshotter: LogSnapshotter
 ) : CWAViewModel(dispatcherProvider = dispatcherProvider) {
 
     private val isActionInProgress = MutableStateFlow(false)
 
-    val logUploads = bugReportingSettings.uploadHistory.flow
+    val logUploads = uploadHistoryStorage.uploadHistory
         .asLiveData(context = dispatcherProvider.Default)
 
     val state: LiveData<State> = combine(

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/bugreporting/debuglog/ui/upload/history/LogUploadHistoryViewModel.kt

@@ -4,19 +4,19 @@ import androidx.lifecycle.LiveData
 import androidx.lifecycle.asLiveData
 import dagger.assisted.AssistedFactory
 import dagger.assisted.AssistedInject
-import de.rki.coronawarnapp.bugreporting.BugReportingSettings
 import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.LogUpload
+import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.storage.UploadHistoryStorage
 import de.rki.coronawarnapp.util.coroutine.DispatcherProvider
 import de.rki.coronawarnapp.util.viewmodel.CWAViewModel
 import de.rki.coronawarnapp.util.viewmodel.SimpleCWAViewModelFactory
 import kotlinx.coroutines.flow.map
 
 class LogUploadHistoryViewModel @AssistedInject constructor(
     dispatcherProvider: DispatcherProvider,
-    bugReportingSettings: BugReportingSettings
+    uploadHistoryStorage: UploadHistoryStorage
 ) : CWAViewModel(dispatcherProvider = dispatcherProvider) {
 
-    val logUploads: LiveData<List<LogUpload>> = bugReportingSettings.uploadHistory.flow
+    val logUploads: LiveData<List<LogUpload>> = uploadHistoryStorage.uploadHistory
         .map { history -> history.logs.sortedByDescending { it.uploadedAt } }
         .asLiveData(context = dispatcherProvider.Default)
 

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/bugreporting/debuglog/upload/SnapshotUploader.kt

@@ -1,8 +1,8 @@
 package de.rki.coronawarnapp.bugreporting.debuglog.upload
 
-import de.rki.coronawarnapp.bugreporting.BugReportingSettings
 import de.rki.coronawarnapp.bugreporting.debuglog.internal.LogSnapshotter
 import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.LogUpload
+import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.storage.UploadHistoryStorage
 import de.rki.coronawarnapp.bugreporting.debuglog.upload.server.LogUploadServer
 import de.rki.coronawarnapp.bugreporting.debuglog.upload.server.auth.LogUploadAuthorizer
 import timber.log.Timber
@@ -14,7 +14,7 @@ class SnapshotUploader @Inject constructor(
     private val snapshotter: LogSnapshotter,
     private val uploadServer: LogUploadServer,
     private val authorizer: LogUploadAuthorizer,
-    private val bugReportingSettings: BugReportingSettings
+    private val uploadHistoryStorage: UploadHistoryStorage
 ) {
 
     suspend fun uploadSnapshot(): LogUpload {
@@ -38,7 +38,7 @@ class SnapshotUploader @Inject constructor(
             }
         }
 
-        bugReportingSettings.uploadHistory.update { oldHistory ->
+        uploadHistoryStorage.update { oldHistory ->
             val newLogs = oldHistory.logs.toMutableList()
             if (newLogs.size >= 10) {
                 newLogs.removeFirst().also {

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/bugreporting/debuglog/upload/history/LogUpload.kt

@@ -1,8 +1,9 @@
 package de.rki.coronawarnapp.bugreporting.debuglog.upload.history
 
+import com.fasterxml.jackson.annotation.JsonProperty
 import java.time.Instant
 
 data class LogUpload(
-    val id: String,
-    val uploadedAt: Instant
+    @JsonProperty("id") val id: String,
+    @JsonProperty("uploadedAt") val uploadedAt: Instant
 )

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/bugreporting/debuglog/upload/history/UploadHistory.kt

@@ -1,5 +1,7 @@
 package de.rki.coronawarnapp.bugreporting.debuglog.upload.history
 
+import com.fasterxml.jackson.annotation.JsonProperty
+
 data class UploadHistory(
-    val logs: List<LogUpload> = emptyList()
+    @JsonProperty("logs") val logs: List<LogUpload> = emptyList()
 )

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/bugreporting/debuglog/upload/history/storage/UploadHistorySerializer.kt

@@ -0,0 +1,15 @@
+package de.rki.coronawarnapp.bugreporting.debuglog.upload.history.storage
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.UploadHistory
+import de.rki.coronawarnapp.util.datastore.BaseJsonSerializer
+import de.rki.coronawarnapp.util.serialization.BaseJackson
+import javax.inject.Inject
+
+class UploadHistorySerializer @Inject constructor(
+    @BaseJackson objectMapper: ObjectMapper
+) : BaseJsonSerializer<UploadHistory>(objectMapper) {
+
+    override val defaultValue: UploadHistory
+        get() = UploadHistory()
+}

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/bugreporting/debuglog/upload/history/storage/UploadHistoryStorage.kt

@@ -0,0 +1,32 @@
+package de.rki.coronawarnapp.bugreporting.debuglog.upload.history.storage
+
+import androidx.datastore.core.DataStore
+import dagger.Reusable
+import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.UploadHistory
+import de.rki.coronawarnapp.tag
+import de.rki.coronawarnapp.util.reset.Resettable
+import kotlinx.coroutines.flow.catch
+import timber.log.Timber
+import javax.inject.Inject
+
+@Reusable
+class UploadHistoryStorage @Inject constructor(
+    private val dataStore: DataStore<UploadHistory>
+) : Resettable {
+
+    val uploadHistory = dataStore.data.catch {
+        Timber.tag(TAG).e("Failed to get UploadHistory")
+        emit(UploadHistory())
+    }
+
+    suspend fun update(transform: suspend (t: UploadHistory) -> UploadHistory) {
+        dataStore.updateData(transform)
+    }
+
+    override suspend fun reset() {
+        Timber.tag(TAG).d("reset")
+        dataStore.updateData { UploadHistory() }
+    }
+}
+
+private val TAG = tag<UploadHistoryStorage>()

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/bugreporting/debuglog/upload/history/storage/UploadHistoryStorageModule.kt

@@ -0,0 +1,75 @@
+package de.rki.coronawarnapp.bugreporting.debuglog.upload.history.storage
+
+import android.content.Context
+import androidx.annotation.VisibleForTesting
+import androidx.datastore.core.DataStore
+import androidx.datastore.core.DataStoreFactory
+import androidx.datastore.dataStoreFile
+import androidx.datastore.migrations.SharedPreferencesMigration
+import com.google.gson.Gson
+import dagger.Binds
+import dagger.Module
+import dagger.Provides
+import dagger.multibindings.IntoSet
+import de.rki.coronawarnapp.bugreporting.debuglog.upload.history.UploadHistory
+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 de.rki.coronawarnapp.util.serialization.BaseGson
+import de.rki.coronawarnapp.util.serialization.fromJson
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.plus
+import timber.log.Timber
+import javax.inject.Singleton
+
+@Module(includes = [UploadHistoryStorageModule.ResetModule::class])
+object UploadHistoryStorageModule {
+
+    @Singleton
+    @Provides
+    fun provideDataStore(
+        serializer: UploadHistorySerializer,
+        @AppScope appScope: CoroutineScope,
+        dispatcherProvider: DispatcherProvider,
+        @AppContext context: Context,
+        migration: SharedPreferencesMigration<UploadHistory>
+    ): DataStore<UploadHistory> = DataStoreFactory.create(
+        serializer = serializer,
+        scope = appScope + dispatcherProvider.IO,
+        migrations = listOf(migration)
+    ) {
+        context.dataStoreFile(UPLOAD_HISTORY_DATA_STORE)
+    }
+
+    @Provides
+    fun provideMigration(
+        @AppContext context: Context,
+        @BaseGson gson: Gson
+    ) = SharedPreferencesMigration<UploadHistory>(
+        context = context,
+        sharedPreferencesName = LEGACY_SHARED_PREFS
+    ) { sharedPreferencesView, uploadHistory ->
+        val migratedUploadHistory = runCatching {
+            // Data was converted with Gson before so use Gson to restore data to avoid corrupted data
+            // Gson and Jackson store Instants differently
+            sharedPreferencesView.getString(LEGACY_UPLOAD_HISTORY_KEY)?.let { gson.fromJson<UploadHistory>(it) }
+        }
+            .onFailure { Timber.tag("SharedPreferencesMigration<UploadHistory>").e(it, "Migration failed") }
+            .getOrNull()
+
+        migratedUploadHistory ?: uploadHistory
+    }
+
+    @Module
+    internal interface ResetModule {
+
+        @Binds
+        @IntoSet
+        fun bindResettableUploadHistoryStorage(resettable: UploadHistoryStorage): Resettable
+    }
+}
+
+private const val UPLOAD_HISTORY_DATA_STORE: String = "upload_history_data_store"
+private const val LEGACY_SHARED_PREFS = "bugreporting_localdata"
+@VisibleForTesting const val LEGACY_UPLOAD_HISTORY_KEY = "upload.history"

Corona-Warn-App/src/main/java/de/rki/coronawarnapp/util/datastore/BaseJsonSerializer.kt

@@ -0,0 +1,26 @@
+package de.rki.coronawarnapp.util.datastore
+
+import androidx.datastore.core.CorruptionException
+import androidx.datastore.core.Serializer
+import com.fasterxml.jackson.databind.ObjectMapper
+import timber.log.Timber
+import java.io.InputStream
+import java.io.OutputStream
+
+abstract class BaseJsonSerializer<T : Any>(
+    private val objectMapper: ObjectMapper
+) : Serializer<T> {
+
+    private val type get() = defaultValue::class.java
+
+    override suspend fun readFrom(input: InputStream): T = runCatching { objectMapper.readValue(input, type) }
+        .onFailure { throw CorruptionException("Failed to read data of type=$type", it) }
+        .getOrThrow()
+
+    override suspend fun writeTo(t: T, output: OutputStream) {
+        runCatching { objectMapper.writeValue(output, t) }
+            .onFailure { Timber.tag(TAG).w(it, "Failed to write data=$t") }
+    }
+}
+
+private const val TAG = "BaseJsonSerializer"