Add 'send private read receipts' option in advanced settings (#2290)

* Add 'send private read receipts' option in advanced settings * Create `SessionPreferencesStore` that stores the settings for the current use separate from those of the app. * Rename `PreferencesStore` to `AppPreferencesStore` to split the preferences. --------- Co-authored-by: ElementBot <[email protected]>
element-hq · Jan 26, 2024 · 7e58f71 · 7e58f71
1 parent b794567
commit 7e58f71
Show file tree

Hide file tree

Showing 38 changed files with 314 additions and 85 deletions.
diff --git a/app/src/main/kotlin/io/element/android/x/di/AppBindings.kt b/app/src/main/kotlin/io/element/android/x/di/AppBindings.kt
@@ -18,7 +18,7 @@ package io.element.android.x.di
 
 import com.squareup.anvil.annotations.ContributesTo
 import io.element.android.features.lockscreen.api.LockScreenService
-import io.element.android.features.preferences.api.store.PreferencesStore
+import io.element.android.features.preferences.api.store.AppPreferencesStore
 import io.element.android.features.rageshake.api.reporter.BugReporter
 import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.di.AppScope
@@ -34,5 +34,5 @@ interface AppBindings {
 
     fun lockScreenService(): LockScreenService
 
-    fun preferencesStore(): PreferencesStore
+    fun preferencesStore(): AppPreferencesStore
 }
diff --git a/changelog.d/2204.feature b/changelog.d/2204.feature
@@ -0,0 +1 @@
+Add 'send private read receipts' option in advanced settings
diff --git a/features/call/src/main/kotlin/io/element/android/features/call/ui/ElementCallActivity.kt b/features/call/src/main/kotlin/io/element/android/features/call/ui/ElementCallActivity.kt
@@ -45,7 +45,7 @@ import io.element.android.features.call.CallForegroundService
 import io.element.android.features.call.CallType
 import io.element.android.features.call.di.CallBindings
 import io.element.android.features.call.utils.CallIntentDataParser
-import io.element.android.features.preferences.api.store.PreferencesStore
+import io.element.android.features.preferences.api.store.AppPreferencesStore
 import io.element.android.libraries.architecture.bindings
 import javax.inject.Inject
 
@@ -67,7 +67,7 @@ class ElementCallActivity : NodeComponentActivity(), CallScreenNavigator {
 
     @Inject lateinit var callIntentDataParser: CallIntentDataParser
     @Inject lateinit var presenterFactory: CallScreenPresenter.Factory
-    @Inject lateinit var preferencesStore: PreferencesStore
+    @Inject lateinit var appPreferencesStore: AppPreferencesStore
 
     private lateinit var presenter: CallScreenPresenter
 
@@ -101,7 +101,7 @@ class ElementCallActivity : NodeComponentActivity(), CallScreenNavigator {
 
         setContent {
             val theme by remember {
-                preferencesStore.getThemeFlow().mapToTheme()
+                appPreferencesStore.getThemeFlow().mapToTheme()
             }
                 .collectAsState(initial = Theme.System)
             val state = presenter.present()

diff --git a/.../call/src/main/kotlin/io/element/android/features/call/utils/DefaultCallWidgetProvider.kt b/.../call/src/main/kotlin/io/element/android/features/call/utils/DefaultCallWidgetProvider.kt
@@ -18,7 +18,7 @@ package io.element.android.features.call.utils
 
 import com.squareup.anvil.annotations.ContributesBinding
 import io.element.android.appconfig.ElementCallConfig
-import io.element.android.features.preferences.api.store.PreferencesStore
+import io.element.android.features.preferences.api.store.AppPreferencesStore
 import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.matrix.api.MatrixClientProvider
 import io.element.android.libraries.matrix.api.core.RoomId
@@ -31,7 +31,7 @@ import javax.inject.Inject
 @ContributesBinding(AppScope::class)
 class DefaultCallWidgetProvider @Inject constructor(
     private val matrixClientsProvider: MatrixClientProvider,
-    private val preferencesStore: PreferencesStore,
+    private val appPreferencesStore: AppPreferencesStore,
     private val callWidgetSettingsProvider: CallWidgetSettingsProvider,
 ) : CallWidgetProvider {
     override suspend fun getWidget(
@@ -42,7 +42,7 @@ class DefaultCallWidgetProvider @Inject constructor(
         theme: String?,
     ): Result<Pair<MatrixWidgetDriver, String>> = runCatching {
         val room = matrixClientsProvider.getOrRestore(sessionId).getOrThrow().getRoom(roomId) ?: error("Room not found")
-        val baseUrl = preferencesStore.getCustomElementCallBaseUrlFlow().firstOrNull() ?: ElementCallConfig.DEFAULT_BASE_URL
+        val baseUrl = appPreferencesStore.getCustomElementCallBaseUrlFlow().firstOrNull() ?: ElementCallConfig.DEFAULT_BASE_URL
         val widgetSettings = callWidgetSettingsProvider.provide(baseUrl)
         val callUrl = room.generateWidgetWebViewUrl(widgetSettings, clientId, languageTag, theme).getOrThrow()
         room.getWidgetDriver(widgetSettings).getOrThrow() to callUrl

diff --git a/...l/src/test/kotlin/io/element/android/features/call/utils/DefaultCallWidgetProviderTest.kt b/...l/src/test/kotlin/io/element/android/features/call/utils/DefaultCallWidgetProviderTest.kt
@@ -17,8 +17,8 @@
 package io.element.android.features.call.utils
 
 import com.google.common.truth.Truth.assertThat
-import io.element.android.features.preferences.api.store.PreferencesStore
-import io.element.android.libraries.featureflag.test.InMemoryPreferencesStore
+import io.element.android.features.preferences.api.store.AppPreferencesStore
+import io.element.android.libraries.featureflag.test.InMemoryAppPreferencesStore
 import io.element.android.libraries.matrix.api.MatrixClientProvider
 import io.element.android.libraries.matrix.api.widget.CallWidgetSettingsProvider
 import io.element.android.libraries.matrix.test.A_ROOM_ID
@@ -94,14 +94,14 @@ class DefaultCallWidgetProviderTest {
         val client = FakeMatrixClient().apply {
             givenGetRoomResult(A_ROOM_ID, room)
         }
-        val preferencesStore = InMemoryPreferencesStore().apply {
+        val preferencesStore = InMemoryAppPreferencesStore().apply {
             setCustomElementCallBaseUrl("https://custom.element.io")
         }
         val settingsProvider = FakeCallWidgetSettingsProvider()
         val provider = createProvider(
             matrixClientProvider = FakeMatrixClientProvider { Result.success(client) },
             callWidgetSettingsProvider = settingsProvider,
-            preferencesStore = preferencesStore,
+            appPreferencesStore = preferencesStore,
         )
         provider.getWidget(A_SESSION_ID, A_ROOM_ID, "clientId", "languageTag", "theme")
 
@@ -110,11 +110,11 @@ class DefaultCallWidgetProviderTest {
 
     private fun createProvider(
         matrixClientProvider: MatrixClientProvider = FakeMatrixClientProvider(),
-        preferencesStore: PreferencesStore = InMemoryPreferencesStore(),
+        appPreferencesStore: AppPreferencesStore = InMemoryAppPreferencesStore(),
         callWidgetSettingsProvider: CallWidgetSettingsProvider = FakeCallWidgetSettingsProvider()
     ) = DefaultCallWidgetProvider(
         matrixClientProvider,
-        preferencesStore,
+        appPreferencesStore,
         callWidgetSettingsProvider,
     )
 }
diff --git a/...sages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesPresenter.kt b/...sages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesPresenter.kt
@@ -63,7 +63,7 @@ import io.element.android.features.messages.impl.utils.messagesummary.MessageSum
 import io.element.android.features.messages.impl.voicemessages.composer.VoiceMessageComposerPresenter
 import io.element.android.features.networkmonitor.api.NetworkMonitor
 import io.element.android.features.networkmonitor.api.NetworkStatus
-import io.element.android.features.preferences.api.store.PreferencesStore
+import io.element.android.features.preferences.api.store.AppPreferencesStore
 import io.element.android.libraries.androidutils.clipboard.ClipboardHelper
 import io.element.android.libraries.architecture.AsyncData
 import io.element.android.libraries.architecture.Presenter
@@ -108,7 +108,7 @@ class MessagesPresenter @AssistedInject constructor(
     private val messageSummaryFormatter: MessageSummaryFormatter,
     private val dispatchers: CoroutineDispatchers,
     private val clipboardHelper: ClipboardHelper,
-    private val preferencesStore: PreferencesStore,
+    private val appPreferencesStore: AppPreferencesStore,
     private val featureFlagsService: FeatureFlagService,
     private val htmlConverterProvider: HtmlConverterProvider,
     @Assisted private val navigator: MessagesNavigator,
@@ -178,7 +178,7 @@ class MessagesPresenter @AssistedInject constructor(
             timelineState.eventSink(TimelineEvents.SetHighlightedEvent(composerState.mode.relatedEventId))
         }
 
-        val enableTextFormatting by preferencesStore.isRichTextEditorEnabledFlow().collectAsState(initial = true)
+        val enableTextFormatting by appPreferencesStore.isRichTextEditorEnabledFlow().collectAsState(initial = true)
 
         var enableVoiceMessages by remember { mutableStateOf(false) }
         LaunchedEffect(featureFlagsService) {

diff --git a/...c/main/kotlin/io/element/android/features/messages/impl/actionlist/ActionListPresenter.kt b/...c/main/kotlin/io/element/android/features/messages/impl/actionlist/ActionListPresenter.kt
@@ -31,15 +31,15 @@ import io.element.android.features.messages.impl.timeline.model.event.TimelineIt
 import io.element.android.features.messages.impl.timeline.model.event.TimelineItemVoiceContent
 import io.element.android.features.messages.impl.timeline.model.event.canBeCopied
 import io.element.android.features.messages.impl.timeline.model.event.canReact
-import io.element.android.features.preferences.api.store.PreferencesStore
+import io.element.android.features.preferences.api.store.AppPreferencesStore
 import io.element.android.libraries.architecture.Presenter
 import kotlinx.collections.immutable.toImmutableList
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 class ActionListPresenter @Inject constructor(
-    private val preferencesStore: PreferencesStore,
+    private val appPreferencesStore: AppPreferencesStore,
 ) : Presenter<ActionListState> {
     @Composable
     override fun present(): ActionListState {
@@ -49,7 +49,7 @@ class ActionListPresenter @Inject constructor(
             mutableStateOf(ActionListState.Target.None)
         }
 
-        val isDeveloperModeEnabled by preferencesStore.isDeveloperModeEnabledFlow().collectAsState(initial = false)
+        val isDeveloperModeEnabled by appPreferencesStore.isDeveloperModeEnabledFlow().collectAsState(initial = false)
 
         fun handleEvents(event: ActionListEvents) {
             when (event) {

diff --git a/...l/src/main/kotlin/io/element/android/features/messages/impl/timeline/TimelinePresenter.kt b/...l/src/main/kotlin/io/element/android/features/messages/impl/timeline/TimelinePresenter.kt
@@ -38,6 +38,7 @@ import io.element.android.features.messages.impl.timeline.session.SessionState
 import io.element.android.features.messages.impl.voicemessages.timeline.RedactedVoiceMessageManager
 import io.element.android.features.poll.api.actions.EndPollAction
 import io.element.android.features.poll.api.actions.SendPollResponseAction
+import io.element.android.features.preferences.api.store.SessionPreferencesStore
 import io.element.android.libraries.architecture.Presenter
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.matrix.api.core.EventId
@@ -73,6 +74,7 @@ class TimelinePresenter @AssistedInject constructor(
     private val redactedVoiceMessageManager: RedactedVoiceMessageManager,
     private val sendPollResponseAction: SendPollResponseAction,
     private val endPollAction: EndPollAction,
+    private val sessionPreferencesStore: SessionPreferencesStore,
 ) : Presenter<TimelineState> {
     @AssistedFactory
     interface Factory {
@@ -103,6 +105,8 @@ class TimelinePresenter @AssistedInject constructor(
         val sessionVerifiedStatus by verificationService.sessionVerifiedStatus.collectAsState()
         val keyBackupState by encryptionService.backupStateStateFlow.collectAsState()
 
+        val isSendPublicReadReceiptsEnabled by sessionPreferencesStore.isSendPublicReadReceiptsEnabled().collectAsState(initial = true)
+
         val sessionState by remember {
             derivedStateOf {
                 SessionState(
@@ -124,7 +128,8 @@ class TimelinePresenter @AssistedInject constructor(
                         firstVisibleIndex = event.firstIndex,
                         timelineItems = timelineItems,
                         lastReadReceiptIndex = lastReadReceiptIndex,
-                        lastReadReceiptId = lastReadReceiptId
+                        lastReadReceiptId = lastReadReceiptId,
+                        readReceiptType = if (isSendPublicReadReceiptsEnabled) ReceiptType.READ else ReceiptType.READ_PRIVATE,
                     )
                 }
                 is TimelineEvents.PollAnswerSelected -> appScope.launch {
@@ -223,13 +228,14 @@ class TimelinePresenter @AssistedInject constructor(
         timelineItems: ImmutableList<TimelineItem>,
         lastReadReceiptIndex: MutableState<Int>,
         lastReadReceiptId: MutableState<EventId?>,
+        readReceiptType: ReceiptType,
     ) = launch(dispatchers.computation) {
         // Get last valid EventId seen by the user, as the first index might refer to a Virtual item
         val eventId = getLastEventIdBeforeOrAt(firstVisibleIndex, timelineItems)
         if (eventId != null && firstVisibleIndex <= lastReadReceiptIndex.value && eventId != lastReadReceiptId.value) {
             lastReadReceiptIndex.value = firstVisibleIndex
             lastReadReceiptId.value = eventId
-            timeline.sendReadReceipt(eventId = eventId, receiptType = ReceiptType.READ)
+            timeline.sendReadReceipt(eventId = eventId, receiptType = readReceiptType)
         }
     }
 

diff --git a/...s/impl/src/test/kotlin/io/element/android/features/messages/impl/MessagesPresenterTest.kt b/...s/impl/src/test/kotlin/io/element/android/features/messages/impl/MessagesPresenterTest.kt
@@ -59,7 +59,8 @@ import io.element.android.libraries.designsystem.components.avatar.AvatarSize
 import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher
 import io.element.android.libraries.featureflag.api.FeatureFlags
 import io.element.android.libraries.featureflag.test.FakeFeatureFlagService
-import io.element.android.libraries.featureflag.test.InMemoryPreferencesStore
+import io.element.android.libraries.featureflag.test.InMemoryAppPreferencesStore
+import io.element.android.libraries.featureflag.test.InMemorySessionPreferencesStore
 import io.element.android.libraries.matrix.api.media.MediaSource
 import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.MatrixRoomMembersState
@@ -668,6 +669,8 @@ class MessagesPresenterTest {
     ): MessagesPresenter {
         val mediaSender = MediaSender(FakeMediaPreProcessor(), matrixRoom)
         val permissionsPresenterFactory = FakePermissionsPresenterFactory(permissionsPresenter)
+        val appPreferencesStore = InMemoryAppPreferencesStore(isRichTextEditorEnabled = true)
+        val sessionPreferencesStore = InMemorySessionPreferencesStore()
         val messageComposerPresenter = MessageComposerPresenter(
             appCoroutineScope = this,
             room = matrixRoom,
@@ -702,14 +705,14 @@ class MessagesPresenterTest {
             redactedVoiceMessageManager = FakeRedactedVoiceMessageManager(),
             endPollAction = FakeEndPollAction(),
             sendPollResponseAction = FakeSendPollResponseAction(),
+            sessionPreferencesStore = sessionPreferencesStore,
         )
         val timelinePresenterFactory = object : TimelinePresenter.Factory {
             override fun create(navigator: MessagesNavigator): TimelinePresenter {
                 return timelinePresenter
             }
         }
-        val preferencesStore = InMemoryPreferencesStore(isRichTextEditorEnabled = true)
-        val actionListPresenter = ActionListPresenter(preferencesStore = preferencesStore)
+        val actionListPresenter = ActionListPresenter(appPreferencesStore = appPreferencesStore)
         val readReceiptBottomSheetPresenter = ReadReceiptBottomSheetPresenter()
         val customReactionPresenter = CustomReactionPresenter(emojibaseProvider = FakeEmojibaseProvider())
         val reactionSummaryPresenter = ReactionSummaryPresenter(room = matrixRoom)
@@ -729,7 +732,7 @@ class MessagesPresenterTest {
             messageSummaryFormatter = FakeMessageSummaryFormatter(),
             navigator = navigator,
             clipboardHelper = clipboardHelper,
-            preferencesStore = preferencesStore,
+            appPreferencesStore = appPreferencesStore,
             featureFlagsService = FakeFeatureFlagService(),
             buildMeta = aBuildMeta(),
             dispatchers = coroutineDispatchers,

diff --git a/...st/kotlin/io/element/android/features/messages/impl/actionlist/ActionListPresenterTest.kt b/...st/kotlin/io/element/android/features/messages/impl/actionlist/ActionListPresenterTest.kt
@@ -30,7 +30,7 @@ import io.element.android.features.messages.impl.timeline.model.event.aTimelineI
 import io.element.android.features.messages.impl.timeline.model.event.aTimelineItemStateEventContent
 import io.element.android.features.messages.impl.timeline.model.event.aTimelineItemVoiceContent
 import io.element.android.features.poll.api.pollcontent.aPollAnswerItemList
-import io.element.android.libraries.featureflag.test.InMemoryPreferencesStore
+import io.element.android.libraries.featureflag.test.InMemoryAppPreferencesStore
 import io.element.android.libraries.matrix.test.A_MESSAGE
 import io.element.android.tests.testutils.WarmUpRule
 import kotlinx.collections.immutable.persistentListOf
@@ -747,6 +747,6 @@ class ActionListPresenterTest {
 }
 
 private fun createActionListPresenter(isDeveloperModeEnabled: Boolean): ActionListPresenter {
-    val preferencesStore = InMemoryPreferencesStore(isDeveloperModeEnabled = isDeveloperModeEnabled)
-    return ActionListPresenter(preferencesStore = preferencesStore)
+    val preferencesStore = InMemoryAppPreferencesStore(isDeveloperModeEnabled = isDeveloperModeEnabled)
+    return ActionListPresenter(appPreferencesStore = preferencesStore)
 }