Merge pull request #3132 from element-hq/feature/fga/draft_in_memory_when_editing

Draft : add volatile storage when moving to edit mode.

Author: ganfra

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

@@ -20,6 +20,6 @@ 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 updateDraft(roomId: RoomId, draft: ComposerDraft?)
+    suspend fun loadDraft(roomId: RoomId, isVolatile: Boolean): ComposerDraft?
+    suspend fun updateDraft(roomId: RoomId, draft: ComposerDraft?, isVolatile: Boolean)
 }

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/draft/ComposerDraftStore.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
+ *
+ *     https://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 ComposerDraftStore {
+    suspend fun loadDraft(roomId: RoomId): ComposerDraft?
+    suspend fun updateDraft(roomId: RoomId, draft: ComposerDraft?)
+}

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

@@ -18,44 +18,28 @@ 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,
+    private val volatileComposerDraftStore: VolatileComposerDraftStore,
+    private val matrixComposerDraftStore: MatrixComposerDraftStore,
 ) : 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 loadDraft(roomId: RoomId, isVolatile: Boolean): ComposerDraft? {
+        return getStore(isVolatile).loadDraft(roomId)
+    }
+
+    override suspend fun updateDraft(roomId: RoomId, draft: ComposerDraft?, isVolatile: Boolean) {
+        getStore(isVolatile).updateDraft(roomId, draft)
     }
 
-    override suspend fun updateDraft(roomId: RoomId, draft: ComposerDraft?) {
-        client.getRoom(roomId)?.use { room ->
-            val updateDraftResult = if (draft == null) {
-                room.clearComposerDraft()
-            } else {
-                room.saveComposerDraft(draft)
-            }
-            updateDraftResult
-                .onFailure {
-                    Timber.e(it, "Failed to update composer draft for room $roomId")
-                }
-                .onSuccess {
-                    Timber.d("Updated composer draft for room $roomId")
-                }
+    private fun getStore(isVolatile: Boolean): ComposerDraftStore {
+        return if (isVolatile) {
+            volatileComposerDraftStore
+        } else {
+            matrixComposerDraftStore
         }
     }
 }

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

@@ -0,0 +1,62 @@
+/*
+ * 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
+ *
+ *     https://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.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
+
+/**
+ * A draft store that persists drafts in the room state.
+ * It can be used to store drafts that should be persisted across app restarts.
+ */
+class MatrixComposerDraftStore @Inject constructor(
+    private val client: MatrixClient,
+) : ComposerDraftStore {
+    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 updateDraft(roomId: RoomId, draft: ComposerDraft?) {
+        client.getRoom(roomId)?.use { room ->
+            val updateDraftResult = if (draft == null) {
+                room.clearComposerDraft()
+            } else {
+                room.saveComposerDraft(draft)
+            }
+            updateDraftResult
+                .onFailure {
+                    Timber.e(it, "Failed to update composer draft for room $roomId")
+                }
+                .onSuccess {
+                    Timber.d("Updated composer draft for room $roomId")
+                }
+        }
+    }
+}

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

@@ -0,0 +1,43 @@
+/*
+ * 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
+ *
+ *     https://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
+import javax.inject.Inject
+
+/**
+ * A volatile draft store that keeps drafts in memory only.
+ * It can be used to store drafts that should not be persisted across app restarts.
+ * Currently it's used to store draft message when moving to edit mode.
+ */
+class VolatileComposerDraftStore @Inject constructor() : ComposerDraftStore {
+    private val drafts: MutableMap<RoomId, ComposerDraft> = mutableMapOf()
+
+    override suspend fun loadDraft(roomId: RoomId): ComposerDraft? {
+        // Remove the draft from the map when it is loaded
+        return drafts.remove(roomId)
+    }
+
+    override suspend fun updateDraft(roomId: RoomId, draft: ComposerDraft?) {
+        if (draft == null) {
+            drafts.remove(roomId)
+        } else {
+            drafts[roomId] = draft
+        }
+    }
+}