Introduce message delivery receipts

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### ⬆️ Improved
 
 ### ✅ Added
+- Introduce message delivery receipts. [#5979](https://github.com/GetStream/stream-chat-android/pull/5979)
 
 ### ⚠️ Changed
 
@@ -17,8 +18,12 @@
 - Use `ExoPlayer` instead of `MediaPlayer` for audio message playback. [#5980](https://github.com/GetStream/stream-chat-android/pull/5980)
 
 ### ✅ Added
+- Introduce `Channel.userRead` extension function to get the read status of a specific user in the channel. [#5979](https://github.com/GetStream/stream-chat-android/pull/5979)
+- Introduce `Channel.readsOf` extension function to get the read statuses representing which users have read the given message in the channel. [#5979](https://github.com/GetStream/stream-chat-android/pull/5979)
+- Introduce `ChatClient.markMessageAsDelivered` to mark a message as delivered for the current user. [#5979](https://github.com/GetStream/stream-chat-android/pull/5979)
 
 ### ⚠️ Changed
+- Deprecate `Channel.hasUnread` property in favor of `Channel.currentUserUnreadCount`. [#5979](https://github.com/GetStream/stream-chat-android/pull/5979)
 
 ### ❌ Removed
 
@@ -3613,7 +3618,7 @@ The following items are breaking changes, since it was very important to improve
 - Added `ChatUI.channelNameFormatter` to allow customizing the channel's name format. [#3068](https://github.com/GetStream/stream-chat-android/pull/3068)
 - Added a customizable height attribute to SearchInputView [#3081](https://github.com/GetStream/stream-chat-android/pull/3081)
 - Added `ChatUI.dateFormatter` to allow customizing the way the dates are formatted. [#3085](https://github.com/GetStream/stream-chat-android/pull/3085)
-- Added ways to show/hide the delivery status indicators for channels and messages. [#3102](https://github.com/GetStream/stream-chat-android/pull/3102)
+- Added ways to show/hide the delivery receipts indicators for channels and messages. [#3102](https://github.com/GetStream/stream-chat-android/pull/3102)
 
 ### ⚠️ Changed
 - Disabled editing on Giphy messages given that it's breaking the UX and can override the GIF that was previously put in. [#3071](https://github.com/GetStream/stream-chat-android/pull/3071)

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

@@ -27,6 +27,7 @@ import io.getstream.chat.android.client.events.ConnectedEvent
 import io.getstream.chat.android.client.events.MarkAllReadEvent
 import io.getstream.chat.android.client.events.MemberAddedEvent
 import io.getstream.chat.android.client.events.MemberRemovedEvent
+import io.getstream.chat.android.client.events.MessageDeliveredEvent
 import io.getstream.chat.android.client.events.MessageReadEvent
 import io.getstream.chat.android.client.events.MessageUpdatedEvent
 import io.getstream.chat.android.client.events.NewMessageEvent
@@ -260,6 +261,26 @@ public fun randomMessageReadEvent(
     )
 }
 
+public fun randomMessageDeliveredEvent(
+    createdAt: Date = Date(),
+    user: User = randomUser(),
+    cid: String = randomCID(),
+    channelType: String = randomString(),
+    channelId: String = randomString(),
+    lastDeliveredAt: Date = randomDate(),
+    lastDeliveredMessageId: String = randomString(),
+) = MessageDeliveredEvent(
+    type = EventType.MESSAGE_DELIVERED,
+    createdAt = createdAt,
+    rawCreatedAt = streamFormatter.format(createdAt),
+    user = user,
+    cid = cid,
+    channelType = channelType,
+    channelId = channelId,
+    lastDeliveredAt = lastDeliveredAt,
+    lastDeliveredMessageId = lastDeliveredMessageId,
+)
+
 public fun randomNotificationMarkReadEvent(
     createdAt: Date = Date(),
     user: User = randomUser(),

stream-chat-android-client/build.gradle.kts

@@ -92,6 +92,10 @@ dependencies {
     implementation(libs.okhttp.logging.interceptor)
     implementation(libs.ok2curl)
 
+    implementation(libs.androidx.room.runtime)
+    implementation(libs.androidx.room.ktx)
+    ksp(libs.androidx.room.compiler)
+
     // Unused dependencies: The following dependencies (appcompat, constraintlayout, livedata-ktx) are not used in the
     // `stream-chat-android-client` module. They are still declared here to prevent potential breaking changes for
     // integrations that might be relying on them transitively. Consider removing them in future major releases.
@@ -106,8 +110,10 @@ dependencies {
     testImplementation(libs.stream.result)
     testImplementation(libs.androidx.test.junit)
     testImplementation(libs.androidx.lifecycle.runtime.testing)
+    testImplementation(libs.androidx.work.testing)
     testImplementation(libs.junit.jupiter.api)
     testImplementation(libs.junit.jupiter.params)
+    testImplementation(libs.turbine)
     testRuntimeOnly(libs.junit.jupiter.engine)
     testRuntimeOnly(libs.junit.vintage.engine)
 

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

@@ -122,12 +122,17 @@ import io.getstream.chat.android.client.parser2.adapters.internal.StreamDateForm
 import io.getstream.chat.android.client.persistance.repository.RepositoryFacade
 import io.getstream.chat.android.client.persistance.repository.factory.RepositoryFactory
 import io.getstream.chat.android.client.persistance.repository.noop.NoOpRepositoryFactory
+import io.getstream.chat.android.client.persistence.db.ChatClientDatabase
+import io.getstream.chat.android.client.persistence.repository.ChatClientRepository
 import io.getstream.chat.android.client.plugin.DependencyResolver
+import io.getstream.chat.android.client.plugin.MessageDeliveredPluginFactory
 import io.getstream.chat.android.client.plugin.Plugin
 import io.getstream.chat.android.client.plugin.factory.PluginFactory
 import io.getstream.chat.android.client.plugin.factory.ThrottlingPluginFactory
 import io.getstream.chat.android.client.query.AddMembersParams
 import io.getstream.chat.android.client.query.CreateChannelParams
+import io.getstream.chat.android.client.receipts.MessageReceiptManager
+import io.getstream.chat.android.client.receipts.MessageReceiptReporter
 import io.getstream.chat.android.client.scope.ClientScope
 import io.getstream.chat.android.client.scope.UserScope
 import io.getstream.chat.android.client.setup.state.ClientState
@@ -275,6 +280,9 @@ internal constructor(
     @InternalStreamChatApi
     public val audioPlayer: AudioPlayer,
     private val now: () -> Date = ::Date,
+    private val repository: ChatClientRepository,
+    private val messageReceiptReporter: MessageReceiptReporter,
+    internal val messageReceiptManager: MessageReceiptManager,
 ) {
     private val logger by taggedLogger(TAG)
     private val waitConnection = MutableSharedFlow<Result<ConnectionData>>()
@@ -447,13 +455,13 @@ internal constructor(
                 mutableClientState.setUser(user)
             }
 
-            is NewMessageEvent,
-            is NotificationReminderDueEvent,
-            -> {
-                // No other events should potentially show notifications
+            is NewMessageEvent -> {
                 notifications.onChatEvent(event)
+                messageReceiptManager.markMessageAsDelivered(event.message)
             }
 
+            is NotificationReminderDueEvent -> notifications.onChatEvent(event)
+
             is ConnectingEvent -> {
                 logger.i { "[handleEvent] event: ConnectingEvent" }
                 mutableClientState.setConnectionState(ConnectionState.Connecting)
@@ -642,6 +650,7 @@ internal constructor(
         tokenManager.setTokenProvider(tokenProvider)
         appSettingsManager.loadAppSettings()
         warmUp()
+        messageReceiptReporter.start()
         logger.i { "[initializeClientWithUser] user.id: '${user.id}'completed" }
     }
 
@@ -737,9 +746,11 @@ internal constructor(
     ): Call<ConnectionData> {
         return CoroutineCall(clientScope) {
             logger.d { "[switchUser] user.id: '${user.id}'" }
-            userScope.userId.value = user.id
             notifications.deleteDevice() // always delete device if switching users
             disconnectUserSuspend(flushPersistence = true)
+            // change userId only after disconnect,
+            // otherwise the userScope won't cancel coroutines related to the previous user.
+            userScope.userId.value = user.id
             onDisconnectionComplete()
             connectUserSuspend(user, tokenProvider, timeoutMilliseconds).also {
                 logger.v { "[switchUser] completed('${user.id}')" }
@@ -1505,6 +1516,8 @@ internal constructor(
             userCredentialStorage.clear()
         }
 
+        repository.clear()
+
         _repositoryFacade = null
         attachmentsSender.cancelJobs()
         appSettingsManager.clear()
@@ -2869,6 +2882,43 @@ internal constructor(
             }
     }
 
+    /**
+     * Request to mark the message with the given id as delivered if:
+     *
+     * - Delivery receipts are enabled for the current user.
+     * - Delivery events are enabled in the channel config.
+     *
+     * and if all of the following conditions are met for the message:
+     *
+     * - Not sent by the current user.
+     * - Not shadow banned.
+     * - Not sent by a muted user.
+     * - Not yet marked as read by the current user.
+     * - Not yet marked as delivered by the current user.
+     *
+     * IMPORTANT: For this feature to function correctly and efficiently,
+     * the [offline plugin](https://getstream.io/chat/docs/sdk/android/client/guides/offline-support/)
+     * must be enabled to avoid extra API calls to retrieve message and channel data.
+     *
+     * @param messageId The ID of the message to mark as delivered.
+     *
+     * @return Executable async [Call] which completes with [Result] having data equal to true if the message
+     * was marked as delivered, false otherwise.
+     */
+    @CheckResult
+    public fun markMessageAsDelivered(messageId: String): Call<Boolean> =
+        CoroutineCall(userScope) {
+            runCatching { messageReceiptManager.markMessageAsDelivered(messageId) }
+                .fold(
+                    onSuccess = { Result.Success(it) },
+                    onFailure = { Result.Failure(Error.GenericError(it.message.orEmpty())) },
+                )
+        }.doOnStart(userScope) {
+            logger.d { "[markMessageAsDelivered] #doOnStart; messageId: $messageId" }
+        }.doOnResult(userScope) {
+            logger.v { "[markMessageAsDelivered] #doOnResult; completed($messageId)" }
+        }
+
     /**
      * Marks the given message as read.
      *
@@ -4716,7 +4766,8 @@ internal constructor(
                     appVersion = this.appVersion,
                 )
 
-            val appSettingsManager = AppSettingManager(module.api())
+            val api = module.api()
+            val appSettingsManager = AppSettingManager(api)
 
             val audioPlayer: AudioPlayer = StreamAudioPlayer(
                 mediaPlayer = NativeMediaPlayerImpl(appContext) {
@@ -4732,12 +4783,15 @@ internal constructor(
                 userScope = userScope,
             )
 
+            val database = ChatClientDatabase.build(appContext)
+            val repository = ChatClientRepository.from(database)
+
             return ChatClient(
-                config,
-                module.api(),
-                module.dtoMapping,
-                module.notifications(),
-                tokenManager,
+                config = config,
+                api = api,
+                dtoMapping = module.dtoMapping,
+                notifications = module.notifications(),
+                tokenManager = tokenManager,
                 userCredentialStorage = userCredentialStorage ?: SharedPreferencesCredentialStorage(appContext),
                 userStateService = module.userStateService,
                 clientDebugger = clientDebugger ?: StubChatClientDebugger,
@@ -4755,6 +4809,18 @@ internal constructor(
                 mutableClientState = MutableClientState(module.networkStateProvider),
                 currentUserFetcher = module.currentUserFetcher,
                 audioPlayer = audioPlayer,
+                repository = repository,
+                messageReceiptReporter = MessageReceiptReporter(
+                    scope = userScope,
+                    messageReceiptRepository = repository,
+                    api = api,
+                ),
+                messageReceiptManager = MessageReceiptManager(
+                    now = ::Date,
+                    getRepositoryFacade = { instance().repositoryFacade },
+                    messageReceiptRepository = repository,
+                    api = api,
+                ),
             ).apply {
                 attachmentsSender = AttachmentsSender(
                     context = appContext,
@@ -4799,7 +4865,10 @@ internal constructor(
          * @see [Plugin]
          * @see [PluginFactory]
          */
-        protected val pluginFactories: MutableList<PluginFactory> = mutableListOf(ThrottlingPluginFactory)
+        protected val pluginFactories: MutableList<PluginFactory> = mutableListOf(
+            ThrottlingPluginFactory,
+            MessageDeliveredPluginFactory,
+        )
 
         /**
          * Create a [ChatClient] instance based on the current configuration

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

@@ -338,6 +338,11 @@ internal interface ChatApi {
         messageId: String = "",
     ): Call<Unit>
 
+    @CheckResult
+    fun markDelivered(
+        messages: List<Message>,
+    ): Call<Unit>
+
     @CheckResult
     fun markThreadRead(
         channelType: String,

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

@@ -57,6 +57,7 @@ import io.getstream.chat.android.client.api2.model.requests.FlagUserRequest
 import io.getstream.chat.android.client.api2.model.requests.GuestUserRequest
 import io.getstream.chat.android.client.api2.model.requests.HideChannelRequest
 import io.getstream.chat.android.client.api2.model.requests.InviteMembersRequest
+import io.getstream.chat.android.client.api2.model.requests.MarkDeliveredRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkReadRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkUnreadRequest
 import io.getstream.chat.android.client.api2.model.requests.MuteChannelRequest
@@ -960,6 +961,11 @@ constructor(
         ).toUnitCall()
     }
 
+    override fun markDelivered(messages: List<Message>): Call<Unit> =
+        channelApi.markDelivered(
+            request = MarkDeliveredRequest.create(messages),
+        ).toUnitCall()
+
     override fun markThreadRead(channelType: String, channelId: String, threadId: String): Call<Unit> {
         return channelApi.markRead(
             channelType = channelType,

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/endpoint/ChannelApi.kt

@@ -23,6 +23,7 @@ import io.getstream.chat.android.client.api2.model.requests.AcceptInviteRequest
 import io.getstream.chat.android.client.api2.model.requests.AddMembersRequest
 import io.getstream.chat.android.client.api2.model.requests.HideChannelRequest
 import io.getstream.chat.android.client.api2.model.requests.InviteMembersRequest
+import io.getstream.chat.android.client.api2.model.requests.MarkDeliveredRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkReadRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkUnreadRequest
 import io.getstream.chat.android.client.api2.model.requests.PinnedMessagesRequest
@@ -211,4 +212,9 @@ internal interface ChannelApi {
         @Path("id") channelId: String,
         @UrlQueryPayload @Query("payload") payload: PinnedMessagesRequest,
     ): RetrofitCall<MessagesResponse>
+
+    @POST("/channels/delivered")
+    fun markDelivered(
+        @Body request: MarkDeliveredRequest,
+    ): RetrofitCall<CompletableResponse>
 }

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/mapping/DomainMapping.kt

@@ -16,13 +16,15 @@
 
 package io.getstream.chat.android.client.api2.mapping
 
+import io.getstream.chat.android.DeliveryReceipts
 import io.getstream.chat.android.PrivacySettings
 import io.getstream.chat.android.ReadReceipts
 import io.getstream.chat.android.TypingIndicators
 import io.getstream.chat.android.client.api2.model.dto.AttachmentDto
 import io.getstream.chat.android.client.api2.model.dto.ChannelInfoDto
 import io.getstream.chat.android.client.api2.model.dto.CommandDto
 import io.getstream.chat.android.client.api2.model.dto.ConfigDto
+import io.getstream.chat.android.client.api2.model.dto.DeliveryReceiptsDto
 import io.getstream.chat.android.client.api2.model.dto.DeviceDto
 import io.getstream.chat.android.client.api2.model.dto.DownstreamChannelDto
 import io.getstream.chat.android.client.api2.model.dto.DownstreamChannelMuteDto
@@ -309,6 +311,7 @@ internal class DomainMapping(
             image = image ?: "",
             role = role,
             invisible = invisible,
+            privacySettings = privacy_settings?.toDomain(),
             language = language ?: "",
             banned = banned,
             devices = devices.orEmpty().map { it.toDomain() },
@@ -525,6 +528,8 @@ internal class DomainMapping(
             lastRead = last_read,
             unreadMessages = unread_messages,
             lastReadMessageId = last_read_message_id,
+            lastDeliveredAt = last_delivered_at,
+            lastDeliveredMessageId = last_delivered_message_id,
         )
 
     /**
@@ -599,6 +604,7 @@ internal class DomainMapping(
         name = name ?: "",
         typingEventsEnabled = typing_events,
         readEventsEnabled = read_events,
+        deliveryEventsEnabled = delivery_events,
         connectEventsEnabled = connect_events,
         searchEnabled = search,
         isReactionsEnabled = reactions,
@@ -675,6 +681,7 @@ internal class DomainMapping(
      */
     internal fun PrivacySettingsDto.toDomain(): PrivacySettings = PrivacySettings(
         typingIndicators = typing_indicators?.toDomain(),
+        deliveryReceipts = delivery_receipts?.toDomain(),
         readReceipts = read_receipts?.toDomain(),
     )
 
@@ -685,6 +692,11 @@ internal class DomainMapping(
         enabled = enabled,
     )
 
+    /**
+     * Transforms [DeliveryReceiptsDto] to [DeliveryReceipts].
+     */
+    internal fun DeliveryReceiptsDto.toDomain() = DeliveryReceipts(enabled = enabled)
+
     /**
      * Transforms [ReadReceiptsDto] to [ReadReceipts].
      */