preview api : rename RoomPreview to RoomPreviewInfo to avoid confusion

2024-11-15 10:51:47 +01:00
parent ebf033f7c0
commit 2ef8bd33ef
10 changed files with 70 additions and 97 deletions
--- 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
@@ -42,7 +42,7 @@ 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.api.room.preview.RoomPreviewInfo
 import io.element.android.libraries.matrix.ui.model.toInviteSender
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
@@ -96,10 +96,10 @@ class JoinRoomPresenter @AssistedInject constructor(
                }
                else -> {
                    value = ContentState.Loading(roomIdOrAlias)
-                    val result = matrixClient.getRoomPreview(roomIdOrAlias, serverNames)
+                    val result = matrixClient.getRoomPreviewInfo(roomIdOrAlias, serverNames)
                    value = result.fold(
-                        onSuccess = { roomPreview ->
-                            roomPreview.toContentState()
+                        onSuccess = { previewInfo ->
+                            previewInfo.toContentState()
                        },
                        onFailure = { throwable ->
                            if (throwable.message?.contains("403") == true) {
@@ -184,7 +184,7 @@ class JoinRoomPresenter @AssistedInject constructor(
    }
 }

-private fun RoomPreview.toContentState(): ContentState {
+private fun RoomPreviewInfo.toContentState(): ContentState {
    return ContentState.Loaded(
        roomId = roomId,
        name = name,
--- 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
@@ -26,7 +26,7 @@ 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.CurrentUserMembership
 import io.element.android.libraries.matrix.api.room.RoomType
-import io.element.android.libraries.matrix.api.room.preview.RoomPreview
+import io.element.android.libraries.matrix.api.room.preview.RoomPreviewInfo
 import io.element.android.libraries.matrix.test.AN_EXCEPTION
 import io.element.android.libraries.matrix.test.A_ROOM_ID
 import io.element.android.libraries.matrix.test.A_ROOM_NAME
@@ -408,9 +408,9 @@ class JoinRoomPresenterTest {
    @Test
    fun `present - when room is not known RoomPreview is loaded`() = runTest {
        val client = FakeMatrixClient(
-            getRoomPreviewResult = { _, _ ->
+            getRoomPreviewInfoResult = { _, _ ->
                Result.success(
-                    RoomPreview(
+                    RoomPreviewInfo(
                        roomId = A_ROOM_ID,
                        canonicalAlias = RoomAlias("#alias:matrix.org"),
                        name = "Room name",
@@ -453,7 +453,7 @@ class JoinRoomPresenterTest {
    @Test
    fun `present - when room is not known RoomPreview is loaded with error`() = runTest {
        val client = FakeMatrixClient(
-            getRoomPreviewResult = { _, _ ->
+            getRoomPreviewInfoResult = { _, _ ->
                Result.failure(AN_EXCEPTION)
            }
        )
@@ -491,7 +491,7 @@ class JoinRoomPresenterTest {
    @Test
    fun `present - when room is not known RoomPreview is loaded with error 403`() = runTest {
        val client = FakeMatrixClient(
-            getRoomPreviewResult = { _, _ ->
+            getRoomPreviewInfoResult = { _, _ ->
                Result.failure(Exception("403"))
            }
        )
--- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/MatrixClient.kt
+++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/MatrixClient.kt
@@ -26,7 +26,7 @@ import io.element.android.libraries.matrix.api.room.MatrixRoomInfo
 import io.element.android.libraries.matrix.api.room.PendingRoom
 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
+import io.element.android.libraries.matrix.api.room.preview.RoomPreviewInfo
 import io.element.android.libraries.matrix.api.roomdirectory.RoomDirectoryService
 import io.element.android.libraries.matrix.api.roomlist.RoomListService
 import io.element.android.libraries.matrix.api.roomlist.RoomSummary
@@ -143,7 +143,7 @@ interface MatrixClient : Closeable {
     * Execute generic GET requests through the SDKs internal HTTP client.
     */
    suspend fun getUrl(url: String): Result<String>
-    suspend fun getRoomPreview(roomIdOrAlias: RoomIdOrAlias, serverNames: List<String>): Result<RoomPreview>
+    suspend fun getRoomPreviewInfo(roomIdOrAlias: RoomIdOrAlias, serverNames: List<String>): Result<RoomPreviewInfo>

    /** Returns `true` if the home server supports native sliding sync. */
    suspend fun isNativeSlidingSyncSupported(): Boolean
--- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/preview/RoomPreviewInfo.kt
+++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/preview/RoomPreviewInfo.kt
@@ -11,7 +11,7 @@ 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.RoomType

-data class RoomPreview(
+data class RoomPreviewInfo(
    /** The room id for this room. */
    val roomId: RoomId,
    /** The canonical alias for the room. */
--- 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
@@ -37,7 +37,7 @@ import io.element.android.libraries.matrix.api.room.PendingRoom
 import io.element.android.libraries.matrix.api.room.RoomMember
 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
+import io.element.android.libraries.matrix.api.room.preview.RoomPreviewInfo
 import io.element.android.libraries.matrix.api.roomdirectory.RoomDirectoryService
 import io.element.android.libraries.matrix.api.roomlist.RoomListService
 import io.element.android.libraries.matrix.api.roomlist.RoomSummary
@@ -57,7 +57,7 @@ import io.element.android.libraries.matrix.impl.room.RoomContentForwarder
 import io.element.android.libraries.matrix.impl.room.RoomSyncSubscriber
 import io.element.android.libraries.matrix.impl.room.RustRoomFactory
 import io.element.android.libraries.matrix.impl.room.TimelineEventTypeFilterFactory
-import io.element.android.libraries.matrix.impl.room.preview.RoomPreviewMapper
+import io.element.android.libraries.matrix.impl.room.preview.RoomPreviewInfoMapper
 import io.element.android.libraries.matrix.impl.roomdirectory.RustRoomDirectoryService
 import io.element.android.libraries.matrix.impl.roomlist.RoomListFactory
 import io.element.android.libraries.matrix.impl.roomlist.RustRoomListService
@@ -455,12 +455,14 @@ class RustMatrixClient(
        }
    }

-    override suspend fun getRoomPreview(roomIdOrAlias: RoomIdOrAlias, serverNames: List<String>): Result<RoomPreview> = withContext(sessionDispatcher) {
+    override suspend fun getRoomPreviewInfo(roomIdOrAlias: RoomIdOrAlias, serverNames: List<String>): Result<RoomPreviewInfo> = withContext(sessionDispatcher) {
        runCatching {
            when (roomIdOrAlias) {
                is RoomIdOrAlias.Alias -> client.getRoomPreviewFromRoomAlias(roomIdOrAlias.roomAlias.value)
                is RoomIdOrAlias.Id -> client.getRoomPreviewFromRoomId(roomIdOrAlias.roomId.value, serverNames)
-            }.let(RoomPreviewMapper::map)
+            }.use { roomPreview ->
+                RoomPreviewInfoMapper.map(roomPreview.info())
+            }
        }
    }

--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/preview/RoomPreviewInfoMapper.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/preview/RoomPreviewInfoMapper.kt
@@ -0,0 +1,35 @@
+/*
+ * Copyright 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.room.preview
+
+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.preview.RoomPreviewInfo
+import io.element.android.libraries.matrix.impl.room.toRoomType
+import org.matrix.rustcomponents.sdk.JoinRule
+import org.matrix.rustcomponents.sdk.Membership
+import org.matrix.rustcomponents.sdk.RoomPreviewInfo as RustRoomPreviewInfo
+
+object RoomPreviewInfoMapper {
+    fun map(info: RustRoomPreviewInfo): RoomPreviewInfo {
+        return RoomPreviewInfo(
+            roomId = RoomId(info.roomId),
+            canonicalAlias = info.canonicalAlias?.let(::RoomAlias),
+            name = info.name,
+            topic = info.topic,
+            avatarUrl = info.avatarUrl,
+            numberOfJoinedMembers = info.numJoinedMembers.toLong(),
+            roomType = info.roomType.toRoomType(),
+            isHistoryWorldReadable = info.isHistoryWorldReadable,
+            isJoined = info.membership == Membership.JOINED,
+            isInvited = info.membership == Membership.INVITED,
+            isPublic = info.joinRule == JoinRule.Public,
+            canKnock = info.joinRule == JoinRule.Knock
+        )
+    }
+}
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/preview/RoomPreviewMapper.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/preview/RoomPreviewMapper.kt
@@ -1,38 +0,0 @@
-/*
- * Copyright 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.room.preview
-
-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.preview.RoomPreview
-import io.element.android.libraries.matrix.impl.room.toRoomType
-import org.matrix.rustcomponents.sdk.JoinRule
-import org.matrix.rustcomponents.sdk.Membership
-import org.matrix.rustcomponents.sdk.RoomPreview as RustRoomPreview
-
-object RoomPreviewMapper {
-    fun map(roomPreview: RustRoomPreview): RoomPreview {
-        return roomPreview.use {
-            val info = roomPreview.info()
-            RoomPreview(
-                roomId = RoomId(info.roomId),
-                canonicalAlias = info.canonicalAlias?.let(::RoomAlias),
-                name = info.name,
-                topic = info.topic,
-                avatarUrl = info.avatarUrl,
-                numberOfJoinedMembers = info.numJoinedMembers.toLong(),
-                roomType = info.roomType.toRoomType(),
-                isHistoryWorldReadable = info.isHistoryWorldReadable,
-                isJoined = info.membership == Membership.JOINED,
-                isInvited = info.membership == Membership.INVITED,
-                isPublic = info.joinRule == JoinRule.Public,
-                canKnock = info.joinRule == JoinRule.Knock
-            )
-        }
-    }
-}
--- a/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/fixtures/fakes/FakeRustRoomPreview.kt
+++ b/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/fixtures/fakes/FakeRustRoomPreview.kt
@@ -1,21 +0,0 @@
-/*
- * Copyright 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.fixtures.fakes
-
-import io.element.android.libraries.matrix.impl.fixtures.factories.aRustRoomPreviewInfo
-import org.matrix.rustcomponents.sdk.NoPointer
-import org.matrix.rustcomponents.sdk.RoomPreview
-import org.matrix.rustcomponents.sdk.RoomPreviewInfo
-
-class FakeRustRoomPreview(
-    private val info: RoomPreviewInfo = aRustRoomPreviewInfo(),
-) : RoomPreview(NoPointer) {
-    override fun info(): RoomPreviewInfo {
-        return info
-    }
-}
--- a/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/room/preview/RoomPreviewInfoMapperTest.kt
+++ b/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/room/preview/RoomPreviewInfoMapperTest.kt
@@ -9,28 +9,25 @@ package io.element.android.libraries.matrix.impl.room.preview

 import com.google.common.truth.Truth.assertThat
 import io.element.android.libraries.matrix.api.room.RoomType
-import io.element.android.libraries.matrix.api.room.preview.RoomPreview
+import io.element.android.libraries.matrix.api.room.preview.RoomPreviewInfo
 import io.element.android.libraries.matrix.impl.fixtures.factories.aRustRoomPreviewInfo
-import io.element.android.libraries.matrix.impl.fixtures.fakes.FakeRustRoomPreview
 import io.element.android.libraries.matrix.test.A_ROOM_ALIAS
 import io.element.android.libraries.matrix.test.A_ROOM_ID
 import org.junit.Test
 import org.matrix.rustcomponents.sdk.JoinRule
 import org.matrix.rustcomponents.sdk.Membership

-class RoomPreviewMapperTest {
+class RoomPreviewInfoMapperTest {
    @Test
    fun `map should map values 1`() {
        assertThat(
-            RoomPreviewMapper.map(
-                FakeRustRoomPreview(
-                    info = aRustRoomPreviewInfo(
-                        membership = null,
-                    )
+            RoomPreviewInfoMapper.map(
+                info = aRustRoomPreviewInfo(
+                    membership = null,
                )
            )
        ).isEqualTo(
-            RoomPreview(
+            RoomPreviewInfo(
                roomId = A_ROOM_ID,
                canonicalAlias = A_ROOM_ALIAS,
                name = "name",
@@ -50,17 +47,15 @@ class RoomPreviewMapperTest {
    @Test
    fun `map should map values 2`() {
        assertThat(
-            RoomPreviewMapper.map(
-                FakeRustRoomPreview(
-                    info = aRustRoomPreviewInfo(
-                        canonicalAlias = null,
-                        membership = Membership.JOINED,
-                        joinRule = JoinRule.Knock,
-                    )
+            RoomPreviewInfoMapper.map(
+                info = aRustRoomPreviewInfo(
+                    canonicalAlias = null,
+                    membership = Membership.JOINED,
+                    joinRule = JoinRule.Knock,
                )
            )
        ).isEqualTo(
-            RoomPreview(
+            RoomPreviewInfo(
                roomId = A_ROOM_ID,
                canonicalAlias = null,
                name = "name",
--- a/libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/FakeMatrixClient.kt
+++ b/libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/FakeMatrixClient.kt
@@ -26,7 +26,7 @@ import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.PendingRoom
 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
+import io.element.android.libraries.matrix.api.room.preview.RoomPreviewInfo
 import io.element.android.libraries.matrix.api.roomdirectory.RoomDirectoryService
 import io.element.android.libraries.matrix.api.roomlist.RoomListService
 import io.element.android.libraries.matrix.api.roomlist.RoomSummary
@@ -78,7 +78,7 @@ class FakeMatrixClient(
        Optional.of(ResolvedRoomAlias(A_ROOM_ID, emptyList()))
    )
    },
-    private val getRoomPreviewResult: (RoomIdOrAlias, List<String>) -> Result<RoomPreview> = { _, _ -> Result.failure(AN_EXCEPTION) },
+    private val getRoomPreviewInfoResult: (RoomIdOrAlias, List<String>) -> Result<RoomPreviewInfo> = { _, _ -> Result.failure(AN_EXCEPTION) },
    private val clearCacheLambda: () -> Unit = { lambdaError() },
    private val userIdServerNameLambda: () -> String = { lambdaError() },
    private val getUrlLambda: (String) -> Result<String> = { lambdaError() },
@@ -313,8 +313,8 @@ class FakeMatrixClient(
        resolveRoomAliasResult(roomAlias)
    }

-    override suspend fun getRoomPreview(roomIdOrAlias: RoomIdOrAlias, serverNames: List<String>): Result<RoomPreview> = simulateLongTask {
-        getRoomPreviewResult(roomIdOrAlias, serverNames)
+    override suspend fun getRoomPreviewInfo(roomIdOrAlias: RoomIdOrAlias, serverNames: List<String>): Result<RoomPreviewInfo> = simulateLongTask {
+        getRoomPreviewInfoResult(roomIdOrAlias, serverNames)
    }

    override suspend fun getRecentlyVisitedRooms(): Result<List<RoomId>> {