Update the chat screen UI using RoomInfo. (#1640)

* Update the chat screen UI using `RoomInfo`.

This is specially useful for getting live values for `hasRoomCall`.

* Ensure the first `MatrixRoomInfo` is emitted ASAP

* Try excluding `*Present$present$*` inner functions from kover as separate entities

* Update strings

---------

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

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

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.matrix.api.room
+
+enum class CurrentUserMembership {
+    INVITED, JOINED, LEFT
+}

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

@@ -32,6 +32,7 @@ import io.element.android.libraries.matrix.api.room.location.AssetType
 import io.element.android.libraries.matrix.api.timeline.MatrixTimeline
 import io.element.android.libraries.matrix.api.widget.MatrixWidgetDriver
 import io.element.android.libraries.matrix.api.widget.MatrixWidgetSettings
+import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.StateFlow
 import java.io.Closeable
 import java.io.File
@@ -51,6 +52,8 @@ interface MatrixRoom : Closeable {
     val activeMemberCount: Long
     val joinedMemberCount: Long
 
+    val roomInfoFlow: Flow<MatrixRoomInfo>
+
     /**
      * A one-to-one is a room with exactly 2 members.
      * See [the Matrix spec](https://spec.matrix.org/latest/client-server-api/#default-underride-rules).

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

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.matrix.api.room
+
+import io.element.android.libraries.matrix.api.timeline.item.event.EventTimelineItem
+
+data class MatrixRoomInfo(
+    val id: String,
+    val name: String?,
+    val topic: String?,
+    val avatarUrl: String?,
+    val isDirect: Boolean,
+    val isPublic: Boolean,
+    val isSpace: Boolean,
+    val isTombstoned: Boolean,
+    val canonicalAlias: String?,
+    val alternativeAliases: List<String>,
+    val currentUserMembership: CurrentUserMembership,
+    val latestEvent: EventTimelineItem?,
+    val inviter: RoomMember?,
+    val activeMembersCount: Long,
+    val invitedMembersCount: Long,
+    val joinedMembersCount: Long,
+    val highlightCount: Long,
+    val notificationCount: Long,
+    val userDefinedNotificationMode: RoomNotificationMode?,
+    val hasRoomCall: Boolean,
+    val activeRoomCallParticipants: List<String>
+)

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

@@ -47,6 +47,7 @@ import io.element.android.libraries.matrix.impl.notification.RustNotificationSer
 import io.element.android.libraries.matrix.impl.notificationsettings.RustNotificationSettingsService
 import io.element.android.libraries.matrix.impl.oidc.toRustAction
 import io.element.android.libraries.matrix.impl.pushers.RustPushersService
+import io.element.android.libraries.matrix.impl.room.MatrixRoomInfoMapper
 import io.element.android.libraries.matrix.impl.room.RoomContentForwarder
 import io.element.android.libraries.matrix.impl.room.RoomSyncSubscriber
 import io.element.android.libraries.matrix.impl.room.RustMatrixRoom
@@ -201,7 +202,8 @@ class RustMatrixClient constructor(
                 systemClock = clock,
                 roomContentForwarder = roomContentForwarder,
                 sessionData = sessionStore.getSession(sessionId.value)!!,
-                roomSyncSubscriber = roomSyncSubscriber
+                roomSyncSubscriber = roomSyncSubscriber,
+                matrixRoomInfoMapper = MatrixRoomInfoMapper(),
             )
         }
     }

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

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.matrix.impl.room
+
+import io.element.android.libraries.matrix.api.room.CurrentUserMembership
+import io.element.android.libraries.matrix.api.room.MatrixRoomInfo
+import io.element.android.libraries.matrix.api.room.RoomNotificationMode
+import io.element.android.libraries.matrix.impl.timeline.item.event.EventTimelineItemMapper
+import org.matrix.rustcomponents.sdk.use
+import org.matrix.rustcomponents.sdk.Membership as RustMembership
+import org.matrix.rustcomponents.sdk.RoomInfo as RustRoomInfo
+import org.matrix.rustcomponents.sdk.RoomNotificationMode as RustRoomNotificationMode
+
+class MatrixRoomInfoMapper(
+    private val timelineItemMapper: EventTimelineItemMapper = EventTimelineItemMapper(),
+) {
+
+    fun map(rustRoomInfo: RustRoomInfo): MatrixRoomInfo = rustRoomInfo.use {
+        return MatrixRoomInfo(
+            id = it.id,
+            name = it.name,
+            topic = it.topic,
+            avatarUrl = it.avatarUrl,
+            isDirect = it.isDirect,
+            isPublic = it.isPublic,
+            isSpace = it.isSpace,
+            isTombstoned = it.isTombstoned,
+            canonicalAlias = it.canonicalAlias,
+            alternativeAliases = it.alternativeAliases,
+            currentUserMembership = it.membership.map(),
+            latestEvent = it.latestEvent?.use (timelineItemMapper::map),
+            inviter = it.inviter?.use(RoomMemberMapper::map),
+            activeMembersCount = it.activeMembersCount.toLong(),
+            invitedMembersCount = it.invitedMembersCount.toLong(),
+            joinedMembersCount = it.joinedMembersCount.toLong(),
+            highlightCount = it.highlightCount.toLong(),
+            notificationCount = it.notificationCount.toLong(),
+            userDefinedNotificationMode = it.userDefinedNotificationMode?.map(),
+            hasRoomCall = it.hasRoomCall,
+            activeRoomCallParticipants = it.activeRoomCallParticipants
+        )
+    }
+}
+
+fun RustMembership.map(): CurrentUserMembership = when(this) {
+    RustMembership.INVITED -> CurrentUserMembership.INVITED
+    RustMembership.JOINED -> CurrentUserMembership.JOINED
+    RustMembership.LEFT -> CurrentUserMembership.LEFT
+}
+
+fun RustRoomNotificationMode.map(): RoomNotificationMode = when(this) {
+    RustRoomNotificationMode.ALL_MESSAGES -> RoomNotificationMode.ALL_MESSAGES
+    RustRoomNotificationMode.MENTIONS_AND_KEYWORDS_ONLY -> RoomNotificationMode.MENTIONS_AND_KEYWORDS_ONLY
+    RustRoomNotificationMode.MUTE -> RoomNotificationMode.MUTE
+}

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

@@ -32,6 +32,7 @@ import io.element.android.libraries.matrix.api.media.MediaUploadHandler
 import io.element.android.libraries.matrix.api.media.VideoInfo
 import io.element.android.libraries.matrix.api.poll.PollKind
 import io.element.android.libraries.matrix.api.room.MatrixRoom
+import io.element.android.libraries.matrix.api.room.MatrixRoomInfo
 import io.element.android.libraries.matrix.api.room.MatrixRoomMembersState
 import io.element.android.libraries.matrix.api.room.MatrixRoomNotificationSettingsState
 import io.element.android.libraries.matrix.api.room.MessageEventType
@@ -50,6 +51,7 @@ import io.element.android.libraries.matrix.impl.poll.toInner
 import io.element.android.libraries.matrix.impl.room.location.toInner
 import io.element.android.libraries.matrix.impl.timeline.RustMatrixTimeline
 import io.element.android.libraries.matrix.impl.util.destroyAll
+import io.element.android.libraries.matrix.impl.util.mxCallbackFlow
 import io.element.android.libraries.matrix.impl.widget.RustWidgetDriver
 import io.element.android.libraries.matrix.impl.widget.generateWidgetWebViewUrl
 import io.element.android.libraries.sessionstorage.api.SessionData
@@ -59,12 +61,16 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.ensureActive
+import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import org.matrix.rustcomponents.sdk.EventTimelineItem
 import org.matrix.rustcomponents.sdk.Room
+import org.matrix.rustcomponents.sdk.RoomInfo
+import org.matrix.rustcomponents.sdk.RoomInfoListener
 import org.matrix.rustcomponents.sdk.RoomListItem
 import org.matrix.rustcomponents.sdk.RoomMember
 import org.matrix.rustcomponents.sdk.RoomMessageEventContentWithoutRelation
@@ -73,6 +79,7 @@ import org.matrix.rustcomponents.sdk.WidgetCapabilities
 import org.matrix.rustcomponents.sdk.WidgetCapabilitiesProvider
 import org.matrix.rustcomponents.sdk.messageEventContentFromHtml
 import org.matrix.rustcomponents.sdk.messageEventContentFromMarkdown
+import org.matrix.rustcomponents.sdk.use
 import timber.log.Timber
 import java.io.File
 
@@ -88,10 +95,23 @@ class RustMatrixRoom(
     private val roomContentForwarder: RoomContentForwarder,
     private val sessionData: SessionData,
     private val roomSyncSubscriber: RoomSyncSubscriber,
+    private val matrixRoomInfoMapper: MatrixRoomInfoMapper,
 ) : MatrixRoom {
 
     override val roomId = RoomId(innerRoom.id())
 
+    override val roomInfoFlow: Flow<MatrixRoomInfo> = mxCallbackFlow {
+        launch {
+            val initial = innerRoom.roomInfo().use(matrixRoomInfoMapper::map)
+            channel.trySend(initial)
+        }
+        innerRoom.subscribeToRoomInfoUpdates(object : RoomInfoListener {
+            override fun call(roomInfo: RoomInfo) {
+                channel.trySend(matrixRoomInfoMapper.map(roomInfo))
+            }
+        })
+    }
+
     // Create a dispatcher for all room methods...
     private val roomDispatcher = coroutineDispatchers.io.limitedParallelism(32)
 

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

@@ -68,7 +68,11 @@ class RustWidgetDriver(
     }
 
     override suspend fun send(message: String) {
-        driverAndHandle.handle.send(message)
+        try {
+            driverAndHandle.handle.send(message)
+        } catch (e: IllegalStateException) {
+            // The handle is closed, ignore
+        }
     }
 
     override fun close() {

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

@@ -29,16 +29,23 @@ import io.element.android.libraries.matrix.api.media.MediaUploadHandler
 import io.element.android.libraries.matrix.api.media.VideoInfo
 import io.element.android.libraries.matrix.api.notificationsettings.NotificationSettingsService
 import io.element.android.libraries.matrix.api.poll.PollKind
+import io.element.android.libraries.matrix.api.room.CurrentUserMembership
 import io.element.android.libraries.matrix.api.room.MatrixRoom
+import io.element.android.libraries.matrix.api.room.MatrixRoomInfo
 import io.element.android.libraries.matrix.api.room.MatrixRoomMembersState
 import io.element.android.libraries.matrix.api.room.MatrixRoomNotificationSettingsState
 import io.element.android.libraries.matrix.api.room.MessageEventType
+import io.element.android.libraries.matrix.api.room.RoomMember
+import io.element.android.libraries.matrix.api.room.RoomNotificationMode
 import io.element.android.libraries.matrix.api.room.StateEventType
 import io.element.android.libraries.matrix.api.room.location.AssetType
 import io.element.android.libraries.matrix.api.timeline.MatrixTimeline
+import io.element.android.libraries.matrix.api.timeline.item.event.EventTimelineItem
 import io.element.android.libraries.matrix.api.widget.MatrixWidgetDriver
 import io.element.android.libraries.matrix.api.widget.MatrixWidgetSettings
+import io.element.android.libraries.matrix.test.AN_AVATAR_URL
 import io.element.android.libraries.matrix.test.A_ROOM_ID
+import io.element.android.libraries.matrix.test.A_ROOM_NAME
 import io.element.android.libraries.matrix.test.A_SESSION_ID
 import io.element.android.libraries.matrix.test.media.FakeMediaUploadHandler
 import io.element.android.libraries.matrix.test.notificationsettings.FakeNotificationSettingsService
@@ -46,6 +53,8 @@ import io.element.android.libraries.matrix.test.timeline.FakeMatrixTimeline
 import io.element.android.libraries.matrix.test.widget.FakeWidgetDriver
 import io.element.android.tests.testutils.simulateLongTask
 import kotlinx.coroutines.delay
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import java.io.File
@@ -143,6 +152,9 @@ class FakeMatrixRoom(
 
     private var leaveRoomError: Throwable? = null
 
+    private val _roomInfoFlow: MutableSharedFlow<MatrixRoomInfo> = MutableStateFlow(aRoomInfo())
+    override val roomInfoFlow: Flow<MatrixRoomInfo> = _roomInfoFlow
+
     override val membersStateFlow: MutableStateFlow<MatrixRoomMembersState> = MutableStateFlow(MatrixRoomMembersState.Unknown)
 
     override val roomNotificationSettingsStateFlow: MutableStateFlow<MatrixRoomNotificationSettingsState> =
@@ -497,6 +509,10 @@ class FakeMatrixRoom(
     fun givenGetWidgetDriverResult(result: Result<MatrixWidgetDriver>) {
         getWidgetDriverResult = result
     }
+
+    fun givenRoomInfo(roomInfo: MatrixRoomInfo) {
+        _roomInfoFlow.tryEmit(roomInfo)
+    }
 }
 
 data class SendLocationInvocation(
@@ -523,3 +539,49 @@ data class EndPollInvocation(
     val pollStartId: EventId,
     val text: String,
 )
+
+fun aRoomInfo(
+    id: String = A_ROOM_ID.value,
+    name: String? = A_ROOM_NAME,
+    topic: String? = "A topic",
+    avatarUrl: String? = AN_AVATAR_URL,
+    isDirect: Boolean = false,
+    isPublic: Boolean = true,
+    isSpace: Boolean = false,
+    isTombstoned: Boolean = false,
+    canonicalAlias: String? = null,
+    alternativeAliases: List<String> = emptyList(),
+    currentUserMembership: CurrentUserMembership = CurrentUserMembership.JOINED,
+    latestEvent: EventTimelineItem? = null,
+    inviter: RoomMember? = null,
+    activeMembersCount: Long = 1,
+    invitedMembersCount: Long = 0,
+    joinedMembersCount: Long = 1,
+    highlightCount: Long = 0,
+    notificationCount: Long = 0,
+    userDefinedNotificationMode: RoomNotificationMode? = null,
+    hasRoomCall: Boolean = false,
+    activeRoomCallParticipants: List<String> = emptyList()
+) = MatrixRoomInfo(
+    id = id,
+    name = name,
+    topic = topic,
+    avatarUrl = avatarUrl,
+    isDirect = isDirect,
+    isPublic = isPublic,
+    isSpace = isSpace,
+    isTombstoned = isTombstoned,
+    canonicalAlias = canonicalAlias,
+    alternativeAliases = alternativeAliases,
+    currentUserMembership = currentUserMembership,
+    latestEvent = latestEvent,
+    inviter = inviter,
+    activeMembersCount = activeMembersCount,
+    invitedMembersCount = invitedMembersCount,
+    joinedMembersCount = joinedMembersCount,
+    highlightCount = highlightCount,
+    notificationCount = notificationCount,
+    userDefinedNotificationMode = userDefinedNotificationMode,
+    hasRoomCall = hasRoomCall,
+    activeRoomCallParticipants = activeRoomCallParticipants
+)

libraries/ui-strings/src/main/res/values/localazy.xml

@@ -11,6 +11,7 @@
   <string name="a11y_poll_end">"Ended poll"</string>
   <string name="a11y_send_files">"Send files"</string>
   <string name="a11y_show_password">"Show password"</string>
+  <string name="a11y_start_call">"Start a call"</string>
   <string name="a11y_user_menu">"User menu"</string>
   <string name="a11y_voice_message_record">"Record voice message. Double tap and hold to record. Release to end recording."</string>
   <string name="action_accept">"Accept"</string>