Add banner for optional migration to simplified sliding sync (#3429)

* Add banner for optional migration to native sliding sync

- Add `MatrixClient.isNativeSlidingSyncSupported()` and `MatrixClient.isUsingNativeSlidingSync` to check whether the home server supports native sliding sync and we're already using it.
- Add `NativeSlidingSyncMigrationBanner` composable to the `RoomList` screen when the home server supports native sliding sync but the current session is not using it.
- Add an extra logout successful action to the logout flow, create `EnableNativeSlidingSyncUseCase` so it can be used there.

* Update screenshots

* Make sure the sliding sync migration banner has lower priority than the encryption setup ones

---------

Co-authored-by: ElementBot <benoitm+elementbot@element.io>

libraries/designsystem/src/main/kotlin/io/element/android/libraries/designsystem/atomic/molecules/DialogLikeBannerMolecule.kt

@@ -39,6 +39,7 @@ fun DialogLikeBannerMolecule(
     onSubmitClick: () -> Unit,
     onDismissClick: (() -> Unit)?,
     modifier: Modifier = Modifier,
+    actionText: String = stringResource(CommonStrings.action_continue),
 ) {
     Box(modifier = modifier.padding(horizontal = 16.dp, vertical = 8.dp)) {
         Surface(
@@ -74,7 +75,7 @@ fun DialogLikeBannerMolecule(
                 )
                 Spacer(modifier = Modifier.height(12.dp))
                 Button(
-                    text = stringResource(CommonStrings.action_continue),
+                    text = actionText,
                     size = ButtonSize.Medium,
                     modifier = Modifier.fillMaxWidth(),
                     onClick = onSubmitClick,

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/MatrixClient.kt

@@ -126,4 +126,10 @@ interface MatrixClient : Closeable {
      */
     suspend fun getUrl(url: String): Result<String>
     suspend fun getRoomPreview(roomIdOrAlias: RoomIdOrAlias, serverNames: List<String>): Result<RoomPreview>
+
+    /** Returns `true` if the home server supports native sliding sync. */
+    suspend fun isNativeSlidingSyncSupported(): Boolean
+
+    /** Returns `true` if the current session is using native sliding sync. */
+    fun isUsingNativeSlidingSync(): Boolean
 }

libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt

@@ -93,6 +93,7 @@ import org.matrix.rustcomponents.sdk.IgnoredUsersListener
 import org.matrix.rustcomponents.sdk.NotificationProcessSetup
 import org.matrix.rustcomponents.sdk.PowerLevels
 import org.matrix.rustcomponents.sdk.SendQueueRoomErrorListener
+import org.matrix.rustcomponents.sdk.SlidingSyncVersion
 import org.matrix.rustcomponents.sdk.TaskHandle
 import org.matrix.rustcomponents.sdk.use
 import timber.log.Timber
@@ -528,6 +529,14 @@ class RustMatrixClient(
         })
     }.buffer(Channel.UNLIMITED)
 
+    override suspend fun isNativeSlidingSyncSupported(): Boolean {
+        return client.availableSlidingSyncVersions().contains(SlidingSyncVersion.Native)
+    }
+
+    override fun isUsingNativeSlidingSync(): Boolean {
+        return client.session().slidingSyncVersion == SlidingSyncVersion.Native
+    }
+
     internal fun setDelegate(delegate: RustClientSessionDelegate) {
         client.setDelegate(delegate)
     }

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/FakeMatrixClient.kt

@@ -77,6 +77,8 @@ class FakeMatrixClient(
     private val clearCacheLambda: () -> Unit = { lambdaError() },
     private val userIdServerNameLambda: () -> String = { lambdaError() },
     private val getUrlLambda: (String) -> Result<String> = { lambdaError() },
+    var isNativeSlidingSyncSupportedLambda: suspend () -> Boolean = { true },
+    var isUsingNativeSlidingSyncLambda: () -> Boolean = { true },
 ) : MatrixClient {
     var setDisplayNameCalled: Boolean = false
         private set
@@ -316,4 +318,12 @@ class FakeMatrixClient(
     override suspend fun getUrl(url: String): Result<String> {
         return getUrlLambda(url)
     }
+
+    override suspend fun isNativeSlidingSyncSupported(): Boolean {
+        return isNativeSlidingSyncSupportedLambda()
+    }
+
+    override fun isUsingNativeSlidingSync(): Boolean {
+        return isUsingNativeSlidingSyncLambda()
+    }
 }

libraries/preferences/api/build.gradle.kts

@@ -17,4 +17,8 @@ dependencies {
     implementation(libs.coroutines.core)
     implementation(projects.libraries.matrix.api)
     implementation(libs.androidx.datastore.preferences)
+
+    testImplementation(projects.libraries.preferences.test)
+    testImplementation(libs.test.truth)
+    testImplementation(libs.coroutines.test)
 }

libraries/preferences/api/src/main/kotlin/io/element/android/libraries/preferences/api/store/EnableNativeSlidingSyncUseCase.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.libraries.preferences.api.store
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
+import javax.inject.Inject
+
+class EnableNativeSlidingSyncUseCase @Inject constructor(
+    private val appPreferencesStore: AppPreferencesStore,
+    private val appCoroutineScope: CoroutineScope,
+) {
+    operator fun invoke() {
+        appCoroutineScope.launch {
+            appPreferencesStore.setSimplifiedSlidingSyncEnabled(true)
+        }
+    }
+}

libraries/preferences/api/src/test/kotlin/io/element/android/libraries/preferences/api/store/EnableNativeSlidingSyncUseCaseTest.kt

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.libraries.preferences.api.store
+
+import com.google.common.truth.Truth.assertThat
+import io.element.android.libraries.preferences.test.InMemoryAppPreferencesStore
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.test.advanceUntilIdle
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+
+class EnableNativeSlidingSyncUseCaseTest {
+    @OptIn(ExperimentalCoroutinesApi::class)
+    @Test
+    fun `ensure that the use case sets the simplified sliding sync enabled flag`() = runTest {
+        val preferencesStore = InMemoryAppPreferencesStore()
+        val useCase = EnableNativeSlidingSyncUseCase(preferencesStore, this)
+        assertThat(preferencesStore.isSimplifiedSlidingSyncEnabledFlow().first()).isFalse()
+
+        useCase()
+        advanceUntilIdle()
+
+        assertThat(preferencesStore.isSimplifiedSlidingSyncEnabledFlow().first()).isTrue()
+    }
+}