Merge pull request #1965 from vector-im/feature/bma/emojiRepresentation

Fix emoji representation

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

@@ -16,7 +16,24 @@
 
 package io.element.android.libraries.matrix.api.verification
 
+import androidx.compose.runtime.Immutable
+
+@Immutable
+sealed interface SessionVerificationData {
+    data class Emojis(
+        // 7 emojis
+        val emojis: List<VerificationEmoji>,
+    ) : SessionVerificationData
+
+    data class Decimals(
+        // 3 numbers
+        val decimals: List<Int>,
+    ) : SessionVerificationData
+}
+
+// https://spec.matrix.org/unstable/client-server-api/#sas-method-emoji
 data class VerificationEmoji(
-    val code: String,
-    val name: String,
+    val number: Int,
+    val emoji: String,
+    val description: String,
 )

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

@@ -17,7 +17,6 @@
 package io.element.android.libraries.matrix.api.verification
 
 import androidx.compose.runtime.Immutable
-import kotlinx.collections.immutable.ImmutableList
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.StateFlow
 
@@ -26,7 +25,7 @@ interface SessionVerificationService {
     /**
      * State of the current verification flow ([VerificationFlowState.Initial] if not started).
      */
-    val verificationFlowState : StateFlow<VerificationFlowState>
+    val verificationFlowState: StateFlow<VerificationFlowState>
 
     /**
      * The internal service that checks verification can only run after the initial sync.
@@ -101,8 +100,8 @@ sealed interface VerificationFlowState {
     /** Short Authentication String (SAS) verification started between the 2 devices. */
     data object StartedSasVerification : VerificationFlowState
 
-    /** Verification data for the SAS verification (emojis) received. */
-    data class ReceivedVerificationData(val emoji: ImmutableList<VerificationEmoji>) : VerificationFlowState
+    /** Verification data for the SAS verification received. */
+    data class ReceivedVerificationData(val data: SessionVerificationData) : VerificationFlowState
 
     /** Verification completed successfully. */
     data object Finished : VerificationFlowState

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

@@ -18,12 +18,12 @@ package io.element.android.libraries.matrix.impl.verification
 
 import io.element.android.libraries.core.data.tryOrNull
 import io.element.android.libraries.matrix.api.sync.SyncState
+import io.element.android.libraries.matrix.api.verification.SessionVerificationData
 import io.element.android.libraries.matrix.api.verification.SessionVerificationService
 import io.element.android.libraries.matrix.api.verification.SessionVerifiedStatus
 import io.element.android.libraries.matrix.api.verification.VerificationEmoji
 import io.element.android.libraries.matrix.api.verification.VerificationFlowState
 import io.element.android.libraries.matrix.impl.sync.RustSyncService
-import kotlinx.collections.immutable.toImmutableList
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
@@ -33,7 +33,8 @@ import kotlinx.coroutines.launch
 import org.matrix.rustcomponents.sdk.SessionVerificationController
 import org.matrix.rustcomponents.sdk.SessionVerificationControllerDelegate
 import org.matrix.rustcomponents.sdk.SessionVerificationControllerInterface
-import org.matrix.rustcomponents.sdk.SessionVerificationEmoji
+import org.matrix.rustcomponents.sdk.use
+import org.matrix.rustcomponents.sdk.SessionVerificationData as RustSessionVerificationData
 
 class RustSessionVerificationService(
     private val syncService: RustSyncService,
@@ -105,12 +106,8 @@ class RustSessionVerificationService(
         updateVerificationStatus(isVerified = true)
     }
 
-    override fun didReceiveVerificationData(data: List<SessionVerificationEmoji>) {
-        val emojis = data.map { emoji ->
-                emoji.use { VerificationEmoji(it.symbol(), it.description()) }
-            }
-            .toImmutableList()
-        _verificationFlowState.value = VerificationFlowState.ReceivedVerificationData(emojis)
+    override fun didReceiveVerificationData(data: RustSessionVerificationData) {
+        _verificationFlowState.value = VerificationFlowState.ReceivedVerificationData(data.map())
     }
 
     // When the actual SAS verification starts
@@ -142,3 +139,28 @@ class RustSessionVerificationService(
         _sessionVerifiedStatus.value = newValue
     }
 }
+
+private fun RustSessionVerificationData.map(): SessionVerificationData {
+    return use { sessionVerificationData ->
+        when (sessionVerificationData) {
+            is RustSessionVerificationData.Emojis -> {
+                SessionVerificationData.Emojis(
+                    emojis = sessionVerificationData.emojis.mapIndexed { index, emoji ->
+                        emoji.use { sessionVerificationEmoji ->
+                            VerificationEmoji(
+                                number = sessionVerificationData.indices[index].toInt(),
+                                emoji = sessionVerificationEmoji.symbol(),
+                                description = sessionVerificationEmoji.description(),
+                            )
+                        }
+                    },
+                )
+            }
+            is RustSessionVerificationData.Decimals -> {
+                SessionVerificationData.Decimals(
+                    decimals = sessionVerificationData.values.map { it.toInt() },
+                )
+            }
+        }
+    }
+}

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

@@ -16,12 +16,10 @@
 
 package io.element.android.libraries.matrix.test.verification
 
+import io.element.android.libraries.matrix.api.verification.SessionVerificationData
 import io.element.android.libraries.matrix.api.verification.SessionVerificationService
-import io.element.android.libraries.matrix.api.verification.VerificationFlowState
 import io.element.android.libraries.matrix.api.verification.SessionVerifiedStatus
-import io.element.android.libraries.matrix.api.verification.VerificationEmoji
-import kotlinx.collections.immutable.persistentListOf
-import kotlinx.collections.immutable.toPersistentList
+import io.element.android.libraries.matrix.api.verification.VerificationFlowState
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
@@ -31,10 +29,9 @@ class FakeSessionVerificationService : SessionVerificationService {
     private val _sessionVerifiedStatus = MutableStateFlow<SessionVerifiedStatus>(SessionVerifiedStatus.Unknown)
     private var _verificationFlowState = MutableStateFlow<VerificationFlowState>(VerificationFlowState.Initial)
     private var _canVerifySessionFlow = MutableStateFlow(true)
-    private var emojiList = persistentListOf<VerificationEmoji>()
     var shouldFail = false
 
-    override val verificationFlowState: StateFlow<VerificationFlowState> =_verificationFlowState
+    override val verificationFlowState: StateFlow<VerificationFlowState> = _verificationFlowState
     override val sessionVerifiedStatus: StateFlow<SessionVerifiedStatus> = _sessionVerifiedStatus
     override val canVerifySessionFlow: Flow<Boolean> = _canVerifySessionFlow
 
@@ -64,8 +61,8 @@ class FakeSessionVerificationService : SessionVerificationService {
         }
     }
 
-    fun triggerReceiveVerificationData() {
-        _verificationFlowState.value = VerificationFlowState.ReceivedVerificationData(emojiList)
+    fun triggerReceiveVerificationData(sessionVerificationData: SessionVerificationData) {
+        _verificationFlowState.value = VerificationFlowState.ReceivedVerificationData(sessionVerificationData)
     }
 
     override suspend fun startVerification() {
@@ -88,10 +85,6 @@ class FakeSessionVerificationService : SessionVerificationService {
         _isReady.value = value
     }
 
-    fun givenEmojiList(emojis: List<VerificationEmoji>) {
-        this.emojiList = emojis.toPersistentList()
-    }
-
     override suspend fun reset() {
         _verificationFlowState.value = VerificationFlowState.Initial
     }