Feature: Support text storage (#11)

* Use key composable to separate conv detail screens. Automatically remember last typed text in persistent storage. * Update comments.
ls1intum · Nov 15, 2023 · eeacf87 · eeacf87
1 parent 07bff0c
commit eeacf87
Show file tree

Hide file tree

Showing 23 changed files with 305 additions and 95 deletions.
diff --git a/feature/course-view/build.gradle.kts b/feature/course-view/build.gradle.kts
@@ -15,7 +15,7 @@ dependencies {
     implementation(project(":feature:metis"))
 
     implementation(libs.kotlinx.datetime)
-    implementation(libs.accompanist.placeholder.material)
+    implementation(libs.placeholder.material)
 
     testImplementation(project(":feature:login"))
     testImplementation(project(":feature:login-test"))

diff --git a/...formatics/www1/artemis/native_app/feature/courseview/ui/course_overview/CourseUiScreen.kt b/...formatics/www1/artemis/native_app/feature/courseview/ui/course_overview/CourseUiScreen.kt
@@ -49,7 +49,7 @@ import androidx.navigation.NavType
 import androidx.navigation.compose.composable
 import androidx.navigation.navArgument
 import androidx.navigation.navDeepLink
-import com.google.accompanist.placeholder.material.placeholder
+import io.github.fornewid.placeholder.material3.placeholder
 import de.tum.informatics.www1.artemis.native_app.core.data.DataState
 import de.tum.informatics.www1.artemis.native_app.core.model.Course
 import de.tum.informatics.www1.artemis.native_app.core.ui.common.BasicDataStateUi

diff --git a/feature/lecture-view/build.gradle.kts b/feature/lecture-view/build.gradle.kts
@@ -15,7 +15,7 @@ dependencies {
     implementation(project(":feature:metis"))
 
     implementation(libs.kotlinx.datetime)
-    implementation(libs.accompanist.placeholder.material)
+    implementation(libs.placeholder.material)
     implementation(libs.accompanist.swiperefresh)
 
     testImplementation(project(":feature:login"))

diff --git a/.../kotlin/de/tum/informatics/www1/artemis/native_app/feature/lectureview/LectureScreenUi.kt b/.../kotlin/de/tum/informatics/www1/artemis/native_app/feature/lectureview/LectureScreenUi.kt
@@ -35,7 +35,7 @@ import androidx.navigation.NavType
 import androidx.navigation.compose.composable
 import androidx.navigation.navArgument
 import androidx.navigation.navDeepLink
-import com.google.accompanist.placeholder.material.placeholder
+import io.github.fornewid.placeholder.material3.placeholder
 import de.tum.informatics.www1.artemis.native_app.core.model.lecture.Attachment
 import de.tum.informatics.www1.artemis.native_app.core.ui.LocalLinkOpener
 import de.tum.informatics.www1.artemis.native_app.core.ui.alert.TextAlertDialog

diff --git a/feature/metis/build.gradle.kts b/feature/metis/build.gradle.kts
@@ -23,6 +23,14 @@ dependencies {
     api(project(":feature:metis:conversation"))
     api(project(":feature:metis:manage-conversations"))
 
+    implementation(libs.androidx.compose.material)
+    implementation(libs.androidx.paging.runtime)
+    implementation(libs.androidx.paging.compose)
+    implementation(libs.kotlinx.datetime)
+    implementation(libs.placeholder.material)
+    implementation(libs.accompanist.flowlayout)
+    implementation(libs.androidx.appcompat)
+
     implementation(libs.androidx.dataStore.core)
     implementation(libs.androidx.dataStore.preferences)
 

diff --git a/feature/metis/conversation/build.gradle.kts b/feature/metis/conversation/build.gradle.kts
@@ -23,12 +23,15 @@ dependencies {
 
     implementation(libs.androidx.paging.runtime)
     implementation(libs.androidx.paging.compose)
+    implementation(libs.placeholder.material)
 
     implementation(libs.androidx.emoji2)
     implementation(libs.androidx.emoji2.views)
     implementation(libs.androidx.emoji2.views.helper)
     implementation(libs.androidx.emoji2.emojiPicker)
 
+    implementation(libs.androidx.dataStore.preferences)
+
     testImplementation(project(":feature:metis-test"))
 }
 

diff --git a/...tum/informatics/www1/artemis/native_app/feature/metis/conversation/conversation_module.kt b/...tum/informatics/www1/artemis/native_app/feature/metis/conversation/conversation_module.kt
@@ -8,7 +8,9 @@ import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.ser
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.network.impl.MetisModificationServiceImpl
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.network.impl.MetisServiceImpl
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.storage.MetisStorageService
+import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.storage.ReplyTextStorageService
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.storage.impl.MetisStorageServiceImpl
+import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.storage.impl.ReplyTextStorageServiceImpl
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.ui.chatlist.MetisListViewModel
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.ui.thread.MetisThreadViewModel
 import org.koin.android.ext.koin.androidContext
@@ -22,6 +24,7 @@ val conversationModule = module {
     single<EmojiService> { EmojiServiceImpl(androidContext()) }
 
     single<MetisStorageService> { MetisStorageServiceImpl(get()) }
+    single<ReplyTextStorageService> { ReplyTextStorageServiceImpl(androidContext()) }
 
     single<MetisContextManager> { MetisContextManager(get(), get()) }
 
@@ -37,6 +40,7 @@ val conversationModule = module {
             get(),
             get(),
             get(),
+            get(),
             get()
         )
     }
@@ -55,6 +59,7 @@ val conversationModule = module {
             get(),
             get(),
             get(),
+            get(),
             get()
         )
     }

diff --git a/.../artemis/native_app/feature/metis/conversation/service/storage/ReplyTextStorageService.kt b/.../artemis/native_app/feature/metis/conversation/service/storage/ReplyTextStorageService.kt
@@ -0,0 +1,19 @@
+package de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.storage
+
+internal interface ReplyTextStorageService {
+
+    suspend fun getStoredReplyText(
+        serverHost: String,
+        courseId: Long,
+        conversationId: Long,
+        postId: Long?
+    ): String
+
+    suspend fun updateStoredReplyText(
+        serverHost: String,
+        courseId: Long,
+        conversationId: Long,
+        postId: Long?,
+        text: String
+    )
+}
diff --git a/...native_app/feature/metis/conversation/service/storage/impl/ReplyTextStorageServiceImpl.kt b/...native_app/feature/metis/conversation/service/storage/impl/ReplyTextStorageServiceImpl.kt
@@ -0,0 +1,51 @@
+package de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.storage.impl
+
+import android.content.Context
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.core.edit
+import androidx.datastore.preferences.core.stringPreferencesKey
+import androidx.datastore.preferences.preferencesDataStore
+import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.storage.ReplyTextStorageService
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.flow.map
+
+internal class ReplyTextStorageServiceImpl(private val context: Context) : ReplyTextStorageService {
+
+    private companion object {
+        private const val DATA_STORE_NAME = "ReplyTextStorage"
+    }
+
+    private val Context.dataStore by preferencesDataStore(DATA_STORE_NAME)
+
+    override suspend fun getStoredReplyText(
+        serverHost: String,
+        courseId: Long,
+        conversationId: Long,
+        postId: Long?
+    ): String = context
+        .dataStore
+        .data
+        .map { it[getKey(serverHost, courseId, conversationId, postId)].orEmpty() }
+        .first()
+
+    override suspend fun updateStoredReplyText(
+        serverHost: String,
+        courseId: Long,
+        conversationId: Long,
+        postId: Long?,
+        text: String
+    ) {
+        context.dataStore.edit { data ->
+            data[getKey(serverHost, courseId, conversationId, postId)] = text
+        }
+    }
+
+    private fun getKey(
+        serverHost: String,
+        courseId: Long,
+        conversationId: Long,
+        postId: Long?
+    ): Preferences.Key<String> =
+        stringPreferencesKey("$serverHost|$courseId|$conversationId|$postId")
+}
diff --git a/...rmatics/www1/artemis/native_app/feature/metis/conversation/ui/ConversationDetailScreen.kt b/...rmatics/www1/artemis/native_app/feature/metis/conversation/ui/ConversationDetailScreen.kt
@@ -26,12 +26,14 @@ import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.focus.FocusRequester
 import androidx.compose.ui.focus.focusRequester
+import de.tum.informatics.www1.artemis.native_app.core.data.isSuccess
 import de.tum.informatics.www1.artemis.native_app.core.ui.common.BasicHintTextField
 import de.tum.informatics.www1.artemis.native_app.feature.metis.shared.content.MetisContext
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.ui.chatlist.MetisChatList
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.ui.chatlist.MetisListViewModel
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.ui.shared.isReplyEnabled
 import de.tum.informatics.www1.artemis.native_app.feature.metis.shared.ui.humanReadableName
+import io.github.fornewid.placeholder.material3.placeholder
 import org.koin.androidx.compose.koinViewModel
 import org.koin.core.parameter.parametersOf
 
@@ -93,7 +95,11 @@ fun ConversationScreen(
                             hintStyle = MaterialTheme.typography.bodyMedium
                         )
                     } else {
-                        Text(text = title, maxLines = 1)
+                        Text(
+                            modifier = Modifier.placeholder(!conversationDataState.isSuccess),
+                            text = title,
+                            maxLines = 1
+                        )
                     }
                 },
                 navigationIcon = {
@@ -127,14 +133,16 @@ fun ConversationScreen(
     ) { padding ->
         val isReplyEnabled = isReplyEnabled(conversationDataState = conversationDataState)
 
-        MetisChatList(
-            modifier = Modifier
-                .fillMaxSize()
-                .padding(padding),
-            viewModel = viewModel,
-            listContentPadding = PaddingValues(),
-            onClickViewPost = onClickViewPost,
-            isReplyEnabled = isReplyEnabled
-        )
+        if (conversationDataState.isSuccess) {
+            MetisChatList(
+                modifier = Modifier
+                    .fillMaxSize()
+                    .padding(padding),
+                viewModel = viewModel,
+                listContentPadding = PaddingValues(),
+                onClickViewPost = onClickViewPost,
+                isReplyEnabled = isReplyEnabled
+            )
+        }
     }
-}
+}
diff --git a/...formatics/www1/artemis/native_app/feature/metis/conversation/ui/chatlist/MetisChatList.kt b/...formatics/www1/artemis/native_app/feature/metis/conversation/ui/chatlist/MetisChatList.kt
@@ -76,6 +76,7 @@ internal fun MetisChatList(
     val hasModerationRights by viewModel.hasModerationRights.collectAsState()
 
     MetisReplyHandler(
+        initialReplyTextProvider = viewModel,
         onCreatePost = viewModel::createPost,
         onEditPost = viewModel::editPost,
         onDeletePost = viewModel::deletePost,

diff --git a/...tics/www1/artemis/native_app/feature/metis/conversation/ui/chatlist/MetisListViewModel.kt b/...tics/www1/artemis/native_app/feature/metis/conversation/ui/chatlist/MetisListViewModel.kt
@@ -24,6 +24,7 @@ import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.ser
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.network.MetisService
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.network.MetisService.StandalonePostsContext
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.storage.MetisStorageService
+import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.service.storage.ReplyTextStorageService
 import de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.ui.shared.MetisContentViewModel
 import de.tum.informatics.www1.artemis.native_app.feature.metis.shared.content.dto.CourseWideContext
 import de.tum.informatics.www1.artemis.native_app.feature.metis.shared.content.dto.DisplayPriority
@@ -39,6 +40,7 @@ import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.collectLatest
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.debounce
+import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.onStart
 import kotlinx.coroutines.flow.shareIn
@@ -65,6 +67,7 @@ internal class MetisListViewModel(
     accountDataService: AccountDataService,
     networkStatusProvider: NetworkStatusProvider,
     conversationService: ConversationService,
+    replyTextStorageService: ReplyTextStorageService,
     private val coroutineContext: CoroutineContext = EmptyCoroutineContext
 ) : MetisContentViewModel(
     initialMetisContext,
@@ -76,9 +79,9 @@ internal class MetisListViewModel(
     accountDataService,
     networkStatusProvider,
     conversationService,
+    replyTextStorageService,
     coroutineContext
 ) {
-
     private val _filter = MutableStateFlow<List<MetisFilter>>(emptyList())
     val filter: StateFlow<List<MetisFilter>> = _filter
 
@@ -181,8 +184,10 @@ internal class MetisListViewModel(
         }
     }
 
-    fun createPost(postText: String): Deferred<MetisModificationFailure?> {
+    fun createPost(): Deferred<MetisModificationFailure?> {
         return viewModelScope.async(coroutineContext) {
+            val postText = newMessageText.first()
+
             val conversation =
                 loadConversation() ?: return@async MetisModificationFailure.CREATE_POST
 
@@ -200,25 +205,11 @@ internal class MetisListViewModel(
         }
     }
 
-    fun addMetisFilter(metisFilter: MetisFilter) {
-        _filter.value = _filter.value + metisFilter
-    }
-
-    fun removeMetisFilter(metisFilter: MetisFilter) {
-        _filter.value = _filter.value.filterNot { it == metisFilter }
-    }
-
-    fun updateCourseWideContext(new: CourseWideContext?) {
-        _courseWideContext.value = new
-    }
-
     fun updateQuery(new: String) {
         _query.value = new.ifEmpty { null }
     }
 
-    fun updateSortingStrategy(new: MetisSortingStrategy) {
-        _sortingStrategy.value = new
-    }
+    override suspend fun getPostId(): Long? = null // by definition we are list, so no post
 
     private fun insertDateSeparators(pagingList: PagingData<ChatListItem.PostChatListItem>) =
         pagingList.insertSeparators { before: ChatListItem.PostChatListItem?, after: ChatListItem.PostChatListItem? ->

diff --git a/...s/www1/artemis/native_app/feature/metis/conversation/ui/reply/InitialReplyTextProvider.kt b/...s/www1/artemis/native_app/feature/metis/conversation/ui/reply/InitialReplyTextProvider.kt
@@ -0,0 +1,10 @@
+package de.tum.informatics.www1.artemis.native_app.feature.metis.conversation.ui.reply
+
+import kotlinx.coroutines.flow.Flow
+
+interface InitialReplyTextProvider {
+
+    val newMessageText: Flow<String>
+
+    fun updateInitialReplyText(text: String)
+}