Refactor: Move message receipt logic to client

Moves the `MessageReceiptRepository` and related classes from the `stream-chat-android-offline` module to the `stream-chat-android-client` module. This refactoring centralizes persistence logic within the client module.

The moved classes have been renamed and their package structure updated. Method names within the repository have been made more specific (e.g., `upsert` is now `upsertMessageReceipts`). The `MessageReceiptRepository` is now an internal interface with a companion object factory.

Author: andremion

stream-chat-android-client/api/stream-chat-android-client.api

@@ -2983,6 +2983,24 @@ public abstract interface class io/getstream/chat/android/client/persistance/rep
 	public abstract fun createRepositoryFactory (Lio/getstream/chat/android/models/User;)Lio/getstream/chat/android/client/persistance/repository/factory/RepositoryFactory;
 }
 
+public final class io/getstream/chat/android/client/persistence/db/ChatClientDatabase_Impl {
+	public static final field Companion Lio/getstream/chat/android/client/persistence/db/ChatClientDatabase$Companion;
+	public fun <init> ()V
+	public fun clearAllTables ()V
+	public fun getAutoMigrations (Ljava/util/Map;)Ljava/util/List;
+	public fun getRequiredAutoMigrationSpecs ()Ljava/util/Set;
+	public fun messageReceiptDao ()Lio/getstream/chat/android/client/persistence/db/dao/MessageReceiptDao;
+}
+
+public final class io/getstream/chat/android/client/persistence/db/dao/MessageReceiptDao_Impl : io/getstream/chat/android/client/persistence/db/dao/MessageReceiptDao {
+	public fun <init> (Landroidx/room/RoomDatabase;)V
+	public fun deleteAll (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public fun deleteByMessageIds (Ljava/util/List;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static fun getRequiredConverters ()Ljava/util/List;
+	public fun selectAllByType (Ljava/lang/String;I)Lkotlinx/coroutines/flow/Flow;
+	public fun upsert (Ljava/util/List;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+}
+
 public abstract interface class io/getstream/chat/android/client/plugin/Plugin : io/getstream/chat/android/client/plugin/DependencyResolver, io/getstream/chat/android/client/plugin/listeners/BlockUserListener, io/getstream/chat/android/client/plugin/listeners/ChannelMarkReadListener, io/getstream/chat/android/client/plugin/listeners/CreateChannelListener, io/getstream/chat/android/client/plugin/listeners/DeleteChannelListener, io/getstream/chat/android/client/plugin/listeners/DeleteMessageForMeListener, io/getstream/chat/android/client/plugin/listeners/DeleteMessageListener, io/getstream/chat/android/client/plugin/listeners/DeleteReactionListener, io/getstream/chat/android/client/plugin/listeners/DraftMessageListener, io/getstream/chat/android/client/plugin/listeners/EditMessageListener, io/getstream/chat/android/client/plugin/listeners/FetchCurrentUserListener, io/getstream/chat/android/client/plugin/listeners/GetMessageListener, io/getstream/chat/android/client/plugin/listeners/HideChannelListener, io/getstream/chat/android/client/plugin/listeners/LiveLocationListener, io/getstream/chat/android/client/plugin/listeners/MarkAllReadListener, io/getstream/chat/android/client/plugin/listeners/PushPreferencesListener, io/getstream/chat/android/client/plugin/listeners/QueryBlockedUsersListener, io/getstream/chat/android/client/plugin/listeners/QueryChannelListener, io/getstream/chat/android/client/plugin/listeners/QueryChannelsListener, io/getstream/chat/android/client/plugin/listeners/QueryMembersListener, io/getstream/chat/android/client/plugin/listeners/QueryThreadsListener, io/getstream/chat/android/client/plugin/listeners/SendAttachmentListener, io/getstream/chat/android/client/plugin/listeners/SendGiphyListener, io/getstream/chat/android/client/plugin/listeners/SendMessageListener, io/getstream/chat/android/client/plugin/listeners/SendReactionListener, io/getstream/chat/android/client/plugin/listeners/ShuffleGiphyListener, io/getstream/chat/android/client/plugin/listeners/ThreadQueryListener, io/getstream/chat/android/client/plugin/listeners/TypingEventListener, io/getstream/chat/android/client/plugin/listeners/UnblockUserListener {
 	public fun getErrorHandler ()Lio/getstream/chat/android/client/errorhandler/ErrorHandler;
 	public fun onAttachmentSendRequest (Ljava/lang/String;Ljava/lang/String;Lio/getstream/chat/android/models/Message;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistance/repository/MessageReceiptRepository.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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 io.getstream.chat.android.client.persistence.db.dao
+
+import androidx.room.Dao
+import androidx.room.Insert
+import androidx.room.OnConflictStrategy
+import androidx.room.Query
+import io.getstream.chat.android.client.persistence.db.entity.MessageReceiptEntity
+import kotlinx.coroutines.flow.Flow
+
+@Dao
+internal interface MessageReceiptDao {
+
+    @Insert(onConflict = OnConflictStrategy.REPLACE)
+    suspend fun upsert(receipts: List<MessageReceiptEntity>)
+
+    @Query("SELECT * FROM message_receipt WHERE type = :type ORDER BY createdAt ASC LIMIT :limit")
+    fun selectAllByType(type: String, limit: Int): Flow<List<MessageReceiptEntity>>
+
+    @Query("DELETE FROM message_receipt WHERE messageId IN (:messageIds)")
+    suspend fun deleteByMessageIds(messageIds: List<String>)
+
+    @Query("DELETE FROM message_receipt")
+    suspend fun deleteAll()
+}

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistence/db/dao/MessageReceiptDao.kt

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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 io.getstream.chat.android.client.persistence.db.entity
+
+import androidx.room.Entity
+import androidx.room.PrimaryKey
+import java.util.Date
+
+@Entity(tableName = "message_receipt")
+internal data class MessageReceiptEntity(
+    @PrimaryKey
+    val messageId: String,
+    val type: String,
+    val createdAt: Date,
+    val cid: String,
+)

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistence/db/entity/MessageReceiptEntity.kt

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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 io.getstream.chat.android.client.persistence.repository
+
+import io.getstream.chat.android.client.persistence.db.ChatClientDatabase
+import io.getstream.chat.android.client.receipts.MessageReceipt
+import kotlinx.coroutines.flow.Flow
+
+internal interface MessageReceiptRepository {
+
+    companion object {
+        operator fun invoke(database: ChatClientDatabase): MessageReceiptRepository =
+            MessageReceiptRepositoryImpl(
+                dao = database.messageReceiptDao(),
+            )
+    }
+
+    suspend fun upsertMessageReceipts(receipts: List<MessageReceipt>)
+
+    fun getAllMessageReceiptsByType(type: String, limit: Int): Flow<List<MessageReceipt>>
+
+    suspend fun deleteMessageReceiptsByMessageIds(messageIds: List<String>)
+
+    suspend fun clearMessageReceipts()
+}

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistence/repository/MessageReceiptRepository.kt

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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 io.getstream.chat.android.client.persistence.repository
+
+import io.getstream.chat.android.client.persistence.db.dao.MessageReceiptDao
+import io.getstream.chat.android.client.persistence.db.entity.MessageReceiptEntity
+import io.getstream.chat.android.client.receipts.MessageReceipt
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.map
+
+internal class MessageReceiptRepositoryImpl(
+    private val dao: MessageReceiptDao,
+) : MessageReceiptRepository {
+
+    override suspend fun upsertMessageReceipts(receipts: List<MessageReceipt>) {
+        dao.upsert(receipts.map(MessageReceipt::toEntity))
+    }
+
+    override fun getAllMessageReceiptsByType(type: String, limit: Int): Flow<List<MessageReceipt>> =
+        dao.selectAllByType(type, limit).map { receipts ->
+            receipts.map(MessageReceiptEntity::toModel)
+        }
+
+    override suspend fun deleteMessageReceiptsByMessageIds(messageIds: List<String>) {
+        dao.deleteByMessageIds(messageIds)
+    }
+
+    override suspend fun clearMessageReceipts() {
+        dao.deleteAll()
+    }
+}

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistence/repository/MessageReceiptRepositoryImpl.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * 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 io.getstream.chat.android.client.persistence.repository
+
+import io.getstream.chat.android.client.persistence.db.entity.MessageReceiptEntity
+import io.getstream.chat.android.client.receipts.MessageReceipt
+
+internal fun MessageReceipt.toEntity() = MessageReceiptEntity(
+    messageId = messageId,
+    type = type,
+    createdAt = createdAt,
+    cid = cid,
+)
+
+internal fun MessageReceiptEntity.toModel() = MessageReceipt(
+    messageId = messageId,
+    type = type,
+    createdAt = createdAt,
+    cid = cid,
+)

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistence/repository/MessageReceiptRepositoryMapper.kt

@@ -14,19 +14,17 @@
  * limitations under the License.
  */
 
-package io.getstream.chat.android.models
+package io.getstream.chat.android.client.receipts
 
-import androidx.compose.runtime.Immutable
 import java.util.Date
 
-@Immutable
-public data class MessageReceipt(
-    public val messageId: String,
-    public val type: String,
-    public val createdAt: Date,
-    public val cid: String,
+internal data class MessageReceipt(
+    val messageId: String,
+    val type: String,
+    val createdAt: Date,
+    val cid: String,
 ) {
-    public companion object {
-        public const val TYPE_DELIVERED: String = "delivered"
+    companion object {
+        const val TYPE_DELIVERY: String = "delivery"
     }
 }

stream-chat-android-core/src/main/java/io/getstream/chat/android/models/MessageReceipt.kt renamed to stream-chat-android-client/src/main/java/io/getstream/chat/android/client/receipts/MessageReceipt.kt

@@ -16,10 +16,9 @@
 
 package io.getstream.chat.android.client.receipts
 
-import io.getstream.chat.android.client.persistance.repository.MessageReceiptRepository
+import io.getstream.chat.android.client.persistence.repository.MessageReceiptRepository
 import io.getstream.chat.android.client.utils.message.isDeleted
 import io.getstream.chat.android.models.Message
-import io.getstream.chat.android.models.MessageReceipt
 import io.getstream.chat.android.models.MessageType
 import io.getstream.chat.android.models.User
 import io.getstream.chat.android.models.UserId
@@ -29,7 +28,8 @@ import kotlinx.coroutines.launch
 import java.util.Date
 
 /**
- * Manages message delivery receipts: creating and storing them in the repository.
+ * Manages message delivery receipts: creating and storing them in the repository
+ * for later reporting to the server.
  */
 internal class MessageReceiptManager(
     private val scope: CoroutineScope,
@@ -48,7 +48,7 @@ internal class MessageReceiptManager(
         }
 
         // Check if delivery receipts are enabled for the current user
-        if (!currentUser.isDeliveryReceiptsEnabled()) {
+        if (!currentUser.isDeliveryReceiptsEnabled) {
             logger.w { "[markMessagesAsDelivered] Delivery receipts disabled for user ${currentUser.id}" }
             return
         }
@@ -71,7 +71,7 @@ internal class MessageReceiptManager(
 
         scope.launch {
             val receipts = filteredMessages.map { message -> message.toDeliveryReceipt() }
-            messageReceiptRepository.upsert(receipts)
+            messageReceiptRepository.upsertMessageReceipts(receipts)
 
             logger.d { "[markMessagesAsDelivered] ${filteredMessages.size} delivery receipts upserted" }
         }
@@ -103,6 +103,3 @@ internal class MessageReceiptManager(
         cid = cid,
     )
 }
-
-private fun User.isDeliveryReceiptsEnabled(): Boolean =
-    privacySettings?.deliveryReceipts?.enabled ?: false

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/receipts/MessageReceiptManager.kt

@@ -17,9 +17,8 @@
 package io.getstream.chat.android.client.receipts
 
 import io.getstream.chat.android.client.ChatClient
-import io.getstream.chat.android.client.persistance.repository.MessageReceiptRepository
+import io.getstream.chat.android.client.persistence.repository.MessageReceiptRepository
 import io.getstream.chat.android.models.Message
-import io.getstream.chat.android.models.MessageReceipt
 import io.getstream.log.taggedLogger
 import io.getstream.result.onSuccessSuspend
 import kotlinx.coroutines.CoroutineScope
@@ -44,7 +43,11 @@ internal class MessageReceiptReporter(
 
     @OptIn(FlowPreview::class)
     fun init() {
-        messageReceiptRepository.getAllByType(type = MessageReceipt.TYPE_DELIVERY, limit = MAX_BATCH_SIZE)
+        logger.d { "[init] Handling message receipts reporting…" }
+        messageReceiptRepository.getAllMessageReceiptsByType(
+            type = MessageReceipt.TYPE_DELIVERY,
+            limit = MAX_BATCH_SIZE,
+        )
             .sample(REPORT_INTERVAL_IN_MS)
             .filterNot(List<MessageReceipt>::isEmpty)
             .map { receipts ->
@@ -60,8 +63,15 @@ internal class MessageReceiptReporter(
                 chatClient.markMessagesAsDelivered(messages)
                     .execute()
                     .onSuccessSuspend {
+                        logger.d { "[init] Successfully reported delivery receipts for ${messages.size} messages" }
                         val deliveredMessageIds = messages.map(Message::id)
-                        messageReceiptRepository.deleteByMessageIds(deliveredMessageIds)
+                        messageReceiptRepository.deleteMessageReceiptsByMessageIds(deliveredMessageIds)
+                    }
+                    .onError { error ->
+                        logger.e {
+                            "[init] Failed to report delivery receipts for ${messages.size} messages: " +
+                                error.message
+                        }
                     }
             }
             .launchIn(scope)