Introduce message delivery receipts by andremion · Pull Request #5979 · GetStream/stream-chat-android

andremion · 2025-10-23T09:49:07Z

🎯 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

https://linear.app/stream/issue/AND-769

🛠 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.
Introduced ChatClient.markMessageAsDelivered to mark a message as delivered for the current user.
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

1-to-1 chat

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

Group chat

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.

github-actions · 2025-10-23T09:55:13Z

SDK Size Comparison 📏

SDK	Before	After	Difference	Status
stream-chat-android-client	5.18 MB	5.22 MB	0.04 MB	🟢
stream-chat-android-offline	5.45 MB	5.46 MB	0.02 MB	🟢
stream-chat-android-ui-components	10.55 MB	10.57 MB	0.02 MB	🟢
stream-chat-android-compose	12.77 MB	12.80 MB	0.03 MB	🟢

github-actions · 2025-10-27T15:22:24Z

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
stream-chat-android-offline/src/main/java/io/getstream/chat/android/offline/repository/domain/user/internal/UserEntity.kt

Copilot

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.

...oid-compose/src/main/java/io/getstream/chat/android/compose/ui/theme/ChatComponentFactory.kt

stream-chat-android-compose-sample/src/main/res/values/strings.xml

...android-client/src/main/java/io/getstream/chat/android/client/extensions/ChannelExtension.kt

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

.../main/java/io/getstream/chat/android/compose/ui/components/channels/MessageReadStatusIcon.kt

stream-chat-android-core/src/main/java/io/getstream/chat/android/models/User.kt

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

...hat-android-client/src/main/java/io/getstream/chat/android/client/receipts/MessageReceipt.kt

...rc/main/java/io/getstream/chat/android/client/persistence/repository/ChatClientRepository.kt

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

...android-client/src/main/java/io/getstream/chat/android/client/extensions/ChannelExtension.kt

Copilot

Pull Request Overview

Copilot reviewed 131 out of 137 changed files in this pull request and generated no new comments.

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

…elivered

…epository

…estamps

…epository

… push messages before they are processed by the SDK.

…on with privacy settings and mutes

…en SDKs

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

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

...in/java/io/getstream/chat/android/client/notifications/handler/NotificationHandlerFactory.kt

...d-client/src/main/java/io/getstream/chat/android/client/persistence/db/ChatClientDatabase.kt

...ent/src/main/java/io/getstream/chat/android/client/persistence/db/converter/DateConverter.kt

...-android-compose-sample/src/main/java/io/getstream/chat/android/compose/sample/ChatHelper.kt

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

…success or failure

…livered.

…mp is always related to the latest message in the channel, and not for each message individually.

…livered.

sonarqubecloud · 2025-11-13T16:53:20Z

Quality Gate failed

Failed conditions
77.9% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

andremion added the core label Oct 23, 2025

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

andremion force-pushed the AND-769-message-delivery-status branch 6 times, most recently from d6aebd9 to 89655f6 Compare November 4, 2025 10:23

andremion requested a review from Copilot November 4, 2025 14:17

Copilot AI reviewed Nov 4, 2025

View reviewed changes

...oid-compose/src/main/java/io/getstream/chat/android/compose/ui/theme/ChatComponentFactory.kt Show resolved Hide resolved

stream-chat-android-compose-sample/src/main/res/values/strings.xml Outdated Show resolved Hide resolved

andremion force-pushed the AND-769-message-delivery-status branch from 19d96be to 7e134c3 Compare November 4, 2025 14:44

andremion marked this pull request as ready for review November 4, 2025 14:44

andremion requested a review from a team as a code owner November 4, 2025 14:44

VelikovPetar reviewed Nov 6, 2025

View reviewed changes

andremion force-pushed the AND-769-message-delivery-status branch from 7e134c3 to ce8df3f Compare November 7, 2025 12:06

xsahil03x reviewed Nov 7, 2025

View reviewed changes

...android-client/src/main/java/io/getstream/chat/android/client/extensions/ChannelExtension.kt Show resolved Hide resolved

andremion force-pushed the AND-769-message-delivery-status branch 3 times, most recently from e71c17a to 63b7e99 Compare November 11, 2025 15:30

andremion requested a review from Copilot November 11, 2025 16:01

Copilot started reviewing on behalf of andremion November 11, 2025 16:01 View session

Copilot finished reviewing on behalf of andremion November 11, 2025 16:02

Copilot AI reviewed Nov 11, 2025

View reviewed changes

andremion force-pushed the AND-769-message-delivery-status branch from 63b7e99 to e235eb4 Compare November 11, 2025 17:22

andremion added 2 commits November 12, 2025 10:40

Add ChatClient.markMessagesAsDelivered function to mark messages as d…

f223b1c

…elivered

Add delivery receipts support to user privacy settings

6242795

andremion added 13 commits November 12, 2025 10:40

Use getCreatedAtOrDefault

e390768

Remove MessageReceipt's 'type' field

4d1bef6

Move MessageReceiptRepositoryImpl to the same file as MessageReceiptR…

13b7ede

…epository

Fix tests after rebased from develop

0b2aae6

Update User.mergePartially to conditionally merge based on update tim…

3056ddb

…estamps

Store UserMuteEntity properly

64e9e05

Refactor event handling to consolidate user updates

edbdfc7

Refactor MessageReceiptManager to fetch the current user from the r…

d3d8110

…epository

Refactor: Lazily inject RepositoryFacade into MessageReceiptManager

fec9268

Expose markMessageAsDelivered and allow custom handling of incoming…

39a4624

… push messages before they are processed by the SDK.

Enhance UserRepositoryTests: Add tests for user insertion and selecti…

07e39e4

…on with privacy settings and mutes

improve test coverage

128a0fc

Rename onNewPushMessage to onNewMessage to keep consistency betwe…

716b933

…en SDKs

andremion force-pushed the AND-769-message-delivery-status branch from 0b179a7 to 716b933 Compare November 12, 2025 10:40

andremion requested a review from VelikovPetar November 12, 2025 10:46

VelikovPetar reviewed Nov 12, 2025

View reviewed changes

andremion added 5 commits November 13, 2025 11:44

Stop using kluent

518dc5a

Refactor markMessageAsDelivered methods to return Boolean indicating …

929b6ab

…success or failure

Check for the MESSAGE_NEW event type before marking a message as de…

6155b1b

…livered.

Add unit tests for MessagingStyleNotificationHandler

24e4c90

Remove timestamps of the read and delivered members since the timesta…

846f02d

…mp is always related to the latest message in the channel, and not for each message individually.

VelikovPetar approved these changes Nov 13, 2025

View reviewed changes

andremion and others added 4 commits November 13, 2025 13:33

kdoc

7d176c8

Check for the MESSAGE_NEW event type before marking a message as de…

3453c20

…livered.

Merge branch 'develop' into AND-769-message-delivery-status

570f740

Add unit tests for NotificationHandlerFactory

9a3c2a4

VelikovPetar merged commit 57f41ff into develop Nov 14, 2025
16 of 18 checks passed

VelikovPetar deleted the AND-769-message-delivery-status branch November 14, 2025 08:55

geolyth mentioned this pull request Dec 18, 2025

markMessageAsDelivered not works as expected #6052

Closed

Comments

Conversation

andremion commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Goal

🛠 Implementation details

Client module

Delivery receipts are:

Privacy:

UI:

🎨 UI Changes

🧪 Testing

Uh oh!

github-actions bot commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SDK Size Comparison 📏

Uh oh!

github-actions bot commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key changes:

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Nov 13, 2025

Quality Gate failed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

andremion commented Oct 23, 2025 •

edited

Loading

github-actions bot commented Oct 23, 2025 •

edited

Loading

github-actions bot commented Oct 27, 2025 •

edited

Loading