Prioritize createdLocallyAt over createdAt for sorting messages. (#5993)

* Prioritize createdLocallyAt over createdAt for sorting messages.

* Fix existing and add new tests.

* Update CHANGELOG.md.

* Fix tests.

* Fix tests.

* Fix tests.

* Add tests.

* Add tests.

* Add tests.

* Simplify tests.

Author: VelikovPetar

CHANGELOG.md

@@ -36,6 +36,7 @@
 ### 🐞 Fixed
 
 ### ⬆️ Improved
+- Prioritize `Message.createdLocallyAt` over `Message.createdAt` when sorting messages, to ensure the message order is consistent before the messages are synced with the server. [#5993](https://github.com/GetStream/stream-chat-android/pull/5993)
 
 ### ✅ Added
 

stream-chat-android-ai-assistant/src/main/kotlin/io/getstream/chat/android/ai/assistant/AiMessageContentFactory.kt

@@ -27,6 +27,7 @@ import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.platform.testTag
 import androidx.compose.ui.text.style.TextOverflow
 import androidx.compose.ui.unit.dp
+import io.getstream.chat.android.client.extensions.getCreatedAtOrNull
 import io.getstream.chat.android.client.utils.message.belongsToThread
 import io.getstream.chat.android.compose.R
 import io.getstream.chat.android.compose.state.DateFormatType
@@ -91,7 +92,7 @@ internal class AiMessageContentFactory : MessageContentFactory() {
                     }
 
                     val updatedAt = message.updatedAt
-                    val createdAt = message.createdAt ?: message.createdLocallyAt
+                    val createdAt = message.getCreatedAtOrNull()
                     val date = when {
                         createdAt == null -> updatedAt
                         updatedAt == null -> createdAt

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/extensions/MessageExtensions.kt

@@ -74,7 +74,7 @@ public fun Message.getCreatedAtOrThrow(): Date {
  * @return when the message was created or null.
  */
 public fun Message.getCreatedAtOrNull(): Date? {
-    return createdAt ?: createdLocallyAt
+    return createdLocallyAt ?: createdAt
 }
 
 /**

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/extensions/internal/Channel.kt

@@ -16,6 +16,8 @@
 
 package io.getstream.chat.android.client.extensions.internal
 
+import io.getstream.chat.android.client.extensions.getCreatedAtOrDefault
+import io.getstream.chat.android.client.extensions.getCreatedAtOrNull
 import io.getstream.chat.android.client.extensions.syncUnreadCountWithReads
 import io.getstream.chat.android.client.query.pagination.AnyChannelPaginationRequest
 import io.getstream.chat.android.client.utils.message.isDeleted
@@ -53,7 +55,7 @@ public fun Channel.users(): List<User> {
 public val Channel.lastMessage: Message?
     get() = messages
         .filterNot { it.isDeleted() }
-        .maxByOrNull { it.createdAt ?: it.createdLocallyAt ?: Date(0) }
+        .maxByOrNull { it.getCreatedAtOrDefault(NEVER) }
 
 /**
  * Updates the [Channel] with newest [Message].
@@ -68,7 +70,7 @@ public fun Channel.updateLastMessage(
     message: Message,
     currentUserId: String,
 ): Channel {
-    val createdAt = message.createdAt ?: message.createdLocallyAt
+    val createdAt = message.getCreatedAtOrNull()
     checkNotNull(createdAt) { "created at cant be null, be sure to set message.createdAt" }
 
     val newMessages = (
@@ -77,7 +79,7 @@ public fun Channel.updateLastMessage(
         )
         .values
         .filterNot { it.isDeleted() }
-        .sortedBy { it.createdAt ?: it.createdLocallyAt }
+        .sortedBy { it.getCreatedAtOrNull() }
 
     val newReads = read.map { read ->
         read.takeUnless { it.user.id == currentUserId }

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/extensions/internal/Message.kt

@@ -16,6 +16,7 @@
 
 package io.getstream.chat.android.client.extensions.internal
 
+import io.getstream.chat.android.client.extensions.getCreatedAtOrDefault
 import io.getstream.chat.android.core.internal.InternalStreamChatApi
 import io.getstream.chat.android.models.Attachment
 import io.getstream.chat.android.models.Channel
@@ -92,31 +93,31 @@ public val NEVER: Date = Date(0)
  */
 @InternalStreamChatApi
 public fun Message.wasCreatedAfterOrAt(date: Date?): Boolean {
-    return (createdAt ?: createdLocallyAt ?: NEVER) >= date
+    return getCreatedAtOrDefault(NEVER) >= date
 }
 
 /**
  * Checks if the message was created after the given [date].
  */
 @InternalStreamChatApi
 public fun Message.wasCreatedAfter(date: Date?): Boolean {
-    return (createdAt ?: createdLocallyAt ?: NEVER) > date
+    return getCreatedAtOrDefault(NEVER) > date
 }
 
 /**
  * Checks if the message was created before the given [date].
  */
 @InternalStreamChatApi
 public fun Message.wasCreatedBefore(date: Date?): Boolean {
-    return (createdAt ?: createdLocallyAt ?: NEVER) < date
+    return getCreatedAtOrDefault(NEVER) < date
 }
 
 /**
  * Checks if the message was created before or at the given [date].
  */
 @InternalStreamChatApi
 public fun Message.wasCreatedBeforeOrAt(date: Date?): Boolean {
-    return (createdAt ?: createdLocallyAt ?: NEVER) <= date
+    return getCreatedAtOrDefault(NEVER) <= date
 }
 
 /**

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/extensions/internal/Thread.kt

@@ -16,6 +16,7 @@
 
 package io.getstream.chat.android.client.extensions.internal
 
+import io.getstream.chat.android.client.extensions.getCreatedAtOrNull
 import io.getstream.chat.android.core.internal.InternalStreamChatApi
 import io.getstream.chat.android.models.ChannelUserRead
 import io.getstream.chat.android.models.Message
@@ -64,11 +65,9 @@ public fun Thread.upsertReply(reply: Message): Thread {
     val newReplies = upsertMessageInList(reply, this.latestReplies)
     val isInsert = newReplies.size > this.latestReplies.size
     val sortedNewReplies = newReplies.sortedBy {
-        it.createdAt ?: it.createdLocallyAt
-    }
-    val lastMessageAt = sortedNewReplies.lastOrNull()?.let { latestReply ->
-        latestReply.createdAt ?: latestReply.createdLocallyAt
+        it.getCreatedAtOrNull()
     }
+    val lastMessageAt = sortedNewReplies.lastOrNull()?.getCreatedAtOrNull()
     // The new message could be from a new thread participant
     val threadParticipants = if (isInsert) {
         upsertThreadParticipantInList(

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/interceptor/message/internal/PrepareMessageLogicImpl.kt

@@ -19,6 +19,7 @@ package io.getstream.chat.android.client.interceptor.message.internal
 import io.getstream.chat.android.client.channel.state.ChannelStateLogicProvider
 import io.getstream.chat.android.client.extensions.EXTRA_UPLOAD_ID
 import io.getstream.chat.android.client.extensions.enrichWithCid
+import io.getstream.chat.android.client.extensions.getCreatedAtOrDefault
 import io.getstream.chat.android.client.extensions.internal.populateMentions
 import io.getstream.chat.android.client.extensions.uploadId
 import io.getstream.chat.android.client.interceptor.message.PrepareMessageLogic
@@ -66,7 +67,7 @@ internal class PrepareMessageLogicImpl(
             user = user,
             attachments = attachments,
             type = getMessageType(message),
-            createdLocallyAt = message.createdAt ?: message.createdLocallyAt ?: Date(),
+            createdLocallyAt = message.getCreatedAtOrDefault(Date()),
             syncStatus = when {
                 attachments.any { it.uploadState is Attachment.UploadState.Idle } -> SyncStatus.AWAITING_ATTACHMENTS
                 clientState.isNetworkAvailable -> SyncStatus.IN_PROGRESS

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/notifications/handler/MessagingStyleNotificationFactory.kt

@@ -29,6 +29,7 @@ import androidx.core.app.Person
 import androidx.core.content.ContextCompat
 import io.getstream.chat.android.client.ChatClient
 import io.getstream.chat.android.client.R
+import io.getstream.chat.android.client.extensions.getCreatedAtOrDefault
 import io.getstream.chat.android.models.Channel
 import io.getstream.chat.android.models.Message
 import io.getstream.chat.android.models.User
@@ -176,7 +177,7 @@ internal class MessagingStyleNotificationFactory(
     private suspend fun Message.person(context: Context): Person = user.toPerson(context)
 
     private val Message.timestamp: Long
-        get() = (createdAt ?: createdLocallyAt ?: Date()).time
+        get() = getCreatedAtOrDefault(Date()).time
 
     private suspend fun User.toPerson(context: Context): Person =
         Person.Builder()

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/utils/message/MessageUtils.kt

@@ -19,6 +19,7 @@
 
 package io.getstream.chat.android.client.utils.message
 
+import io.getstream.chat.android.client.extensions.getCreatedAtOrNull
 import io.getstream.chat.android.core.internal.InternalStreamChatApi
 import io.getstream.chat.android.core.utils.date.after
 import io.getstream.chat.android.models.AttachmentType
@@ -55,8 +56,8 @@ public fun List<Message>.latestOrNull(): Message? = when (size >= ITEM_COUNT_OF_
  */
 @InternalStreamChatApi
 public fun Message.createdAfter(that: Message): Boolean {
-    val thisDate = this.createdAt ?: this.createdLocallyAt
-    val thatDate = that.createdAt ?: that.createdLocallyAt
+    val thisDate = this.getCreatedAtOrNull()
+    val thatDate = that.getCreatedAtOrNull()
     return thisDate after thatDate
 }
 

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/extensions/ChannelExtensionsTests.kt

@@ -127,15 +127,18 @@ internal class ChannelExtensionsTests {
                 text = "Hello @${user.id}",
                 mentionedUsers = listOf(user),
                 createdAt = Date(lastReadDate.time - 1000),
+                createdLocallyAt = null,
             ),
             randomMessage(
                 text = "Hi @${user.id}",
                 mentionedUsers = listOf(user),
                 createdAt = Date(lastReadDate.time + 1000),
+                createdLocallyAt = null,
             ),
             randomMessage(
                 text = "No mention here",
                 createdAt = Date(lastReadDate.time + 2000),
+                createdLocallyAt = null,
             ),
         )
         val channelRead = randomChannelUserRead(user = user, lastRead = lastReadDate)