Sort the room member list and display member roles (#2412)

* Sort the room member list and display member roles

---------

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

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

@@ -27,7 +27,17 @@ data class RoomMember(
     val powerLevel: Long,
     val normalizedPowerLevel: Long,
     val isIgnored: Boolean,
+    val role: Role,
 ) {
+    /**
+     * Role of the RoomMember, based on its [powerLevel].
+     */
+    enum class Role {
+        ADMIN,
+        MODERATOR,
+        USER
+    }
+
     /**
      * Disambiguated display name for the RoomMember.
      * If the display name is null, the user ID is returned.
@@ -49,6 +59,10 @@ enum class RoomMembershipState {
     LEAVE
 }
 
+/**
+ * Returns the best name value to display for the RoomMember.
+ * If the [RoomMember.displayName] is present and not empty it'll be used, otherwise the [RoomMember.userId] will be used.
+ */
 fun RoomMember.getBestName(): String {
     return displayName?.takeIf { it.isNotEmpty() } ?: userId.value
 }

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

@@ -24,5 +24,5 @@ import kotlinx.parcelize.Parcelize
 data class MatrixUser(
     val userId: UserId,
     val displayName: String? = null,
-    val avatarUrl: String? = null
+    val avatarUrl: String? = null,
 ) : Parcelable

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

@@ -19,6 +19,7 @@ package io.element.android.libraries.matrix.impl.room.member
 import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.room.RoomMember
 import io.element.android.libraries.matrix.api.room.RoomMembershipState
+import uniffi.matrix_sdk.RoomMemberRole
 import org.matrix.rustcomponents.sdk.MembershipState as RustMembershipState
 import org.matrix.rustcomponents.sdk.RoomMember as RustRoomMember
 
@@ -33,9 +34,17 @@ object RoomMemberMapper {
             it.powerLevel(),
             it.normalizedPowerLevel(),
             it.isIgnored(),
+            mapRole(it.suggestedRoleForPowerLevel())
         )
     }
 
+    fun mapRole(role: RoomMemberRole): RoomMember.Role =
+        when (role) {
+            RoomMemberRole.ADMINISTRATOR -> RoomMember.Role.ADMIN
+            RoomMemberRole.MODERATOR -> RoomMember.Role.MODERATOR
+            RoomMemberRole.USER -> RoomMember.Role.USER
+        }
+
     fun mapMembership(membershipState: RustMembershipState): RoomMembershipState =
         when (membershipState) {
             RustMembershipState.BAN -> RoomMembershipState.BAN

libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/room/member/RoomMemberListFetcherTest.kt

@@ -34,6 +34,7 @@ import org.matrix.rustcomponents.sdk.NoPointer
 import org.matrix.rustcomponents.sdk.Room
 import org.matrix.rustcomponents.sdk.RoomMember
 import org.matrix.rustcomponents.sdk.RoomMembersIterator
+import uniffi.matrix_sdk.RoomMemberRole
 
 class RoomMemberListFetcherTest {
     @Test
@@ -268,6 +269,7 @@ class FakeRustRoomMember(
     private val membership: MembershipState = MembershipState.JOIN,
     private val isNameAmbiguous: Boolean = false,
     private val powerLevel: Long = 0L,
+    private val role: RoomMemberRole = RoomMemberRole.USER,
 ) : RoomMember(NoPointer) {
     override fun userId(): String {
         return userId.value
@@ -300,4 +302,8 @@ class FakeRustRoomMember(
     override fun isIgnored(): Boolean {
         return false
     }
+
+    override fun suggestedRoleForPowerLevel(): RoomMemberRole {
+        return role
+    }
 }

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

@@ -29,6 +29,7 @@ fun aRoomMember(
     powerLevel: Long = 0L,
     normalizedPowerLevel: Long = 0L,
     isIgnored: Boolean = false,
+    role: RoomMember.Role = RoomMember.Role.USER,
 ) = RoomMember(
     userId = userId,
     displayName = displayName,
@@ -38,4 +39,5 @@ fun aRoomMember(
     powerLevel = powerLevel,
     normalizedPowerLevel = normalizedPowerLevel,
     isIgnored = isIgnored,
+    role = role,
 )

libraries/matrixui/src/main/kotlin/io/element/android/libraries/matrix/ui/room/RoomMemberExtensions.kt

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2024 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.ui.room
+
+import io.element.android.libraries.matrix.api.room.RoomMember
+
+/**
+ * Returns the name value to use when sorting room members.
+ *
+ * If the display name is not null and not empty, it is returned.
+ * Otherwise, the user ID is returned without the initial "@".
+ */
+fun RoomMember.sortingName(): String {
+    return displayName?.takeIf { it.isNotEmpty() } ?: userId.value.drop(1)
+}