Merge pull request #3631 from element-hq/feature/fga/rework_room_summary

Rework room summary
2024-10-09 11:44:45 +02:00 · 2024-10-09 11:44:45 +02:00 · a3db4b2043
commit a3db4b2043
parent 47dcdef6aa 5afa7f6437
70 changed files with 734 additions and 563 deletions
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt
@ -32,7 +32,6 @@ import io.element.android.libraries.matrix.api.pusher.PushersService
 import io.element.android.libraries.matrix.api.room.CurrentUserMembership
 import io.element.android.libraries.matrix.api.room.InvitedRoom
 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.RoomMembershipObserver
 import io.element.android.libraries.matrix.api.room.alias.ResolvedRoomAlias
 import io.element.android.libraries.matrix.api.room.preview.RoomPreview
@ -84,8 +83,8 @@ import kotlinx.coroutines.flow.buffer
 import kotlinx.coroutines.flow.distinctUntilChanged
 import kotlinx.coroutines.flow.filter
 import kotlinx.coroutines.flow.first
-import kotlinx.coroutines.flow.flow
 import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.mapNotNull
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
@ -105,8 +104,8 @@ import org.matrix.rustcomponents.sdk.use
 import timber.log.Timber
 import java.io.File
 import java.util.Optional
+import kotlin.jvm.optionals.getOrNull
 import kotlin.time.Duration
-import kotlin.time.Duration.Companion.INFINITE
 import kotlin.time.Duration.Companion.seconds
 import org.matrix.rustcomponents.sdk.CreateRoomParameters as RustCreateRoomParameters
 import org.matrix.rustcomponents.sdk.RoomPreset as RustRoomPreset
@ -262,21 +261,14 @@ class RustMatrixClient(
     * @param timeout the timeout to wait for the room to be available
     * @throws TimeoutCancellationException if the room is not available after the timeout
     */
-    private suspend fun awaitJoinedRoom(roomIdOrAlias: RoomIdOrAlias, timeout: Duration): RoomSummary {
-        val predicate: (List<RoomSummary>) -> Boolean = when (roomIdOrAlias) {
-            is RoomIdOrAlias.Alias -> { roomSummaries: List<RoomSummary> ->
-                val found = roomSummaries.find { it.aliases.contains(roomIdOrAlias.roomAlias) }
-                found != null && found.currentUserMembership == CurrentUserMembership.JOINED
-            }
-            is RoomIdOrAlias.Id -> { roomSummaries: List<RoomSummary> ->
-                val found = roomSummaries.find { it.roomId == roomIdOrAlias.roomId }
-                found != null && found.currentUserMembership == CurrentUserMembership.JOINED
-            }
-        }
+    private suspend fun awaitJoinedRoom(
+        roomIdOrAlias: RoomIdOrAlias,
+        timeout: Duration
+    ): RoomSummary {
        return withTimeout(timeout) {
-            roomListService.allRooms.summaries
-                .filter(predicate)
-                .first()
+            getRoomSummaryFlow(roomIdOrAlias)
+                .mapNotNull { optionalRoomSummary -> optionalRoomSummary.getOrNull() }
+                .filter { roomSummary -> roomSummary.info.currentUserMembership == CurrentUserMembership.JOINED }
                .first()
                // Ensure that the room is ready
                .also { client.awaitRoomRemoteEcho(it.roomId.value) }
@ -568,20 +560,21 @@ class RustMatrixClient(

    override fun roomMembershipObserver(): RoomMembershipObserver = roomMembershipObserver

-    override fun getRoomInfoFlow(roomId: RoomId): Flow<Optional<MatrixRoomInfo>> {
-        return flow {
-            var room = getRoom(roomId)
-            if (room == null) {
-                emit(Optional.empty())
-                awaitJoinedRoom(roomId.toRoomIdOrAlias(), INFINITE)
-                room = getRoom(roomId)
+    override fun getRoomSummaryFlow(roomIdOrAlias: RoomIdOrAlias): Flow<Optional<RoomSummary>> {
+        val predicate: (RoomSummary) -> Boolean = when (roomIdOrAlias) {
+            is RoomIdOrAlias.Alias -> { roomSummary ->
+                roomSummary.info.aliases.contains(roomIdOrAlias.roomAlias)
            }
-            room?.use {
-                room.roomInfoFlow
-                    .map { roomInfo -> Optional.of(roomInfo) }
-                    .collect(this)
+            is RoomIdOrAlias.Id -> { roomSummary ->
+                roomSummary.roomId == roomIdOrAlias.roomId
            }
-        }.distinctUntilChanged()
+        }
+        return roomListService.allRooms.summaries
+            .map { roomSummaries ->
+                val roomSummary = roomSummaries.firstOrNull(predicate)
+                Optional.ofNullable(roomSummary)
+            }
+            .distinctUntilChanged()
    }

    override suspend fun setAllSendQueuesEnabled(enabled: Boolean) = withContext(sessionDispatcher) {
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/MatrixRoomInfoMapper.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/MatrixRoomInfoMapper.kt
@ -53,6 +53,10 @@ class MatrixRoomInfoMapper {
            activeRoomCallParticipants = it.activeRoomCallParticipants.map(::UserId).toImmutableList(),
            heroes = it.elementHeroes().toImmutableList(),
            pinnedEventIds = it.pinnedEventIds.map(::EventId).toImmutableList(),
+            isMarkedUnread = it.isMarkedUnread,
+            numUnreadMessages = it.numUnreadMessages.toLong(),
+            numUnreadMentions = it.numUnreadMentions.toLong(),
+            numUnreadNotifications = it.numUnreadNotifications.toLong(),
        )
    }
 }
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomListFactory.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomListFactory.kt
@ -31,7 +31,7 @@ internal class RoomListFactory(
    private val innerRoomListService: RoomListService,
    private val sessionCoroutineScope: CoroutineScope,
 ) {
-    private val roomSummaryDetailsFactory: RoomSummaryDetailsFactory = RoomSummaryDetailsFactory()
+    private val roomSummaryDetailsFactory: RoomSummaryFactory = RoomSummaryFactory()

    /**
     * Creates a room list that can be used to load more rooms and filter them dynamically.
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomListFilter.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomListFilter.kt
@ -8,6 +8,7 @@
 package io.element.android.libraries.matrix.impl.roomlist

 import io.element.android.libraries.matrix.api.room.CurrentUserMembership
+import io.element.android.libraries.matrix.api.room.isDm
 import io.element.android.libraries.matrix.api.roomlist.RoomListFilter
 import io.element.android.libraries.matrix.api.roomlist.RoomSummary

@ -17,19 +18,19 @@ val RoomListFilter.predicate
        is RoomListFilter.Any -> { _: RoomSummary -> true }
        RoomListFilter.None -> { _: RoomSummary -> false }
        RoomListFilter.Category.Group -> { roomSummary: RoomSummary ->
-            !roomSummary.isDm && !roomSummary.isInvited()
+            !roomSummary.info.isDm && !roomSummary.isInvited()
        }
        RoomListFilter.Category.People -> { roomSummary: RoomSummary ->
-            roomSummary.isDm && !roomSummary.isInvited()
+            roomSummary.info.isDm && !roomSummary.isInvited()
        }
        RoomListFilter.Favorite -> { roomSummary: RoomSummary ->
-            roomSummary.isFavorite && !roomSummary.isInvited()
+            roomSummary.info.isFavorite && !roomSummary.isInvited()
        }
        RoomListFilter.Unread -> { roomSummary: RoomSummary ->
-            !roomSummary.isInvited() && (roomSummary.numUnreadNotifications > 0 || roomSummary.isMarkedUnread)
+            !roomSummary.isInvited() && (roomSummary.info.numUnreadNotifications > 0 || roomSummary.info.isMarkedUnread)
        }
        is RoomListFilter.NormalizedMatchRoomName -> { roomSummary: RoomSummary ->
-            roomSummary.name.orEmpty().contains(pattern, ignoreCase = true)
+            roomSummary.info.name.orEmpty().contains(pattern, ignoreCase = true)
        }
        RoomListFilter.Invite -> { roomSummary: RoomSummary ->
            roomSummary.isInvited()
@ -50,4 +51,4 @@ fun List<RoomSummary>.filter(filter: RoomListFilter): List<RoomSummary> {
    }
 }

-private fun RoomSummary.isInvited() = currentUserMembership == CurrentUserMembership.INVITED
+private fun RoomSummary.isInvited() = info.currentUserMembership == CurrentUserMembership.INVITED
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomSummaryDetailsFactory.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomSummaryDetailsFactory.kt
@ -1,51 +0,0 @@
-/*
- * Copyright 2023, 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.matrix.impl.roomlist
-
-import io.element.android.libraries.matrix.api.core.RoomAlias
-import io.element.android.libraries.matrix.api.core.RoomId
-import io.element.android.libraries.matrix.api.room.isDm
-import io.element.android.libraries.matrix.api.roomlist.RoomSummary
-import io.element.android.libraries.matrix.impl.notificationsettings.RoomNotificationSettingsMapper
-import io.element.android.libraries.matrix.impl.room.elementHeroes
-import io.element.android.libraries.matrix.impl.room.map
-import io.element.android.libraries.matrix.impl.room.member.RoomMemberMapper
-import io.element.android.libraries.matrix.impl.room.message.RoomMessageFactory
-import org.matrix.rustcomponents.sdk.RoomListItem
-import org.matrix.rustcomponents.sdk.use
-
-class RoomSummaryDetailsFactory(
-    private val roomMessageFactory: RoomMessageFactory = RoomMessageFactory(),
-) {
-    suspend fun create(roomListItem: RoomListItem): RoomSummary {
-        val roomInfo = roomListItem.roomInfo()
-        val latestRoomMessage = roomListItem.latestEvent().use { event ->
-            roomMessageFactory.create(event)
-        }
-        return RoomSummary(
-            roomId = RoomId(roomInfo.id),
-            name = roomInfo.displayName,
-            canonicalAlias = roomInfo.canonicalAlias?.let(::RoomAlias),
-            alternativeAliases = roomInfo.alternativeAliases.map(::RoomAlias),
-            isDirect = roomInfo.isDirect,
-            avatarUrl = roomInfo.avatarUrl,
-            numUnreadMentions = roomInfo.numUnreadMentions.toInt(),
-            numUnreadMessages = roomInfo.numUnreadMessages.toInt(),
-            numUnreadNotifications = roomInfo.numUnreadNotifications.toInt(),
-            isMarkedUnread = roomInfo.isMarkedUnread,
-            lastMessage = latestRoomMessage,
-            inviter = roomInfo.inviter?.let(RoomMemberMapper::map),
-            userDefinedNotificationMode = roomInfo.cachedUserDefinedNotificationMode?.let(RoomNotificationSettingsMapper::mapMode),
-            hasRoomCall = roomInfo.hasRoomCall,
-            isDm = isDm(isDirect = roomInfo.isDirect, activeMembersCount = roomInfo.activeMembersCount.toInt()),
-            isFavorite = roomInfo.isFavourite,
-            currentUserMembership = roomInfo.membership.map(),
-            heroes = roomInfo.elementHeroes(),
-        )
-    }
-}
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomSummaryFactory.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomSummaryFactory.kt
@ -0,0 +1,30 @@
+/*
+ * Copyright 2023, 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.matrix.impl.roomlist
+
+import io.element.android.libraries.matrix.api.roomlist.RoomSummary
+import io.element.android.libraries.matrix.impl.room.MatrixRoomInfoMapper
+import io.element.android.libraries.matrix.impl.room.message.RoomMessageFactory
+import org.matrix.rustcomponents.sdk.RoomListItem
+import org.matrix.rustcomponents.sdk.use
+
+class RoomSummaryFactory(
+    private val roomMessageFactory: RoomMessageFactory = RoomMessageFactory(),
+    private val roomInfoMapper: MatrixRoomInfoMapper = MatrixRoomInfoMapper(),
+) {
+    suspend fun create(roomListItem: RoomListItem): RoomSummary {
+        val roomInfo = roomListItem.roomInfo().let(roomInfoMapper::map)
+        val latestRoomMessage = roomListItem.latestEvent().use { event ->
+            roomMessageFactory.create(event)
+        }
+        return RoomSummary(
+            info = roomInfo,
+            lastMessage = latestRoomMessage,
+        )
+    }
+}
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomSummaryListProcessor.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/roomlist/RoomSummaryListProcessor.kt
@ -23,7 +23,7 @@ class RoomSummaryListProcessor(
    private val roomSummaries: MutableSharedFlow<List<RoomSummary>>,
    private val roomListService: RoomListServiceInterface,
    private val coroutineContext: CoroutineContext,
-    private val roomSummaryDetailsFactory: RoomSummaryDetailsFactory = RoomSummaryDetailsFactory(),
+    private val roomSummaryDetailsFactory: RoomSummaryFactory = RoomSummaryFactory(),
 ) {
    private val roomSummariesByIdentifier = HashMap<String, RoomSummary>()
    private val mutex = Mutex()