added read receipts for threads #7474

fedrunov · 2022-10-27T10:49:01Z

Type of change

Feature
Bugfix
Technical
Other :

Content

with MSC3771 we have a possibility to display read receipts for messages in a thread

Motivation and context

#6996

Screenshots / GIFs

bmarty

Thanks! The code is not compiling, can you check please? Also I have added some remarks.

bmarty · 2022-11-07T14:50:32Z

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/read/ReadService.kt

@@ -34,12 +34,12 @@ interface ReadService {
    /**
     * Force the read marker to be set on the latest event.
     */
-    suspend fun markAsRead(params: MarkAsReadParams = MarkAsReadParams.BOTH)
+    suspend fun markAsRead(params: MarkAsReadParams = MarkAsReadParams.BOTH, mainTimeLineOnly: Boolean)


Maybe add default value to the new parameters to avoid API breaks.
Also can you document API change in a .sdk file for towncrier? Thanks.

bmarty · 2022-11-07T14:53:19Z

...-android/src/main/java/org/matrix/android/sdk/internal/database/helper/ThreadEventsHelper.kt

@@ -294,7 +295,7 @@ internal fun isUserMentioned(currentUserId: String, timelineEventEntity: Timelin
 * immediately so we should not display wrong notifications
 */
 internal fun updateNotificationsNew(roomId: String, realm: Realm, currentUserId: String) {
-    val readReceipt = findMyReadReceipt(realm, roomId, currentUserId) ?: return
+    val readReceipt = findMyReadReceipt(realm, roomId, currentUserId, ReadService.THREAD_ID_MAIN) ?: return


Maybe use null instead of introducing const ReadService.THREAD_ID_MAIN. Not sure it's better though.

null and main values for threadId in read receipt are different cases so we can't use null here

After looking deeper at this method I've realised that it needs to be changed, so it will use exact threadId instead of main

bmarty · 2022-11-07T14:57:03Z

...oid/src/main/java/org/matrix/android/sdk/internal/database/query/ReadReceiptEntityQueries.kt

 internal fun ReadReceiptEntity.Companion.where(realm: Realm, roomId: String, userId: String): RealmQuery<ReadReceiptEntity> {
    return realm.where<ReadReceiptEntity>()
-            .equalTo(ReadReceiptEntityFields.PRIMARY_KEY, buildPrimaryKey(roomId, userId))
+            .equalTo(ReadReceiptEntityFields.USER_ID, userId)


Maybe make this fun private to avoid any mistake. I understand that only the 2 functions above have to be used now.

I've found some usages of this method, but after some closer look it appeared that these cases should use threadId also, so now there is no usages and I'll rather remove this method completely. Or is there a reason to keep it and make private even if it's not used?

bmarty · 2022-11-07T14:59:42Z

...oid/src/main/java/org/matrix/android/sdk/internal/database/query/ReadReceiptEntityQueries.kt

                    }
 }

-private fun buildPrimaryKey(roomId: String, userId: String) = "${roomId}_$userId"
+private fun buildPrimaryKey(roomId: String, userId: String, threadId: String?) = "${roomId}_${userId}_${threadId ?: "null"}"


For compatibility I would have written

Suggested change

private fun buildPrimaryKey(roomId: String, userId: String, threadId: String?) = "${roomId}_${userId}_${threadId ?: "null"}"

private fun buildPrimaryKey(roomId: String, userId: String, threadId: String?): String {

return if (threadId == null) {

"${roomId}_${userId}"

} else {

"${roomId}_${userId}_${threadId}"

}

bmarty · 2022-11-07T15:02:39Z

...ndroid/src/main/java/org/matrix/android/sdk/internal/session/room/read/DefaultReadService.kt

@@ -40,25 +42,37 @@ internal class DefaultReadService @AssistedInject constructor(
        @SessionDatabase private val monarchy: Monarchy,
        private val setReadMarkersTask: SetReadMarkersTask,
        private val readReceiptsSummaryMapper: ReadReceiptsSummaryMapper,
-        @UserId private val userId: String
+        @UserId private val userId: String,
+        private val homeServerCapabilitiesService: HomeServerCapabilitiesService,


Better to inject HomeServerCapabilitiesDataSource here.

bmarty · 2022-11-07T15:05:11Z

...droid/src/main/java/org/matrix/android/sdk/internal/session/room/timeline/DefaultTimeline.kt

@@ -411,7 +411,6 @@ internal class DefaultTimeline(
    private fun ensureReadReceiptAreLoaded(realm: Realm) {
        readReceiptHandler.getContentFromInitSync(roomId)
                ?.also {
-                    Timber.w("INIT_SYNC Insert when opening timeline RR for room $roomId")


Maybe just reduce the log level to d, or delete the also block.

bmarty · 2022-11-07T15:05:40Z

...rc/main/java/org/matrix/android/sdk/internal/session/sync/handler/room/ReadReceiptHandler.kt

@@ -115,7 +122,6 @@ internal class ReadReceiptHandler @Inject constructor(
    ) {
        // First check if we have data from init sync to handle
        getContentFromInitSync(roomId)?.let {
-            Timber.w("INIT_SYNC Insert during incremental sync RR for room $roomId")


Same remark about log level.

bmarty · 2022-11-07T15:08:04Z

...ain/java/im/vector/app/features/home/room/detail/timeline/factory/ReadReceiptsItemFactory.kt

@@ -45,7 +44,7 @@ class ReadReceiptsItemFactory @Inject constructor(private val avatarRenderer: Av
                .eventId(eventId)
                .readReceipts(readReceiptsData)
                .avatarRenderer(avatarRenderer)
-                .shouldHideReadReceipts(isFromThreadTimeLine)
+                .shouldHideReadReceipts(false)


Maybe shouldHideReadReceipts can be just removed. Or maybe set to something like isFromThreadTimeLine && !canUseThreadReadReceiptsAndNotifications

…ipts capability

bmarty

LGTM, thanks for the update. Just a last remark about API doc.

bmarty · 2022-11-24T12:53:06Z

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/read/ReadService.kt


    /**
     * Set the read receipt on the event with provided eventId.
     */
-    suspend fun setReadReceipt(eventId: String)
+    suspend fun setReadReceipt(eventId: String, threadId: String)


Maybe add Kdoc for parameters, especially tell about the possible value THREAD_ID_MAIN for threadId.

sonarqubecloud · 2022-11-24T14:43:55Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

1.5% Coverage
0.0% Duplication

This reverts commit 18bcc83.

added read receipts for threads

1f8ac06

fedrunov requested a review from ericdecanini October 27, 2022 10:49

lint

33e673c

fedrunov requested review from bmarty and removed request for ericdecanini November 1, 2022 13:13

bmarty reviewed Nov 7, 2022

View reviewed changes

NIkita Fedrunov added 5 commits November 16, 2022 13:11

Merge branch 'develop' into feature/nfe/threads_read_receipts

5dd40bd

fixed compilation error

e560d7a

Merge branch 'develop' into feature/nfe/threads_read_receipts

60e7242

lint

0a425cf

added read receipts hiding for homeservers without threaded read rece…

a46d807

…ipts capability

fedrunov requested a review from bmarty November 24, 2022 08:42

changelog

fbb2ca2

bmarty approved these changes Nov 24, 2022

View reviewed changes

added kdoc for setReadReceipt method

9cfe82c

fedrunov merged commit 18bcc83 into develop Nov 25, 2022

fedrunov deleted the feature/nfe/threads_read_receipts branch November 25, 2022 08:49

fedrunov added a commit that referenced this pull request Nov 25, 2022

Revert "added read receipts for threads (#7474)"

3a21647

This reverts commit 18bcc83.

This was referenced Nov 25, 2022

Revert "added read receipts for threads" #7639

Closed

read receipt migration added #7640

Merged

germain-gg mentioned this pull request Dec 12, 2022

Implement MSC3771 (read receipts for threads) #6996

Closed

B-McDonnell mentioned this pull request Jan 10, 2023

Two "Seen by" dots shown #7882

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added read receipts for threads #7474

added read receipts for threads #7474

fedrunov commented Oct 27, 2022

bmarty left a comment

bmarty Nov 7, 2022

bmarty Nov 7, 2022

fedrunov Nov 23, 2022

fedrunov Nov 24, 2022

bmarty Nov 7, 2022

fedrunov Nov 23, 2022

bmarty Nov 7, 2022

bmarty Nov 7, 2022

bmarty Nov 7, 2022

bmarty Nov 7, 2022

bmarty Nov 7, 2022

bmarty left a comment

bmarty Nov 24, 2022

sonarqubecloud bot commented Nov 24, 2022

-private fun buildPrimaryKey(roomId: String, userId: String, threadId: String?) = "${roomId}_${userId}_${threadId ?: "null"}"
+private fun buildPrimaryKey(roomId: String, userId: String, threadId: String?): String {
+    return if (threadId == null) {
+        "${roomId}_${userId}"
+    } else {
+        "${roomId}_${userId}_${threadId}"
+    }

added read receipts for threads #7474

added read receipts for threads #7474

Conversation

fedrunov commented Oct 27, 2022

Type of change

Content

Motivation and context

Screenshots / GIFs

bmarty left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bmarty left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 24, 2022