Add tests on RustSpaceRoomList

2025-09-11 14:51:56 +02:00
parent 2cc4bd5820
commit b1e6ab17c0
2 changed files with 176 additions and 0 deletions
--- a/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/fixtures/fakes/FakeFfiSpaceRoomList.kt
+++ b/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/fixtures/fakes/FakeFfiSpaceRoomList.kt
@@ -0,0 +1,58 @@
+/*
+ * 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.impl.fixtures.fakes
+
+import io.element.android.tests.testutils.lambda.lambdaError
+import io.element.android.tests.testutils.simulateLongTask
+import org.matrix.rustcomponents.sdk.NoPointer
+import org.matrix.rustcomponents.sdk.SpaceListUpdate
+import org.matrix.rustcomponents.sdk.SpaceRoom
+import org.matrix.rustcomponents.sdk.SpaceRoomList
+import org.matrix.rustcomponents.sdk.SpaceRoomListEntriesListener
+import org.matrix.rustcomponents.sdk.SpaceRoomListPaginationStateListener
+import org.matrix.rustcomponents.sdk.TaskHandle
+import uniffi.matrix_sdk_ui.SpaceRoomListPaginationState
+
+class FakeFfiSpaceRoomList(
+    private val paginateResult: () -> Unit = { lambdaError() },
+    private val paginationStateResult: () -> SpaceRoomListPaginationState = { lambdaError() },
+    private val roomsResult: () -> List<SpaceRoom> = { lambdaError() },
+) : SpaceRoomList(NoPointer) {
+    private var spaceRoomListPaginationStateListener: SpaceRoomListPaginationStateListener? = null
+    private var spaceRoomListEntriesListener: SpaceRoomListEntriesListener? = null
+
+    override suspend fun paginate() = simulateLongTask {
+        paginateResult()
+    }
+
+    override fun paginationState(): SpaceRoomListPaginationState {
+        return paginationStateResult()
+    }
+
+    override fun rooms(): List<SpaceRoom> {
+        return roomsResult()
+    }
+
+    override fun subscribeToPaginationStateUpdates(listener: SpaceRoomListPaginationStateListener): TaskHandle {
+        spaceRoomListPaginationStateListener = listener
+        return FakeFfiTaskHandle()
+    }
+
+    fun triggerPaginationStateUpdate(state: SpaceRoomListPaginationState) {
+        spaceRoomListPaginationStateListener?.onUpdate(state)
+    }
+
+    override fun subscribeToRoomUpdate(listener: SpaceRoomListEntriesListener): TaskHandle {
+        spaceRoomListEntriesListener = listener
+        return FakeFfiTaskHandle()
+    }
+
+    fun triggerRoomListUpdate(rooms: List<SpaceListUpdate>) {
+        spaceRoomListEntriesListener?.onUpdate(rooms)
+    }
+}
--- a/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/spaces/RustSpaceRoomListTest.kt
+++ b/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/spaces/RustSpaceRoomListTest.kt
@@ -0,0 +1,118 @@
+/*
+ * 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.
+ */
+
+@file:OptIn(ExperimentalCoroutinesApi::class)
+
+package io.element.android.libraries.matrix.impl.spaces
+
+import app.cash.turbine.test
+import com.google.common.truth.Truth.assertThat
+import io.element.android.libraries.matrix.api.core.RoomId
+import io.element.android.libraries.matrix.api.spaces.SpaceRoomList
+import io.element.android.libraries.matrix.impl.fixtures.factories.aRustSpaceRoom
+import io.element.android.libraries.matrix.impl.fixtures.fakes.FakeFfiSpaceRoomList
+import io.element.android.libraries.matrix.test.A_ROOM_ID
+import io.element.android.libraries.matrix.test.A_ROOM_ID_2
+import io.element.android.libraries.previewutils.room.aSpaceRoom
+import io.element.android.tests.testutils.lambda.lambdaRecorder
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.test.TestScope
+import kotlinx.coroutines.test.runCurrent
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+import org.matrix.rustcomponents.sdk.SpaceListUpdate
+import uniffi.matrix_sdk_ui.SpaceRoomListPaginationState
+import org.matrix.rustcomponents.sdk.SpaceRoomList as InnerSpaceRoomList
+
+class RustSpaceRoomListTest {
+    @Test
+    fun `paginationStatusFlow emits values`() = runTest {
+        val innerSpaceRoomList = FakeFfiSpaceRoomList(
+            paginationStateResult = { SpaceRoomListPaginationState.Idle(false) }
+        )
+        val sut = createRustSpaceRoomList(
+            innerSpaceRoomList = innerSpaceRoomList,
+        )
+        sut.paginationStatusFlow.test {
+            // First value is the initial one
+            assertThat(awaitItem()).isEqualTo(SpaceRoomList.PaginationStatus.Idle(hasMoreToLoad = false))
+            // First value after the subscription occurs
+            assertThat(awaitItem()).isEqualTo(SpaceRoomList.PaginationStatus.Idle(hasMoreToLoad = true))
+            innerSpaceRoomList.triggerPaginationStateUpdate(SpaceRoomListPaginationState.Loading)
+            assertThat(awaitItem()).isEqualTo(SpaceRoomList.PaginationStatus.Loading)
+            innerSpaceRoomList.triggerPaginationStateUpdate(SpaceRoomListPaginationState.Idle(true))
+            assertThat(awaitItem()).isEqualTo(SpaceRoomList.PaginationStatus.Idle(hasMoreToLoad = false))
+            innerSpaceRoomList.triggerPaginationStateUpdate(SpaceRoomListPaginationState.Idle(false))
+            assertThat(awaitItem()).isEqualTo(SpaceRoomList.PaginationStatus.Idle(hasMoreToLoad = true))
+        }
+    }
+
+    @Test
+    fun `spaceRoomsFlow emits values`() = runTest {
+        val innerSpaceRoomList = FakeFfiSpaceRoomList(
+            paginationStateResult = { SpaceRoomListPaginationState.Idle(false) }
+        )
+        val sut = createRustSpaceRoomList(
+            innerSpaceRoomList = innerSpaceRoomList,
+        )
+        sut.spaceRoomsFlow.test {
+            // Give time for the subscription to be set
+            runCurrent()
+            innerSpaceRoomList.triggerRoomListUpdate(
+                listOf(
+                    SpaceListUpdate.PushBack(aRustSpaceRoom(roomId = A_ROOM_ID_2))
+                )
+            )
+            val rooms = awaitItem()
+            assertThat(rooms).hasSize(1)
+            assertThat(rooms[0].roomId).isEqualTo(A_ROOM_ID_2)
+        }
+    }
+
+    @Test
+    fun `paginate invokes paginate on the inner class`() = runTest {
+        val paginateResult = lambdaRecorder<Unit> { }
+        val innerSpaceRoomList = FakeFfiSpaceRoomList(
+            paginateResult = paginateResult,
+        )
+        val sut = createRustSpaceRoomList(
+            innerSpaceRoomList = innerSpaceRoomList,
+        )
+        sut.paginate()
+        paginateResult.assertions().isCalledOnce()
+    }
+
+    @Test
+    fun `currentSpaceFlow reads value from the SpaceRoomCache`() = runTest {
+        val spaceRoomCache = SpaceRoomCache()
+        val sut = createRustSpaceRoomList(
+            spaceRoomCache = spaceRoomCache,
+        )
+        sut.currentSpaceFlow().test {
+            assertThat(awaitItem()).isNull()
+            val spaceRoom = aSpaceRoom(roomId = A_ROOM_ID)
+            spaceRoomCache.update(listOf(spaceRoom))
+            assertThat(awaitItem()).isEqualTo(spaceRoom)
+        }
+    }
+
+    private fun TestScope.createRustSpaceRoomList(
+        roomId: RoomId = A_ROOM_ID,
+        innerSpaceRoomList: InnerSpaceRoomList = FakeFfiSpaceRoomList(),
+        innerProvider: suspend () -> InnerSpaceRoomList = { innerSpaceRoomList },
+        spaceRoomMapper: SpaceRoomMapper = SpaceRoomMapper(),
+        spaceRoomCache: SpaceRoomCache = SpaceRoomCache(),
+    ): RustSpaceRoomList {
+        return RustSpaceRoomList(
+            roomId = roomId,
+            innerProvider = innerProvider,
+            sessionCoroutineScope = backgroundScope,
+            spaceRoomMapper = spaceRoomMapper,
+            spaceRoomCache = spaceRoomCache,
+        )
+    }
+}