Refactor: Make MessageReceiptManager functions suspend

The `MessageReceiptManager` is refactored to use `suspend` functions instead of launching new coroutines from a provided `CoroutineScope`. This simplifies the class by removing the need for an injected scope and improves testability.

Key changes:
- `markChannelsAsDelivered` and `markMessageAsDelivered` are now `suspend` functions.
- The `CoroutineScope` dependency has been removed from `MessageReceiptManager` and its initialization in `ChatClient`.
- `MessageDeliveredPlugin` is updated to use `onSuccessSuspend` to call the new suspend functions.
- `ChatNotificationsImpl` now launches a coroutine to call the suspend function `markMessageAsDelivered`.
- Tests are updated to use `verifyBlocking` for testing suspend functions and to provide the necessary `CoroutineScope` where required.

Author: andremion

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

@@ -335,7 +335,6 @@ internal constructor(
     private var _repositoryFacade: RepositoryFacade? = null
 
     internal val messageReceiptManager = MessageReceiptManager(
-        scope = userScope,
         now = now,
         getCurrentUser = ::getCurrentUser,
         channelRepository = repositoryFacade,

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

@@ -114,7 +114,7 @@ internal class ChatNotificationsImpl(
             id = pushMessage.messageId,
             cid = "${pushMessage.channelType}:${pushMessage.channelId}",
         )
-        chatClient.messageReceiptManager.markMessageAsDelivered(message)
+        scope.launch { chatClient.messageReceiptManager.markMessageAsDelivered(message) }
 
         if (notificationConfig.shouldShowNotificationOnPush() && !handler.onPushMessage(pushMessage)) {
             handlePushMessage(pushMessage)

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/plugin/MessageDeliveredPlugin.kt

@@ -24,6 +24,7 @@ import io.getstream.chat.android.client.receipts.MessageReceiptManager
 import io.getstream.chat.android.models.Channel
 import io.getstream.chat.android.models.User
 import io.getstream.result.Result
+import io.getstream.result.onSuccessSuspend
 
 /**
  * A plugin that marks messages as delivered when channels are queried.
@@ -34,7 +35,7 @@ internal class MessageDeliveredPlugin(
 ) : Plugin {
 
     override suspend fun onQueryChannelsResult(result: Result<List<Channel>>, request: QueryChannelsRequest) {
-        result.onSuccess { channels ->
+        result.onSuccessSuspend { channels ->
             messageReceiptManager.markChannelsAsDelivered(channels)
         }
     }
@@ -45,7 +46,7 @@ internal class MessageDeliveredPlugin(
         channelId: String,
         request: QueryChannelRequest,
     ) {
-        result.onSuccess { channel ->
+        result.onSuccessSuspend { channel ->
             if (request.pagination() == null) { // only mark as delivered on initial load
                 messageReceiptManager.markChannelsAsDelivered(channels = listOf(channel))
             }

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

@@ -31,16 +31,13 @@ import io.getstream.chat.android.models.Message
 import io.getstream.chat.android.models.MessageType
 import io.getstream.chat.android.models.User
 import io.getstream.log.taggedLogger
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.launch
 import java.util.Date
 
 /**
  * Manages message delivery receipts: creating and storing them in the repository
  * for later reporting to the server.
  */
 internal class MessageReceiptManager(
-    private val scope: CoroutineScope,
     private val now: () -> Date,
     private val getCurrentUser: () -> User?,
     private val channelRepository: ChannelRepository,
@@ -64,7 +61,7 @@ internal class MessageReceiptManager(
      * - Is not yet marked as read by the current user
      * - Is not yet marked as delivered by the current user
      */
-    fun markChannelsAsDelivered(channels: List<Channel>) {
+    suspend fun markChannelsAsDelivered(channels: List<Channel>) {
         val currentUser = getCurrentUser() ?: run {
             logger.w { "[markChannelsAsDelivered] Current user is null" }
             return
@@ -86,23 +83,21 @@ internal class MessageReceiptManager(
      *
      * @see [markChannelsAsDelivered] for the conditions to mark a message as delivered.
      */
-    fun markMessageAsDelivered(message: Message) {
+    suspend fun markMessageAsDelivered(message: Message) {
         val currentUser = getCurrentUser() ?: run {
             logger.w { "[markMessageAsDelivered] Current user is null" }
             return
         }
 
         if (!currentUser.isDeliveryReceiptsEnabled) return
 
-        scope.launch {
-            val channel = getChannel(message.cid) ?: run {
-                logger.w { "[markMessageAsDelivered] Channel ${message.cid} not found" }
-                return@launch
-            }
+        val channel = getChannel(message.cid) ?: run {
+            logger.w { "[markMessageAsDelivered] Channel ${message.cid} not found" }
+            return
+        }
 
-            if (canMarkMessageAsDelivered(currentUser, channel, message)) {
-                markMessagesAsDelivered(messages = listOf(message))
-            }
+        if (canMarkMessageAsDelivered(currentUser, channel, message)) {
+            markMessagesAsDelivered(messages = listOf(message))
         }
     }
 
@@ -115,20 +110,18 @@ internal class MessageReceiptManager(
                     .await().getOrNull()
             }
 
-    private fun markMessagesAsDelivered(messages: List<Message>) {
+    private suspend fun markMessagesAsDelivered(messages: List<Message>) {
         if (messages.isEmpty()) {
             logger.w { "[markMessagesAsDelivered] No receipts to send" }
             return
         }
 
         logger.d { "[markMessagesAsDelivered] Processing delivery receipts for ${messages.size} messages…" }
 
-        scope.launch {
-            val receipts = messages.map { message -> message.toDeliveryReceipt() }
-            messageReceiptRepository.upsertMessageReceipts(receipts)
+        val receipts = messages.map { message -> message.toDeliveryReceipt() }
+        messageReceiptRepository.upsertMessageReceipts(receipts)
 
-            logger.d { "[markMessagesAsDelivered] ${messages.size} delivery receipts upserted" }
-        }
+        logger.d { "[markMessagesAsDelivered] ${messages.size} delivery receipts upserted" }
     }
 
     private fun canMarkMessageAsDelivered(

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/notifications/ChatNotificationsImplTest.kt

@@ -29,13 +29,16 @@ 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
 import org.junit.Test
 import org.junit.jupiter.api.Assertions.assertNotNull
 import org.junit.jupiter.api.Assertions.assertNull
 import org.junit.runner.RunWith
 import org.mockito.kotlin.doReturn
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.verify
+import org.mockito.kotlin.verifyBlocking
 import org.mockito.kotlin.whenever
 import org.robolectric.annotation.Config
 
@@ -130,7 +133,7 @@ internal class ChatNotificationsImplTest {
         }
 
         fun verifyMarkMessageAsDeliveredCalled(message: Message) {
-            verify(mockMessageReceiptManager).markMessageAsDelivered(message)
+            verifyBlocking(mockMessageReceiptManager) { markMessageAsDelivered(message) }
         }
 
         fun get(): ChatNotificationsImpl {
@@ -141,7 +144,7 @@ internal class ChatNotificationsImplTest {
                 handler = mockNotificationHandler,
                 notificationConfig = notificationConfig,
                 context = context,
-                scope = mock(),
+                scope = CoroutineScope(UnconfinedTestDispatcher()),
                 chatClientProvider = { mockChatClient },
             )
         }

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/plugin/MessageDeliveredPluginTest.kt

@@ -27,7 +27,7 @@ import org.mockito.kotlin.doReturn
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.never
 import org.mockito.kotlin.times
-import org.mockito.kotlin.verify
+import org.mockito.kotlin.verifyBlocking
 import org.mockito.verification.VerificationMode
 
 internal class MessageDeliveredPluginTest {
@@ -109,7 +109,9 @@ internal class MessageDeliveredPluginTest {
             mode: VerificationMode = times(1),
             channels: List<Channel>? = null,
         ) {
-            verify(mockMessageReceiptManager, mode).markChannelsAsDelivered(channels ?: any())
+            verifyBlocking(mockMessageReceiptManager, mode) {
+                markChannelsAsDelivered(channels ?: any())
+            }
         }
 
         fun get() = MessageDeliveredPlugin(

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/receipts/MessageReceiptManagerTest.kt

@@ -30,8 +30,6 @@ import io.getstream.chat.android.randomMessage
 import io.getstream.chat.android.randomUser
 import io.getstream.chat.android.test.asCall
 import io.getstream.result.Error
-import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.test.UnconfinedTestDispatcher
 import kotlinx.coroutines.test.runTest
 import org.junit.Test
 import org.mockito.kotlin.any
@@ -345,7 +343,6 @@ internal class MessageReceiptManagerTest {
         }
 
         fun get() = MessageReceiptManager(
-            scope = CoroutineScope(UnconfinedTestDispatcher()),
             now = { Now },
             getCurrentUser = getCurrentUser,
             channelRepository = mockChannelRepository,