dependencies (rust sdk) : replace RoomTombstone by SuccessorRoom

Author: ganfra

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

@@ -32,7 +32,6 @@ data class RoomInfo(
     val isEncrypted: Boolean?,
     val joinRule: JoinRule?,
     val isSpace: Boolean,
-    val tombstone: RoomTombstone?,
     val isFavorite: Boolean,
     val canonicalAlias: RoomAlias?,
     val alternativeAliases: ImmutableList<RoomAlias>,
@@ -74,12 +73,8 @@ data class RoomInfo(
     val pinnedEventIds: ImmutableList<EventId>,
     val creator: UserId?,
     val historyVisibility: RoomHistoryVisibility,
+    val successorRoom: SuccessorRoom?,
 ) {
     val aliases: List<RoomAlias>
         get() = listOfNotNull(canonicalAlias) + alternativeAliases
 }
-
-data class RoomTombstone(
-    val body: String,
-    val replacementRoomId: RoomId,
-)

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

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.libraries.matrix.api.room
+
+import io.element.android.libraries.matrix.api.core.RoomId
+
+/**
+ *
+ * When a room A is tombstoned, it is replaced by a room B. The room A is the
+ * predecessor of B, and B is the successor of A. This type holds information
+ * about the successor room.
+ *
+ * A room is tombstoned if it has received a m.room.tombstone state event.
+ *
+ */
+data class SuccessorRoom(
+    /**
+     * The ID of the replacement room.
+     */
+    val roomId: RoomId,
+    /**
+     * The message explaining why the room has been tombstoned.
+     */
+    val reason: String?,
+)

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

@@ -14,7 +14,7 @@ import io.element.android.libraries.matrix.api.core.UserId
 import io.element.android.libraries.matrix.api.room.CurrentUserMembership
 import io.element.android.libraries.matrix.api.room.RoomInfo
 import io.element.android.libraries.matrix.api.room.RoomNotificationMode
-import io.element.android.libraries.matrix.api.room.RoomTombstone
+import io.element.android.libraries.matrix.api.room.SuccessorRoom
 import io.element.android.libraries.matrix.api.user.MatrixUser
 import io.element.android.libraries.matrix.impl.room.history.map
 import io.element.android.libraries.matrix.impl.room.join.map
@@ -28,6 +28,7 @@ import uniffi.matrix_sdk_base.EncryptionState
 import org.matrix.rustcomponents.sdk.Membership as RustMembership
 import org.matrix.rustcomponents.sdk.RoomInfo as RustRoomInfo
 import org.matrix.rustcomponents.sdk.RoomNotificationMode as RustRoomNotificationMode
+import org.matrix.rustcomponents.sdk.SuccessorRoom as RustSuccessorRoom
 
 class RoomInfoMapper {
     fun map(rustRoomInfo: RustRoomInfo): RoomInfo = rustRoomInfo.let {
@@ -47,9 +48,6 @@ class RoomInfoMapper {
             },
             joinRule = it.joinRule?.map(),
             isSpace = it.isSpace,
-            tombstone = it.tombstone?.let {
-                RoomTombstone(it.body, RoomId(it.replacementRoomId))
-            },
             isFavorite = it.isFavourite,
             canonicalAlias = it.canonicalAlias?.let(::RoomAlias),
             alternativeAliases = it.alternativeAliases.map(::RoomAlias).toImmutableList(),
@@ -71,6 +69,7 @@ class RoomInfoMapper {
             numUnreadMentions = it.numUnreadMentions.toLong(),
             numUnreadNotifications = it.numUnreadNotifications.toLong(),
             historyVisibility = it.historyVisibility.map(),
+            successorRoom = it.successorRoom?.map(),
         )
     }
 }
@@ -89,6 +88,11 @@ fun RustRoomNotificationMode.map(): RoomNotificationMode = when (this) {
     RustRoomNotificationMode.MUTE -> RoomNotificationMode.MUTE
 }
 
+fun RustSuccessorRoom.map(): SuccessorRoom = SuccessorRoom(
+    roomId = RoomId(roomId),
+    reason = reason,
+)
+
 /**
  * Map a RoomHero to a MatrixUser. There is not need to create a RoomHero type on the application side.
  */

libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/fixtures/factories/RoomInfo.kt

@@ -17,7 +17,7 @@ import org.matrix.rustcomponents.sdk.RoomHistoryVisibility
 import org.matrix.rustcomponents.sdk.RoomInfo
 import org.matrix.rustcomponents.sdk.RoomMember
 import org.matrix.rustcomponents.sdk.RoomNotificationMode
-import org.matrix.rustcomponents.sdk.RoomTombstoneInfo
+import org.matrix.rustcomponents.sdk.SuccessorRoom
 import uniffi.matrix_sdk_base.EncryptionState
 
 fun aRustRoomInfo(
@@ -30,7 +30,6 @@ fun aRustRoomInfo(
     isDirect: Boolean = false,
     isPublic: Boolean = false,
     isSpace: Boolean = false,
-    tombstone: RoomTombstoneInfo? = null,
     isFavourite: Boolean = false,
     canonicalAlias: String? = null,
     alternativeAliases: List<String> = listOf(),
@@ -54,6 +53,7 @@ fun aRustRoomInfo(
     roomCreator: UserId? = null,
     joinRule: JoinRule? = null,
     historyVisibility: RoomHistoryVisibility = RoomHistoryVisibility.Joined,
+    successorRoom: SuccessorRoom? = null,
 ) = RoomInfo(
     id = id,
     displayName = displayName,
@@ -64,7 +64,6 @@ fun aRustRoomInfo(
     isDirect = isDirect,
     isPublic = isPublic,
     isSpace = isSpace,
-    tombstone = tombstone,
     isFavourite = isFavourite,
     canonicalAlias = canonicalAlias,
     alternativeAliases = alternativeAliases,
@@ -87,5 +86,6 @@ fun aRustRoomInfo(
     pinnedEventIds = pinnedEventIds,
     creator = roomCreator?.value,
     joinRule = joinRule,
-    historyVisibility = historyVisibility
+    historyVisibility = historyVisibility,
+    successorRoom = successorRoom,
 )

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

@@ -54,7 +54,7 @@ class RoomInfoMapperTest {
                     isPublic = false,
                     isSpace = false,
                     joinRule = RustJoinRule.Invite,
-                    tombstone = null,
+                    successorRoom = null,
                     isFavourite = false,
                     canonicalAlias = A_ROOM_ALIAS.value,
                     alternativeAliases = listOf(A_ROOM_ALIAS.value),
@@ -90,7 +90,6 @@ class RoomInfoMapperTest {
                 isDirect = true,
                 isEncrypted = true,
                 isSpace = false,
-                tombstone = null,
                 isFavorite = false,
                 joinRule = JoinRule.Invite,
                 canonicalAlias = A_ROOM_ALIAS,
@@ -120,6 +119,7 @@ class RoomInfoMapperTest {
                 numUnreadNotifications = 13L,
                 numUnreadMentions = 14L,
                 historyVisibility = RoomHistoryVisibility.Joined,
+                successorRoom = null
             )
         )
     }
@@ -139,7 +139,7 @@ class RoomInfoMapperTest {
                     isPublic = true,
                     joinRule = null,
                     isSpace = false,
-                    tombstone = null,
+                    successorRoom = null,
                     isFavourite = true,
                     canonicalAlias = null,
                     alternativeAliases = emptyList(),
@@ -175,7 +175,7 @@ class RoomInfoMapperTest {
                 isDirect = false,
                 joinRule = null,
                 isSpace = false,
-                tombstone = null,
+                successorRoom = null,
                 isFavorite = true,
                 canonicalAlias = null,
                 alternativeAliases = emptyList<RoomAlias>().toPersistentList(),

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

@@ -15,7 +15,7 @@ import io.element.android.libraries.matrix.api.room.CurrentUserMembership
 import io.element.android.libraries.matrix.api.room.RoomInfo
 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.RoomTombstone
+import io.element.android.libraries.matrix.api.room.SuccessorRoom
 import io.element.android.libraries.matrix.api.room.history.RoomHistoryVisibility
 import io.element.android.libraries.matrix.api.room.join.JoinRule
 import io.element.android.libraries.matrix.api.user.MatrixUser
@@ -39,7 +39,7 @@ fun aRoomInfo(
     isEncrypted: Boolean = false,
     joinRule: JoinRule? = JoinRule.Public,
     isSpace: Boolean = false,
-    tombstone: RoomTombstone? = null,
+    successorRoom: SuccessorRoom? = null,
     isFavorite: Boolean = false,
     canonicalAlias: RoomAlias? = null,
     alternativeAliases: List<RoomAlias> = emptyList(),
@@ -73,7 +73,7 @@ fun aRoomInfo(
     isEncrypted = isEncrypted,
     joinRule = joinRule,
     isSpace = isSpace,
-    tombstone = tombstone,
+    successorRoom = successorRoom,
     isFavorite = isFavorite,
     canonicalAlias = canonicalAlias,
     alternativeAliases = alternativeAliases.toImmutableList(),

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

@@ -15,7 +15,7 @@ import io.element.android.libraries.matrix.api.room.CurrentUserMembership
 import io.element.android.libraries.matrix.api.room.RoomInfo
 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.RoomTombstone
+import io.element.android.libraries.matrix.api.room.SuccessorRoom
 import io.element.android.libraries.matrix.api.room.history.RoomHistoryVisibility
 import io.element.android.libraries.matrix.api.room.join.JoinRule
 import io.element.android.libraries.matrix.api.room.message.RoomMessage
@@ -52,7 +52,7 @@ fun aRoomSummary(
     isEncrypted: Boolean = false,
     joinRule: JoinRule? = JoinRule.Public,
     isSpace: Boolean = false,
-    tombstone: RoomTombstone? = null,
+    successorRoom: SuccessorRoom? = null,
     isFavorite: Boolean = false,
     canonicalAlias: RoomAlias? = null,
     alternativeAliases: List<RoomAlias> = emptyList(),
@@ -88,7 +88,7 @@ fun aRoomSummary(
         isEncrypted = isEncrypted,
         joinRule = joinRule,
         isSpace = isSpace,
-        tombstone = tombstone,
+        successorRoom = successorRoom,
         isFavorite = isFavorite,
         canonicalAlias = canonicalAlias,
         alternativeAliases = alternativeAliases.toPersistentList(),