Merge pull request #7951 from vector-im/feature/mna/poll-history-load-more-ui

[Poll] History list: Load more UI mechanism (PSG-1095)

Author: mnaturel

changelog.d/7864.wip

@@ -0,0 +1 @@
+[Poll] History list: Load more UI mechanism

library/ui-strings/src/main/res/values/strings.xml

@@ -3199,8 +3199,19 @@
     <string name="unable_to_decrypt_some_events_in_poll">Due to decryption errors, some votes may not be counted</string>
     <string name="room_polls_active">Active polls</string>
     <string name="room_polls_active_no_item">There are no active polls in this room</string>
+    <plurals name="room_polls_active_no_item_for_loaded_period">
+        <item quantity="one">"There are no active polls for the past day.\nLoad more polls to view polls for previous days."</item>
+        <item quantity="other">"There are no active polls for the past %1$d days.\nLoad more polls to view polls for previous days."</item>
+    </plurals>
     <string name="room_polls_ended">Past polls</string>
     <string name="room_polls_ended_no_item">There are no past polls in this room</string>
+    <plurals name="room_polls_ended_no_item_for_loaded_period">
+        <item quantity="one">"There are no past polls for the past day.\nLoad more polls to view polls for previous days."</item>
+        <item quantity="other">"There are no past polls for the past %1$d days.\nLoad more polls to view polls for previous days."</item>
+    </plurals>
+    <string name="room_polls_wait_for_display">Displaying polls</string>
+    <string name="room_polls_load_more">Load more polls</string>
+    <string name="room_polls_loading_error">Error fetching polls.</string>
 
     <!-- Location -->
     <string name="location_activity_title_static_sharing">Share location</string>

vector/src/main/java/im/vector/app/core/error/ErrorFormatter.kt

@@ -20,6 +20,7 @@ import android.content.ActivityNotFoundException
 import im.vector.app.R
 import im.vector.app.core.resources.StringProvider
 import im.vector.app.features.call.dialpad.DialPadLookup
+import im.vector.app.features.roomprofile.polls.RoomPollsLoadingError
 import im.vector.app.features.voice.VoiceFailure
 import im.vector.app.features.voicebroadcast.VoiceBroadcastFailure
 import im.vector.app.features.voicebroadcast.VoiceBroadcastFailure.RecordingError
@@ -138,6 +139,7 @@ class DefaultErrorFormatter @Inject constructor(
                 stringProvider.getString(R.string.login_signin_matrix_id_error_invalid_matrix_id)
             is VoiceFailure -> voiceMessageError(throwable)
             is VoiceBroadcastFailure -> voiceBroadcastMessageError(throwable)
+            is RoomPollsLoadingError -> stringProvider.getString(R.string.room_polls_loading_error)
             is ActivityNotFoundException ->
                 stringProvider.getString(R.string.error_no_external_application_found)
             else -> throwable.localizedMessage

vector/src/main/java/im/vector/app/features/roomprofile/RoomProfileActivity.kt

@@ -76,6 +76,8 @@ class RoomProfileActivity :
         return ActivitySimpleBinding.inflate(layoutInflater)
     }
 
+    override fun getCoordinatorLayout() = views.coordinatorLayout
+
     override fun initUiAndData() {
         sharedActionViewModel = viewModelProvider.get(RoomProfileSharedActionViewModel::class.java)
         roomProfileArgs = intent?.extras?.getParcelableCompat(Mavericks.KEY_ARG) ?: return

vector/src/main/java/im/vector/app/features/roomprofile/polls/RoomPollsAction.kt

@@ -18,4 +18,6 @@ package im.vector.app.features.roomprofile.polls
 
 import im.vector.app.core.platform.VectorViewModelAction
 
-sealed interface RoomPollsAction : VectorViewModelAction
+sealed interface RoomPollsAction : VectorViewModelAction {
+    object LoadMorePolls : RoomPollsAction
+}

vector/src/main/java/im/vector/app/features/roomprofile/polls/RoomPollsLoadingError.kt

@@ -0,0 +1,19 @@
+/*
+ * 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 im.vector.app.features.roomprofile.polls
+
+class RoomPollsLoadingError : Throwable()

vector/src/main/java/im/vector/app/features/roomprofile/polls/RoomPollsViewEvent.kt

@@ -18,4 +18,6 @@ package im.vector.app.features.roomprofile.polls
 
 import im.vector.app.core.platform.VectorViewEvents
 
-sealed class RoomPollsViewEvent : VectorViewEvents
+sealed class RoomPollsViewEvent : VectorViewEvents {
+    object LoadingError : RoomPollsViewEvent()
+}

vector/src/main/java/im/vector/app/features/roomprofile/polls/RoomPollsViewModel.kt

@@ -23,12 +23,20 @@ import dagger.assisted.AssistedInject
 import im.vector.app.core.di.MavericksAssistedViewModelFactory
 import im.vector.app.core.di.hiltMavericksViewModelFactory
 import im.vector.app.core.platform.VectorViewModel
+import im.vector.app.features.roomprofile.polls.list.domain.GetLoadedPollsStatusUseCase
+import im.vector.app.features.roomprofile.polls.list.domain.GetPollsUseCase
+import im.vector.app.features.roomprofile.polls.list.domain.LoadMorePollsUseCase
+import im.vector.app.features.roomprofile.polls.list.domain.SyncPollsUseCase
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
+import kotlinx.coroutines.launch
 
 class RoomPollsViewModel @AssistedInject constructor(
         @Assisted initialState: RoomPollsViewState,
         private val getPollsUseCase: GetPollsUseCase,
+        private val getLoadedPollsStatusUseCase: GetLoadedPollsStatusUseCase,
+        private val loadMorePollsUseCase: LoadMorePollsUseCase,
+        private val syncPollsUseCase: SyncPollsUseCase,
 ) : VectorViewModel<RoomPollsViewState, RoomPollsAction, RoomPollsViewEvent>(initialState) {
 
     @AssistedFactory
@@ -39,16 +47,63 @@ class RoomPollsViewModel @AssistedInject constructor(
     companion object : MavericksViewModelFactory<RoomPollsViewModel, RoomPollsViewState> by hiltMavericksViewModelFactory()
 
     init {
-        observePolls()
+        val roomId = initialState.roomId
+        updateLoadedPollStatus(roomId)
+        syncPolls(roomId)
+        observePolls(roomId)
     }
 
-    private fun observePolls() {
-        getPollsUseCase.execute()
+    private fun updateLoadedPollStatus(roomId: String) {
+        val loadedPollsStatus = getLoadedPollsStatusUseCase.execute(roomId)
+        setState {
+            copy(
+                    canLoadMore = loadedPollsStatus.canLoadMore,
+                    nbLoadedDays = loadedPollsStatus.nbLoadedDays
+            )
+        }
+    }
+
+    private fun syncPolls(roomId: String) {
+        viewModelScope.launch {
+            setState { copy(isSyncing = true) }
+            val result = runCatching {
+                syncPollsUseCase.execute(roomId)
+            }
+            if (result.isFailure) {
+                _viewEvents.post(RoomPollsViewEvent.LoadingError)
+            }
+            setState { copy(isSyncing = false) }
+        }
+    }
+
+    private fun observePolls(roomId: String) {
+        getPollsUseCase.execute(roomId)
                 .onEach { setState { copy(polls = it) } }
                 .launchIn(viewModelScope)
     }
 
     override fun handle(action: RoomPollsAction) {
-        // do nothing for now
+        when (action) {
+            RoomPollsAction.LoadMorePolls -> handleLoadMore()
+        }
+    }
+
+    private fun handleLoadMore() = withState { viewState ->
+        viewModelScope.launch {
+            setState { copy(isLoadingMore = true) }
+            val result = runCatching {
+                val status = loadMorePollsUseCase.execute(viewState.roomId)
+                setState {
+                    copy(
+                            canLoadMore = status.canLoadMore,
+                            nbLoadedDays = status.nbLoadedDays,
+                    )
+                }
+            }
+            if (result.isFailure) {
+                _viewEvents.post(RoomPollsViewEvent.LoadingError)
+            }
+            setState { copy(isLoadingMore = false) }
+        }
     }
 }

vector/src/main/java/im/vector/app/features/roomprofile/polls/RoomPollsViewState.kt

@@ -18,11 +18,19 @@ package im.vector.app.features.roomprofile.polls
 
 import com.airbnb.mvrx.MavericksState
 import im.vector.app.features.roomprofile.RoomProfileArgs
+import im.vector.app.features.roomprofile.polls.list.ui.PollSummary
 
 data class RoomPollsViewState(
         val roomId: String,
         val polls: List<PollSummary> = emptyList(),
+        val isLoadingMore: Boolean = false,
+        val canLoadMore: Boolean = true,
+        val nbLoadedDays: Int = 0,
+        val isSyncing: Boolean = false,
 ) : MavericksState {
 
     constructor(roomProfileArgs: RoomProfileArgs) : this(roomId = roomProfileArgs.roomId)
+
+    fun hasNoPolls() = polls.isEmpty()
+    fun hasNoPollsAndCanLoadMore() = !isSyncing && hasNoPolls() && canLoadMore
 }

vector/src/main/java/im/vector/app/features/roomprofile/polls/active/RoomActivePollsFragment.kt

@@ -19,13 +19,17 @@ package im.vector.app.features.roomprofile.polls.active
 import dagger.hilt.android.AndroidEntryPoint
 import im.vector.app.R
 import im.vector.app.features.roomprofile.polls.RoomPollsType
-import im.vector.app.features.roomprofile.polls.list.RoomPollsListFragment
+import im.vector.app.features.roomprofile.polls.list.ui.RoomPollsListFragment
 
 @AndroidEntryPoint
 class RoomActivePollsFragment : RoomPollsListFragment() {
 
-    override fun getEmptyListTitle(): String {
-        return getString(R.string.room_polls_active_no_item)
+    override fun getEmptyListTitle(canLoadMore: Boolean, nbLoadedDays: Int): String {
+        return if (canLoadMore) {
+            stringProvider.getQuantityString(R.plurals.room_polls_active_no_item_for_loaded_period, nbLoadedDays, nbLoadedDays)
+        } else {
+            getString(R.string.room_polls_active_no_item)
+        }
     }
 
     override fun getRoomPollsType(): RoomPollsType {