Stop voice message on redaction (#1826)

As per product spec: Voice messages must stop playing when redacted.
2023-11-20 10:48:25 +01:00
parent af8f5b805c
commit 2e62671cda
6 changed files with 222 additions and 2 deletions
--- a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/TimelinePresenter.kt
+++ b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/TimelinePresenter.kt
@@ -32,6 +32,7 @@ import im.vector.app.features.analytics.plan.PollVote
 import io.element.android.features.messages.impl.timeline.factories.TimelineItemsFactory
 import io.element.android.features.messages.impl.timeline.model.TimelineItem
 import io.element.android.features.messages.impl.timeline.session.SessionState
+import io.element.android.features.messages.impl.voicemessages.timeline.RedactedVoiceMessageManager
 import io.element.android.libraries.architecture.Presenter
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.matrix.api.core.EventId
@@ -63,6 +64,7 @@ class TimelinePresenter @Inject constructor(
    private val analyticsService: AnalyticsService,
    private val verificationService: SessionVerificationService,
    private val encryptionService: EncryptionService,
+    private val redactedVoiceMessageManager: RedactedVoiceMessageManager,
 ) : Presenter<TimelineState> {

    private val timeline = room.timeline
@@ -142,6 +144,7 @@ class TimelinePresenter @Inject constructor(
                        paginateBackwards()
                    }
                }
+                .onEach(redactedVoiceMessageManager::onEachMatrixTimelineItem)
                .launchIn(this)
        }

--- a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/voicemessages/timeline/RedactedVoiceMessageManager.kt
+++ b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/voicemessages/timeline/RedactedVoiceMessageManager.kt
@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2023 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.features.messages.impl.voicemessages.timeline
+
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.libraries.core.coroutine.CoroutineDispatchers
+import io.element.android.libraries.di.RoomScope
+import io.element.android.libraries.matrix.api.timeline.MatrixTimelineItem
+import io.element.android.libraries.matrix.api.timeline.item.event.RedactedContent
+import io.element.android.libraries.mediaplayer.api.MediaPlayer
+import kotlinx.coroutines.withContext
+import javax.inject.Inject
+
+interface RedactedVoiceMessageManager {
+    suspend fun onEachMatrixTimelineItem(timelineItems: List<MatrixTimelineItem>)
+}
+
+@ContributesBinding(RoomScope::class)
+class DefaultRedactedVoiceMessageManager @Inject constructor(
+    private val dispatchers: CoroutineDispatchers,
+    private val mediaPlayer: MediaPlayer,
+) : RedactedVoiceMessageManager {
+    override suspend fun onEachMatrixTimelineItem(timelineItems: List<MatrixTimelineItem>) {
+        withContext(dispatchers.computation) {
+            mediaPlayer.state.value.let { playerState ->
+                if (playerState.isPlaying && playerState.mediaId != null) {
+                    val needsToPausePlayer = timelineItems.any {
+                        it is MatrixTimelineItem.Event &&
+                            playerState.mediaId == it.eventId?.value &&
+                            it.event.content is RedactedContent
+                    }
+                    if (needsToPausePlayer) {
+                        withContext(dispatchers.main) { mediaPlayer.pause() }
+                    }
+                }
+            }
+        }
+    }
+}
--- a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/MessagesPresenterTest.kt
+++ b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/MessagesPresenterTest.kt
@@ -47,6 +47,7 @@ import io.element.android.features.messages.test.FakeMessageComposerContext
 import io.element.android.features.messages.textcomposer.TestRichTextEditorStateFactory
 import io.element.android.features.messages.timeline.components.customreaction.FakeEmojibaseProvider
 import io.element.android.features.messages.utils.messagesummary.FakeMessageSummaryFormatter
+import io.element.android.features.messages.voicemessages.timeline.FakeRedactedVoiceMessageManager
 import io.element.android.features.networkmonitor.test.FakeNetworkMonitor
 import io.element.android.libraries.androidutils.clipboard.FakeClipboardHelper
 import io.element.android.libraries.architecture.Async
@@ -653,6 +654,7 @@ class MessagesPresenterTest {
            analyticsService = analyticsService,
            encryptionService = FakeEncryptionService(),
            verificationService = FakeSessionVerificationService(),
+            redactedVoiceMessageManager = FakeRedactedVoiceMessageManager(),
        )
        val preferencesStore = InMemoryPreferencesStore(isRichTextEditorEnabled = true)
        val actionListPresenter = ActionListPresenter(preferencesStore = preferencesStore)
--- a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/timeline/TimelinePresenterTest.kt
+++ b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/timeline/TimelinePresenterTest.kt
@@ -24,11 +24,14 @@ import im.vector.app.features.analytics.plan.PollEnd
 import im.vector.app.features.analytics.plan.PollVote
 import io.element.android.features.messages.fixtures.aMessageEvent
 import io.element.android.features.messages.fixtures.aTimelineItemsFactory
-import io.element.android.features.messages.impl.timeline.session.SessionState
 import io.element.android.features.messages.impl.timeline.TimelineEvents
 import io.element.android.features.messages.impl.timeline.TimelinePresenter
 import io.element.android.features.messages.impl.timeline.factories.TimelineItemsFactory
 import io.element.android.features.messages.impl.timeline.model.TimelineItem
+import io.element.android.features.messages.impl.timeline.session.SessionState
+import io.element.android.features.messages.impl.voicemessages.timeline.RedactedVoiceMessageManager
+import io.element.android.features.messages.voicemessages.timeline.FakeRedactedVoiceMessageManager
+import io.element.android.features.messages.voicemessages.timeline.aRedactedMatrixTimeline
 import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.timeline.MatrixTimeline
 import io.element.android.libraries.matrix.api.timeline.MatrixTimelineItem
@@ -310,9 +313,31 @@ class TimelinePresenterTest {
        }
    }

+    @Test
+    fun `present - side effect on redacted items is invoked`() = runTest {
+        val redactedVoiceMessageManager = FakeRedactedVoiceMessageManager()
+        val presenter = createTimelinePresenter(
+            timeline = FakeMatrixTimeline(
+                initialTimelineItems = aRedactedMatrixTimeline(AN_EVENT_ID),
+            ),
+            redactedVoiceMessageManager = redactedVoiceMessageManager,
+        )
+        moleculeFlow(RecompositionMode.Immediate) {
+            presenter.present()
+        }.test {
+            skipItems(1) // skip initial state
+            assertThat(redactedVoiceMessageManager.invocations.size).isEqualTo(0)
+            awaitItem().let {
+                assertThat(it.timelineItems).isNotEmpty()
+                assertThat(redactedVoiceMessageManager.invocations.size).isEqualTo(1)
+            }
+        }
+    }
+
    private fun TestScope.createTimelinePresenter(
        timeline: MatrixTimeline = FakeMatrixTimeline(),
-        timelineItemsFactory: TimelineItemsFactory = aTimelineItemsFactory()
+        timelineItemsFactory: TimelineItemsFactory = aTimelineItemsFactory(),
+        redactedVoiceMessageManager: RedactedVoiceMessageManager = FakeRedactedVoiceMessageManager(),
    ): TimelinePresenter {
        return TimelinePresenter(
            timelineItemsFactory = timelineItemsFactory,
@@ -322,6 +347,7 @@ class TimelinePresenterTest {
            analyticsService = FakeAnalyticsService(),
            encryptionService = FakeEncryptionService(),
            verificationService = FakeSessionVerificationService(),
+            redactedVoiceMessageManager = redactedVoiceMessageManager,
        )
    }

@@ -337,6 +363,7 @@ class TimelinePresenterTest {
            analyticsService = analyticsService,
            encryptionService = FakeEncryptionService(),
            verificationService = FakeSessionVerificationService(),
+            redactedVoiceMessageManager = FakeRedactedVoiceMessageManager(),
        )
    }
 }
--- a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/voicemessages/timeline/FakeRedactedVoiceMessageManager.kt
+++ b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/voicemessages/timeline/FakeRedactedVoiceMessageManager.kt
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2023 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.features.messages.voicemessages.timeline
+
+import io.element.android.features.messages.impl.voicemessages.timeline.RedactedVoiceMessageManager
+import io.element.android.libraries.matrix.api.timeline.MatrixTimelineItem
+
+class FakeRedactedVoiceMessageManager : RedactedVoiceMessageManager {
+
+    private val _invocations: MutableList<List<MatrixTimelineItem>> = mutableListOf()
+    val invocations: List<List<MatrixTimelineItem>>
+        get() = _invocations
+
+    override suspend fun onEachMatrixTimelineItem(timelineItems: List<MatrixTimelineItem>) {
+        _invocations.add(timelineItems)
+    }
+}
--- a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/voicemessages/timeline/RedactedVoiceMessageManagerTest.kt
+++ b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/voicemessages/timeline/RedactedVoiceMessageManagerTest.kt
@@ -0,0 +1,104 @@
+/*
+ * Copyright (c) 2023 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.features.messages.voicemessages.timeline
+
+import com.google.common.truth.Truth
+import io.element.android.features.messages.impl.voicemessages.timeline.DefaultRedactedVoiceMessageManager
+import io.element.android.libraries.matrix.api.core.EventId
+import io.element.android.libraries.matrix.api.timeline.MatrixTimelineItem
+import io.element.android.libraries.matrix.api.timeline.item.TimelineItemDebugInfo
+import io.element.android.libraries.matrix.api.timeline.item.event.EventTimelineItem
+import io.element.android.libraries.matrix.api.timeline.item.event.ProfileTimelineDetails
+import io.element.android.libraries.matrix.api.timeline.item.event.RedactedContent
+import io.element.android.libraries.matrix.test.AN_EVENT_ID
+import io.element.android.libraries.matrix.test.AN_EVENT_ID_2
+import io.element.android.libraries.matrix.test.A_USER_ID
+import io.element.android.libraries.mediaplayer.api.MediaPlayer
+import io.element.android.libraries.mediaplayer.test.FakeMediaPlayer
+import io.element.android.tests.testutils.testCoroutineDispatchers
+import kotlinx.coroutines.test.TestScope
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+
+class RedactedVoiceMessageManagerTest {
+    @Test
+    fun `redacted event - no playing related media`() = runTest {
+        val mediaPlayer = FakeMediaPlayer().apply {
+            setMedia(uri = "someUri", mediaId = AN_EVENT_ID.value, mimeType = "audio/ogg")
+            play()
+        }
+        val manager = aDefaultRedactedVoiceMessageManager(mediaPlayer = mediaPlayer)
+
+        Truth.assertThat(mediaPlayer.state.value.mediaId).isEqualTo(AN_EVENT_ID.value)
+        Truth.assertThat(mediaPlayer.state.value.isPlaying).isTrue()
+
+        manager.onEachMatrixTimelineItem(aRedactedMatrixTimeline(AN_EVENT_ID_2))
+
+        Truth.assertThat(mediaPlayer.state.value.mediaId).isEqualTo(AN_EVENT_ID.value)
+        Truth.assertThat(mediaPlayer.state.value.isPlaying).isTrue()
+    }
+
+    @Test
+    fun `redacted event - playing related media is paused`() = runTest {
+        val mediaPlayer = FakeMediaPlayer().apply {
+            setMedia(uri = "someUri", mediaId = AN_EVENT_ID.value, mimeType = "audio/ogg")
+            play()
+        }
+        val manager = aDefaultRedactedVoiceMessageManager(mediaPlayer = mediaPlayer)
+
+        Truth.assertThat(mediaPlayer.state.value.mediaId).isEqualTo(AN_EVENT_ID.value)
+        Truth.assertThat(mediaPlayer.state.value.isPlaying).isTrue()
+
+        manager.onEachMatrixTimelineItem(aRedactedMatrixTimeline(AN_EVENT_ID))
+
+        Truth.assertThat(mediaPlayer.state.value.mediaId).isEqualTo(AN_EVENT_ID.value)
+        Truth.assertThat(mediaPlayer.state.value.isPlaying).isFalse()
+    }
+}
+
+fun TestScope.aDefaultRedactedVoiceMessageManager(
+    mediaPlayer: MediaPlayer = FakeMediaPlayer(),
+) = DefaultRedactedVoiceMessageManager(
+    dispatchers = this.testCoroutineDispatchers(true),
+    mediaPlayer = mediaPlayer,
+)
+
+fun aRedactedMatrixTimeline(eventId: EventId) = listOf<MatrixTimelineItem>(
+    MatrixTimelineItem.Event(
+        uniqueId = 0,
+        event = EventTimelineItem(
+            eventId = eventId,
+            transactionId = null,
+            isEditable = false,
+            isLocal = false,
+            isOwn = false,
+            isRemote = false,
+            localSendState = null,
+            reactions = listOf(),
+            sender = A_USER_ID,
+            senderProfile = ProfileTimelineDetails.Unavailable,
+            timestamp = 9442,
+            content = RedactedContent,
+            debugInfo = TimelineItemDebugInfo(
+                model = "enim",
+                originalJson = null,
+                latestEditedJson = null
+            ),
+            origin = null
+        ),
+    )
+)