ChannelLogic refactor (part 1) and event handling bug fixes

CHANGELOG.md

@@ -34,6 +34,7 @@
 
 ## stream-chat-android-state
 ### 🐞 Fixed
+- Fix `message.updated` and `message.deleted` events unhiding the channel. [#6038](https://github.com/GetStream/stream-chat-android/pull/6038)
 
 ### ⬆️ Improved
 

stream-chat-android-client-test/src/main/java/io/getstream/chat/android/client/test/Mother.kt

@@ -68,6 +68,7 @@ import io.getstream.chat.android.models.MessageReminder
 import io.getstream.chat.android.models.NeutralFilterObject
 import io.getstream.chat.android.models.Poll
 import io.getstream.chat.android.models.Reaction
+import io.getstream.chat.android.models.ThreadInfo
 import io.getstream.chat.android.models.User
 import io.getstream.chat.android.models.Vote
 import io.getstream.chat.android.models.querysort.QuerySortByField
@@ -86,6 +87,7 @@ import io.getstream.chat.android.randomPollAnswer
 import io.getstream.chat.android.randomPollVote
 import io.getstream.chat.android.randomReaction
 import io.getstream.chat.android.randomString
+import io.getstream.chat.android.randomThreadInfo
 import io.getstream.chat.android.randomUser
 import java.util.Date
 
@@ -291,6 +293,7 @@ public fun randomNotificationMarkReadEvent(
     unreadChannels: Int = randomInt(),
     lastReadMessageId: String? = randomString(),
     threadId: String? = randomString(),
+    thread: ThreadInfo? = randomThreadInfo(),
     unreadThreads: Int? = randomInt(),
     unreadThreadMessages: Int? = randomInt(),
 ): NotificationMarkReadEvent = NotificationMarkReadEvent(
@@ -305,6 +308,7 @@ public fun randomNotificationMarkReadEvent(
     unreadChannels = unreadChannels,
     lastReadMessageId = lastReadMessageId,
     threadId = threadId,
+    thread = thread,
     unreadThreads = unreadThreads,
     unreadThreadMessages = unreadThreadMessages,
 )

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/channel/state/ChannelState.kt

@@ -60,6 +60,7 @@ public interface ChannelState {
     public val messagesState: StateFlow<MessagesState>
 
     /** The collection of messages from previous pages of data.*/
+    @Deprecated("This property is not used anymore and will be removed in future versions.")
     public val oldMessages: StateFlow<List<Message>>
 
     /** The number of people currently watching the channel.*/
@@ -131,7 +132,7 @@ public interface ChannelState {
     public fun toChannel(): Channel
 
     /**
-     * Gets message using the ID. This is a more performatic way to request one message than request the whole list
+     * Gets message using the ID. This is a more performant way to request one message than request the whole list
      * of messages
      */
     public fun getMessageById(id: String): Message?

stream-chat-android-core/src/testFixtures/kotlin/io/getstream/chat/android/Mother.kt

@@ -59,6 +59,7 @@ import io.getstream.chat.android.models.Reaction
 import io.getstream.chat.android.models.ReactionGroup
 import io.getstream.chat.android.models.SyncStatus
 import io.getstream.chat.android.models.Thread
+import io.getstream.chat.android.models.ThreadInfo
 import io.getstream.chat.android.models.ThreadParticipant
 import io.getstream.chat.android.models.UnreadChannel
 import io.getstream.chat.android.models.UnreadChannelByType
@@ -1004,6 +1005,36 @@ public fun randomThread(
     draft = draftMessage,
 )
 
+public fun randomThreadInfo(
+    activeParticipantCount: Int = positiveRandomInt(),
+    cid: String = randomCID(),
+    parentMessageId: String = randomString(),
+    parentMessage: Message = randomMessage(id = parentMessageId),
+    createdByUserId: String = randomString(),
+    createdBy: User = randomUser(id = createdByUserId),
+    participantCount: Int = positiveRandomInt(),
+    lastMessageAt: Date = randomDate(),
+    createdAt: Date = randomDate(),
+    updatedAt: Date = randomDate(),
+    deletedAt: Date? = randomDateOrNull(),
+    replyCount: Int = positiveRandomInt(),
+    title: String = randomString(),
+): ThreadInfo = ThreadInfo(
+    activeParticipantCount = activeParticipantCount,
+    cid = cid,
+    parentMessageId = parentMessageId,
+    parentMessage = parentMessage,
+    createdByUserId = createdByUserId,
+    createdBy = createdBy,
+    participantCount = participantCount,
+    lastMessageAt = lastMessageAt,
+    createdAt = createdAt,
+    updatedAt = updatedAt,
+    deletedAt = deletedAt,
+    replyCount = replyCount,
+    title = title,
+)
+
 public fun randomAppSettings(
     app: App = randomApp(),
 ): AppSettings = AppSettings(

stream-chat-android-state/src/main/java/io/getstream/chat/android/state/event/handler/internal/utils/ChatEventUtils.kt

@@ -74,6 +74,6 @@ internal fun MarkAllReadEvent.toChannelUserRead() = ChannelUserRead(
     lastReceivedEventDate = createdAt,
     lastRead = createdAt,
     unreadMessages = 0,
-// TODO: Backend should send us the last read message id
+    // MarkAllReadEvent does not provide last read message ID because it is a global event
     lastReadMessageId = null,
 )

stream-chat-android-state/src/main/java/io/getstream/chat/android/state/extensions/ChatClient.kt

@@ -334,7 +334,7 @@ public fun ChatClient.loadOlderMessages(cid: String, messageLimit: Int): Call<Ch
             is Result.Success -> {
                 val (channelType, channelId) = cid.cidToTypeAndId()
                 logic.channel(channelType = channelType, channelId = channelId)
-                    .loadOlderMessages(messageLimit = messageLimit)
+                    .loadBefore(messageId = null, limit = messageLimit)
             }
             is Result.Failure -> cidValidationResult
         }
@@ -355,7 +355,7 @@ public fun ChatClient.loadNewerMessages(
             is Result.Success -> {
                 val (channelType, channelId) = channelCid.cidToTypeAndId()
                 logic.channel(channelType = channelType, channelId = channelId)
-                    .loadNewerMessages(messageId = baseMessageId, limit = messageLimit)
+                    .loadAfter(messageId = baseMessageId, limit = messageLimit)
             }
             is Result.Failure -> cidValidationResult
         }
@@ -380,7 +380,7 @@ public fun ChatClient.loadMessagesAroundId(
             is Result.Success -> {
                 val (channelType, channelId) = cid.cidToTypeAndId()
                 logic.channel(channelType = channelType, channelId = channelId)
-                    .loadMessagesAroundId(messageId)
+                    .loadAround(messageId)
             }
             is Result.Failure -> cidValidationResult
         }
@@ -474,7 +474,7 @@ private suspend fun ChatClient.loadMessageByIdInternal(
 
     val (channelType, channelId) = cid.cidToTypeAndId()
     val result = logic.channel(channelType = channelType, channelId = channelId)
-        .loadMessagesAroundId(messageId)
+        .loadAround(messageId)
 
     return when (result) {
         is Result.Success -> {

stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/listener/internal/EditMessageListenerState.kt

@@ -45,7 +45,7 @@ internal class EditMessageListenerState(
         val isOnline = clientState.isNetworkAvailable
         val messageToEdit = message.updateMessageOnlineState(isOnline)
 
-        logic.channelFromMessage(messageToEdit)?.stateLogic()?.upsertMessage(messageToEdit)
+        logic.channelFromMessage(messageToEdit)?.stateLogic?.upsertMessage(messageToEdit)
         logic.getActiveQueryThreadsLogic().forEach { it.upsertMessage(messageToEdit) }
         logic.threadFromMessage(messageToEdit)?.stateLogic()?.upsertMessage(messageToEdit)
     }
@@ -62,7 +62,7 @@ internal class EditMessageListenerState(
             is Result.Failure -> originalMessage.updateFailedMessage(result.value)
         }
 
-        logic.channelFromMessage(parsedMessage)?.stateLogic()?.upsertMessage(parsedMessage)
+        logic.channelFromMessage(parsedMessage)?.stateLogic?.upsertMessage(parsedMessage)
         logic.getActiveQueryThreadsLogic().forEach { it.upsertMessage(parsedMessage) }
         logic.threadFromMessage(parsedMessage)?.stateLogic()?.upsertMessage(parsedMessage)
     }

stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/listener/internal/HideChannelListenerState.kt

@@ -54,7 +54,7 @@ internal class HideChannelListenerState(private val logic: LogicRegistry) : Hide
      * @param clearHistory Boolean, if you want to clear the history of this channel or not.
      */
     override suspend fun onHideChannelRequest(channelType: String, channelId: String, clearHistory: Boolean) {
-        logic.channel(channelType, channelId).stateLogic().toggleHidden(true)
+        logic.channel(channelType, channelId).stateLogic.setHidden(true)
     }
 
     /**
@@ -71,7 +71,7 @@ internal class HideChannelListenerState(private val logic: LogicRegistry) : Hide
         channelId: String,
         clearHistory: Boolean,
     ) {
-        val channelStateLogic = logic.channel(channelType, channelId).stateLogic()
+        val channelStateLogic = logic.channel(channelType, channelId).stateLogic
         when (result) {
             is Result.Success -> {
                 if (clearHistory) {
@@ -82,7 +82,7 @@ internal class HideChannelListenerState(private val logic: LogicRegistry) : Hide
                     }
                 }
             }
-            is Result.Failure -> channelStateLogic.toggleHidden(false)
+            is Result.Failure -> channelStateLogic.setHidden(false)
         }
     }
 }

stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/listener/internal/PushPreferencesListenerState.kt

@@ -50,7 +50,7 @@ internal class PushPreferencesListenerState(private val logic: LogicRegistry) :
     private fun updateChannelPushPreference(cid: String, pushPreference: PushPreference) {
         val (type, id) = cid.cidToTypeAndId()
         logic.channel(type, id)
-            .stateLogic()
+            .stateLogic
             .updateChannelData { data ->
                 data?.copy(pushPreference = pushPreference)
             }

stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/listener/internal/QueryChannelListenerState.kt

@@ -76,9 +76,6 @@ internal class QueryChannelListenerState(private val logic: LogicRegistry) : Que
             "[onQueryChannelResult] cid: $channelType:$channelId, " +
                 "request: $request, result: ${result.stringify { it.cid }}"
         }
-        val channelStateLogic = logic.channel(channelType, channelId).stateLogic()
-
-        result.onSuccess { channel -> channelStateLogic.propagateChannelQuery(channel, request) }
-            .onError(channelStateLogic::propagateQueryError)
+        logic.channel(channelType, channelId).onQueryChannelResult(request, result)
     }
 }

stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/listener/internal/SendGiphyListenerState.kt

@@ -38,7 +38,7 @@ internal class SendGiphyListenerState(private val logic: LogicRegistry) : SendGi
     override fun onGiphySendResult(cid: String, result: Result<Message>) {
         if (result is Result.Success) {
             val message = result.value
-            logic.channelFromMessage(message)?.stateLogic()?.upsertMessage(message)
+            logic.channelFromMessage(message)?.stateLogic?.upsertMessage(message)
             logic.getActiveQueryThreadsLogic().forEach { it.upsertMessage(message) }
             logic.threadFromMessage(message)?.stateLogic()?.upsertMessage(message)
         }