Allow deleting a recorded voice message (#1635)

---------

Co-authored-by: ElementBot <benoitm+elementbot@element.io>

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/messagecomposer/MessageComposerView.kt

@@ -75,10 +75,14 @@ internal fun MessageComposerView(
         voiceMessageState.eventSink(VoiceMessageComposerEvents.RecordButtonEvent(press))
     }
 
-    fun onSendVoiceMessage() {
+    val onSendVoiceMessage = {
         voiceMessageState.eventSink(VoiceMessageComposerEvents.SendVoiceMessage)
     }
 
+    val onDeleteVoiceMessage = {
+        voiceMessageState.eventSink(VoiceMessageComposerEvents.DeleteVoiceMessage)
+    }
+
     TextComposer(
         modifier = modifier,
         state = state.richTextEditorState,
@@ -94,7 +98,8 @@ internal fun MessageComposerView(
         enableTextFormatting = enableTextFormatting,
         enableVoiceMessages = enableVoiceMessages,
         onVoiceRecordButtonEvent = onVoiceRecordButtonEvent,
-        onSendVoiceMessage = ::onSendVoiceMessage,
+        onSendVoiceMessage = onSendVoiceMessage,
+        onDeleteVoiceMessage = onDeleteVoiceMessage,
         onError = ::onError,
     )
 }

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/voicemessages/composer/VoiceMessageComposerEvents.kt

@@ -24,6 +24,7 @@ sealed interface VoiceMessageComposerEvents {
         val pressEvent: PressEvent
     ): VoiceMessageComposerEvents
     data object SendVoiceMessage: VoiceMessageComposerEvents
+    data object DeleteVoiceMessage: VoiceMessageComposerEvents
     data object AcceptPermissionRationale: VoiceMessageComposerEvents
     data object DismissPermissionsRationale: VoiceMessageComposerEvents
     data class LifecycleEvent(val event: Lifecycle.Event): VoiceMessageComposerEvents

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/voicemessages/composer/VoiceMessageComposerPresenter.kt

@@ -134,6 +134,7 @@ class VoiceMessageComposerPresenter @Inject constructor(
                 is VoiceMessageComposerEvents.SendVoiceMessage -> localCoroutineScope.launch {
                     onSendButtonPress()
                 }
+                VoiceMessageComposerEvents.DeleteVoiceMessage -> localCoroutineScope.deleteRecording()
                 VoiceMessageComposerEvents.DismissPermissionsRationale -> onDismissPermissionsRationale()
                 VoiceMessageComposerEvents.AcceptPermissionRationale -> onAcceptPermissionsRationale()
                 is VoiceMessageComposerEvents.LifecycleEvent -> onLifecycleEvent(event.event)
@@ -175,6 +176,10 @@ class VoiceMessageComposerPresenter @Inject constructor(
         voiceRecorder.stopRecord(cancelled = true)
     }
 
+    private fun CoroutineScope.deleteRecording() = launch {
+        voiceRecorder.deleteRecording()
+    }
+
     private fun CoroutineScope.sendMessage(
         file: File, mimeType: String,
     ) = launch {

features/messages/impl/src/test/kotlin/io/element/android/features/messages/voicemessages/VoiceMessageComposerPresenterTest.kt

@@ -74,6 +74,7 @@ class VoiceMessageComposerPresenterTest {
         }.test {
             val initialState = awaitItem()
             assertThat(initialState.voiceMessageState).isEqualTo(VoiceMessageState.Idle)
+            voiceRecorder.assertCalls(started = 0)
 
             testPauseAndDestroy(initialState)
         }
@@ -89,6 +90,7 @@ class VoiceMessageComposerPresenterTest {
 
             val finalState = awaitItem()
             assertThat(finalState.voiceMessageState).isEqualTo(RECORDING_STATE)
+            voiceRecorder.assertCalls(started = 1)
 
             testPauseAndDestroy(finalState)
         }
@@ -105,6 +107,7 @@ class VoiceMessageComposerPresenterTest {
 
             val finalState = awaitItem()
             assertThat(finalState.voiceMessageState).isEqualTo(VoiceMessageState.Idle)
+            voiceRecorder.assertCalls(started = 1, stopped = 1, deleted = 1)
 
             testPauseAndDestroy(finalState)
         }
@@ -121,6 +124,25 @@ class VoiceMessageComposerPresenterTest {
 
             val finalState = awaitItem()
             assertThat(finalState.voiceMessageState).isEqualTo(VoiceMessageState.Preview)
+            voiceRecorder.assertCalls(started = 1, stopped = 1, deleted = 0)
+
+            testPauseAndDestroy(finalState)
+        }
+    }
+
+    @Test
+    fun `present - delete recording`() = runTest {
+        val presenter = createVoiceMessageComposerPresenter()
+        moleculeFlow(RecompositionMode.Immediate) {
+            presenter.present()
+        }.test {
+            awaitItem().eventSink(VoiceMessageComposerEvents.RecordButtonEvent(PressEvent.PressStart))
+            awaitItem().eventSink(VoiceMessageComposerEvents.RecordButtonEvent(PressEvent.LongPressEnd))
+            awaitItem().eventSink(VoiceMessageComposerEvents.DeleteVoiceMessage)
+
+            val finalState = awaitItem()
+            assertThat(finalState.voiceMessageState).isEqualTo(VoiceMessageState.Idle)
+            voiceRecorder.assertCalls(started = 1, stopped = 1, deleted = 1)
 
             testPauseAndDestroy(finalState)
         }
@@ -140,6 +162,7 @@ class VoiceMessageComposerPresenterTest {
             val finalState = awaitItem()
             assertThat(finalState.voiceMessageState).isEqualTo(VoiceMessageState.Idle)
             assertThat(matrixRoom.sendMediaCount).isEqualTo(1)
+            voiceRecorder.assertCalls(started = 1, stopped = 1, deleted = 1)
 
             testPauseAndDestroy(finalState)
         }
@@ -162,6 +185,7 @@ class VoiceMessageComposerPresenterTest {
             val finalState = awaitItem()
             assertThat(finalState.voiceMessageState).isEqualTo(VoiceMessageState.Idle)
             assertThat(matrixRoom.sendMediaCount).isEqualTo(1)
+            voiceRecorder.assertCalls(started = 1, stopped = 1, deleted = 1)
 
             testPauseAndDestroy(finalState)
         }
@@ -186,6 +210,7 @@ class VoiceMessageComposerPresenterTest {
             assertThat(finalState.voiceMessageState).isEqualTo(VoiceMessageState.Sending)
             assertThat(matrixRoom.sendMediaCount).isEqualTo(0)
             assertThat(analyticsService.trackedErrors).hasSize(0)
+            voiceRecorder.assertCalls(started = 1, stopped = 1, deleted = 0)
 
             testPauseAndDestroy(finalState)
         }
@@ -215,6 +240,7 @@ class VoiceMessageComposerPresenterTest {
             val finalState = awaitItem()
             assertThat(finalState.voiceMessageState).isEqualTo(VoiceMessageState.Idle)
             assertThat(matrixRoom.sendMediaCount).isEqualTo(1)
+            voiceRecorder.assertCalls(started = 1, stopped = 1, deleted = 1)
 
             testPauseAndDestroy(finalState)
         }
@@ -233,6 +259,7 @@ class VoiceMessageComposerPresenterTest {
             assertThat(initialState.voiceMessageState).isEqualTo(VoiceMessageState.Idle)
             assertThat(matrixRoom.sendMediaCount).isEqualTo(0)
             assertThat(analyticsService.trackedErrors).hasSize(1)
+            voiceRecorder.assertCalls(started = 0)
 
             testPauseAndDestroy(initialState)
         }
@@ -253,6 +280,7 @@ class VoiceMessageComposerPresenterTest {
             assertThat(analyticsService.trackedErrors).containsExactly(
                 VoiceMessageException.PermissionMissing(message = "Expected permission to record but none", cause = exception)
             )
+            voiceRecorder.assertCalls(started = 1)
 
             testPauseAndDestroy(initialState)
         }
@@ -274,11 +302,14 @@ class VoiceMessageComposerPresenterTest {
             assertThat(awaitItem().voiceMessageState).isEqualTo(VoiceMessageState.Idle)
 
             initialState.eventSink(VoiceMessageComposerEvents.RecordButtonEvent(PressEvent.LongPressEnd))
+            voiceRecorder.assertCalls(stopped = 1)
+
             permissionsPresenter.setPermissionGranted()
 
             awaitItem().eventSink(VoiceMessageComposerEvents.RecordButtonEvent(PressEvent.PressStart))
             val finalState = awaitItem()
             assertThat(finalState.voiceMessageState).isEqualTo(RECORDING_STATE)
+            voiceRecorder.assertCalls(stopped = 1, started = 1)
 
             testPauseAndDestroy(finalState)
         }
@@ -312,6 +343,7 @@ class VoiceMessageComposerPresenterTest {
             awaitItem().eventSink(VoiceMessageComposerEvents.RecordButtonEvent(PressEvent.PressStart))
             val finalState = awaitItem()
             assertThat(finalState.voiceMessageState).isEqualTo(RECORDING_STATE)
+            voiceRecorder.assertCalls(started = 1)
 
             testPauseAndDestroy(finalState)
         }
@@ -348,6 +380,7 @@ class VoiceMessageComposerPresenterTest {
                 assertThat(it.voiceMessageState).isEqualTo(VoiceMessageState.Idle)
                 assertThat(it.showPermissionRationaleDialog).isTrue()
             }
+            voiceRecorder.assertCalls(started = 0)
 
             testPauseAndDestroy(finalState)
         }

libraries/textcomposer/impl/src/main/kotlin/io/element/android/libraries/textcomposer/TextComposer.kt

@@ -65,10 +65,11 @@ import io.element.android.libraries.testtags.testTag
 import io.element.android.libraries.textcomposer.components.ComposerOptionsButton
 import io.element.android.libraries.textcomposer.components.DismissTextFormattingButton
 import io.element.android.libraries.textcomposer.components.RecordButton
-import io.element.android.libraries.textcomposer.components.VoiceMessagePreview
-import io.element.android.libraries.textcomposer.components.VoiceMessageRecording
 import io.element.android.libraries.textcomposer.components.SendButton
 import io.element.android.libraries.textcomposer.components.TextFormatting
+import io.element.android.libraries.textcomposer.components.VoiceMessageDeleteButton
+import io.element.android.libraries.textcomposer.components.VoiceMessagePreview
+import io.element.android.libraries.textcomposer.components.VoiceMessageRecording
 import io.element.android.libraries.textcomposer.components.textInputRoundedCornerShape
 import io.element.android.libraries.textcomposer.model.Message
 import io.element.android.libraries.textcomposer.model.MessageComposerMode
@@ -99,6 +100,7 @@ fun TextComposer(
     onDismissTextFormatting: () -> Unit = {},
     onVoiceRecordButtonEvent: (PressEvent) -> Unit = {},
     onSendVoiceMessage: () -> Unit = {},
+    onDeleteVoiceMessage: () -> Unit = {},
     onError: (Throwable) -> Unit = {},
 ) {
     val onSendClicked = {
@@ -187,6 +189,16 @@ fun TextComposer(
         }
     }
 
+    val voiceDeleteButton = @Composable {
+        val enabled = when (voiceMessageState) {
+            VoiceMessageState.Preview -> true
+            VoiceMessageState.Sending,
+            is VoiceMessageState.Recording,
+            VoiceMessageState.Idle -> false
+        }
+        VoiceMessageDeleteButton(enabled = enabled, onClick = onDeleteVoiceMessage)
+    }
+
     if (showTextFormatting) {
         TextFormattingLayout(
             modifier = layoutModifier,
@@ -206,6 +218,7 @@ fun TextComposer(
             textInput = textInput,
             endButton = sendOrRecordButton,
             voiceRecording = voiceRecording,
+            voiceDeleteButton = voiceDeleteButton,
         )
     }
 
@@ -225,6 +238,7 @@ private fun StandardLayout(
     textInput: @Composable () -> Unit,
     composerOptionsButton: @Composable () -> Unit,
     voiceRecording: @Composable () -> Unit,
+    voiceDeleteButton: @Composable () -> Unit,
     endButton: @Composable () -> Unit,
     modifier: Modifier = Modifier,
 ) {
@@ -233,9 +247,21 @@ private fun StandardLayout(
         verticalAlignment = Alignment.Bottom,
     ) {
         if (enableVoiceMessages && voiceMessageState !is VoiceMessageState.Idle) {
+            if (voiceMessageState is VoiceMessageState.Preview || voiceMessageState is VoiceMessageState.Sending) {
+                Box(
+                    modifier = Modifier
+                        .padding(bottom = 5.dp, top = 5.dp, end = 3.dp, start = 3.dp)
+                        .size(48.dp.applyScaleUp()),
+                    contentAlignment = Alignment.Center,
+                ) {
+                    voiceDeleteButton()
+                }
+            } else {
+                Spacer(modifier = Modifier.width(16.dp))
+            }
             Box(
                 modifier = Modifier
-                    .padding(start = 16.dp, bottom = 8.dp, top = 8.dp)
+                    .padding(bottom = 8.dp, top = 8.dp)
                     .weight(1f)
             ) {
                 voiceRecording()

libraries/textcomposer/impl/src/main/kotlin/io/element/android/libraries/textcomposer/components/VoiceMessageDeleteButton.kt

@@ -0,0 +1,66 @@
+/*
+ * 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.libraries.textcomposer.components
+
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.size
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.unit.dp
+import io.element.android.libraries.designsystem.preview.ElementPreview
+import io.element.android.libraries.designsystem.preview.PreviewsDayNight
+import io.element.android.libraries.designsystem.text.applyScaleUp
+import io.element.android.libraries.designsystem.theme.components.Icon
+import io.element.android.libraries.designsystem.theme.components.IconButton
+import io.element.android.libraries.designsystem.utils.CommonDrawables
+import io.element.android.libraries.theme.ElementTheme
+import io.element.android.libraries.ui.strings.CommonStrings
+
+@Composable
+fun VoiceMessageDeleteButton(
+    enabled: Boolean,
+    modifier: Modifier = Modifier,
+    onClick: () -> Unit = {},
+) {
+    IconButton(
+        modifier = modifier
+            .size(48.dp),
+        enabled = enabled,
+        onClick = onClick,
+    ) {
+        Icon(
+            modifier = Modifier.size(24.dp.applyScaleUp()),
+            resourceId = CommonDrawables.ic_compound_delete,
+            contentDescription = stringResource(CommonStrings.a11y_delete),
+            tint = if (enabled) {
+                ElementTheme.colors.iconCriticalPrimary
+            } else {
+                ElementTheme.colors.iconDisabled
+            },
+        )
+    }
+}
+
+@PreviewsDayNight
+@Composable
+internal fun VoiceMessageDeleteButtonPreview() = ElementPreview {
+    Row {
+        VoiceMessageDeleteButton(enabled = true)
+        VoiceMessageDeleteButton(enabled = false)
+    }
+}

libraries/voicerecorder/test/build.gradle.kts

@@ -27,4 +27,5 @@ dependencies {
     implementation(projects.tests.testutils)
 
     implementation(libs.coroutines.test)
+    implementation(libs.test.truth)
 }

libraries/voicerecorder/test/src/main/kotlin/io/element/android/libraries/voicerecorder/test/FakeVoiceRecorder.kt

@@ -16,6 +16,7 @@
 
 package io.element.android.libraries.voicerecorder.test
 
+import com.google.common.truth.Truth.assertThat
 import io.element.android.libraries.voicerecorder.api.VoiceRecorder
 import io.element.android.libraries.voicerecorder.api.VoiceRecorderState
 import kotlinx.coroutines.flow.MutableStateFlow
@@ -37,7 +38,12 @@ class FakeVoiceRecorder(
 
     private var securityException: SecurityException? = null
 
+    private var startedCount = 0
+    private var stoppedCount = 0
+    private var deletedCount = 0
+
     override suspend fun startRecord() {
+        startedCount += 1
         val startedAt = timeSource.markNow()
         securityException?.let { throw it }
 
@@ -55,6 +61,8 @@ class FakeVoiceRecorder(
     override suspend fun stopRecord(
         cancelled: Boolean
     ) {
+        stoppedCount++
+
         if (cancelled) {
             deleteRecording()
         }
@@ -68,6 +76,7 @@ class FakeVoiceRecorder(
     }
 
     override suspend fun deleteRecording() {
+        deletedCount++
         curRecording = null
 
         _state.emit(
@@ -75,6 +84,17 @@ class FakeVoiceRecorder(
         )
     }
 
+
+    fun assertCalls(
+        started: Int = 0,
+        stopped: Int = 0,
+        deleted: Int = 0,
+    ) {
+        assertThat(startedCount).isEqualTo(started)
+        assertThat(stoppedCount).isEqualTo(stopped)
+        assertThat(deletedCount).isEqualTo(deleted)
+    }
+
     fun givenThrowsSecurityException(exception: SecurityException) {
         this.securityException = exception
     }