Merge pull request #3099 from element-hq/feature/fga/draft_support

Feature : Draft support

Author: ganfra

changelog.d/2869.feature

@@ -0,0 +1 @@
+Store and restore drafts for each room.

features/location/impl/src/test/kotlin/io/element/android/features/location/impl/send/SendLocationPresenterTest.kt

@@ -379,8 +379,8 @@ class SendLocationPresenterTest {
         fakeMessageComposerContext.apply {
             composerMode = MessageComposerMode.Edit(
                 eventId = null,
-                defaultContent = "",
-                transactionId = null
+                transactionId = null,
+                content = ""
             )
         }
 
@@ -427,8 +427,8 @@ class SendLocationPresenterTest {
         fakeMessageComposerContext.apply {
             composerMode = MessageComposerMode.Edit(
                 eventId = null,
-                defaultContent = "",
-                transactionId = null
+                transactionId = null,
+                content = ""
             )
         }
 

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

@@ -26,6 +26,7 @@ import androidx.compose.runtime.saveable.rememberSaveable
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.platform.LocalContext
+import androidx.lifecycle.Lifecycle
 import com.bumble.appyx.core.lifecycle.subscribe
 import com.bumble.appyx.core.modality.BuildContext
 import com.bumble.appyx.core.node.Node
@@ -35,6 +36,7 @@ import dagger.assisted.Assisted
 import dagger.assisted.AssistedInject
 import io.element.android.anvilannotations.ContributesNode
 import io.element.android.features.messages.impl.attachments.Attachment
+import io.element.android.features.messages.impl.messagecomposer.MessageComposerEvents
 import io.element.android.features.messages.impl.timeline.TimelineController
 import io.element.android.features.messages.impl.timeline.TimelineEvents
 import io.element.android.features.messages.impl.timeline.di.LocalTimelineItemPresenterFactories
@@ -45,6 +47,7 @@ import io.element.android.libraries.androidutils.system.toast
 import io.element.android.libraries.architecture.NodeInputs
 import io.element.android.libraries.architecture.inputs
 import io.element.android.libraries.core.bool.orFalse
+import io.element.android.libraries.designsystem.utils.OnLifecycleEvent
 import io.element.android.libraries.di.ApplicationContext
 import io.element.android.libraries.di.RoomScope
 import io.element.android.libraries.matrix.api.analytics.toAnalyticsViewRoom
@@ -195,6 +198,12 @@ class MessagesNode @AssistedInject constructor(
             LocalTimelineItemPresenterFactories provides timelineItemPresenterFactories,
         ) {
             val state = presenter.present()
+            OnLifecycleEvent { _, event ->
+                when (event) {
+                    Lifecycle.Event.ON_PAUSE -> state.composerState.eventSink(MessageComposerEvents.SaveDraft)
+                    else -> Unit
+                }
+            }
             MessagesView(
                 state = state,
                 onBackClick = this::navigateUp,

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

@@ -47,23 +47,10 @@ import io.element.android.features.messages.impl.timeline.components.customreact
 import io.element.android.features.messages.impl.timeline.components.reactionsummary.ReactionSummaryPresenter
 import io.element.android.features.messages.impl.timeline.components.receipt.bottomsheet.ReadReceiptBottomSheetPresenter
 import io.element.android.features.messages.impl.timeline.model.TimelineItem
-import io.element.android.features.messages.impl.timeline.model.event.TimelineItemAudioContent
-import io.element.android.features.messages.impl.timeline.model.event.TimelineItemCallNotifyContent
-import io.element.android.features.messages.impl.timeline.model.event.TimelineItemEncryptedContent
-import io.element.android.features.messages.impl.timeline.model.event.TimelineItemFileContent
-import io.element.android.features.messages.impl.timeline.model.event.TimelineItemImageContent
-import io.element.android.features.messages.impl.timeline.model.event.TimelineItemLegacyCallInviteContent
-import io.element.android.features.messages.impl.timeline.model.event.TimelineItemLocationContent
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemPollContent
-import io.element.android.features.messages.impl.timeline.model.event.TimelineItemRedactedContent
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemStateContent
-import io.element.android.features.messages.impl.timeline.model.event.TimelineItemStickerContent
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemTextBasedContent
-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.typing.TypingNotificationPresenter
-import io.element.android.features.messages.impl.utils.messagesummary.MessageSummaryFormatter
 import io.element.android.features.messages.impl.voicemessages.composer.VoiceMessageComposerPresenter
 import io.element.android.features.networkmonitor.api.NetworkMonitor
 import io.element.android.features.networkmonitor.api.NetworkStatus
@@ -80,12 +67,12 @@ import io.element.android.libraries.designsystem.utils.snackbar.collectSnackbarM
 import io.element.android.libraries.featureflag.api.FeatureFlagService
 import io.element.android.libraries.featureflag.api.FeatureFlags
 import io.element.android.libraries.matrix.api.core.EventId
+import io.element.android.libraries.matrix.api.permalink.PermalinkParser
 import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.MatrixRoomInfo
 import io.element.android.libraries.matrix.api.room.MatrixRoomMembersState
 import io.element.android.libraries.matrix.api.room.MessageEventType
-import io.element.android.libraries.matrix.ui.components.AttachmentThumbnailInfo
-import io.element.android.libraries.matrix.ui.components.AttachmentThumbnailType
+import io.element.android.libraries.matrix.ui.messages.reply.map
 import io.element.android.libraries.matrix.ui.model.getAvatarData
 import io.element.android.libraries.matrix.ui.room.canCall
 import io.element.android.libraries.matrix.ui.room.canRedactOtherAsState
@@ -100,6 +87,7 @@ import kotlinx.coroutines.withContext
 import timber.log.Timber
 
 class MessagesPresenter @AssistedInject constructor(
+    @Assisted private val navigator: MessagesNavigator,
     private val room: MatrixRoom,
     private val composerPresenter: MessageComposerPresenter,
     private val voiceMessageComposerPresenter: VoiceMessageComposerPresenter,
@@ -111,14 +99,13 @@ class MessagesPresenter @AssistedInject constructor(
     private val readReceiptBottomSheetPresenter: ReadReceiptBottomSheetPresenter,
     private val networkMonitor: NetworkMonitor,
     private val snackbarDispatcher: SnackbarDispatcher,
-    private val messageSummaryFormatter: MessageSummaryFormatter,
     private val dispatchers: CoroutineDispatchers,
     private val clipboardHelper: ClipboardHelper,
     private val featureFlagsService: FeatureFlagService,
     private val htmlConverterProvider: HtmlConverterProvider,
-    @Assisted private val navigator: MessagesNavigator,
     private val buildMeta: BuildMeta,
     private val timelineController: TimelineController,
+    private val permalinkParser: PermalinkParser,
 ) : Presenter<MessagesState> {
     private val timelinePresenter = timelinePresenterFactory.create(navigator = navigator)
 
@@ -336,14 +323,14 @@ class MessagesPresenter @AssistedInject constructor(
             else -> {
                 val composerMode = MessageComposerMode.Edit(
                     targetEvent.eventId,
+                    targetEvent.transactionId,
                     (targetEvent.content as? TimelineItemTextBasedContent)?.let {
                         if (enableTextFormatting) {
                             it.htmlBody ?: it.body
                         } else {
                             it.body
                         }
                     }.orEmpty(),
-                    targetEvent.transactionId,
                 )
                 composerState.eventSink(
                     MessageComposerEvents.SetMode(composerMode)
@@ -352,66 +339,15 @@ class MessagesPresenter @AssistedInject constructor(
         }
     }
 
-    private fun handleActionReply(targetEvent: TimelineItem.Event, composerState: MessageComposerState) {
+    private suspend fun handleActionReply(targetEvent: TimelineItem.Event, composerState: MessageComposerState) {
         if (targetEvent.eventId == null) return
-        val textContent = messageSummaryFormatter.format(targetEvent)
-        val attachmentThumbnailInfo = when (targetEvent.content) {
-            is TimelineItemImageContent -> AttachmentThumbnailInfo(
-                thumbnailSource = targetEvent.content.thumbnailSource ?: targetEvent.content.mediaSource,
-                textContent = targetEvent.content.body,
-                type = AttachmentThumbnailType.Image,
-                blurHash = targetEvent.content.blurhash,
-            )
-            is TimelineItemStickerContent -> AttachmentThumbnailInfo(
-                thumbnailSource = targetEvent.content.thumbnailSource ?: targetEvent.content.mediaSource,
-                textContent = targetEvent.content.body,
-                type = AttachmentThumbnailType.Image,
-                blurHash = targetEvent.content.blurhash,
-            )
-            is TimelineItemVideoContent -> AttachmentThumbnailInfo(
-                thumbnailSource = targetEvent.content.thumbnailSource,
-                textContent = targetEvent.content.body,
-                type = AttachmentThumbnailType.Video,
-                blurHash = targetEvent.content.blurHash,
-            )
-            is TimelineItemFileContent -> AttachmentThumbnailInfo(
-                thumbnailSource = targetEvent.content.thumbnailSource,
-                textContent = targetEvent.content.body,
-                type = AttachmentThumbnailType.File,
-            )
-            is TimelineItemAudioContent -> AttachmentThumbnailInfo(
-                textContent = targetEvent.content.body,
-                type = AttachmentThumbnailType.Audio,
-            )
-            is TimelineItemVoiceContent -> AttachmentThumbnailInfo(
-                textContent = textContent,
-                type = AttachmentThumbnailType.Voice,
-            )
-            is TimelineItemLocationContent -> AttachmentThumbnailInfo(
-                type = AttachmentThumbnailType.Location,
-            )
-            is TimelineItemPollContent -> AttachmentThumbnailInfo(
-                textContent = targetEvent.content.question,
-                type = AttachmentThumbnailType.Poll,
+        timelineController.invokeOnCurrentTimeline {
+            val replyToDetails = loadReplyDetails(targetEvent.eventId).map(permalinkParser)
+            val composerMode = MessageComposerMode.Reply(replyToDetails = replyToDetails)
+            composerState.eventSink(
+                MessageComposerEvents.SetMode(composerMode)
             )
-            is TimelineItemTextBasedContent,
-            is TimelineItemRedactedContent,
-            is TimelineItemStateContent,
-            is TimelineItemEncryptedContent,
-            is TimelineItemLegacyCallInviteContent,
-            is TimelineItemCallNotifyContent,
-            is TimelineItemUnknownContent -> null
         }
-        val composerMode = MessageComposerMode.Reply(
-            isThreaded = targetEvent.isThreaded,
-            senderName = targetEvent.safeSenderName,
-            eventId = targetEvent.eventId,
-            attachmentThumbnailInfo = attachmentThumbnailInfo,
-            defaultContent = textContent,
-        )
-        composerState.eventSink(
-            MessageComposerEvents.SetMode(composerMode)
-        )
     }
 
     private fun handleShowDebugInfoAction(event: TimelineItem.Event) {

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/actionlist/ActionListView.kt

@@ -55,8 +55,6 @@ import androidx.compose.ui.unit.dp
 import io.element.android.compound.theme.ElementTheme
 import io.element.android.compound.tokens.generated.CompoundIcons
 import io.element.android.features.messages.impl.actionlist.model.TimelineItemAction
-import io.element.android.features.messages.impl.sender.SenderName
-import io.element.android.features.messages.impl.sender.SenderNameMode
 import io.element.android.features.messages.impl.timeline.model.TimelineItem
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemAudioContent
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemCallNotifyContent
@@ -88,6 +86,8 @@ import io.element.android.libraries.designsystem.theme.components.ListItemStyle
 import io.element.android.libraries.designsystem.theme.components.ModalBottomSheet
 import io.element.android.libraries.designsystem.theme.components.Text
 import io.element.android.libraries.designsystem.theme.components.hide
+import io.element.android.libraries.matrix.ui.messages.sender.SenderName
+import io.element.android.libraries.matrix.ui.messages.sender.SenderNameMode
 import io.element.android.libraries.ui.strings.CommonStrings
 import kotlinx.collections.immutable.ImmutableList
 

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/draft/ComposerDraftService.kt

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2024 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.draft
+
+import io.element.android.libraries.matrix.api.core.RoomId
+import io.element.android.libraries.matrix.api.room.draft.ComposerDraft
+
+interface ComposerDraftService {
+    suspend fun loadDraft(roomId: RoomId): ComposerDraft?
+    suspend fun saveDraft(roomId: RoomId, draft: ComposerDraft)
+}

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/draft/DefaultComposerDraftService.kt

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2024 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.draft
+
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.libraries.di.RoomScope
+import io.element.android.libraries.matrix.api.MatrixClient
+import io.element.android.libraries.matrix.api.core.RoomId
+import io.element.android.libraries.matrix.api.room.draft.ComposerDraft
+import timber.log.Timber
+import javax.inject.Inject
+
+@ContributesBinding(RoomScope::class)
+class DefaultComposerDraftService @Inject constructor(
+    private val client: MatrixClient,
+) : ComposerDraftService {
+    override suspend fun loadDraft(roomId: RoomId): ComposerDraft? {
+        return client.getRoom(roomId)?.use { room ->
+            room.loadComposerDraft()
+                .onFailure {
+                    Timber.e(it, "Failed to load composer draft for room $roomId")
+                }
+                .onSuccess { draft ->
+                    room.clearComposerDraft()
+                    Timber.d("Loaded composer draft for room $roomId : $draft")
+                }
+                .getOrNull()
+        }
+    }
+
+    override suspend fun saveDraft(roomId: RoomId, draft: ComposerDraft) {
+        client.getRoom(roomId)?.use { room ->
+            room.saveComposerDraft(draft)
+                .onFailure {
+                    Timber.e(it, "Failed to save composer draft for room $roomId")
+                }
+                .onSuccess {
+                    Timber.d("Saved composer draft for room $roomId")
+                }
+        }
+    }
+}

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

@@ -45,4 +45,5 @@ sealed interface MessageComposerEvents {
     data class TypingNotice(val isTyping: Boolean) : MessageComposerEvents
     data class SuggestionReceived(val suggestion: Suggestion?) : MessageComposerEvents
     data class InsertMention(val mention: ResolvedMentionSuggestion) : MessageComposerEvents
+    data object SaveDraft : MessageComposerEvents
 }