Skip to content

Conversation

@andremion
Copy link
Contributor

@andremion andremion commented Oct 23, 2025

🎯 Goal

  • Send message delivery receipts, supporting local data buffering, batched reporting, event handling, and UI indicators.
  • Marks messages as delivered on:
    • Single channel query result (first page only)
    • Channel list query result
    • Push notification received
    • WS message.new event

🛠 Implementation details

Client module

  • New persistence and repository for delivery receipts (MessageReceiptDao/Entity/Repository, ChatClientDatabase, DateConverter).
  • New delivery reporting pipeline (MessageReceiptManager, MessageReceiptReporter) with 1s buffer and max 100 confirmations per call.
  • message.delivered WS event support.
  • Introduced new Channel extensions: readsOf, deliveredReadsOf.
  • PrivacySettings.delivery_receipts support.
  • Channel read state extended with last_delivered_at and last_delivered_message_id.

Delivery receipts are:

  • Buffered and sent every 1s, max 100 per request.
  • Not sent for own messages, not sent if already read or already delivered.
  • Reconciled against reads (reads supersede delivered).

Privacy:

  • Suppressed if ownUser.privacySettings.deliveryReceipts.enabled == false.

UI:

  • Compose and XML indicators updated to support the new grey double tick (delivered)
  • Unified logic to hide the message status indicator when a message is deleted / ephemeral / sync status failed permanently.

🎨 UI Changes

Screen.Recording.2025-11-04.at.08.43.56.mov
Screen.Recording.2025-11-04.at.10.06.56.mov

🧪 Testing

  • Open the channel list from two devices connected with different users.
  • Send a message from user A to user B.
  • Long press on the new message from user A.
  • Click on Message Info.
  • The message should be Delivered.
  • Enter the chat from user B.
  • From user A, notice that the message should now be Read.

@andremion andremion added the core label Oct 23, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2025

SDK Size Comparison 📏

SDK Before After Difference Status
stream-chat-android-client 3.23 MB 3.25 MB 0.02 MB 🟢
stream-chat-android-offline 3.45 MB 3.47 MB 0.02 MB 🟢
stream-chat-android-ui-components 10.54 MB 10.57 MB 0.03 MB 🟢
stream-chat-android-compose 12.76 MB 12.79 MB 0.03 MB 🟢

@andremion andremion force-pushed the AND-769-message-delivery-status branch 3 times, most recently from cbf13fa to 0b052a3 Compare October 27, 2025 15:21
@github-actions
Copy link
Contributor

github-actions bot commented Oct 27, 2025

DB Entities have been updated. Do we need to upgrade DB Version?
Modified Entities :

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistence/db/entity/MessageReceiptEntity.kt
stream-chat-android-offline/src/main/java/io/getstream/chat/android/offline/repository/domain/channelconfig/internal/ChannelConfigEntity.kt

@andremion andremion force-pushed the AND-769-message-delivery-status branch 4 times, most recently from e3bbb11 to a43c291 Compare October 30, 2025 09:32
…`clear` function

The `MessageReceiptRepository.getAllByType` function now accepts a `limit` parameter and returns a `Flow<List<MessageReceipt>>` instead of a `suspend` function returning `List<MessageReceipt>`.

A new `clear()` function has been added to `MessageReceiptRepository` to delete all receipts from the database.
The `DeliveryReceiptsManager` has been renamed to `MessageReceiptManager`.

Instead of making a direct API call to mark messages as delivered, the manager now creates `MessageReceipt` objects and upserts them into the local `MessageReceiptRepository`. This change also refactors the corresponding tests to verify the local database interaction rather than the API call.
…rving the local database for delivery receipts and reporting them to the backend.

This reporter collects receipts in batches and sends them periodically to reduce network traffic. After a successful API call, the reported receipts are removed from the local database. New tests are included to verify this functionality.
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.
This commit adds support for the `message.delivered` event, which is triggered when a message is marked as delivered.

The following changes are included:
- A new `MessageDeliveredEvent` data class.
- New fields (`last_delivered_at`, `last_delivered_message_id`) to the `ChannelUserRead` DTO and model.
- Logic to parse and map the `message.delivered` event from the backend DTO to the domain model.
Extracted the logic for retrieving a user's read state into a new `Channel.userRead()` helper function. This simplifies the implementation of `countUnreadMentionsForUser` and `currentUserUnreadCount`.

Additionally, introduced `Channel.deliveredReads(message)` to get a list of users who have received a specific message.
…message in a list of channels as delivered. It contains logic to identify the appropriate message to mark as delivered, considering factors like whether the message is already read or delivered.
Replaced the Flow-based implementation in `MessageReceiptReporter` with a `while(isActive)` loop and a `delay`. This change simplifies the logic for polling and reporting message delivery receipts.

The `getAllMessageReceiptsByType` function in `MessageReceiptRepository` and `MessageReceiptDao` is now a `suspend` function instead of returning a `Flow`.

The corresponding tests have been updated to reflect these changes.
…er is disconnected. This ensures that coroutines related to the previous user are properly cancelled before the new user connects.
Added a `deliveryEventsEnabled` flag to the `Config` model. This allows disabling message delivery events on a per-channel basis. Delivery receipts will not be stored or sent if this flag is disabled in the channel configuration.
This commit refactors the `MessageReceiptManager` to enhance the logic for marking messages as delivered.

Key changes include:
- Renaming `markMessagesAsDelivered(messages: List<Message>)` to `markMessageAsDelivered(message: Message)` and making it the public API. The old function is now private and handles batch processing.
- Before marking a message as delivered, the manager now fetches the corresponding channel from the local repository or the API to ensure all conditions are met.
- The responsibility of filtering messages that can be marked as delivered is moved into a new private function `canMarkMessageAsDelivered`.
- Test cases have been updated to reflect these changes and improve coverage.
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.
@andremion andremion force-pushed the AND-769-message-delivery-status branch from ead6af1 to eb33b8c Compare October 31, 2025 13:09
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.
This change prevents sending message delivery receipts for messages that are either shadowed or sent by a user who has been muted by the current user.
@andremion andremion force-pushed the AND-769-message-delivery-status branch from d6aebd9 to 89655f6 Compare November 4, 2025 10:23
@andremion andremion requested a review from Copilot November 4, 2025 14:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds delivery status indicators for messages in the Stream Chat SDK. It introduces a new "delivered" state between "sent" and "read" states, allowing the UI to display when messages have been delivered to recipients but not yet read.

Key changes:

  • Added isMessageDelivered property to message and channel state classes
  • Introduced new delivery status icon and UI indicators
  • Updated database schema version to support delivery events persistence
  • Added new drawable resource for the delivered state (double checkmark in grey)

Reviewed Changes

Copilot reviewed 116 out of 122 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
stream-chat-android-core/src/main/java/io/getstream/chat/android/models/ChannelUserRead.kt Added lastDeliveredAt and lastDeliveredMessageId properties
stream-chat-android-core/src/main/java/io/getstream/chat/android/models/Config.kt Added deliveryEventsEnabled configuration flag
stream-chat-android-core/src/main/java/io/getstream/chat/android/PrivacySettings.kt Added delivery receipts privacy settings
stream-chat-android-ui-components/src/main/res/drawable/stream_ui_ic_check_double_grey.xml New drawable for delivered status indicator
stream-chat-android-ui-components/src/main/kotlin/io/getstream/chat/android/ui/feature/messages/list/adapter/MessageListItem.kt Added isMessageDelivered property to MessageItem
stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/ui/components/channels/MessageReadStatusIcon.kt Updated to support delivered status icon
stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/ui/theme/ChatComponentFactory.kt Added new MessageFooterStatusIndicator overload with params
stream-chat-android-offline/src/main/java/io/getstream/chat/android/offline/repository/database/internal/ChatDatabase.kt Incremented database version to 96
stream-chat-android-state/src/main/java/io/getstream/chat/android/state/event/handler/internal/utils/ChatEventUtils.kt Added MessageDeliveredEvent to ChannelUserRead conversion

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +1407 to +1415
if (params.messageItem.isMessageDelivered) {
MessageReadStatusIcon(
modifier = params.modifier,
message = params.messageItem.message,
isMessageRead = params.messageItem.isMessageRead,
isMessageDelivered = params.messageItem.isMessageDelivered,
readCount = params.messageItem.messageReadBy.size,
)
} else {
Copy link

Copilot AI Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The conditional logic at line 1407 checks isMessageDelivered, but the message could be read (which implies delivered). The condition should check for both read and delivered states to ensure MessageReadStatusIcon is always called with the isMessageDelivered parameter, maintaining consistency. Consider simplifying this to always pass the isMessageDelivered parameter.

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is done to prevent breaking changes in the component factory.
If isMessageDelivered == true, that means we can call the new overloaded function; otherwise, we have to call the deprecated one.

@andremion andremion force-pushed the AND-769-message-delivery-status branch from 19d96be to 7e134c3 Compare November 4, 2025 14:44
@andremion andremion marked this pull request as ready for review November 4, 2025 14:44
@andremion andremion requested a review from a team as a code owner November 4, 2025 14:44
@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 4, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants