Reduce API of JoinedRoom, caller must use the Timeline API from liveTimeline instead. (#4731)

This removes lots of boilerplate code.
2025-05-20 09:07:43 +02:00 · 2025-05-20 09:07:43 +02:00 · 8d115213cc
commit 8d115213cc
parent 3cf8237d29
20 changed files with 258 additions and 651 deletions
--- 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
@ -424,7 +424,7 @@ class MessageComposerPresenter @AssistedInject constructor(
        resetComposer(markdownTextEditorState, richTextEditorState, fromEdit = capturedMode is MessageComposerMode.Edit)
        when (capturedMode) {
            is MessageComposerMode.Attachment,
-            is MessageComposerMode.Normal -> room.sendMessage(
+            is MessageComposerMode.Normal -> room.liveTimeline.sendMessage(
                body = message.markdown,
                htmlBody = message.html,
                intentionalMentions = message.intentionalMentions
--- a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/MessagesPresenterTest.kt
+++ b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/MessagesPresenterTest.kt
@ -5,6 +5,8 @@
 * Please see LICENSE files in the repository root for full details.
 */

+@file:OptIn(ExperimentalCoroutinesApi::class)
+
 package io.element.android.features.messages.impl

 import androidx.lifecycle.Lifecycle
@ -96,6 +98,7 @@ import kotlinx.collections.immutable.persistentListOf
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.test.TestScope
+import kotlinx.coroutines.test.advanceUntilIdle
 import kotlinx.coroutines.test.runCurrent
 import kotlinx.coroutines.test.runTest
 import org.junit.Rule
@ -173,12 +176,14 @@ class MessagesPresenterTest {
            skipItems(1)
            val initialState = awaitItem()
            initialState.eventSink(MessagesEvents.ToggleReaction("👍", AN_EVENT_ID.toEventOrTransactionId()))
+            advanceUntilIdle()
            assert(toggleReactionSuccess)
                .isCalledOnce()
                .with(value("👍"), value(AN_EVENT_ID.toEventOrTransactionId()))
            // No crashes when sending a reaction failed
-            timeline.apply { toggleReactionLambda = toggleReactionFailure }
+            timeline.toggleReactionLambda = toggleReactionFailure
            initialState.eventSink(MessagesEvents.ToggleReaction("👍", AN_EVENT_ID.toEventOrTransactionId()))
+            advanceUntilIdle()
            assert(toggleReactionFailure)
                .isCalledOnce()
                .with(value("👍"), value(AN_EVENT_ID.toEventOrTransactionId()))
@ -209,6 +214,7 @@ class MessagesPresenterTest {
            val initialState = awaitItem()
            initialState.eventSink(MessagesEvents.ToggleReaction("👍", AN_EVENT_ID.toEventOrTransactionId()))
            initialState.eventSink(MessagesEvents.ToggleReaction("👍", AN_EVENT_ID.toEventOrTransactionId()))
+            advanceUntilIdle()
            assert(toggleReactionSuccess)
                .isCalledExactly(2)
                .withSequence(
--- a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/attachments/AttachmentsPreviewPresenterTest.kt
+++ b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/attachments/AttachmentsPreviewPresenterTest.kt
@ -35,6 +35,7 @@ import io.element.android.libraries.matrix.test.A_CAPTION
 import io.element.android.libraries.matrix.test.media.FakeMediaUploadHandler
 import io.element.android.libraries.matrix.test.permalink.FakePermalinkBuilder
 import io.element.android.libraries.matrix.test.room.FakeJoinedRoom
+import io.element.android.libraries.matrix.test.timeline.FakeTimeline
 import io.element.android.libraries.mediaupload.api.MediaPreProcessor
 import io.element.android.libraries.mediaupload.api.MediaSender
 import io.element.android.libraries.mediaupload.api.MediaUploadInfo
@ -108,15 +109,18 @@ class AttachmentsPreviewPresenterTest {
    fun `present - send media success scenario`() = runTest {
        val sendFileResult =
            lambdaRecorder<File, FileInfo, String?, String?, ProgressCallback?, ReplyParameters?, Result<FakeMediaUploadHandler>> { _, _, _, _, _, _ ->
-            Result.success(FakeMediaUploadHandler())
-        }
+                Result.success(FakeMediaUploadHandler())
+            }
        val room = FakeJoinedRoom(
-            progressCallbackValues = listOf(
-                Pair(0, 10),
-                Pair(5, 10),
-                Pair(10, 10)
-            ),
-            sendFileResult = sendFileResult,
+            liveTimeline = FakeTimeline(
+                progressCallbackValues = listOf(
+                    Pair(0, 10),
+                    Pair(5, 10),
+                    Pair(10, 10)
+                ),
+            ).apply {
+                sendFileLambda = sendFileResult
+            },
        )
        val onDoneListener = lambdaRecorder<Unit> { }
        val presenter = createAttachmentsPreviewPresenter(
@ -146,10 +150,12 @@ class AttachmentsPreviewPresenterTest {
    fun `present - send media after pre-processing success scenario`() = runTest {
        val sendFileResult =
            lambdaRecorder<File, FileInfo, String?, String?, ProgressCallback?, ReplyParameters?, Result<FakeMediaUploadHandler>> { _, _, _, _, _, _ ->
-            Result.success(FakeMediaUploadHandler())
-        }
+                Result.success(FakeMediaUploadHandler())
+            }
        val room = FakeJoinedRoom(
-            sendFileResult = sendFileResult,
+            liveTimeline = FakeTimeline().apply {
+                sendFileLambda = sendFileResult
+            },
        )
        val onDoneListener = lambdaRecorder<Unit> { }
        val processLatch = CompletableDeferred<Unit>()
@ -182,10 +188,12 @@ class AttachmentsPreviewPresenterTest {
    fun `present - send media before pre-processing success scenario`() = runTest {
        val sendFileResult =
            lambdaRecorder<File, FileInfo, String?, String?, ProgressCallback?, ReplyParameters?, Result<FakeMediaUploadHandler>> { _, _, _, _, _, _ ->
-            Result.success(FakeMediaUploadHandler())
-        }
+                Result.success(FakeMediaUploadHandler())
+            }
        val room = FakeJoinedRoom(
-            sendFileResult = sendFileResult,
+            liveTimeline = FakeTimeline().apply {
+                sendFileLambda = sendFileResult
+            },
        )
        val onDoneListener = lambdaRecorder<Unit> { }
        val processLatch = CompletableDeferred<Unit>()
@ -298,7 +306,9 @@ class AttachmentsPreviewPresenterTest {
            givenImageResult()
        }
        val room = FakeJoinedRoom(
-            sendImageResult = sendImageResult,
+            liveTimeline = FakeTimeline().apply {
+                sendImageLambda = sendImageResult
+            },
        )
        val onDoneListener = lambdaRecorder<Unit> { }
        val presenter = createAttachmentsPreviewPresenter(
@ -340,7 +350,9 @@ class AttachmentsPreviewPresenterTest {
            givenVideoResult()
        }
        val room = FakeJoinedRoom(
-            sendVideoResult = sendVideoResult,
+            liveTimeline = FakeTimeline().apply {
+                sendVideoLambda = sendVideoResult
+            },
        )
        val onDoneListener = lambdaRecorder<Unit> { }
        val presenter = createAttachmentsPreviewPresenter(
@ -382,7 +394,9 @@ class AttachmentsPreviewPresenterTest {
            givenAudioResult()
        }
        val room = FakeJoinedRoom(
-            sendAudioResult = sendAudioResult,
+            liveTimeline = FakeTimeline().apply {
+                sendAudioLambda = sendAudioResult
+            },
        )
        val onDoneListener = lambdaRecorder<Unit> { }
        val presenter = createAttachmentsPreviewPresenter(
@ -416,10 +430,12 @@ class AttachmentsPreviewPresenterTest {
        val failure = MediaPreProcessor.Failure(null)
        val sendFileResult =
            lambdaRecorder<File, FileInfo, String?, String?, ProgressCallback?, ReplyParameters?, Result<FakeMediaUploadHandler>> { _, _, _, _, _, _ ->
-            Result.failure(failure)
-        }
+                Result.failure(failure)
+            }
        val room = FakeJoinedRoom(
-            sendFileResult = sendFileResult,
+            liveTimeline = FakeTimeline().apply {
+                sendFileLambda = sendFileResult
+            },
        )
        val presenter = createAttachmentsPreviewPresenter(room = room, mediaUploadOnSendQueueEnabled = false)
        moleculeFlow(RecompositionMode.Immediate) {
@ -445,11 +461,13 @@ class AttachmentsPreviewPresenterTest {
        val failure = MediaPreProcessor.Failure(null)
        val sendFileResult =
            lambdaRecorder<File, FileInfo, String?, String?, ProgressCallback?, ReplyParameters?, Result<FakeMediaUploadHandler>> { _, _, _, _, _, _ ->
-            Result.failure(failure)
-        }
+                Result.failure(failure)
+            }
        val onDoneListenerResult = lambdaRecorder<Unit> {}
        val room = FakeJoinedRoom(
-            sendFileResult = sendFileResult,
+            liveTimeline = FakeTimeline().apply {
+                sendFileLambda = sendFileResult
+            },
        )
        val presenter = createAttachmentsPreviewPresenter(room = room, mediaUploadOnSendQueueEnabled = true, onDoneListener = onDoneListenerResult)
        moleculeFlow(RecompositionMode.Immediate) {
--- a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/messagecomposer/MessageComposerPresenterTest.kt
+++ b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/messagecomposer/MessageComposerPresenterTest.kt
@ -384,7 +384,9 @@ class MessageComposerPresenterTest {
        val presenter = createPresenter(
            coroutineScope = this,
            room = FakeJoinedRoom(
-                sendMessageResult = { _, _, _ -> Result.success(Unit) },
+                liveTimeline = FakeTimeline().apply {
+                    sendMessageLambda = { _, _, _ -> Result.success(Unit) }
+                },
                typingNoticeResult = { Result.success(Unit) }
            ),
        )
@ -418,7 +420,9 @@ class MessageComposerPresenterTest {
            coroutineScope = this,
            isRichTextEditorEnabled = false,
            room = FakeJoinedRoom(
-                sendMessageResult = { _, _, _ -> Result.success(Unit) },
+                liveTimeline = FakeTimeline().apply {
+                    sendMessageLambda = { _, _, _ -> Result.success(Unit) }
+                },
                typingNoticeResult = { Result.success(Unit) }
            ),
        )
@ -1118,16 +1122,16 @@ class MessageComposerPresenterTest {
        val editMessageLambda = lambdaRecorder { _: EventOrTransactionId, _: String, _: String?, _: List<IntentionalMention> ->
            Result.success(Unit)
        }
-        val timeline = FakeTimeline().apply {
-            this.replyMessageLambda = replyMessageLambda
-            this.editMessageLambda = editMessageLambda
-        }
        val sendMessageResult = lambdaRecorder { _: String, _: String?, _: List<IntentionalMention> ->
            Result.success(Unit)
        }
+        val timeline = FakeTimeline().apply {
+            this.replyMessageLambda = replyMessageLambda
+            this.editMessageLambda = editMessageLambda
+            sendMessageLambda = sendMessageResult
+        }
        val room = FakeJoinedRoom(
            liveTimeline = timeline,
-            sendMessageResult = sendMessageResult,
            typingNoticeResult = { Result.success(Unit) }
        )
        val presenter = createPresenter(room = room, coroutineScope = this)
--- a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/voicemessages/composer/VoiceMessageComposerPresenterTest.kt
+++ b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/voicemessages/composer/VoiceMessageComposerPresenterTest.kt
@ -24,6 +24,7 @@ import io.element.android.libraries.matrix.api.media.AudioInfo
 import io.element.android.libraries.matrix.api.room.message.ReplyParameters
 import io.element.android.libraries.matrix.test.media.FakeMediaUploadHandler
 import io.element.android.libraries.matrix.test.room.FakeJoinedRoom
+import io.element.android.libraries.matrix.test.timeline.FakeTimeline
 import io.element.android.libraries.mediaplayer.test.FakeMediaPlayer
 import io.element.android.libraries.mediaupload.api.MediaSender
 import io.element.android.libraries.mediaupload.test.FakeMediaPreProcessor
@ -45,6 +46,7 @@ import kotlinx.collections.immutable.toImmutableList
 import kotlinx.collections.immutable.toPersistentList
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.test.TestScope
+import kotlinx.coroutines.test.advanceUntilIdle
 import kotlinx.coroutines.test.runTest
 import org.junit.Rule
 import org.junit.Test
@ -65,7 +67,9 @@ class VoiceMessageComposerPresenterTest {
            Result.success(FakeMediaUploadHandler())
        }
    private val joinedRoom = FakeJoinedRoom(
-        sendVoiceMessageResult = sendVoiceMessageResult
+        liveTimeline = FakeTimeline().apply {
+            sendVoiceMessageLambda = sendVoiceMessageResult
+        },
    )
    private val mediaPreProcessor = FakeMediaPreProcessor().apply { givenAudioResult() }
    private val mediaSender = MediaSender(mediaPreProcessor, joinedRoom, InMemorySessionPreferencesStore())
@ -295,7 +299,6 @@ class VoiceMessageComposerPresenterTest {
            awaitItem().eventSink(VoiceMessageComposerEvents.RecorderEvent(VoiceMessageRecorderEvent.Stop))
            awaitItem().eventSink(VoiceMessageComposerEvents.SendVoiceMessage)
            assertThat(awaitItem().voiceMessageState).isEqualTo(aPreviewState().toSendingState())
-
            val finalState = awaitItem()
            assertThat(finalState.voiceMessageState).isEqualTo(VoiceMessageState.Idle)
            sendVoiceMessageResult.assertions().isCalledOnce()
@ -317,7 +320,7 @@ class VoiceMessageComposerPresenterTest {
            awaitItem().eventSink(VoiceMessageComposerEvents.RecorderEvent(VoiceMessageRecorderEvent.Stop))
            awaitItem().eventSink(VoiceMessageComposerEvents.SendVoiceMessage)
            skipItems(1) // Sending state
-
+            advanceUntilIdle()
            // Now reply with a voice message
            messageComposerContext.composerMode = aReplyMode()
            awaitItem().eventSink(VoiceMessageComposerEvents.RecorderEvent(VoiceMessageRecorderEvent.Start))
@ -653,7 +656,7 @@ class VoiceMessageComposerPresenterTest {
        permissionsPresenter: PermissionsPresenter = createFakePermissionsPresenter(),
    ): VoiceMessageComposerPresenter {
        return VoiceMessageComposerPresenter(
-            this,
+            backgroundScope,
            voiceRecorder,
            analyticsService,
            mediaSender,