Merge pull request #1716 from vector-im/feature/bma/secureBackupFeatureFlag

Secure backup: create a feature flag (disabled)
2023-10-31 22:52:18 +01:00
parent b985afa4be 75a99cf3ba
commit d764536af5
13 changed files with 68 additions and 11 deletions
--- a/features/logout/impl/build.gradle.kts
+++ b/features/logout/impl/build.gradle.kts
@@ -34,6 +34,7 @@ dependencies {
    implementation(projects.libraries.androidutils)
    implementation(projects.libraries.core)
    implementation(projects.libraries.architecture)
+    implementation(projects.libraries.featureflag.api)
    implementation(projects.libraries.matrix.api)
    implementation(projects.libraries.designsystem)
    implementation(projects.libraries.testtags)
@@ -48,5 +49,6 @@ dependencies {
    testImplementation(libs.test.truth)
    testImplementation(libs.test.turbine)
    testImplementation(projects.libraries.matrix.test)
+    testImplementation(projects.libraries.featureflag.test)
    testImplementation(projects.tests.testutils)
 }
--- a/features/logout/impl/src/main/kotlin/io/element/android/features/logout/impl/LogoutPresenter.kt
+++ b/features/logout/impl/src/main/kotlin/io/element/android/features/logout/impl/LogoutPresenter.kt
@@ -28,16 +28,21 @@ import androidx.compose.runtime.setValue
 import io.element.android.libraries.architecture.Async
 import io.element.android.libraries.architecture.Presenter
 import io.element.android.libraries.architecture.runCatchingUpdatingState
+import io.element.android.libraries.featureflag.api.FeatureFlagService
+import io.element.android.libraries.featureflag.api.FeatureFlags
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.encryption.BackupUploadState
 import io.element.android.libraries.matrix.api.encryption.EncryptionService
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.flow.emptyFlow
+import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.launch
 import javax.inject.Inject

 class LogoutPresenter @Inject constructor(
    private val matrixClient: MatrixClient,
    private val encryptionService: EncryptionService,
+    private val featureFlagService: FeatureFlagService,
 ) : Presenter<LogoutState> {

    @Composable
@@ -47,8 +52,15 @@ class LogoutPresenter @Inject constructor(
            mutableStateOf(Async.Uninitialized)
        }

-        val backupUploadState: BackupUploadState by remember {
-            encryptionService.waitForBackupUploadSteadyState()
+        val secureStorageFlag by featureFlagService.isFeatureEnabledFlow(FeatureFlags.SecureStorage)
+            .collectAsState(initial = null)
+
+        val backupUploadState: BackupUploadState by remember(secureStorageFlag) {
+            when (secureStorageFlag) {
+                true -> encryptionService.waitForBackupUploadSteadyState()
+                false -> flowOf(BackupUploadState.Done)
+                else -> emptyFlow()
+            }
        }
            .collectAsState(initial = BackupUploadState.Unknown)

--- a/features/logout/impl/src/test/kotlin/io/element/android/features/logout/impl/LogoutPresenterTest.kt
+++ b/features/logout/impl/src/test/kotlin/io/element/android/features/logout/impl/LogoutPresenterTest.kt
@@ -21,6 +21,8 @@ import app.cash.molecule.moleculeFlow
 import app.cash.turbine.test
 import com.google.common.truth.Truth.assertThat
 import io.element.android.libraries.architecture.Async
+import io.element.android.libraries.featureflag.api.FeatureFlags
+import io.element.android.libraries.featureflag.test.FakeFeatureFlagService
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.encryption.BackupUploadState
 import io.element.android.libraries.matrix.api.encryption.EncryptionService
@@ -28,6 +30,7 @@ import io.element.android.libraries.matrix.test.A_THROWABLE
 import io.element.android.libraries.matrix.test.FakeMatrixClient
 import io.element.android.libraries.matrix.test.encryption.FakeEncryptionService
 import io.element.android.tests.testutils.WarmUpRule
+import io.element.android.tests.testutils.awaitLastSequentialItem
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.flow
 import kotlinx.coroutines.test.runTest
@@ -45,7 +48,7 @@ class LogoutPresenterTest {
        moleculeFlow(RecompositionMode.Immediate) {
            presenter.present()
        }.test {
-            val initialState = awaitItem()
+            val initialState = awaitLastSequentialItem()
            assertThat(initialState.isLastSession).isFalse()
            assertThat(initialState.backupUploadState).isEqualTo(BackupUploadState.Unknown)
            assertThat(initialState.showConfirmationDialog).isFalse()
@@ -90,6 +93,7 @@ class LogoutPresenterTest {
        moleculeFlow(RecompositionMode.Immediate) {
            presenter.present()
        }.test {
+            skipItems(1)
            val initialState = awaitItem()
            assertThat(initialState.isLastSession).isFalse()
            assertThat(initialState.backupUploadState).isEqualTo(BackupUploadState.Unknown)
@@ -110,7 +114,7 @@ class LogoutPresenterTest {
        moleculeFlow(RecompositionMode.Immediate) {
            presenter.present()
        }.test {
-            val initialState = awaitItem()
+            val initialState = awaitLastSequentialItem()
            initialState.eventSink.invoke(LogoutEvents.Logout(ignoreSdkError = false))
            val confirmationState = awaitItem()
            assertThat(confirmationState.showConfirmationDialog).isTrue()
@@ -126,7 +130,7 @@ class LogoutPresenterTest {
        moleculeFlow(RecompositionMode.Immediate) {
            presenter.present()
        }.test {
-            val initialState = awaitItem()
+            val initialState = awaitLastSequentialItem()
            initialState.eventSink.invoke(LogoutEvents.Logout(ignoreSdkError = false))
            val confirmationState = awaitItem()
            assertThat(confirmationState.showConfirmationDialog).isTrue()
@@ -151,7 +155,7 @@ class LogoutPresenterTest {
        moleculeFlow(RecompositionMode.Immediate) {
            presenter.present()
        }.test {
-            val initialState = awaitItem()
+            val initialState = awaitLastSequentialItem()
            initialState.eventSink.invoke(LogoutEvents.Logout(ignoreSdkError = false))
            val confirmationState = awaitItem()
            assertThat(confirmationState.showConfirmationDialog).isTrue()
@@ -179,7 +183,7 @@ class LogoutPresenterTest {
        moleculeFlow(RecompositionMode.Immediate) {
            presenter.present()
        }.test {
-            val initialState = awaitItem()
+            val initialState = awaitLastSequentialItem()
            initialState.eventSink.invoke(LogoutEvents.Logout(ignoreSdkError = false))
            val confirmationState = awaitItem()
            assertThat(confirmationState.showConfirmationDialog).isTrue()
@@ -205,6 +209,7 @@ class LogoutPresenterTest {
    ): LogoutPresenter = LogoutPresenter(
        matrixClient = matrixClient,
        encryptionService = encryptionService,
+        featureFlagService = FakeFeatureFlagService(mapOf(FeatureFlags.SecureStorage.key to true)),
    )
 }

--- a/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/root/PreferencesRootPresenter.kt
+++ b/features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/root/PreferencesRootPresenter.kt
@@ -78,6 +78,9 @@ class PreferencesRootPresenter @Inject constructor(

        val showSecureBackupIndicator by indicatorService.showSettingChatBackupIndicator()

+        val secureStorageFlag by featureFlagService.isFeatureEnabledFlow(FeatureFlags.SecureStorage)
+            .collectAsState(initial = null)
+
        val accountManagementUrl: MutableState<String?> = remember {
            mutableStateOf(null)
        }
@@ -94,7 +97,7 @@ class PreferencesRootPresenter @Inject constructor(
            myUser = matrixUser.value,
            version = versionFormatter.get(),
            showCompleteVerification = showCompleteVerification,
-            showSecureBackup = !showCompleteVerification,
+            showSecureBackup = !showCompleteVerification && secureStorageFlag == true,
            showSecureBackupBadge = showSecureBackupIndicator,
            accountManagementUrl = accountManagementUrl.value,
            devicesManagementUrl = devicesManagementUrl.value,
--- a/features/preferences/impl/src/test/kotlin/io/element/android/features/preferences/impl/root/PreferencesRootPresenterTest.kt
+++ b/features/preferences/impl/src/test/kotlin/io/element/android/features/preferences/impl/root/PreferencesRootPresenterTest.kt
@@ -56,6 +56,7 @@ class PreferencesRootPresenterTest {
            DefaultIndicatorService(
                sessionVerificationService = sessionVerificationService,
                encryptionService = FakeEncryptionService(),
+                featureFlagService = FakeFeatureFlagService(),
            ),
        )
        moleculeFlow(RecompositionMode.Immediate) {
--- a/features/roomlist/impl/build.gradle.kts
+++ b/features/roomlist/impl/build.gradle.kts
@@ -41,6 +41,7 @@ dependencies {
    implementation(projects.libraries.core)
    implementation(projects.libraries.androidutils)
    implementation(projects.libraries.architecture)
+    implementation(projects.libraries.featureflag.api)
    implementation(projects.libraries.matrix.api)
    implementation(projects.libraries.matrixui)
    implementation(projects.libraries.designsystem)
@@ -64,6 +65,7 @@ dependencies {
    testImplementation(libs.test.turbine)
    testImplementation(libs.test.robolectric)
    testImplementation(projects.libraries.matrix.test)
+    testImplementation(projects.libraries.featureflag.test)
    testImplementation(projects.libraries.dateformatter.test)
    testImplementation(projects.libraries.eventformatter.test)
    testImplementation(projects.libraries.indicator.impl)
--- a/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/RoomListPresenter.kt
+++ b/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/RoomListPresenter.kt
@@ -35,6 +35,8 @@ import io.element.android.features.roomlist.impl.datasource.RoomListDataSource
 import io.element.android.libraries.architecture.Presenter
 import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.designsystem.utils.snackbar.collectSnackbarMessageAsState
+import io.element.android.libraries.featureflag.api.FeatureFlagService
+import io.element.android.libraries.featureflag.api.FeatureFlags
 import io.element.android.libraries.indicator.api.IndicatorService
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.encryption.EncryptionService
@@ -57,6 +59,7 @@ class RoomListPresenter @Inject constructor(
    private val leaveRoomPresenter: LeaveRoomPresenter,
    private val roomListDataSource: RoomListDataSource,
    private val encryptionService: EncryptionService,
+    private val featureFlagService: FeatureFlagService,
    private val indicatorService: IndicatorService,
 ) : Presenter<RoomListState> {

@@ -84,10 +87,14 @@ class RoomListPresenter @Inject constructor(
            derivedStateOf { canVerifySession && !verificationPromptDismissed }
        }
        val recoveryState by encryptionService.recoveryStateStateFlow.collectAsState()
+        val secureStorageFlag by featureFlagService.isFeatureEnabledFlow(FeatureFlags.SecureStorage)
+            .collectAsState(initial = null)
        var recoveryKeyPromptDismissed by rememberSaveable { mutableStateOf(false) }
        val displayRecoveryKeyPrompt by remember {
            derivedStateOf {
-                recoveryState == RecoveryState.INCOMPLETE && !recoveryKeyPromptDismissed
+                secureStorageFlag == true &&
+                    recoveryState == RecoveryState.INCOMPLETE &&
+                    !recoveryKeyPromptDismissed
            }
        }

--- a/features/roomlist/impl/src/test/kotlin/io/element/android/features/roomlist/impl/RoomListPresenterTests.kt
+++ b/features/roomlist/impl/src/test/kotlin/io/element/android/features/roomlist/impl/RoomListPresenterTests.kt
@@ -37,6 +37,8 @@ import io.element.android.libraries.designsystem.components.avatar.AvatarSize
 import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.eventformatter.api.RoomLastMessageFormatter
 import io.element.android.libraries.eventformatter.test.FakeRoomLastMessageFormatter
+import io.element.android.libraries.featureflag.api.FeatureFlags
+import io.element.android.libraries.featureflag.test.FakeFeatureFlagService
 import io.element.android.libraries.indicator.impl.DefaultIndicatorService
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.encryption.BackupState
@@ -417,9 +419,11 @@ class RoomListPresenterTests {
            appScope = coroutineScope
        ),
        encryptionService = encryptionService,
+        featureFlagService = FakeFeatureFlagService(mapOf(FeatureFlags.SecureStorage.key to true)),
        indicatorService = DefaultIndicatorService(
            sessionVerificationService = sessionVerificationService,
            encryptionService = encryptionService,
+            featureFlagService = FakeFeatureFlagService(mapOf(FeatureFlags.SecureStorage.key to true)),
        ),
    )
 }
--- a/libraries/featureflag/api/src/main/kotlin/io/element/android/libraries/featureflag/api/FeatureFlags.kt
+++ b/libraries/featureflag/api/src/main/kotlin/io/element/android/libraries/featureflag/api/FeatureFlags.kt
@@ -66,5 +66,11 @@ enum class FeatureFlags(
        title = "Mentions",
        description = "Type `@` to get mention suggestions and insert them",
        defaultValue = false,
+    ),
+    SecureStorage(
+        key = "feature.securestorage",
+        title = "Chat backup",
+        description = "Allow access to backup and restore chat history settings",
+        defaultValue = false,
    )
 }
--- a/libraries/featureflag/impl/src/main/kotlin/io/element/android/libraries/featureflag/impl/StaticFeatureFlagProvider.kt
+++ b/libraries/featureflag/impl/src/main/kotlin/io/element/android/libraries/featureflag/impl/StaticFeatureFlagProvider.kt
@@ -41,6 +41,7 @@ class StaticFeatureFlagProvider @Inject constructor() :
                FeatureFlags.PinUnlock -> true
                FeatureFlags.InRoomCalls -> true
                FeatureFlags.Mentions -> false
+                FeatureFlags.SecureStorage -> false
            }
        } else {
            false
--- a/libraries/indicator/impl/build.gradle.kts
+++ b/libraries/indicator/impl/build.gradle.kts
@@ -31,6 +31,7 @@ dependencies {
    anvil(projects.anvilcodegen)
    implementation(libs.dagger)
    implementation(projects.libraries.di)
+    implementation(projects.libraries.featureflag.api)
    implementation(projects.libraries.matrix.api)
    implementation(projects.anvilannotations)

@@ -38,6 +39,7 @@ dependencies {

    api(projects.libraries.indicator.api)

+    testImplementation(projects.libraries.featureflag.test)
    testImplementation(projects.libraries.matrix.test)
    testImplementation(libs.test.junit)
    testImplementation(libs.coroutines.test)
--- a/libraries/indicator/impl/src/main/kotlin/io/element/android/libraries/indicator/impl/DefaultIndicatorService.kt
+++ b/libraries/indicator/impl/src/main/kotlin/io/element/android/libraries/indicator/impl/DefaultIndicatorService.kt
@@ -24,6 +24,8 @@ import androidx.compose.runtime.getValue
 import androidx.compose.runtime.remember
 import com.squareup.anvil.annotations.ContributesBinding
 import io.element.android.libraries.di.SessionScope
+import io.element.android.libraries.featureflag.api.FeatureFlagService
+import io.element.android.libraries.featureflag.api.FeatureFlags
 import io.element.android.libraries.indicator.api.IndicatorService
 import io.element.android.libraries.matrix.api.encryption.BackupState
 import io.element.android.libraries.matrix.api.encryption.EncryptionService
@@ -35,6 +37,7 @@ import javax.inject.Inject
 class DefaultIndicatorService @Inject constructor(
    private val sessionVerificationService: SessionVerificationService,
    private val encryptionService: EncryptionService,
+    private val featureFlagService: FeatureFlagService,
 ) : IndicatorService {

    @Composable
@@ -51,6 +54,8 @@ class DefaultIndicatorService @Inject constructor(

    @Composable
    override fun showSettingChatBackupIndicator(): State<Boolean> {
+        val secureStorageFlag by featureFlagService.isFeatureEnabledFlow(FeatureFlags.SecureStorage)
+            .collectAsState(initial = null)
        val backupState by encryptionService.backupStateStateFlow.collectAsState()
        val recoveryState by encryptionService.recoveryStateStateFlow.collectAsState()

@@ -63,7 +68,7 @@ class DefaultIndicatorService @Inject constructor(
                    RecoveryState.DISABLED,
                    RecoveryState.INCOMPLETE,
                )
-                showForBackup || showForRecovery
+                secureStorageFlag == true && (showForBackup || showForRecovery)
            }
        }
    }
--- a/samples/minimal/src/main/kotlin/io/element/android/samples/minimal/RoomListScreen.kt
+++ b/samples/minimal/src/main/kotlin/io/element/android/samples/minimal/RoomListScreen.kt
@@ -36,6 +36,8 @@ import io.element.android.libraries.eventformatter.impl.DefaultRoomLastMessageFo
 import io.element.android.libraries.eventformatter.impl.ProfileChangeContentFormatter
 import io.element.android.libraries.eventformatter.impl.RoomMembershipContentFormatter
 import io.element.android.libraries.eventformatter.impl.StateContentFormatter
+import io.element.android.libraries.featureflag.impl.DefaultFeatureFlagService
+import io.element.android.libraries.featureflag.impl.StaticFeatureFlagProvider
 import io.element.android.libraries.indicator.impl.DefaultIndicatorService
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.RoomId
@@ -62,6 +64,9 @@ class RoomListScreen(
    private val sessionVerificationService = matrixClient.sessionVerificationService()
    private val encryptionService = matrixClient.encryptionService()
    private val stringProvider = AndroidStringProvider(context.resources)
+    private val featureFlagService = DefaultFeatureFlagService(
+        providers = setOf(StaticFeatureFlagProvider())
+    )
    private val presenter = RoomListPresenter(
        client = matrixClient,
        sessionVerificationService = sessionVerificationService,
@@ -87,7 +92,9 @@ class RoomListScreen(
        indicatorService = DefaultIndicatorService(
            sessionVerificationService = sessionVerificationService,
            encryptionService = encryptionService,
-        )
+            featureFlagService = featureFlagService,
+        ),
+        featureFlagService = featureFlagService,
    )

    @Composable