Unify the way we decide whether a room is a DM or a group room (#3100)

* Add centralised 'room is DM' check Also add extension functions for `MatrixRoom` and `MatrixRoomInfo`. * Use the centralised method and extension functions through the app, including: - Room list. - Room details screen. - Invites. - Notifications. Replace most `isDirect` usages with `isDm`. * Update screenshots --------- Co-authored-by: ElementBot <benoitm+elementbot@element.io>
2024-07-10 18:28:46 +02:00 · 2024-07-10 18:28:46 +02:00 · 0be7058416
commit 0be7058416
parent 1a03edbe63
47 changed files with 195 additions and 73 deletions
--- a/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/response/AcceptDeclineInviteStateProvider.kt
+++ b/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/response/AcceptDeclineInviteStateProvider.kt
@ -27,13 +27,13 @@ open class AcceptDeclineInviteStateProvider : PreviewParameterProvider<AcceptDec
            anAcceptDeclineInviteState(),
            anAcceptDeclineInviteState(
                invite = Optional.of(
-                    InviteData(RoomId("!room:matrix.org"), isDirect = true, roomName = "Alice"),
+                    InviteData(RoomId("!room:matrix.org"), isDm = true, roomName = "Alice"),
                ),
                declineAction = AsyncAction.Confirming,
            ),
            anAcceptDeclineInviteState(
                invite = Optional.of(
-                    InviteData(RoomId("!room:matrix.org"), isDirect = false, roomName = "Some room"),
+                    InviteData(RoomId("!room:matrix.org"), isDm = false, roomName = "Some room"),
                ),
                declineAction = AsyncAction.Confirming,
            ),
--- a/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/response/InviteData.kt
+++ b/features/invite/api/src/main/kotlin/io/element/android/features/invite/api/response/InviteData.kt
@ -21,5 +21,5 @@ import io.element.android.libraries.matrix.api.core.RoomId
 data class InviteData(
    val roomId: RoomId,
    val roomName: String,
-    val isDirect: Boolean,
+    val isDm: Boolean,
 )
--- a/features/invite/impl/src/main/kotlin/io/element/android/features/invite/impl/response/AcceptDeclineInviteView.kt
+++ b/features/invite/impl/src/main/kotlin/io/element/android/features/invite/impl/response/AcceptDeclineInviteView.kt
@ -79,13 +79,13 @@ private fun DeclineConfirmationDialog(
    onDismissClick: () -> Unit,
    modifier: Modifier = Modifier
 ) {
-    val contentResource = if (invite.isDirect) {
+    val contentResource = if (invite.isDm) {
        R.string.screen_invites_decline_direct_chat_message
    } else {
        R.string.screen_invites_decline_chat_message
    }

-    val titleResource = if (invite.isDirect) {
+    val titleResource = if (invite.isDm) {
        R.string.screen_invites_decline_direct_chat_title
    } else {
        R.string.screen_invites_decline_chat_title
--- a/features/invite/impl/src/test/kotlin/io/element/android/features/invite/impl/response/AcceptDeclineInvitePresenterTest.kt
+++ b/features/invite/impl/src/test/kotlin/io/element/android/features/invite/impl/response/AcceptDeclineInvitePresenterTest.kt
@ -260,12 +260,12 @@ class AcceptDeclineInvitePresenterTest {
    private fun anInviteData(
        roomId: RoomId = A_ROOM_ID,
        name: String = A_ROOM_NAME,
-        isDirect: Boolean = false
+        isDm: Boolean = false
    ): InviteData {
        return InviteData(
            roomId = roomId,
            roomName = name,
-            isDirect = isDirect
+            isDm = isDm
        )
    }

--- a/features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomPresenter.kt
+++ b/features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomPresenter.kt
@ -45,6 +45,7 @@ import io.element.android.libraries.matrix.api.core.RoomIdOrAlias
 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.RoomType
+import io.element.android.libraries.matrix.api.room.isDm
 import io.element.android.libraries.matrix.api.room.join.JoinRoom
 import io.element.android.libraries.matrix.api.room.preview.RoomPreview
 import io.element.android.libraries.matrix.ui.model.toInviteSender
@ -173,7 +174,7 @@ private fun RoomPreview.toContentState(): ContentState {
        topic = topic,
        alias = canonicalAlias,
        numberOfMembers = numberOfJoinedMembers,
-        isDirect = false,
+        isDm = false,
        roomType = roomType,
        roomAvatarUrl = avatarUrl,
        joinAuthorisationStatus = when {
@ -194,7 +195,7 @@ internal fun RoomDescription.toContentState(): ContentState {
        topic = topic,
        alias = alias,
        numberOfMembers = numberOfMembers,
-        isDirect = false,
+        isDm = false,
        roomType = RoomType.Room,
        roomAvatarUrl = avatarUrl,
        joinAuthorisationStatus = when (joinRule) {
@ -213,7 +214,7 @@ internal fun MatrixRoomInfo.toContentState(): ContentState {
        topic = topic,
        alias = canonicalAlias,
        numberOfMembers = activeMembersCount,
-        isDirect = isDirect,
+        isDm = isDm,
        roomType = if (isSpace) RoomType.Space else RoomType.Room,
        roomAvatarUrl = avatarUrl,
        joinAuthorisationStatus = when {
@ -233,7 +234,7 @@ internal fun ContentState.toInviteData(): InviteData? {
            roomId = roomId,
            // Note: name should not be null at this point, but use Id just in case...
            roomName = name ?: roomId.value,
-            isDirect = isDirect
+            isDm = isDm
        )
        else -> null
    }
--- a/features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomState.kt
+++ b/features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomState.kt
@ -53,7 +53,7 @@ sealed interface ContentState {
        val topic: String?,
        val alias: RoomAlias?,
        val numberOfMembers: Long?,
-        val isDirect: Boolean,
+        val isDm: Boolean,
        val roomType: RoomType,
        val roomAvatarUrl: String?,
        val joinAuthorisationStatus: JoinAuthorisationStatus,
--- a/features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomStateProvider.kt
+++ b/features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomStateProvider.kt
@ -28,6 +28,7 @@ import io.element.android.libraries.matrix.api.core.RoomIdOrAlias
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.core.toRoomIdOrAlias
 import io.element.android.libraries.matrix.api.room.RoomType
+import io.element.android.libraries.matrix.api.room.isDm
 import io.element.android.libraries.matrix.ui.model.InviteSender

 open class JoinRoomStateProvider : PreviewParameterProvider<JoinRoomState> {
@ -84,6 +85,12 @@ open class JoinRoomStateProvider : PreviewParameterProvider<JoinRoomState> {
                    roomType = RoomType.Space,
                )
            ),
+            aJoinRoomState(
+                contentState = aLoadedContentState(
+                    name = "A DM",
+                    isDm = true,
+                )
+            ),
        )
 }

@ -106,7 +113,7 @@ fun aLoadedContentState(
    alias: RoomAlias? = RoomAlias("#exa:matrix.org"),
    topic: String? = "Element X is a secure, private and decentralized messenger.",
    numberOfMembers: Long? = null,
-    isDirect: Boolean = false,
+    isDm: Boolean = false,
    roomType: RoomType = RoomType.Room,
    roomAvatarUrl: String? = null,
    joinAuthorisationStatus: JoinAuthorisationStatus = JoinAuthorisationStatus.Unknown
@ -116,7 +123,7 @@ fun aLoadedContentState(
    alias = alias,
    topic = topic,
    numberOfMembers = numberOfMembers,
-    isDirect = isDirect,
+    isDm = isDm,
    roomType = roomType,
    roomAvatarUrl = roomAvatarUrl,
    joinAuthorisationStatus = joinAuthorisationStatus
--- a/features/joinroom/impl/src/test/kotlin/io/element/android/features/joinroom/impl/JoinRoomPresenterTest.kt
+++ b/features/joinroom/impl/src/test/kotlin/io/element/android/features/joinroom/impl/JoinRoomPresenterTest.kt
@ -93,7 +93,7 @@ class JoinRoomPresenterTest {
                assertThat(contentState.topic).isEqualTo(roomInfo.topic)
                assertThat(contentState.alias).isEqualTo(roomInfo.canonicalAlias)
                assertThat(contentState.numberOfMembers).isEqualTo(roomInfo.activeMembersCount)
-                assertThat(contentState.isDirect).isEqualTo(roomInfo.isDirect)
+                assertThat(contentState.isDm).isEqualTo(roomInfo.isDirect)
                assertThat(contentState.roomAvatarUrl).isEqualTo(roomInfo.avatarUrl)
            }
        }
@ -283,7 +283,7 @@ class JoinRoomPresenterTest {
                assertThat(contentState.topic).isEqualTo(roomDescription.topic)
                assertThat(contentState.alias).isEqualTo(roomDescription.alias)
                assertThat(contentState.numberOfMembers).isEqualTo(roomDescription.numberOfMembers)
-                assertThat(contentState.isDirect).isFalse()
+                assertThat(contentState.isDm).isFalse()
                assertThat(contentState.roomAvatarUrl).isEqualTo(roomDescription.avatarUrl)
            }
        }
@ -398,7 +398,7 @@ class JoinRoomPresenterTest {
                        topic = "Room topic",
                        alias = RoomAlias("#alias:matrix.org"),
                        numberOfMembers = 2,
-                        isDirect = false,
+                        isDm = false,
                        roomType = RoomType.Room,
                        roomAvatarUrl = "avatarUrl",
                        joinAuthorisationStatus = JoinAuthorisationStatus.CanJoin
--- a/features/leaveroom/impl/src/main/kotlin/io/element/android/features/leaveroom/impl/DefaultLeaveRoomPresenter.kt
+++ b/features/leaveroom/impl/src/main/kotlin/io/element/android/features/leaveroom/impl/DefaultLeaveRoomPresenter.kt
@ -34,6 +34,7 @@ import io.element.android.libraries.di.SessionScope
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.room.RoomMembershipObserver
+import io.element.android.libraries.matrix.api.room.isDm
 import kotlinx.coroutines.launch
 import timber.log.Timber
 import javax.inject.Inject
--- a/features/leaveroom/impl/src/test/kotlin/io/element/android/features/leaveroom/impl/DefaultLeaveRoomPresenterTest.kt
+++ b/features/leaveroom/impl/src/test/kotlin/io/element/android/features/leaveroom/impl/DefaultLeaveRoomPresenterTest.kt
@ -119,7 +119,7 @@ class DefaultLeaveRoomPresenterTest {
            client = FakeMatrixClient().apply {
                givenGetRoomResult(
                    roomId = A_ROOM_ID,
-                    result = FakeMatrixRoom(activeMemberCount = 2, isDirect = true, isOneToOne = true),
+                    result = FakeMatrixRoom(activeMemberCount = 2, isDirect = true),
                )
            }
        )
--- a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesPresenter.kt
+++ b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesPresenter.kt
@ -72,6 +72,7 @@ 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.MessageEventType
+import io.element.android.libraries.matrix.api.room.isDm
 import io.element.android.libraries.matrix.ui.messages.reply.map
 import io.element.android.libraries.matrix.ui.model.getAvatarData
 import io.element.android.libraries.matrix.ui.room.canCall
@ -162,7 +163,7 @@ class MessagesPresenter @AssistedInject constructor(
        var showReinvitePrompt by remember { mutableStateOf(false) }
        LaunchedEffect(hasDismissedInviteDialog, composerState.textEditorState.hasFocus(), syncUpdateFlow.value) {
            withContext(dispatchers.io) {
-                showReinvitePrompt = !hasDismissedInviteDialog && composerState.textEditorState.hasFocus() && room.isDirect && room.activeMemberCount == 1L
+                showReinvitePrompt = !hasDismissedInviteDialog && composerState.textEditorState.hasFocus() && room.isDm && room.activeMemberCount == 1L
            }
        }
        val networkConnectionStatus by networkMonitor.connectivity.collectAsState()
--- a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/messagecomposer/MessageComposerPresenter.kt
+++ b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/messagecomposer/MessageComposerPresenter.kt
@ -57,6 +57,7 @@ import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.Mention
 import io.element.android.libraries.matrix.api.room.draft.ComposerDraft
 import io.element.android.libraries.matrix.api.room.draft.ComposerDraftType
+import io.element.android.libraries.matrix.api.room.isDm
 import io.element.android.libraries.matrix.ui.messages.reply.InReplyToDetails
 import io.element.android.libraries.matrix.ui.messages.reply.map
 import io.element.android.libraries.mediapickers.api.PickerProvider
--- a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/TimelinePresenter.kt
+++ b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/TimelinePresenter.kt
@ -42,6 +42,7 @@ import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.matrix.api.core.EventId
 import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.MessageEventType
+import io.element.android.libraries.matrix.api.room.isDm
 import io.element.android.libraries.matrix.api.room.roomMembers
 import io.element.android.libraries.matrix.api.timeline.ReceiptType
 import io.element.android.libraries.matrix.api.timeline.item.event.TimelineItemEventOrigin
--- a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/textcomposer/MessageComposerPresenterTest.kt
+++ b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/textcomposer/MessageComposerPresenterTest.kt
@ -839,7 +839,6 @@ class MessageComposerPresenterTest {
        val david = aRoomMember(userId = A_USER_ID_4, displayName = "Dave", membership = RoomMembershipState.JOIN)
        val room = FakeMatrixRoom(
            isDirect = false,
-            isOneToOne = false,
        ).apply {
            givenRoomMembersState(
                MatrixRoomMembersState.Ready(
@ -904,7 +903,8 @@ class MessageComposerPresenterTest {
        val david = aRoomMember(userId = A_USER_ID_4, displayName = "Dave", membership = RoomMembershipState.JOIN)
        val room = FakeMatrixRoom(
            isDirect = true,
-            isOneToOne = true,
+            activeMemberCount = 2,
+            isEncrypted = true,
        ).apply {
            givenRoomMembersState(
                MatrixRoomMembersState.Ready(
--- a/features/roomdetails/impl/src/main/kotlin/io/element/android/features/roomdetails/impl/RoomDetailsPresenter.kt
+++ b/features/roomdetails/impl/src/main/kotlin/io/element/android/features/roomdetails/impl/RoomDetailsPresenter.kt
@ -41,6 +41,7 @@ import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.MatrixRoomMembersState
 import io.element.android.libraries.matrix.api.room.RoomMember
 import io.element.android.libraries.matrix.api.room.StateEventType
+import io.element.android.libraries.matrix.api.room.isDm
 import io.element.android.libraries.matrix.api.room.powerlevels.canInvite
 import io.element.android.libraries.matrix.api.room.powerlevels.canSendState
 import io.element.android.libraries.matrix.api.room.roomNotificationSettings
--- a/features/roomdetails/impl/src/main/kotlin/io/element/android/features/roomdetails/impl/members/moderation/DefaultRoomMembersModerationPresenter.kt
+++ b/features/roomdetails/impl/src/main/kotlin/io/element/android/features/roomdetails/impl/members/moderation/DefaultRoomMembersModerationPresenter.kt
@ -35,6 +35,7 @@ import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.RoomMember
 import io.element.android.libraries.matrix.api.room.RoomMembershipState
+import io.element.android.libraries.matrix.api.room.isDm
 import io.element.android.libraries.matrix.api.room.powerlevels.canBan
 import io.element.android.libraries.matrix.api.room.powerlevels.canKick
 import io.element.android.services.analytics.api.AnalyticsService
@ -58,8 +59,7 @@ class DefaultRoomMembersModerationPresenter @Inject constructor(
    private suspend fun canKick() = room.canKick().getOrDefault(false)

    override suspend fun canDisplayModerationActions(): Boolean {
-        val isDm = room.isDm && room.isEncrypted
-        return !isDm && (canBan() || canKick())
+        return !room.isDm && (canBan() || canKick())
    }

    @Composable
--- a/features/roomdetails/impl/src/test/kotlin/io/element/android/features/roomdetails/members/moderation/DefaultRoomMembersModerationPresenterTest.kt
+++ b/features/roomdetails/impl/src/test/kotlin/io/element/android/features/roomdetails/members/moderation/DefaultRoomMembersModerationPresenterTest.kt
@ -45,7 +45,7 @@ import org.junit.Test
 class DefaultRoomMembersModerationPresenterTest {
    @Test
    fun `canDisplayModerationActions - when room is DM is false`() = runTest {
-        val room = FakeMatrixRoom(isDirect = true, isPublic = true, isOneToOne = true).apply {
+        val room = FakeMatrixRoom(isDirect = true, isPublic = true, activeMemberCount = 2).apply {
            givenRoomInfo(aRoomInfo(isDirect = true, isPublic = false, activeMembersCount = 2))
        }
        val presenter = createDefaultRoomMembersModerationPresenter(matrixRoom = room)
@ -54,7 +54,7 @@ class DefaultRoomMembersModerationPresenterTest {

    @Test
    fun `canDisplayModerationActions - when user can kick other users, FF is enabled and room is not a DM returns true`() = runTest {
-        val room = FakeMatrixRoom(isDirect = false, isOneToOne = false).apply {
+        val room = FakeMatrixRoom(isDirect = false, activeMemberCount = 10).apply {
            givenCanKickResult(Result.success(true))
        }
        val presenter = createDefaultRoomMembersModerationPresenter(matrixRoom = room)
@ -63,7 +63,7 @@ class DefaultRoomMembersModerationPresenterTest {

    @Test
    fun `canDisplayModerationActions - when user can ban other users, FF is enabled and room is not a DM returns true`() = runTest {
-        val room = FakeMatrixRoom(isDirect = false, isOneToOne = false).apply {
+        val room = FakeMatrixRoom(isDirect = false, activeMemberCount = 10).apply {
            givenCanBanResult(Result.success(true))
        }
        val presenter = createDefaultRoomMembersModerationPresenter(matrixRoom = room)
--- a/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/RoomListPresenter.kt
+++ b/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/RoomListPresenter.kt
@ -290,5 +290,5 @@ internal fun RoomListRoomSummary.toInviteData() = InviteData(
    roomId = roomId,
    // Note: `name` should not be null at this point, but just in case, fallback to the roomId
    roomName = name ?: roomId.value,
-    isDirect = isDirect,
+    isDm = isDm,
 )
--- a/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/components/RoomSummaryRow.kt
+++ b/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/components/RoomSummaryRow.kt
@ -95,8 +95,8 @@ internal fun RoomSummaryRow(
                modifier = modifier
            ) {
                InviteNameAndIndicatorRow(name = room.name)
-                InviteSubtitle(isDirect = room.isDirect, inviteSender = room.inviteSender, canonicalAlias = room.canonicalAlias)
-                if (!room.isDirect && room.inviteSender != null) {
+                InviteSubtitle(isDm = room.isDm, inviteSender = room.inviteSender, canonicalAlias = room.canonicalAlias)
+                if (!room.isDm && room.inviteSender != null) {
                    Spacer(modifier = Modifier.height(4.dp))
                    InviteSenderView(
                        modifier = Modifier.fillMaxWidth(),
@ -206,12 +206,12 @@ private fun NameAndTimestampRow(

@Composable
 private fun InviteSubtitle(
-    isDirect: Boolean,
+    isDm: Boolean,
    inviteSender: InviteSender?,
    canonicalAlias: RoomAlias?,
    modifier: Modifier = Modifier
 ) {
-    val subtitle = if (isDirect) {
+    val subtitle = if (isDm) {
        inviteSender?.userId?.value
    } else {
        canonicalAlias?.value
--- a/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/datasource/RoomListRoomSummaryFactory.kt
+++ b/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/datasource/RoomListRoomSummaryFactory.kt
@ -45,7 +45,7 @@ class RoomListRoomSummaryFactory @Inject constructor(
            isMarkedUnread = details.isMarkedUnread,
            timestamp = lastMessageTimestampFormatter.format(details.lastMessageTimestamp),
            lastMessage = details.lastMessage?.let { message ->
-                roomLastMessageFormatter.format(message.event, details.isDirect)
+                roomLastMessageFormatter.format(message.event, details.isDm)
            }.orEmpty(),
            avatarData = avatarData,
            userDefinedNotificationMode = details.userDefinedNotificationMode,
--- a/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/model/RoomListRoomSummaryProvider.kt
+++ b/features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/model/RoomListRoomSummaryProvider.kt
@ -101,7 +101,7 @@ open class RoomListRoomSummaryProvider : PreviewParameterProvider<RoomListRoomSu
                        userId = UserId("@bob:matrix.org"),
                        displayName = "Bob",
                    ),
-                    isDirect = true,
+                    isDm = true,
                ),
                aRoomListRoomSummary(
                    name = null,