[PM-19870] Migrate ServerConfig and ConfigDiskSource to the data module (#4992)

authenticator/build.gradle.kts

@@ -207,6 +207,7 @@ dependencies {
     debugImplementation(libs.androidx.compose.ui.tooling)
 
     // Pull in test fixtures from other modules.
+    testImplementation(testFixtures(project(":data")))
     testImplementation(testFixtures(project(":network")))
 
     testImplementation(libs.androidx.compose.ui.test)

authenticator/src/main/kotlin/com/bitwarden/authenticator/data/platform/datasource/disk/ConfigDiskSource.kt

@@ -1,21 +0,0 @@
-package com.bitwarden.authenticator.data.platform.datasource.disk
-
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
-import kotlinx.coroutines.flow.Flow
-
-/**
- * Primary access point for server configuration-related disk information.
- */
-interface ConfigDiskSource {
-
-    /**
-     * The currently persisted [ServerConfig] (or `null` if not set).
-     */
-    var serverConfig: ServerConfig?
-
-    /**
-     * Emits updates that track [ServerConfig]. This will replay the last known value,
-     * if any.
-     */
-    val serverConfigFlow: Flow<ServerConfig?>
-}

authenticator/src/main/kotlin/com/bitwarden/authenticator/data/platform/datasource/disk/ConfigDiskSourceImpl.kt

@@ -1,37 +0,0 @@
-package com.bitwarden.authenticator.data.platform.datasource.disk
-
-import android.content.SharedPreferences
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
-import com.bitwarden.core.data.repository.util.bufferedMutableSharedFlow
-import com.bitwarden.core.data.util.decodeFromStringOrNull
-import com.bitwarden.data.datasource.disk.BaseDiskSource
-import kotlinx.coroutines.flow.Flow
-import kotlinx.coroutines.flow.onSubscription
-import kotlinx.serialization.json.Json
-
-private const val SERVER_CONFIGURATIONS = "serverConfigurations"
-
-/**
- * Primary implementation of [ConfigDiskSource].
- */
-class ConfigDiskSourceImpl(
-    sharedPreferences: SharedPreferences,
-    private val json: Json,
-) : BaseDiskSource(sharedPreferences = sharedPreferences),
-    ConfigDiskSource {
-
-    override var serverConfig: ServerConfig?
-        get() = getString(key = SERVER_CONFIGURATIONS)?.let { json.decodeFromStringOrNull(it) }
-        set(value) {
-            putString(
-                key = SERVER_CONFIGURATIONS,
-                value = value?.let { json.encodeToString(it) },
-            )
-            mutableServerConfigFlow.tryEmit(value)
-        }
-
-    override val serverConfigFlow: Flow<ServerConfig?>
-        get() = mutableServerConfigFlow.onSubscription { emit(serverConfig) }
-
-    private val mutableServerConfigFlow = bufferedMutableSharedFlow<ServerConfig?>(replay = 1)
-}

authenticator/src/main/kotlin/com/bitwarden/authenticator/data/platform/datasource/disk/di/PlatformDiskModule.kt

@@ -2,14 +2,14 @@ package com.bitwarden.authenticator.data.platform.datasource.disk.di
 
 import android.content.SharedPreferences
 import com.bitwarden.authenticator.data.platform.datasource.di.UnencryptedPreferences
-import com.bitwarden.authenticator.data.platform.datasource.disk.ConfigDiskSource
-import com.bitwarden.authenticator.data.platform.datasource.disk.ConfigDiskSourceImpl
 import com.bitwarden.authenticator.data.platform.datasource.disk.FeatureFlagDiskSource
 import com.bitwarden.authenticator.data.platform.datasource.disk.FeatureFlagDiskSourceImpl
 import com.bitwarden.authenticator.data.platform.datasource.disk.FeatureFlagOverrideDiskSource
 import com.bitwarden.authenticator.data.platform.datasource.disk.FeatureFlagOverrideDiskSourceImpl
 import com.bitwarden.authenticator.data.platform.datasource.disk.SettingsDiskSource
 import com.bitwarden.authenticator.data.platform.datasource.disk.SettingsDiskSourceImpl
+import com.bitwarden.data.datasource.disk.ConfigDiskSource
+import com.bitwarden.data.datasource.disk.ConfigDiskSourceImpl
 import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn

authenticator/src/main/kotlin/com/bitwarden/authenticator/data/platform/datasource/disk/model/ServerConfig.kt

@@ -1,22 +0,0 @@
-package com.bitwarden.authenticator.data.platform.datasource.disk.model
-
-import com.bitwarden.network.model.ConfigResponseJson
-import kotlinx.serialization.SerialName
-import kotlinx.serialization.Serializable
-
-/**
- * A higher-level wrapper around [ConfigResponseJson] that provides a timestamp
- * to check if a sync is necessary
- *
- * @property lastSync The [Long] of the last sync.
- * @property serverData The raw [ConfigResponseJson] that contains specific data of the
- * server configuration
- */
-@Serializable
-data class ServerConfig(
-    @SerialName("lastSync")
-    val lastSync: Long,
-
-    @SerialName("serverData")
-    val serverData: ConfigResponseJson,
-)

authenticator/src/main/kotlin/com/bitwarden/authenticator/data/platform/manager/FeatureFlagManagerImpl.kt

@@ -1,8 +1,8 @@
 package com.bitwarden.authenticator.data.platform.manager
 
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
 import com.bitwarden.authenticator.data.platform.manager.model.FlagKey
 import com.bitwarden.authenticator.data.platform.repository.ServerConfigRepository
+import com.bitwarden.data.datasource.disk.model.ServerConfig
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.map
 

authenticator/src/main/kotlin/com/bitwarden/authenticator/data/platform/repository/ServerConfigRepository.kt

@@ -1,6 +1,6 @@
 package com.bitwarden.authenticator.data.platform.repository
 
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
+import com.bitwarden.data.datasource.disk.model.ServerConfig
 import kotlinx.coroutines.flow.StateFlow
 
 /**

authenticator/src/main/kotlin/com/bitwarden/authenticator/data/platform/repository/ServerConfigRepositoryImpl.kt

@@ -1,8 +1,8 @@
 package com.bitwarden.authenticator.data.platform.repository
 
-import com.bitwarden.authenticator.data.platform.datasource.disk.ConfigDiskSource
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
 import com.bitwarden.authenticator.data.platform.manager.DispatcherManager
+import com.bitwarden.data.datasource.disk.ConfigDiskSource
+import com.bitwarden.data.datasource.disk.model.ServerConfig
 import com.bitwarden.network.service.ConfigService
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.SharingStarted

authenticator/src/main/kotlin/com/bitwarden/authenticator/data/platform/repository/di/PlatformRepositoryModule.kt

@@ -2,7 +2,6 @@ package com.bitwarden.authenticator.data.platform.repository.di
 
 import com.bitwarden.authenticator.data.auth.datasource.disk.AuthDiskSource
 import com.bitwarden.authenticator.data.authenticator.datasource.sdk.AuthenticatorSdkSource
-import com.bitwarden.authenticator.data.platform.datasource.disk.ConfigDiskSource
 import com.bitwarden.authenticator.data.platform.datasource.disk.FeatureFlagDiskSource
 import com.bitwarden.authenticator.data.platform.datasource.disk.FeatureFlagOverrideDiskSource
 import com.bitwarden.authenticator.data.platform.datasource.disk.SettingsDiskSource
@@ -16,6 +15,7 @@ import com.bitwarden.authenticator.data.platform.repository.ServerConfigReposito
 import com.bitwarden.authenticator.data.platform.repository.ServerConfigRepositoryImpl
 import com.bitwarden.authenticator.data.platform.repository.SettingsRepository
 import com.bitwarden.authenticator.data.platform.repository.SettingsRepositoryImpl
+import com.bitwarden.data.datasource.disk.ConfigDiskSource
 import com.bitwarden.network.service.ConfigService
 import dagger.Module
 import dagger.Provides

authenticator/src/test/java/com/bitwarden/authenticator/data/auth/datasource/disk/AuthDiskSourceTest.kt

@@ -1,7 +1,7 @@
 package com.bitwarden.authenticator.data.auth.datasource.disk
 
-import com.bitwarden.authenticator.data.platform.base.FakeSharedPreferences
 import com.bitwarden.authenticatorbridge.util.generateSecretKey
+import com.bitwarden.data.datasource.disk.base.FakeSharedPreferences
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Assertions.assertNull
 import org.junit.jupiter.api.Assertions.assertTrue

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/base/FakeSharedPreferences.kt

@@ -1,109 +0,0 @@
-package com.bitwarden.authenticator.data.platform.base
-
-import android.content.SharedPreferences
-
-/**
- * A faked implementation of [SharedPreferences] that is backed by an internal, memory-based map.
- */
-class FakeSharedPreferences : SharedPreferences {
-    private val sharedPreferences: MutableMap<String, Any?> = mutableMapOf()
-    private val listeners = mutableSetOf<SharedPreferences.OnSharedPreferenceChangeListener>()
-
-    override fun contains(key: String): Boolean =
-        sharedPreferences.containsKey(key)
-
-    override fun edit(): SharedPreferences.Editor = Editor()
-
-    override fun getAll(): Map<String, *> = sharedPreferences
-
-    override fun getBoolean(key: String, defaultValue: Boolean): Boolean =
-        getValue(key, defaultValue)
-
-    override fun getFloat(key: String, defaultValue: Float): Float =
-        getValue(key, defaultValue)
-
-    override fun getInt(key: String, defaultValue: Int): Int =
-        getValue(key, defaultValue)
-
-    override fun getLong(key: String, defaultValue: Long): Long =
-        getValue(key, defaultValue)
-
-    override fun getString(key: String, defaultValue: String?): String? =
-        getValue(key, defaultValue)
-
-    override fun getStringSet(key: String, defaultValue: Set<String>?): Set<String>? =
-        getValue(key, defaultValue)
-
-    override fun registerOnSharedPreferenceChangeListener(
-        listener: SharedPreferences.OnSharedPreferenceChangeListener,
-    ) {
-        listeners += listener
-    }
-
-    override fun unregisterOnSharedPreferenceChangeListener(
-        listener: SharedPreferences.OnSharedPreferenceChangeListener,
-    ) {
-        listeners -= listener
-    }
-
-    private inline fun <reified T> getValue(
-        key: String,
-        defaultValue: T,
-    ): T = sharedPreferences[key] as? T ?: defaultValue
-
-    inner class Editor : SharedPreferences.Editor {
-        private val pendingSharedPreferences = sharedPreferences.toMutableMap()
-
-        override fun apply() {
-            sharedPreferences.apply {
-                clear()
-                putAll(pendingSharedPreferences)
-
-                // Notify listeners
-                listeners.forEach { listener ->
-                    pendingSharedPreferences.keys.forEach { key ->
-                        listener.onSharedPreferenceChanged(this@FakeSharedPreferences, key)
-                    }
-                }
-            }
-        }
-
-        override fun clear(): SharedPreferences.Editor =
-            apply { pendingSharedPreferences.clear() }
-
-        override fun commit(): Boolean {
-            apply()
-            return true
-        }
-
-        override fun putBoolean(key: String, value: Boolean): SharedPreferences.Editor =
-            putValue(key, value)
-
-        override fun putFloat(key: String, value: Float): SharedPreferences.Editor =
-            putValue(key, value)
-
-        override fun putInt(key: String, value: Int): SharedPreferences.Editor =
-            putValue(key, value)
-
-        override fun putLong(key: String, value: Long): SharedPreferences.Editor =
-            putValue(key, value)
-
-        override fun putString(key: String, value: String?): SharedPreferences.Editor =
-            putValue(key, value)
-
-        override fun putStringSet(key: String, value: Set<String>?): SharedPreferences.Editor =
-            putValue(key, value)
-
-        override fun remove(key: String): SharedPreferences.Editor =
-            apply { pendingSharedPreferences.remove(key) }
-
-        private inline fun <reified T> putValue(
-            key: String,
-            value: T,
-        ): SharedPreferences.Editor = apply {
-            value
-                ?.let { pendingSharedPreferences[key] = it }
-                ?: pendingSharedPreferences.remove(key)
-        }
-    }
-}

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/datasource/disk/ConfigDiskSourceTest.kt

@@ -1,116 +0,0 @@
-package com.bitwarden.authenticator.data.platform.datasource.disk
-
-import androidx.core.content.edit
-import app.cash.turbine.test
-import com.bitwarden.authenticator.data.platform.base.FakeSharedPreferences
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
-import com.bitwarden.core.di.CoreModule
-import com.bitwarden.network.model.ConfigResponseJson
-import com.bitwarden.network.model.ConfigResponseJson.EnvironmentJson
-import com.bitwarden.network.model.ConfigResponseJson.ServerJson
-import kotlinx.coroutines.test.runTest
-import kotlinx.serialization.json.JsonPrimitive
-import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.Assertions.assertNull
-import org.junit.jupiter.api.Test
-import java.time.Instant
-
-class ConfigDiskSourceTest {
-    private val json = CoreModule.providesJson()
-
-    private val fakeSharedPreferences = FakeSharedPreferences()
-
-    private val configDiskSource = ConfigDiskSourceImpl(
-        sharedPreferences = fakeSharedPreferences,
-        json = json,
-    )
-
-    @Test
-    fun `serverConfig should pull from and update SharedPreferences`() =
-        runTest {
-        val serverConfigKey = "bwPreferencesStorage:serverConfigurations"
-
-        // Shared preferences and the repository start with the same value.
-        assertNull(configDiskSource.serverConfig)
-        assertNull(fakeSharedPreferences.getString(serverConfigKey, null))
-
-        // Updating the repository updates shared preferences
-        configDiskSource.serverConfig = SERVER_CONFIG
-        assertEquals(
-            json.parseToJsonElement(
-                SERVER_CONFIG_JSON,
-            ),
-            json.parseToJsonElement(
-                fakeSharedPreferences.getString(serverConfigKey, null)!!,
-            ),
-        )
-
-        // Update SharedPreferences updates the repository
-        fakeSharedPreferences.edit { putString(serverConfigKey, null) }
-        assertNull(configDiskSource.serverConfig)
-    }
-
-    @Test
-    fun `serverConfigFlow should react to changes in serverConfig`() =
-        runTest {
-            configDiskSource.serverConfigFlow.test {
-                // The initial values of the Flow and the property are in sync
-                assertNull(configDiskSource.serverConfig)
-                assertNull(awaitItem())
-
-                // Updating the repository updates shared preferences
-                configDiskSource.serverConfig = SERVER_CONFIG
-                assertEquals(SERVER_CONFIG, awaitItem())
-            }
-        }
-}
-
-private const val SERVER_CONFIG_JSON = """
-{
-  "lastSync": 1698408000000,
-  "serverData": {
-    "version": "2024.7.0",
-    "gitHash": "25cf6119-dirty",
-    "server": {
-        "name": "example",
-        "url": "https://localhost:8080"
-    },
-    "environment": {
-        "vault": "https://localhost:8080",
-        "api": "http://localhost:4000",
-        "identity": "http://localhost:33656",
-        "notifications": "http://localhost:61840",
-        "sso": "http://localhost:51822"
-    },
-    "featureStates": {
-        "duo-redirect": true,
-        "flexible-collections-v-1": false
-    }
-  }
-}
-
-"""
-private val SERVER_CONFIG = ServerConfig(
-    lastSync = Instant.parse("2023-10-27T12:00:00Z").toEpochMilli(),
-    serverData = ConfigResponseJson(
-        type = null,
-        version = "2024.7.0",
-        gitHash = "25cf6119-dirty",
-        server = ServerJson(
-            name = "example",
-            url = "https://localhost:8080",
-        ),
-        environment = EnvironmentJson(
-            cloudRegion = null,
-            vaultUrl = "https://localhost:8080",
-            apiUrl = "http://localhost:4000",
-            identityUrl = "http://localhost:33656",
-            notificationsUrl = "http://localhost:61840",
-            ssoUrl = "http://localhost:51822",
-        ),
-        featureStates = mapOf(
-            "duo-redirect" to JsonPrimitive(true),
-            "flexible-collections-v-1" to JsonPrimitive(false),
-        ),
-    ),
-)

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/datasource/disk/FeatureFlagDiskSourceTest.kt

@@ -2,10 +2,10 @@ package com.bitwarden.authenticator.data.platform.datasource.disk
 
 import androidx.core.content.edit
 import app.cash.turbine.test
-import com.bitwarden.authenticator.data.platform.base.FakeSharedPreferences
 import com.bitwarden.authenticator.data.platform.datasource.disk.model.FeatureFlagsConfiguration
 import com.bitwarden.authenticator.data.platform.manager.model.FlagKey
 import com.bitwarden.core.di.CoreModule
+import com.bitwarden.data.datasource.disk.base.FakeSharedPreferences
 import kotlinx.coroutines.test.runTest
 import kotlinx.serialization.json.JsonPrimitive
 import org.junit.jupiter.api.Assertions.assertEquals

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/datasource/disk/FeatureFlagOverrideDiskSourceTest.kt

@@ -1,8 +1,8 @@
 package com.bitwarden.authenticator.data.platform.datasource.disk
 
 import androidx.core.content.edit
-import com.bitwarden.authenticator.data.platform.base.FakeSharedPreferences
 import com.bitwarden.authenticator.data.platform.manager.model.FlagKey
+import com.bitwarden.data.datasource.disk.base.FakeSharedPreferences
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Assertions.assertFalse
 import org.junit.jupiter.api.Assertions.assertNull

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/datasource/disk/SettingDiskSourceTest.kt

@@ -2,8 +2,8 @@ package com.bitwarden.authenticator.data.platform.datasource.disk
 
 import androidx.core.content.edit
 import app.cash.turbine.test
-import com.bitwarden.authenticator.data.platform.base.FakeSharedPreferences
 import com.bitwarden.authenticator.ui.platform.feature.settings.data.model.DefaultSaveOption
+import com.bitwarden.data.datasource.disk.base.FakeSharedPreferences
 import kotlinx.coroutines.test.runTest
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Assertions.assertFalse

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/datasource/disk/util/FakeConfigDiskSource.kt

@@ -1,25 +0,0 @@
-package com.bitwarden.authenticator.data.platform.datasource.disk.util
-
-import com.bitwarden.authenticator.data.platform.datasource.disk.ConfigDiskSource
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
-import com.bitwarden.core.data.repository.util.bufferedMutableSharedFlow
-import kotlinx.coroutines.flow.Flow
-import kotlinx.coroutines.flow.onSubscription
-
-class FakeConfigDiskSource : ConfigDiskSource {
-    private var serverConfigValue: ServerConfig? = null
-
-    override var serverConfig: ServerConfig?
-        get() = serverConfigValue
-        set(value) {
-            serverConfigValue = value
-            mutableServerConfigFlow.tryEmit(value)
-        }
-
-    override val serverConfigFlow: Flow<ServerConfig?>
-        get() = mutableServerConfigFlow
-            .onSubscription { emit(serverConfig) }
-
-    private val mutableServerConfigFlow =
-        bufferedMutableSharedFlow<ServerConfig?>(replay = 1)
-}

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/manager/FeatureFlagManagerTest.kt

@@ -1,9 +1,9 @@
 package com.bitwarden.authenticator.data.platform.manager
 
 import app.cash.turbine.test
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
 import com.bitwarden.authenticator.data.platform.manager.model.FlagKey
 import com.bitwarden.authenticator.data.platform.repository.util.FakeServerConfigRepository
+import com.bitwarden.data.datasource.disk.model.ServerConfig
 import com.bitwarden.network.model.ConfigResponseJson
 import com.bitwarden.network.model.ConfigResponseJson.EnvironmentJson
 import com.bitwarden.network.model.ConfigResponseJson.ServerJson

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/repository/DebugMenuRepositoryTest.kt

@@ -2,8 +2,8 @@ package com.bitwarden.authenticator.data.platform.repository
 
 import app.cash.turbine.test
 import com.bitwarden.authenticator.data.platform.datasource.disk.FeatureFlagOverrideDiskSource
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
 import com.bitwarden.authenticator.data.platform.manager.model.FlagKey
+import com.bitwarden.data.datasource.disk.model.ServerConfig
 import com.bitwarden.network.model.ConfigResponseJson
 import io.mockk.every
 import io.mockk.just

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/repository/ServerConfigRepositoryTest.kt

@@ -2,10 +2,10 @@ package com.bitwarden.authenticator.data.platform.repository
 
 import app.cash.turbine.test
 import com.bitwarden.authenticator.data.platform.base.FakeDispatcherManager
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
-import com.bitwarden.authenticator.data.platform.datasource.disk.util.FakeConfigDiskSource
 import com.bitwarden.authenticator.data.platform.manager.DispatcherManager
 import com.bitwarden.core.data.util.asSuccess
+import com.bitwarden.data.datasource.disk.model.ServerConfig
+import com.bitwarden.data.datasource.disk.util.FakeConfigDiskSource
 import com.bitwarden.network.model.ConfigResponseJson
 import com.bitwarden.network.model.ConfigResponseJson.EnvironmentJson
 import com.bitwarden.network.model.ConfigResponseJson.ServerJson

authenticator/src/test/java/com/bitwarden/authenticator/data/platform/repository/util/FakeServerConfigRepository.kt

@@ -1,7 +1,7 @@
 package com.bitwarden.authenticator.data.platform.repository.util
 
-import com.bitwarden.authenticator.data.platform.datasource.disk.model.ServerConfig
 import com.bitwarden.authenticator.data.platform.repository.ServerConfigRepository
+import com.bitwarden.data.datasource.disk.model.ServerConfig
 import com.bitwarden.network.model.ConfigResponseJson
 import com.bitwarden.network.model.ConfigResponseJson.EnvironmentJson
 import com.bitwarden.network.model.ConfigResponseJson.ServerJson