Fix: Fetch message from API when marking as delivered by ID

andremion · andremion · commit 6a6952a84419 · 2025-10-31T15:35:38.000Z
When `markMessageAsDelivered` is called with a `messageId`, the SDK now fetches the message from the local repository. If the message is not found locally, it falls back to fetching it from the API.

This ensures that a delivery receipt can be sent for a push notification even if the message is not yet in the local database.
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/ChatClient.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/ChatClient.kt
@@ -338,7 +338,7 @@ internal constructor(
         MessageReceiptManager(
             now = now,
             getCurrentUser = ::getCurrentUser,
-            channelRepository = repositoryFacade,
+            repositoryFacade = repositoryFacade,
             messageReceiptRepository = repository,
             api = api,
         )
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/notifications/ChatNotifications.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/notifications/ChatNotifications.kt
@@ -28,7 +28,6 @@ import io.getstream.chat.android.client.notifications.handler.NotificationConfig
 import io.getstream.chat.android.client.notifications.handler.NotificationHandler
 import io.getstream.chat.android.core.internal.coroutines.DispatcherProvider
 import io.getstream.chat.android.models.Device
-import io.getstream.chat.android.models.Message
 import io.getstream.chat.android.models.PushMessage
 import io.getstream.chat.android.models.User
 import io.getstream.log.taggedLogger
@@ -110,11 +109,7 @@ internal class ChatNotificationsImpl(
 
         pushNotificationReceivedListener.onPushNotificationReceived(pushMessage.channelType, pushMessage.channelId)
 
-        val message = Message(
-            id = pushMessage.messageId,
-            cid = "${pushMessage.channelType}:${pushMessage.channelId}",
-        )
-        scope.launch { chatClient.messageReceiptManager.markMessageAsDelivered(message) }
+        scope.launch { chatClient.messageReceiptManager.markMessageAsDelivered(pushMessage.messageId) }
 
         if (notificationConfig.shouldShowNotificationOnPush() && !handler.onPushMessage(pushMessage)) {
             handlePushMessage(pushMessage)
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/receipts/MessageReceiptManager.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/receipts/MessageReceiptManager.kt
@@ -23,7 +23,7 @@ import io.getstream.chat.android.client.extensions.getCreatedAtOrThrow
 import io.getstream.chat.android.client.extensions.internal.NEVER
 import io.getstream.chat.android.client.extensions.internal.lastMessage
 import io.getstream.chat.android.client.extensions.userRead
-import io.getstream.chat.android.client.persistance.repository.ChannelRepository
+import io.getstream.chat.android.client.persistance.repository.RepositoryFacade
 import io.getstream.chat.android.client.persistence.repository.MessageReceiptRepository
 import io.getstream.chat.android.client.utils.message.isDeleted
 import io.getstream.chat.android.models.Channel
@@ -40,7 +40,7 @@ import java.util.Date
 internal class MessageReceiptManager(
     private val now: () -> Date,
     private val getCurrentUser: () -> User?,
-    private val channelRepository: ChannelRepository,
+    private val repositoryFacade: RepositoryFacade,
     private val messageReceiptRepository: MessageReceiptRepository,
     private val api: ChatApi,
 ) {
@@ -91,7 +91,7 @@ internal class MessageReceiptManager(
 
         if (!currentUser.isDeliveryReceiptsEnabled) return
 
-        val channel = getChannel(message.cid) ?: run {
+        val channel = retrieveChannel(message.cid) ?: run {
             logger.w { "[markMessageAsDelivered] Channel ${message.cid} not found" }
             return
         }
@@ -101,14 +101,33 @@ internal class MessageReceiptManager(
         }
     }
 
-    private suspend fun getChannel(cid: String): Channel? =
-        channelRepository.selectChannel(cid)
-            ?: run {
-                val (channelType, channelId) = cid.cidToTypeAndId()
-                val request = QueryChannelRequest()
-                api.queryChannel(channelType, channelId, request)
-                    .await().getOrNull()
-            }
+    /**
+     * Request to mark the message with the given id as delivered.
+     *
+     * @see [markChannelsAsDelivered] for the conditions to mark a message as delivered.
+     */
+    suspend fun markMessageAsDelivered(messageId: String) {
+        val message = retrieveMessage(messageId) ?: run {
+            logger.w { "[markMessageAsDelivered] Message $messageId not found" }
+            return
+        }
+
+        markMessageAsDelivered(message)
+    }
+
+    private suspend fun retrieveChannel(cid: String): Channel? =
+        repositoryFacade.selectChannel(cid) ?: run {
+            val (channelType, channelId) = cid.cidToTypeAndId()
+            val request = QueryChannelRequest()
+            api.queryChannel(channelType, channelId, request)
+                .await().getOrNull()
+        }
+
+    private suspend fun retrieveMessage(id: String): Message? =
+        repositoryFacade.selectMessage(id) ?: run {
+            api.getMessage(id)
+                .await().getOrNull()
+        }
 
     private suspend fun markMessagesAsDelivered(messages: List<Message>) {
         if (messages.isEmpty()) {
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/notifications/ChatNotificationsImplTest.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/notifications/ChatNotificationsImplTest.kt
@@ -27,7 +27,6 @@ import io.getstream.chat.android.client.notifications.handler.NotificationConfig
 import io.getstream.chat.android.client.notifications.handler.NotificationHandler
 import io.getstream.chat.android.client.randomPushMessage
 import io.getstream.chat.android.client.receipts.MessageReceiptManager
-import io.getstream.chat.android.models.Message
 import io.getstream.chat.android.models.PushMessage
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.test.UnconfinedTestDispatcher
@@ -69,11 +68,7 @@ internal class ChatNotificationsImplTest {
 
         sut.onPushMessage(pushMessage)
 
-        val message = Message(
-            id = pushMessage.messageId,
-            cid = "${pushMessage.channelType}:${pushMessage.channelId}",
-        )
-        fixture.verifyMarkMessageAsDeliveredCalled(message)
+        fixture.verifyMarkMessageAsDeliveredCalled(messageId = pushMessage.messageId)
     }
 
     @Test
@@ -132,8 +127,8 @@ internal class ChatNotificationsImplTest {
             notificationConfig = config
         }
 
-        fun verifyMarkMessageAsDeliveredCalled(message: Message) {
-            verifyBlocking(mockMessageReceiptManager) { markMessageAsDelivered(message) }
+        fun verifyMarkMessageAsDeliveredCalled(messageId: String) {
+            verifyBlocking(mockMessageReceiptManager) { markMessageAsDelivered(messageId) }
         }
 
         fun get(): ChatNotificationsImpl {
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/receipts/MessageReceiptManagerTest.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/receipts/MessageReceiptManagerTest.kt
@@ -20,7 +20,7 @@ import io.getstream.chat.android.DeliveryReceipts
 import io.getstream.chat.android.PrivacySettings
 import io.getstream.chat.android.client.api.ChatApi
 import io.getstream.chat.android.client.extensions.internal.NEVER
-import io.getstream.chat.android.client.persistance.repository.ChannelRepository
+import io.getstream.chat.android.client.persistance.repository.RepositoryFacade
 import io.getstream.chat.android.client.persistence.repository.MessageReceiptRepository
 import io.getstream.chat.android.models.User
 import io.getstream.chat.android.randomChannel
@@ -64,10 +64,10 @@ internal class MessageReceiptManagerTest {
     }
 
     @Test
-    fun `store message delivery receipt when channel is found from API`() = runTest {
+    fun `fetch channel from API when channel is not found from repository`() = runTest {
         val message = DeliverableMessage
         val fixture = Fixture()
-            .givenChannelNotFromRepository()
+            .givenChannelNotFoundFromRepository()
         val sut = fixture.get()
 
         sut.markMessageAsDelivered(message)
@@ -83,11 +83,44 @@ internal class MessageReceiptManagerTest {
         fixture.verifyUpsertMessageReceiptsCalled(receipts = receipts)
     }
 
+    @Test
+    fun `fetch message from API when message is not found from repository`() = runTest {
+        val message = DeliverableMessage
+        val fixture = Fixture()
+            .givenMessageNotFoundFromRepository()
+        val sut = fixture.get()
+
+        sut.markMessageAsDelivered(messageId = message.id)
+
+        val receipts = listOf(
+            MessageReceipt(
+                messageId = message.id,
+                type = MessageReceipt.TYPE_DELIVERY,
+                createdAt = Now,
+                cid = message.cid,
+            ),
+        )
+        fixture.verifyUpsertMessageReceiptsCalled(receipts = receipts)
+    }
+
+    @Test
+    fun `should skip storing message delivery receipt when message is not found`() = runTest {
+        val message = DeliverableMessage
+        val fixture = Fixture()
+            .givenMessageNotFoundFromRepository()
+            .givenMessageNotFoundFromApi()
+        val sut = fixture.get()
+
+        sut.markMessageAsDelivered(messageId = message.id)
+
+        fixture.verifyUpsertMessageReceiptsCalled(never())
+    }
+
     @Test
     fun `should skip storing message delivery receipt when channel is not found`() = runTest {
         val message = DeliverableMessage
         val fixture = Fixture()
-            .givenChannelNotFromRepository()
+            .givenChannelNotFoundFromRepository()
             .givenChannelNotFoundFromApi()
         val sut = fixture.get()
 
@@ -301,8 +334,9 @@ internal class MessageReceiptManagerTest {
 
     private class Fixture {
         private var getCurrentUser: () -> User? = { CurrentUser }
-        private val mockChannelRepository = mock<ChannelRepository> {
+        private val mockRepositoryFacade = mock<RepositoryFacade> {
             onBlocking { selectChannel(DeliverableChannel.cid) } doReturn DeliverableChannel
+            onBlocking { selectMessage(DeliverableMessage.id) } doReturn DeliverableMessage
         }
         private val mockMessageReceiptRepository = mock<MessageReceiptRepository>()
         private val mockChatApi = mock<ChatApi> {
@@ -313,14 +347,19 @@ internal class MessageReceiptManagerTest {
                     query = any(),
                 )
             } doReturn DeliverableChannel.asCall()
+            on { getMessage(messageId = DeliverableMessage.id) } doReturn DeliverableMessage.asCall()
         }
 
         fun givenCurrentUser(user: User?) = apply {
             getCurrentUser = { user }
         }
 
-        fun givenChannelNotFromRepository() = apply {
-            wheneverBlocking { mockChannelRepository.selectChannel(cid = any()) } doReturn null
+        fun givenChannelNotFoundFromRepository() = apply {
+            wheneverBlocking { mockRepositoryFacade.selectChannel(cid = any()) } doReturn null
+        }
+
+        fun givenMessageNotFoundFromRepository() = apply {
+            wheneverBlocking { mockRepositoryFacade.selectMessage(messageId = any()) } doReturn null
         }
 
         fun givenChannelNotFoundFromApi() = apply {
@@ -333,6 +372,10 @@ internal class MessageReceiptManagerTest {
             } doReturn mock<Error>().asCall()
         }
 
+        fun givenMessageNotFoundFromApi() = apply {
+            wheneverBlocking { mockChatApi.getMessage(messageId = any()) } doReturn mock<Error>().asCall()
+        }
+
         fun verifyUpsertMessageReceiptsCalled(
             mode: VerificationMode = times(1),
             receipts: List<MessageReceipt>? = null,
@@ -345,7 +388,7 @@ internal class MessageReceiptManagerTest {
         fun get() = MessageReceiptManager(
             now = { Now },
             getCurrentUser = getCurrentUser,
-            channelRepository = mockChannelRepository,
+            repositoryFacade = mockRepositoryFacade,
             messageReceiptRepository = mockMessageReceiptRepository,
             api = mockChatApi,
         )

Original file line number	Diff line number	Diff line change
`@@ -338,7 +338,7 @@ internal constructor(`
`338`	`338`	`MessageReceiptManager(`
`339`	`339`	`now = now,`
`340`	`340`	`getCurrentUser = ::getCurrentUser,`
`341`		`- channelRepository = repositoryFacade,`
	`341`	`+ repositoryFacade = repositoryFacade,`
`342`	`342`	`messageReceiptRepository = repository,`
`343`	`343`	`api = api,`
`344`	`344`	`)`