[i236] fix message list blinking

CHANGELOG.md

@@ -59,6 +59,7 @@
 
 ## stream-chat-android-ui-components
 ### 🐞 Fixed
+- Fixed blinking of the message list. [#5150](https://github.com/GetStream/stream-chat-android/pull/5150)
 
 ### ⬆️ Improved
 

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/utils/buffer/StartStopBuffer.kt

@@ -18,6 +18,7 @@ package io.getstream.chat.android.client.utils.buffer
 
 import io.getstream.chat.android.core.internal.InternalStreamChatApi
 import io.getstream.chat.android.core.internal.coroutines.DispatcherProvider
+import io.getstream.log.taggedLogger
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.collectLatest
@@ -30,7 +31,13 @@ import java.util.concurrent.atomic.AtomicBoolean
 private const val NO_LIMIT = -1
 
 @InternalStreamChatApi
-public class StartStopBuffer<T>(private val bufferLimit: Int = NO_LIMIT, customTrigger: StateFlow<Boolean>? = null) {
+public class StartStopBuffer<T>(
+    suffix: String = "Default",
+    private val bufferLimit: Int = NO_LIMIT,
+    customTrigger: StateFlow<Boolean>? = null,
+) {
+
+    private val logger by taggedLogger("Chat:StartStopBuffer-$suffix")
 
     private val events: Queue<T> = ConcurrentLinkedQueue()
     private var active = AtomicBoolean(true)
@@ -39,8 +46,9 @@ public class StartStopBuffer<T>(private val bufferLimit: Int = NO_LIMIT, customT
     init {
         CoroutineScope(DispatcherProvider.IO).launch {
             customTrigger?.collectLatest { active ->
+                logger.v { "<init> active: $active" }
                 if (active) {
-                    active()
+                    active(src = "init")
                 } else {
                     hold()
                 }
@@ -52,33 +60,32 @@ public class StartStopBuffer<T>(private val bufferLimit: Int = NO_LIMIT, customT
         active.set(false)
     }
 
-    public fun active() {
+    public fun active(src: String) {
         active.set(true)
-
         if (func != null) {
-            propagateData()
+            propagateData(src = src)
         }
     }
 
     public fun subscribe(func: (T) -> Unit) {
         this.func = func
 
         if (active.get()) {
-            propagateData()
+            propagateData(src = "subscribe")
         }
     }
 
     public fun enqueueData(data: T) {
         events.offer(data)
 
         if (active.get() || aboveSafetyThreshold()) {
-            propagateData()
+            propagateData(src = "enqueue")
         }
     }
 
     private fun aboveSafetyThreshold(): Boolean = events.size > bufferLimit && bufferLimit != NO_LIMIT
 
-    private fun propagateData() {
+    private fun propagateData(src: String) {
         CoroutineScope(DispatcherProvider.IO).launch {
             while (active.get() && events.isNotEmpty() || aboveSafetyThreshold()) {
                 events.poll()?.let {

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/utils/buffer/StartStopBufferTest.kt

@@ -35,7 +35,7 @@ internal class StartStopBufferTest {
             val data = randomString()
             var resultText = ""
 
-            active()
+            active(src = "test")
             subscribe { result ->
                 resultText = result
             }
@@ -79,7 +79,7 @@ internal class StartStopBufferTest {
 
             lastNumber `should be equal to` "0"
 
-            active()
+            active(src = "test")
 
             lastNumber `should be equal to` data1
         }
@@ -106,7 +106,7 @@ internal class StartStopBufferTest {
 
             lastNumber `should be equal to` "0"
 
-            active()
+            active(src = "test")
 
             lastNumber `should be equal to` data1
         }
@@ -132,7 +132,7 @@ internal class StartStopBufferTest {
 
             lastNumber `should be equal to` "0"
 
-            active()
+            active(src = "test")
 
             lastNumber `should be equal to` data3
         }
@@ -159,8 +159,8 @@ internal class StartStopBufferTest {
 
             lastNumber `should be equal to` "0"
 
-            active()
-            active()
+            active(src = "test")
+            active(src = "test")
 
             lastNumber `should be equal to` data2
         }

stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/logic/channel/internal/UnreadCountLogic.kt

@@ -54,6 +54,7 @@ internal class UnreadCountLogic(
     private val globalState: GlobalState,
     private val unreadTrigger: StateFlow<Boolean>,
     private val countBuffer: StartStopBuffer<ChatEvent> = StartStopBuffer(
+        suffix = "UCL",
         bufferLimit = COUNT_BUFFER_LIMIT,
         customTrigger = unreadTrigger,
     ),

stream-chat-android-ui-components/api/stream-chat-android-ui-components.api

@@ -2120,6 +2120,7 @@ public final class io/getstream/chat/android/ui/feature/messages/list/MessageLis
 	public final fun showMessageOptionsDialog (Landroidx/fragment/app/FragmentManager;Lio/getstream/chat/android/models/Message;Ljava/util/List;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function1;)V
 	public static synthetic fun showMessageOptionsDialog$default (Lio/getstream/chat/android/ui/feature/messages/list/MessageListView;Landroidx/fragment/app/FragmentManager;Lio/getstream/chat/android/models/Message;Ljava/util/List;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)V
 	public final fun showModeratedMessageDialog (Lio/getstream/chat/android/models/Message;)V
+	public final fun updateChannel (Lio/getstream/chat/android/models/Channel;)V
 }
 
 public abstract interface class io/getstream/chat/android/ui/feature/messages/list/MessageListView$AttachmentClickListener {
@@ -2533,6 +2534,7 @@ public abstract class io/getstream/chat/android/ui/feature/messages/list/adapter
 
 public abstract class io/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem {
 	public final fun getStableId ()J
+	public abstract fun stringify ()Ljava/lang/String;
 }
 
 public final class io/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem$DateSeparatorItem : io/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem {
@@ -2543,11 +2545,15 @@ public final class io/getstream/chat/android/ui/feature/messages/list/adapter/Me
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getDate ()Ljava/util/Date;
 	public fun hashCode ()I
+	public fun stringify ()Ljava/lang/String;
 	public fun toString ()Ljava/lang/String;
 }
 
 public final class io/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem$LoadingMoreIndicatorItem : io/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem {
 	public static final field INSTANCE Lio/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem$LoadingMoreIndicatorItem;
+	public fun equals (Ljava/lang/Object;)Z
+	public fun hashCode ()I
+	public fun stringify ()Ljava/lang/String;
 	public fun toString ()Ljava/lang/String;
 }
 
@@ -2573,6 +2579,7 @@ public final class io/getstream/chat/android/ui/feature/messages/list/adapter/Me
 	public final fun isMine ()Z
 	public final fun isTheirs ()Z
 	public final fun isThreadMode ()Z
+	public fun stringify ()Ljava/lang/String;
 	public fun toString ()Ljava/lang/String;
 }
 
@@ -2584,11 +2591,15 @@ public final class io/getstream/chat/android/ui/feature/messages/list/adapter/Me
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getChannel ()Lio/getstream/chat/android/models/Channel;
 	public fun hashCode ()I
+	public fun stringify ()Ljava/lang/String;
 	public fun toString ()Ljava/lang/String;
 }
 
 public final class io/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem$ThreadPlaceholderItem : io/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem {
 	public static final field INSTANCE Lio/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem$ThreadPlaceholderItem;
+	public fun equals (Ljava/lang/Object;)Z
+	public fun hashCode ()I
+	public fun stringify ()Ljava/lang/String;
 	public fun toString ()Ljava/lang/String;
 }
 
@@ -2602,6 +2613,7 @@ public final class io/getstream/chat/android/ui/feature/messages/list/adapter/Me
 	public final fun getDate ()Ljava/util/Date;
 	public final fun getMessageCount ()I
 	public fun hashCode ()I
+	public fun stringify ()Ljava/lang/String;
 	public fun toString ()Ljava/lang/String;
 }
 
@@ -2613,6 +2625,7 @@ public final class io/getstream/chat/android/ui/feature/messages/list/adapter/Me
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getUsers ()Ljava/util/List;
 	public fun hashCode ()I
+	public fun stringify ()Ljava/lang/String;
 	public fun toString ()Ljava/lang/String;
 }
 
@@ -2624,6 +2637,7 @@ public final class io/getstream/chat/android/ui/feature/messages/list/adapter/Me
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getUnreadCount ()I
 	public fun hashCode ()I
+	public fun stringify ()Ljava/lang/String;
 	public fun toString ()Ljava/lang/String;
 }
 

stream-chat-android-ui-components/src/main/kotlin/io/getstream/chat/android/ui/feature/messages/list/MessageListView.kt

@@ -35,7 +35,6 @@ import io.getstream.chat.android.client.ChatClient
 import io.getstream.chat.android.client.utils.attachment.isGiphy
 import io.getstream.chat.android.client.utils.attachment.isImage
 import io.getstream.chat.android.client.utils.attachment.isVideo
-import io.getstream.chat.android.client.utils.buffer.StartStopBuffer
 import io.getstream.chat.android.client.utils.message.isModerationError
 import io.getstream.chat.android.client.utils.message.isThreadReply
 import io.getstream.chat.android.core.ExperimentalStreamChatApi
@@ -165,8 +164,6 @@ public class MessageListView : ConstraintLayout {
 
     private lateinit var binding: StreamUiMessageListViewBinding
 
-    private val buffer: StartStopBuffer<MessageListItemWrapper> = StartStopBuffer()
-
     private lateinit var adapter: MessageListItemAdapter
     private lateinit var loadingView: View
     private lateinit var loadingViewContainer: ViewGroup
@@ -367,7 +364,11 @@ public class MessageListView : ConstraintLayout {
                 } else {
                     val style = requireStyle()
                     val isEditEnabled = style.editMessageEnabled && !message.isGiphyNotEphemeral()
-                    val viewStyle = style.copy(editMessageEnabled = isEditEnabled)
+                    val isThreadEnabled = style.threadsEnabled && channel.config.isThreadEnabled
+                    val viewStyle = style.copy(
+                        editMessageEnabled = isEditEnabled,
+                        threadsEnabled = isThreadEnabled,
+                    )
 
                     val messageOptionItems = messageOptionItemsFactory.createMessageOptionItems(
                         selectedMessage = message,
@@ -613,9 +614,6 @@ public class MessageListView : ConstraintLayout {
         binding.defaultEmptyStateView.setTextStyle(requireStyle().emptyViewTextStyle)
 
         layoutTransition = LayoutTransition()
-
-        buffer.subscribe(::handleNewWrapper)
-        buffer.active()
     }
 
     private fun initLoadingView() {
@@ -770,22 +768,37 @@ public class MessageListView : ConstraintLayout {
         binding.chatMessagesRV.adapter = adapter
     }
 
+    /**
+     * Updates the channel object used by the message list and initializes adapter if it's not initialized yet.
+     *
+     * @param channel The channel object.
+     */
+    public fun updateChannel(channel: Channel) {
+        this.channel = channel
+        initAdapter()
+    }
+
     /**
      * Initializes the message list view with the [Channel] object.
      *
      * @param channel The channel object.
      */
+    @Deprecated(
+        message = "Use updateChannel instead",
+        replaceWith = ReplaceWith("updateChannel(channel)"),
+        level = DeprecationLevel.WARNING,
+    )
     public fun init(channel: Channel) {
         this.channel = channel
         initAdapter()
-
-        messageListViewStyle = requireStyle().copy(
-            replyEnabled = requireStyle().replyEnabled,
-            threadsEnabled = requireStyle().threadsEnabled && channel.config.isThreadEnabled,
-        )
     }
 
     private fun initAdapter() {
+        if (::adapter.isInitialized) {
+            logger.v { "[initAdapter] rejected (already initialized)" }
+            return
+        }
+        val style = requireStyle()
         // Create default DateFormatter if needed
         if (::messageDateFormatter.isInitialized.not()) {
             messageDateFormatter = ChatUI.dateFormatter
@@ -801,7 +814,7 @@ public class MessageListView : ConstraintLayout {
         }
 
         if (::messageBackgroundFactory.isInitialized.not()) {
-            messageBackgroundFactory = MessageBackgroundFactoryImpl(requireStyle().itemStyle)
+            messageBackgroundFactory = MessageBackgroundFactoryImpl(style.itemStyle)
         }
 
         if (::messageOptionItemsFactory.isInitialized.not()) {
@@ -811,7 +824,7 @@ public class MessageListView : ConstraintLayout {
         messageListItemViewHolderFactory.decoratorProvider = ChatUI.decoratorProviderFactory.createDecoratorProvider(
             channel = channel,
             dateFormatter = messageDateFormatter,
-            messageListViewStyle = requireStyle(),
+            messageListViewStyle = style,
             showAvatarPredicate = this.showAvatarPredicate,
             messageBackgroundFactory = messageBackgroundFactory,
             deletedMessageVisibility = { deletedMessageVisibility },
@@ -820,15 +833,14 @@ public class MessageListView : ConstraintLayout {
 
         messageListItemViewHolderFactory.setListenerContainer(this.listenerContainer)
         messageListItemViewHolderFactory.setAttachmentFactoryManager(this.attachmentFactoryManager)
-        messageListItemViewHolderFactory.setMessageListItemStyle(requireStyle().itemStyle)
-        messageListItemViewHolderFactory.setGiphyViewHolderStyle(requireStyle().giphyViewHolderStyle)
-        messageListItemViewHolderFactory.setAudioRecordViewStyle(requireStyle().audioRecordPlayerViewStyle)
-        messageListItemViewHolderFactory.setReplyMessageListItemViewStyle(requireStyle().replyMessageStyle)
-
-        adapter = MessageListItemAdapter(messageListItemViewHolderFactory)
-        adapter.setHasStableIds(true)
+        messageListItemViewHolderFactory.setMessageListItemStyle(style.itemStyle)
+        messageListItemViewHolderFactory.setGiphyViewHolderStyle(style.giphyViewHolderStyle)
+        messageListItemViewHolderFactory.setAudioRecordViewStyle(style.audioRecordPlayerViewStyle)
+        messageListItemViewHolderFactory.setReplyMessageListItemViewStyle(style.replyMessageStyle)
 
-        setMessageListItemAdapter(adapter)
+        adapter = MessageListItemAdapter(messageListItemViewHolderFactory).also {
+            setMessageListItemAdapter(it)
+        }
     }
 
     /**
@@ -1090,7 +1102,7 @@ public class MessageListView : ConstraintLayout {
      * the message list.
      */
     public fun displayNewMessages(messageListItemWrapper: MessageListItemWrapper) {
-        buffer.enqueueData(messageListItemWrapper)
+        handleNewWrapper(messageListItemWrapper)
     }
 
     /**
@@ -1162,8 +1174,6 @@ public class MessageListView : ConstraintLayout {
                 .let(messageListItemTransformer::transform)
 
             withContext(DispatcherProvider.Main) {
-                buffer.hold()
-
                 val isThreadStart = !adapter.isThread && listItem.isThread ||
                     (listItem.isThread && listItem.items.size > 1 && adapter.itemCount <= 1)
                 val isNormalModeStart = adapter.isThread && !listItem.isThread
@@ -1183,15 +1193,14 @@ public class MessageListView : ConstraintLayout {
                     messageListViewStyle?.messagesStart?.let(::chatMessageStart)
                 }
 
+                logger.v { "[handleNewWrapper] filteredList.size: ${filteredList.size}" }
                 adapter.submitList(filteredList) {
                     scrollHelper.onMessageListChanged(
                         isThreadStart = isThreadStart,
                         hasNewMessages = listItem.hasNewMessages,
                         isInitialList = isOldListEmpty && filteredList.isNotEmpty(),
                         areNewestMessagesLoaded = listItem.areNewestMessagesLoaded,
                     )
-
-                    buffer.active()
                 }
             }
         }