ganfra
3 months ago
committed by
GitHub
10 changed files with 436 additions and 124 deletions
@ -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?) |
||||||
|
} |
@ -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") |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
} |
@ -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 |
||||||
|
} |
||||||
|
} |
||||||
|
} |
@ -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 |
||||||
|
* |
||||||
|
* 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 com.google.common.truth.Truth.assertThat |
||||||
|
import io.element.android.libraries.matrix.api.room.draft.ComposerDraft |
||||||
|
import io.element.android.libraries.matrix.api.room.draft.ComposerDraftType |
||||||
|
import io.element.android.libraries.matrix.test.A_ROOM_ID |
||||||
|
import kotlinx.coroutines.test.runTest |
||||||
|
import org.junit.Test |
||||||
|
|
||||||
|
class VolatileComposerDraftStoreTest { |
||||||
|
private val roomId = A_ROOM_ID |
||||||
|
private val sut = VolatileComposerDraftStore() |
||||||
|
private val draft = ComposerDraft("plainText", "htmlText", ComposerDraftType.NewMessage) |
||||||
|
|
||||||
|
@Test |
||||||
|
fun `when storing a non-null draft and then loading it, it's loaded and removed`() = runTest { |
||||||
|
val initialDraft = sut.loadDraft(roomId) |
||||||
|
assertThat(initialDraft).isNull() |
||||||
|
|
||||||
|
sut.updateDraft(roomId, draft) |
||||||
|
|
||||||
|
val loadedDraft = sut.loadDraft(roomId) |
||||||
|
assertThat(loadedDraft).isEqualTo(draft) |
||||||
|
|
||||||
|
val loadedDraftAfter = sut.loadDraft(roomId) |
||||||
|
assertThat(loadedDraftAfter).isNull() |
||||||
|
} |
||||||
|
|
||||||
|
@Test |
||||||
|
fun `when storing a null draft and then loading it, it's removing the previous one`() = runTest { |
||||||
|
val initialDraft = sut.loadDraft(roomId) |
||||||
|
assertThat(initialDraft).isNull() |
||||||
|
|
||||||
|
sut.updateDraft(roomId, draft) |
||||||
|
sut.updateDraft(roomId, null) |
||||||
|
|
||||||
|
val loadedDraft = sut.loadDraft(roomId) |
||||||
|
assertThat(loadedDraft).isNull() |
||||||
|
} |
||||||
|
} |
Loading…
Reference in new issue