Decoupled MessageReceiptReporter from ChatClient by passing ChatApi directly to its constructor. This simplifies dependencies and removes the need for ChatClient as an intermediary for API calls.

Updated tests to reflect this change, mocking `ChatApi` instead of `ChatClient`.

Author: andremion

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

@@ -281,6 +281,7 @@ internal constructor(
     public val audioPlayer: AudioPlayer,
     private val now: () -> Date = ::Date,
     private val repository: ChatClientRepository,
+    private val messageReceiptReporter: MessageReceiptReporter,
 ) {
     private val logger by taggedLogger(TAG)
     private val waitConnection = MutableSharedFlow<Result<ConnectionData>>()
@@ -340,12 +341,6 @@ internal constructor(
         messageReceiptRepository = repository,
     )
 
-    private val messageReceiptReporter = MessageReceiptReporter(
-        scope = userScope,
-        chatClient = this,
-        messageReceiptRepository = repository,
-    )
-
     private var pushNotificationReceivedListener: PushNotificationReceivedListener =
         PushNotificationReceivedListener { _, _ -> }
 
@@ -4756,7 +4751,8 @@ internal constructor(
                     appVersion = this.appVersion,
                 )
 
-            val appSettingsManager = AppSettingManager(module.api())
+            val api = module.api()
+            val appSettingsManager = AppSettingManager(api)
 
             val audioPlayer: AudioPlayer = StreamMediaPlayer(
                 mediaPlayer = NativeMediaPlayerImpl {
@@ -4772,10 +4768,11 @@ internal constructor(
             )
 
             val database = ChatClientDatabase.build(appContext)
+            val repository = ChatClientRepository.from(database)
 
             return ChatClient(
                 config = config,
-                api = module.api(),
+                api = api,
                 dtoMapping = module.dtoMapping,
                 notifications = module.notifications(),
                 tokenManager = tokenManager,
@@ -4796,7 +4793,12 @@ internal constructor(
                 mutableClientState = MutableClientState(module.networkStateProvider),
                 currentUserFetcher = module.currentUserFetcher,
                 audioPlayer = audioPlayer,
-                repository = ChatClientRepository.from(database),
+                repository = repository,
+                messageReceiptReporter = MessageReceiptReporter(
+                    scope = userScope,
+                    messageReceiptRepository = repository,
+                    api = api,
+                ),
             ).apply {
                 attachmentsSender = AttachmentsSender(
                     context = appContext,

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

@@ -16,7 +16,7 @@
 
 package io.getstream.chat.android.client.receipts
 
-import io.getstream.chat.android.client.ChatClient
+import io.getstream.chat.android.client.api.ChatApi
 import io.getstream.chat.android.client.persistence.repository.MessageReceiptRepository
 import io.getstream.chat.android.models.Message
 import io.getstream.log.taggedLogger
@@ -32,8 +32,8 @@ import kotlinx.coroutines.launch
  */
 internal class MessageReceiptReporter(
     private val scope: CoroutineScope,
-    private val chatClient: ChatClient,
     private val messageReceiptRepository: MessageReceiptRepository,
+    private val api: ChatApi,
 ) {
 
     private val logger by taggedLogger("Chat:MessageReceiptReporter")
@@ -55,7 +55,7 @@ internal class MessageReceiptReporter(
 
                     if (messages.isNotEmpty()) {
                         logger.d { "Reporting delivery receipts for ${messages.size} messages…" }
-                        chatClient.markMessagesAsDelivered(messages)
+                        api.markDelivered(messages)
                             .execute()
                             .onSuccessSuspend {
                                 logger.d { "Successfully reported delivery receipts for ${messages.size} messages" }

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

@@ -26,7 +26,6 @@ import io.getstream.chat.android.client.events.ErrorEvent
 import io.getstream.chat.android.client.network.NetworkStateProvider
 import io.getstream.chat.android.client.parser2.adapters.internal.StreamDateFormatter
 import io.getstream.chat.android.client.persistance.repository.noop.NoOpRepositoryFactory
-import io.getstream.chat.android.client.persistence.repository.ChatClientRepository
 import io.getstream.chat.android.client.scope.ClientTestScope
 import io.getstream.chat.android.client.scope.UserTestScope
 import io.getstream.chat.android.client.setup.state.internal.MutableClientState
@@ -60,7 +59,6 @@ import org.amshove.kluent.shouldBeInstanceOf
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.RegisterExtension
-import org.mockito.kotlin.any
 import org.mockito.kotlin.doReturn
 import org.mockito.kotlin.eq
 import org.mockito.kotlin.mock
@@ -114,9 +112,6 @@ internal class ChatClientConnectionTests {
             tokenManager = tokenManager,
             networkStateProvider = networkStateProvider,
         )
-        val mockRepository = mock<ChatClientRepository> {
-            onBlocking { getAllMessageReceiptsByType(type = any(), limit = any()) } doReturn emptyList()
-        }
         client = ChatClient(
             config = config,
             api = chatApi,
@@ -136,7 +131,8 @@ internal class ChatClientConnectionTests {
             mutableClientState = mutableClientState,
             currentUserFetcher = mock(),
             audioPlayer = mock(),
-            repository = mockRepository,
+            repository = mock(),
+            messageReceiptReporter = mock(),
         ).apply {
             attachmentsSender = mock()
         }

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

@@ -134,9 +134,6 @@ internal class ChatClientTest {
             wssUrl = wssUrl,
             networkStateProvider = networkStateProvider,
         )
-        val mockRepository = mock<ChatClientRepository> {
-            onBlocking { getAllMessageReceiptsByType(type = any(), limit = any()) } doReturn emptyList()
-        }
         client = ChatClient(
             config = config,
             api = api,
@@ -156,7 +153,8 @@ internal class ChatClientTest {
             repositoryFactoryProvider = NoOpRepositoryFactory.Provider,
             currentUserFetcher = mock(),
             audioPlayer = mock(),
-            repository = mockRepository,
+            repository = mock(),
+            messageReceiptReporter = mock(),
         ).apply {
             attachmentsSender = mock()
             connectUser(user, token).enqueue()

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

@@ -180,6 +180,7 @@ public class DependencyResolverTest {
             currentUserFetcher = mock(),
             audioPlayer = mock(),
             repository = mock(),
+            messageReceiptReporter = mock(),
         ).apply {
             this.plugins = this@Fixture.plugins
         }

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

@@ -127,6 +127,7 @@ internal class MockClientBuilder(
             currentUserFetcher = mock(),
             audioPlayer = streamPlayer,
             repository = mock(),
+            messageReceiptReporter = mock(),
         )
 
         client.attachmentsSender = attachmentSender

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/chatclient/BaseChatClientTest.kt

@@ -129,6 +129,7 @@ internal open class BaseChatClientTest {
             audioPlayer = mock(),
             now = { now },
             repository = mock(),
+            messageReceiptReporter = mock(),
         )
         chatClient.attachmentsSender = attachmentsSender
         chatClient.plugins = plugins

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/debugger/ChatClientDebuggerTest.kt

@@ -148,6 +148,7 @@ internal class ChatClientDebuggerTest {
             currentUserFetcher = mock(),
             audioPlayer = mock(),
             repository = mockRepository,
+            messageReceiptReporter = mock(),
         ).apply {
             attachmentsSender = this@ChatClientDebuggerTest.attachmentsSender
             connectUser(user, token).enqueue()

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

@@ -16,7 +16,7 @@
 
 package io.getstream.chat.android.client.receipts
 
-import io.getstream.chat.android.client.ChatClient
+import io.getstream.chat.android.client.api.ChatApi
 import io.getstream.chat.android.client.persistence.repository.MessageReceiptRepository
 import io.getstream.chat.android.client.randomMessageReceipt
 import io.getstream.chat.android.models.Message
@@ -56,13 +56,13 @@ internal class MessageReceiptReporterTest {
         }
         val fixture = Fixture()
             .givenMessageReceipts(receipts)
-            .givenMarkMessagesAsDelivered(messages)
+            .givenMarkDelivered(messages)
         val sut = fixture.get(backgroundScope)
 
         sut.start()
         advanceTimeBy(100) // Allow initial execution
 
-        fixture.verifyMarkMessagesAsDeliveredCalled(messages = messages)
+        fixture.verifyMarkDeliveredCalled(messages = messages)
         val messageIds = messages.map(Message::id)
         fixture.verifyDeleteByMessageIdsCalled(messageIds = messageIds)
     }
@@ -72,7 +72,7 @@ internal class MessageReceiptReporterTest {
         val fixture = Fixture()
             .givenMessageReceipts(listOf(randomMessageReceipt()))
             // Simulate an error when marking messages as delivered
-            .givenMarkMessagesAsDelivered(error = mock())
+            .givenMarkDelivered(error = mock())
         val sut = fixture.get(backgroundScope)
 
         sut.start()
@@ -81,10 +81,10 @@ internal class MessageReceiptReporterTest {
         fixture.verifyDeleteByMessageIdsCalled(never())
 
         // Keep processing in the next time window
-        fixture.givenMarkMessagesAsDelivered()
+        fixture.givenMarkDelivered()
         advanceTimeBy(1000)
 
-        fixture.verifyMarkMessagesAsDeliveredCalled(times(2))
+        fixture.verifyMarkDeliveredCalled(times(2))
         fixture.verifyDeleteByMessageIdsCalled()
     }
 
@@ -97,15 +97,15 @@ internal class MessageReceiptReporterTest {
         sut.start()
         advanceTimeBy(100) // Allow initial execution
 
-        fixture.verifyMarkMessagesAsDeliveredCalled(never())
+        fixture.verifyMarkDeliveredCalled(never())
         fixture.verifyDeleteByMessageIdsCalled(never())
     }
 
     @Test
     fun `should execute periodically with correct delay`() = runTest {
         val fixture = Fixture()
             .givenMessageReceipts(listOf(randomMessageReceipt()))
-            .givenMarkMessagesAsDelivered()
+            .givenMarkDelivered()
         val sut = fixture.get(backgroundScope)
 
         sut.start()
@@ -117,14 +117,14 @@ internal class MessageReceiptReporterTest {
 
         advanceTimeBy(1000) // Advance to the fourth interval
 
-        fixture.verifyMarkMessagesAsDeliveredCalled(times(4))
+        fixture.verifyMarkDeliveredCalled(times(4))
     }
 
     @Test
     fun `should stop execution when coroutine scope is cancelled`() = runTest {
         val fixture = Fixture()
             .givenMessageReceipts(listOf(randomMessageReceipt()))
-            .givenMarkMessagesAsDelivered()
+            .givenMarkDelivered()
         val sut = fixture.get(backgroundScope)
 
         sut.start()
@@ -134,13 +134,12 @@ internal class MessageReceiptReporterTest {
 
         advanceTimeBy(1000) // Try to advance time after cancellation
 
-        fixture.verifyMarkMessagesAsDeliveredCalled(times(1))
+        fixture.verifyMarkDeliveredCalled(times(1))
     }
 
     private class Fixture {
-        private val mockChatClient = mock<ChatClient>()
-
         private val mockMessageReceiptRepository = mock<MessageReceiptRepository>()
+        private val mockApi = mock<ChatApi>()
 
         fun givenMessageReceipts(receipts: List<MessageReceipt>) = apply {
             wheneverBlocking {
@@ -151,25 +150,31 @@ internal class MessageReceiptReporterTest {
             } doReturn receipts
         }
 
-        fun givenMarkMessagesAsDelivered(messages: List<Message>? = null, error: Error? = null) = apply {
-            whenever(mockChatClient.markMessagesAsDelivered(messages ?: any())) doReturn
+        fun givenMarkDelivered(messages: List<Message>? = null, error: Error? = null) = apply {
+            whenever(mockApi.markDelivered(messages ?: any())) doReturn
                 (error?.asCall() ?: Unit.asCall())
         }
 
-        fun verifyMarkMessagesAsDeliveredCalled(mode: VerificationMode = times(1), messages: List<Message>? = null) {
-            verify(mockChatClient, mode).markMessagesAsDelivered(messages ?: any())
+        fun verifyMarkDeliveredCalled(
+            mode: VerificationMode = times(1),
+            messages: List<Message>? = null,
+        ) {
+            verify(mockApi, mode).markDelivered(messages ?: any())
         }
 
-        fun verifyDeleteByMessageIdsCalled(mode: VerificationMode = times(1), messageIds: List<String>? = null) {
+        fun verifyDeleteByMessageIdsCalled(
+            mode: VerificationMode = times(1),
+            messageIds: List<String>? = null,
+        ) {
             verifyBlocking(mockMessageReceiptRepository, mode) {
                 deleteMessageReceiptsByMessageIds(messageIds ?: any())
             }
         }
 
         fun get(scope: CoroutineScope) = MessageReceiptReporter(
             scope = scope,
-            chatClient = mockChatClient,
             messageReceiptRepository = mockMessageReceiptRepository,
+            api = mockApi,
         )
     }
 }