Merge pull request #4036 from element-hq/feature/bma/extractVoiceMess…

…agePlayer Extract voice message player to its own module
element-hq · Dec 13, 2024 · 3643ec3 · 3643ec3
2 parents 3f90004 + f74258d
commit 3643ec3
Show file tree

Hide file tree

Showing 23 changed files with 321 additions and 141 deletions.
diff --git a/features/messages/impl/build.gradle.kts b/features/messages/impl/build.gradle.kts
@@ -47,6 +47,7 @@ dependencies {
     implementation(projects.libraries.permissions.api)
     implementation(projects.libraries.preferences.api)
     implementation(projects.libraries.roomselect.api)
+    implementation(projects.libraries.voiceplayer.api)
     implementation(projects.libraries.voicerecorder.api)
     implementation(projects.libraries.mediaplayer.api)
     implementation(projects.libraries.uiUtils)

diff --git a/.../android/features/messages/impl/timeline/components/event/TimelineItemEventContentView.kt b/.../android/features/messages/impl/timeline/components/event/TimelineItemEventContentView.kt
@@ -29,8 +29,8 @@ import io.element.android.features.messages.impl.timeline.model.event.TimelineIt
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemUnknownContent
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemVideoContent
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemVoiceContent
-import io.element.android.features.messages.impl.voicemessages.timeline.VoiceMessageState
 import io.element.android.libraries.architecture.Presenter
+import io.element.android.libraries.voiceplayer.api.VoiceMessageState
 
 @Composable
 fun TimelineItemEventContentView(

diff --git a/...element/android/features/messages/impl/timeline/components/event/TimelineItemVoiceView.kt b/...element/android/features/messages/impl/timeline/components/event/TimelineItemVoiceView.kt
@@ -40,9 +40,6 @@ import io.element.android.compound.tokens.generated.CompoundIcons
 import io.element.android.features.messages.impl.timeline.components.layout.ContentAvoidingLayoutData
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemVoiceContent
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemVoiceContentProvider
-import io.element.android.features.messages.impl.voicemessages.timeline.VoiceMessageEvents
-import io.element.android.features.messages.impl.voicemessages.timeline.VoiceMessageState
-import io.element.android.features.messages.impl.voicemessages.timeline.VoiceMessageStateProvider
 import io.element.android.libraries.androidutils.accessibility.isScreenReaderEnabled
 import io.element.android.libraries.designsystem.components.media.WaveformPlaybackView
 import io.element.android.libraries.designsystem.preview.ElementPreview
@@ -52,6 +49,9 @@ import io.element.android.libraries.designsystem.theme.components.Icon
 import io.element.android.libraries.designsystem.theme.components.IconButton
 import io.element.android.libraries.designsystem.theme.components.Text
 import io.element.android.libraries.ui.strings.CommonStrings
+import io.element.android.libraries.voiceplayer.api.VoiceMessageEvents
+import io.element.android.libraries.voiceplayer.api.VoiceMessageState
+import io.element.android.libraries.voiceplayer.api.VoiceMessageStateProvider
 import kotlinx.coroutines.delay
 
 @Composable

diff --git a/.../element/android/features/messages/impl/timeline/di/FakeTimelineItemPresenterFactories.kt b/.../element/android/features/messages/impl/timeline/di/FakeTimelineItemPresenterFactories.kt
@@ -8,9 +8,9 @@
 package io.element.android.features.messages.impl.timeline.di
 
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemVoiceContent
-import io.element.android.features.messages.impl.voicemessages.timeline.VoiceMessageState
-import io.element.android.features.messages.impl.voicemessages.timeline.aVoiceMessageState
 import io.element.android.libraries.architecture.Presenter
+import io.element.android.libraries.voiceplayer.api.VoiceMessageState
+import io.element.android.libraries.voiceplayer.api.aVoiceMessageState
 
 /**
  * A fake [TimelineItemPresenterFactories] for screenshot tests.

diff --git a/...nt/android/features/messages/impl/voicemessages/composer/VoiceMessageComposerPresenter.kt b/...nt/android/features/messages/impl/voicemessages/composer/VoiceMessageComposerPresenter.kt
@@ -21,14 +21,14 @@ import androidx.core.net.toUri
 import androidx.lifecycle.Lifecycle
 import im.vector.app.features.analytics.plan.Composer
 import io.element.android.features.messages.api.MessageComposerContext
-import io.element.android.features.messages.impl.voicemessages.VoiceMessageException
 import io.element.android.libraries.architecture.Presenter
 import io.element.android.libraries.mediaupload.api.MediaSender
 import io.element.android.libraries.permissions.api.PermissionsEvents
 import io.element.android.libraries.permissions.api.PermissionsPresenter
 import io.element.android.libraries.textcomposer.model.VoiceMessagePlayerEvent
 import io.element.android.libraries.textcomposer.model.VoiceMessageRecorderEvent
 import io.element.android.libraries.textcomposer.model.VoiceMessageState
+import io.element.android.libraries.voiceplayer.api.VoiceMessageException
 import io.element.android.libraries.voicerecorder.api.VoiceRecorder
 import io.element.android.libraries.voicerecorder.api.VoiceRecorderState
 import io.element.android.services.analytics.api.AnalyticsService

diff --git a/...io/element/android/features/messages/impl/voicemessages/timeline/VoiceMessagePresenter.kt b/...io/element/android/features/messages/impl/voicemessages/timeline/VoiceMessagePresenter.kt
@@ -8,11 +8,6 @@
 package io.element.android.features.messages.impl.voicemessages.timeline
 
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.collectAsState
-import androidx.compose.runtime.derivedStateOf
-import androidx.compose.runtime.getValue
-import androidx.compose.runtime.mutableStateOf
-import androidx.compose.runtime.remember
 import com.squareup.anvil.annotations.ContributesTo
 import dagger.Binds
 import dagger.Module
@@ -23,17 +18,10 @@ import dagger.multibindings.IntoMap
 import io.element.android.features.messages.impl.timeline.di.TimelineItemEventContentKey
 import io.element.android.features.messages.impl.timeline.di.TimelineItemPresenterFactory
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemVoiceContent
-import io.element.android.features.messages.impl.voicemessages.VoiceMessageException
-import io.element.android.libraries.architecture.AsyncData
 import io.element.android.libraries.architecture.Presenter
-import io.element.android.libraries.architecture.runUpdatingState
-import io.element.android.libraries.core.extensions.flatMap
 import io.element.android.libraries.di.RoomScope
-import io.element.android.libraries.ui.utils.time.formatShort
-import io.element.android.services.analytics.api.AnalyticsService
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.launch
-import kotlin.time.Duration.Companion.milliseconds
+import io.element.android.libraries.voiceplayer.api.VoiceMessagePresenterFactory
+import io.element.android.libraries.voiceplayer.api.VoiceMessageState
 
 @Module
 @ContributesTo(RoomScope::class)
@@ -45,107 +33,24 @@ interface VoiceMessagePresenterModule {
 }
 
 class VoiceMessagePresenter @AssistedInject constructor(
-    voiceMessagePlayerFactory: VoiceMessagePlayer.Factory,
-    private val analyticsService: AnalyticsService,
-    private val scope: CoroutineScope,
+    voiceMessagePresenterFactory: VoiceMessagePresenterFactory,
     @Assisted private val content: TimelineItemVoiceContent,
 ) : Presenter<VoiceMessageState> {
     @AssistedFactory
     fun interface Factory : TimelineItemPresenterFactory<TimelineItemVoiceContent, VoiceMessageState> {
         override fun create(content: TimelineItemVoiceContent): VoiceMessagePresenter
     }
 
-    private val player = voiceMessagePlayerFactory.create(
+    private val presenter = voiceMessagePresenterFactory.createVoiceMessagePresenter(
         eventId = content.eventId,
         mediaSource = content.mediaSource,
         mimeType = content.mimeType,
         filename = content.filename,
+        duration = content.duration,
     )
 
-    private val play = mutableStateOf<AsyncData<Unit>>(AsyncData.Uninitialized)
-
     @Composable
     override fun present(): VoiceMessageState {
-        val playerState by player.state.collectAsState(
-            VoiceMessagePlayer.State(
-                isReady = false,
-                isPlaying = false,
-                isEnded = false,
-                currentPosition = 0L,
-                duration = null
-            )
-        )
-
-        val button by remember {
-            derivedStateOf {
-                when {
-                    content.eventId == null -> VoiceMessageState.Button.Disabled
-                    playerState.isPlaying -> VoiceMessageState.Button.Pause
-                    play.value is AsyncData.Loading -> VoiceMessageState.Button.Downloading
-                    play.value is AsyncData.Failure -> VoiceMessageState.Button.Retry
-                    else -> VoiceMessageState.Button.Play
-                }
-            }
-        }
-        val duration by remember {
-            derivedStateOf { playerState.duration ?: content.duration.inWholeMilliseconds }
-        }
-        val progress by remember {
-            derivedStateOf {
-                playerState.currentPosition / duration.toFloat()
-            }
-        }
-        val time by remember {
-            derivedStateOf {
-                when {
-                    playerState.isReady && !playerState.isEnded -> playerState.currentPosition
-                    playerState.currentPosition > 0 -> playerState.currentPosition
-                    else -> duration
-                }.milliseconds.formatShort()
-            }
-        }
-        val showCursor by remember {
-            derivedStateOf {
-                !play.value.isUninitialized() && !playerState.isEnded
-            }
-        }
-
-        fun eventSink(event: VoiceMessageEvents) {
-            when (event) {
-                is VoiceMessageEvents.PlayPause -> {
-                    if (playerState.isPlaying) {
-                        player.pause()
-                    } else if (playerState.isReady) {
-                        player.play()
-                    } else {
-                        scope.launch {
-                            play.runUpdatingState(
-                                errorTransform = {
-                                    analyticsService.trackError(
-                                        VoiceMessageException.PlayMessageError("Error while trying to play voice message", it)
-                                    )
-                                    it
-                                },
-                            ) {
-                                player.prepare().flatMap {
-                                    runCatching { player.play() }
-                                }
-                            }
-                        }
-                    }
-                }
-                is VoiceMessageEvents.Seek -> {
-                    player.seekTo((event.percentage * duration).toLong())
-                }
-            }
-        }
-
-        return VoiceMessageState(
-            button = button,
-            progress = progress,
-            time = time,
-            showCursor = showCursor,
-            eventSink = { eventSink(it) },
-        )
+        return presenter.present()
     }
 }
diff --git a/...ndroid/features/messages/impl/voicemessages/composer/VoiceMessageComposerPresenterTest.kt b/...ndroid/features/messages/impl/voicemessages/composer/VoiceMessageComposerPresenterTest.kt
@@ -18,7 +18,6 @@ import app.cash.turbine.test
 import com.google.common.truth.Truth.assertThat
 import im.vector.app.features.analytics.plan.Composer
 import io.element.android.features.messages.impl.messagecomposer.aReplyMode
-import io.element.android.features.messages.impl.voicemessages.VoiceMessageException
 import io.element.android.features.messages.test.FakeMessageComposerContext
 import io.element.android.libraries.matrix.api.core.ProgressCallback
 import io.element.android.libraries.matrix.api.media.AudioInfo
@@ -36,6 +35,7 @@ import io.element.android.libraries.textcomposer.model.MessageComposerMode
 import io.element.android.libraries.textcomposer.model.VoiceMessagePlayerEvent
 import io.element.android.libraries.textcomposer.model.VoiceMessageRecorderEvent
 import io.element.android.libraries.textcomposer.model.VoiceMessageState
+import io.element.android.libraries.voiceplayer.api.VoiceMessageException
 import io.element.android.libraries.voicerecorder.test.FakeVoiceRecorder
 import io.element.android.services.analytics.test.FakeAnalyticsService
 import io.element.android.tests.testutils.WarmUpRule

diff --git a/libraries/voiceplayer/api/build.gradle.kts b/libraries/voiceplayer/api/build.gradle.kts
@@ -0,0 +1,23 @@
+import extension.setupAnvil
+
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+plugins {
+    id("io.element.android-compose-library")
+}
+
+android {
+    namespace = "io.element.android.libraries.voiceplayer.api"
+}
+
+setupAnvil()
+
+dependencies {
+    implementation(libs.androidx.annotationjvm)
+    implementation(libs.coroutines.core)
+    implementation(projects.libraries.matrix.api)
+}
diff --git a/...cemessages/timeline/VoiceMessageEvents.kt → ...ies/voiceplayer/api/VoiceMessageEvents.kt b/...cemessages/timeline/VoiceMessageEvents.kt → ...ies/voiceplayer/api/VoiceMessageEvents.kt
@@ -5,7 +5,7 @@
  * Please see LICENSE in the repository root for full details.
  */
 
-package io.element.android.features.messages.impl.voicemessages.timeline
+package io.element.android.libraries.voiceplayer.api
 
 sealed interface VoiceMessageEvents {
     data object PlayPause : VoiceMessageEvents

diff --git a/...pl/voicemessages/VoiceMessageException.kt → .../voiceplayer/api/VoiceMessageException.kt b/...pl/voicemessages/VoiceMessageException.kt → .../voiceplayer/api/VoiceMessageException.kt
@@ -5,17 +5,19 @@
  * Please see LICENSE in the repository root for full details.
  */
 
-package io.element.android.features.messages.impl.voicemessages
+package io.element.android.libraries.voiceplayer.api
 
-internal sealed class VoiceMessageException : Exception() {
+sealed class VoiceMessageException : Exception() {
     data class FileException(
         override val message: String?,
         override val cause: Throwable? = null
     ) : VoiceMessageException()
+
     data class PermissionMissing(
         override val message: String?,
         override val cause: Throwable?
     ) : VoiceMessageException()
+
     data class PlayMessageError(
         override val message: String?,
         override val cause: Throwable?

diff --git a/.../main/kotlin/io/element/android/libraries/voiceplayer/api/VoiceMessagePresenterFactory.kt b/.../main/kotlin/io/element/android/libraries/voiceplayer/api/VoiceMessagePresenterFactory.kt
@@ -0,0 +1,23 @@
+/*
+ * 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.voiceplayer.api
+
+import io.element.android.libraries.architecture.Presenter
+import io.element.android.libraries.matrix.api.core.EventId
+import io.element.android.libraries.matrix.api.media.MediaSource
+import kotlin.time.Duration
+
+interface VoiceMessagePresenterFactory {
+    fun createVoiceMessagePresenter(
+        eventId: EventId?,
+        mediaSource: MediaSource,
+        mimeType: String?,
+        filename: String?,
+        duration: Duration,
+    ): Presenter<VoiceMessageState>
+}
diff --git a/...icemessages/timeline/VoiceMessageState.kt → ...ries/voiceplayer/api/VoiceMessageState.kt b/...icemessages/timeline/VoiceMessageState.kt → ...ries/voiceplayer/api/VoiceMessageState.kt
@@ -5,7 +5,7 @@
  * Please see LICENSE in the repository root for full details.
  */
 
-package io.element.android.features.messages.impl.voicemessages.timeline
+package io.element.android.libraries.voiceplayer.api
 
 data class VoiceMessageState(
     val button: Button,

diff --git a/...ges/timeline/VoiceMessageStateProvider.kt → ...ceplayer/api/VoiceMessageStateProvider.kt b/...ges/timeline/VoiceMessageStateProvider.kt → ...ceplayer/api/VoiceMessageStateProvider.kt
@@ -5,7 +5,7 @@
  * Please see LICENSE in the repository root for full details.
  */
 
-package io.element.android.features.messages.impl.voicemessages.timeline
+package io.element.android.libraries.voiceplayer.api
 
 import androidx.compose.ui.tooling.preview.PreviewParameterProvider
 

diff --git a/libraries/voiceplayer/impl/build.gradle.kts b/libraries/voiceplayer/impl/build.gradle.kts
@@ -0,0 +1,43 @@
+import extension.setupAnvil
+
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+plugins {
+    id("io.element.android-compose-library")
+}
+
+android {
+    namespace = "io.element.android.libraries.voiceplayer.impl"
+}
+
+setupAnvil()
+
+dependencies {
+    api(projects.libraries.voiceplayer.api)
+
+    implementation(projects.libraries.core)
+    implementation(projects.libraries.di)
+    implementation(projects.libraries.matrix.api)
+    implementation(projects.libraries.mediaplayer.api)
+    implementation(projects.libraries.uiUtils)
+    implementation(projects.services.analytics.api)
+
+    implementation(libs.androidx.annotationjvm)
+    implementation(libs.coroutines.core)
+
+    testImplementation(libs.molecule.runtime)
+    testImplementation(libs.test.junit)
+    testImplementation(libs.test.truth)
+    testImplementation(libs.test.mockk)
+    testImplementation(libs.test.turbine)
+    testImplementation(libs.coroutines.core)
+    testImplementation(libs.coroutines.test)
+    testImplementation(projects.libraries.matrix.test)
+    testImplementation(projects.libraries.mediaplayer.test)
+    testImplementation(projects.services.analytics.test)
+    testImplementation(projects.tests.testutils)
+}