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

Rework room summary

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

@@ -38,6 +38,8 @@ import kotlinx.collections.immutable.ImmutableList
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.distinctUntilChanged
+import kotlinx.coroutines.flow.map
 import java.io.Closeable
 import java.util.Optional
 
@@ -94,7 +96,13 @@ interface MatrixClient : Closeable {
     suspend fun getAccountManagementUrl(action: AccountManagementAction?): Result<String?>
     suspend fun uploadMedia(mimeType: String, data: ByteArray, progressCallback: ProgressCallback?): Result<String>
     fun roomMembershipObserver(): RoomMembershipObserver
-    fun getRoomInfoFlow(roomId: RoomId): Flow<Optional<MatrixRoomInfo>>
+
+    /**
+     * Get a room summary flow for a given room ID or alias.
+     * The flow will emit a new value whenever the room summary is updated.
+     * The flow will emit Optional.empty item if the room is not found.
+     */
+    fun getRoomSummaryFlow(roomIdOrAlias: RoomIdOrAlias): Flow<Optional<RoomSummary>>
 
     fun isMe(userId: UserId?) = userId == sessionId
 
@@ -142,3 +150,14 @@ interface MatrixClient : Closeable {
     fun canDeactivateAccount(): Boolean
     suspend fun deactivateAccount(password: String, eraseData: Boolean): Result<Unit>
 }
+
+/**
+ * Get a room info flow for a given room ID or alias.
+ * The flow will emit a new value whenever the room info is updated.
+ * The flow will emit Optional.empty item if the room is not found.
+ */
+fun MatrixClient.getRoomInfoFlow(roomIdOrAlias: RoomIdOrAlias): Flow<Optional<MatrixRoomInfo>> {
+    return getRoomSummaryFlow(roomIdOrAlias)
+        .map { roomSummary -> roomSummary.map { it.info } }
+        .distinctUntilChanged()
+}

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

@@ -33,6 +33,13 @@ data class MatrixRoomInfo(
     val canonicalAlias: RoomAlias?,
     val alternativeAliases: ImmutableList<RoomAlias>,
     val currentUserMembership: CurrentUserMembership,
+    /**
+     * Member who invited the current user to a room that's in the invited
+     * state.
+     *
+     * Can be missing if the room membership invite event is missing from the
+     * store.
+     */
     val inviter: RoomMember?,
     val activeMembersCount: Long,
     val invitedMembersCount: Long,
@@ -43,7 +50,26 @@ data class MatrixRoomInfo(
     val userDefinedNotificationMode: RoomNotificationMode?,
     val hasRoomCall: Boolean,
     val activeRoomCallParticipants: ImmutableList<UserId>,
+    val isMarkedUnread: Boolean,
+    /**
+     * "Interesting" messages received in that room, independently of the
+     * notification settings.
+     */
+    val numUnreadMessages: Long,
+    /**
+     * Events that will notify the user, according to their
+     * notification settings.
+     */
+    val numUnreadNotifications: Long,
+    /**
+     * Events causing mentions/highlights for the user, according to their
+     * notification settings.
+     */
+    val numUnreadMentions: Long,
     val heroes: ImmutableList<MatrixUser>,
     val pinnedEventIds: ImmutableList<EventId>,
     val creator: UserId?,
-)
+) {
+    val aliases: List<RoomAlias>
+        get() = listOfNotNull(canonicalAlias) + alternativeAliases
+}

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

@@ -7,35 +7,14 @@
 
 package io.element.android.libraries.matrix.api.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.CurrentUserMembership
-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.MatrixRoomInfo
 import io.element.android.libraries.matrix.api.room.message.RoomMessage
-import io.element.android.libraries.matrix.api.user.MatrixUser
 
 data class RoomSummary(
-    val roomId: RoomId,
-    val name: String?,
-    val canonicalAlias: RoomAlias?,
-    val alternativeAliases: List<RoomAlias>,
-    val isDirect: Boolean,
-    val avatarUrl: String?,
+    val info: MatrixRoomInfo,
     val lastMessage: RoomMessage?,
-    val numUnreadMessages: Int,
-    val numUnreadMentions: Int,
-    val numUnreadNotifications: Int,
-    val isMarkedUnread: Boolean,
-    val inviter: RoomMember?,
-    val userDefinedNotificationMode: RoomNotificationMode?,
-    val hasRoomCall: Boolean,
-    val isDm: Boolean,
-    val isFavorite: Boolean,
-    val currentUserMembership: CurrentUserMembership,
-    val heroes: List<MatrixUser>,
 ) {
+    val roomId = info.id
     val lastMessageTimestamp = lastMessage?.originServerTs
-    val aliases: List<RoomAlias>
-        get() = listOfNotNull(canonicalAlias) + alternativeAliases
+    val isOneToOne get() = info.activeMembersCount == 2L
 }