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 <benoitm+elementbot@element.io>

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/timeline/FakeMatrixTimeline.kt

@@ -39,7 +39,7 @@ class FakeMatrixTimeline(
     private val _paginationState: MutableStateFlow<MatrixTimeline.PaginationState> = MutableStateFlow(initialPaginationState)
     private val _timelineItems: MutableStateFlow<List<MatrixTimelineItem>> = MutableStateFlow(initialTimelineItems)
 
-    var sendReadReceiptCount = 0
+    var sentReadReceipts = mutableListOf<Pair<EventId, ReceiptType>>()
         private set
 
     var sendReadReceiptLatch: CompletableDeferred<Unit>? = null
@@ -81,7 +81,7 @@ class FakeMatrixTimeline(
         eventId: EventId,
         receiptType: ReceiptType,
     ): Result<Unit> = simulateLongTask {
-        sendReadReceiptCount++
+        sentReadReceipts.add(eventId to receiptType)
         sendReadReceiptLatch?.complete(Unit)
         Result.success(Unit)
     }

libraries/preferences/api/src/main/kotlin/io/element/android/features/preferences/api/store/AppPreferencesStore.kt

@@ -18,7 +18,7 @@ package io.element.android.features.preferences.api.store
 
 import kotlinx.coroutines.flow.Flow
 
-interface PreferencesStore {
+interface AppPreferencesStore {
     suspend fun setRichTextEditorEnabled(enabled: Boolean)
     fun isRichTextEditorEnabledFlow(): Flow<Boolean>
 

libraries/preferences/api/src/main/kotlin/io/element/android/features/preferences/api/store/SessionPreferencesStore.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2024 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.features.preferences.api.store
+
+import kotlinx.coroutines.flow.Flow
+
+interface SessionPreferencesStore {
+    suspend fun setSendPublicReadReceipts(enabled: Boolean)
+    fun isSendPublicReadReceiptsEnabled(): Flow<Boolean>
+
+    suspend fun clear()
+}

libraries/preferences/impl/build.gradle.kts

@@ -31,6 +31,8 @@ dependencies {
     api(projects.libraries.preferences.api)
     implementation(libs.dagger)
     implementation(libs.androidx.datastore.preferences)
+    implementation(projects.libraries.androidutils)
     implementation(projects.libraries.di)
     implementation(projects.libraries.core)
+    implementation(projects.libraries.matrix.api)
 }

libraries/preferences/impl/src/main/kotlin/io/element/android/libraries/preferences/impl/store/DefaultAppPreferencesStore.kt

@@ -24,7 +24,7 @@ import androidx.datastore.preferences.core.edit
 import androidx.datastore.preferences.core.stringPreferencesKey
 import androidx.datastore.preferences.preferencesDataStore
 import com.squareup.anvil.annotations.ContributesBinding
-import io.element.android.features.preferences.api.store.PreferencesStore
+import io.element.android.features.preferences.api.store.AppPreferencesStore
 import io.element.android.libraries.core.bool.orTrue
 import io.element.android.libraries.core.meta.BuildMeta
 import io.element.android.libraries.core.meta.BuildType
@@ -42,10 +42,10 @@ private val customElementCallBaseUrlKey = stringPreferencesKey("elementCallBaseU
 private val themeKey = stringPreferencesKey("theme")
 
 @ContributesBinding(AppScope::class)
-class DefaultPreferencesStore @Inject constructor(
+class DefaultAppPreferencesStore @Inject constructor(
     @ApplicationContext context: Context,
     private val buildMeta: BuildMeta,
-) : PreferencesStore {
+) : AppPreferencesStore {
     private val store = context.dataStore
 
     override suspend fun setRichTextEditorEnabled(enabled: Boolean) {

libraries/preferences/impl/src/main/kotlin/io/element/android/libraries/preferences/impl/store/DefaultSessionPreferencesStore.kt

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2024 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.preferences.impl.store
+
+import android.content.Context
+import androidx.datastore.preferences.core.PreferenceDataStoreFactory
+import androidx.datastore.preferences.core.Preferences
+import androidx.datastore.preferences.core.booleanPreferencesKey
+import androidx.datastore.preferences.core.edit
+import androidx.datastore.preferences.preferencesDataStoreFile
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.features.preferences.api.store.SessionPreferencesStore
+import io.element.android.libraries.androidutils.file.safeDelete
+import io.element.android.libraries.androidutils.hash.hash
+import io.element.android.libraries.di.ApplicationContext
+import io.element.android.libraries.di.SessionScope
+import io.element.android.libraries.di.SingleIn
+import io.element.android.libraries.matrix.api.user.CurrentSessionIdHolder
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.map
+import javax.inject.Inject
+
+@ContributesBinding(SessionScope::class)
+@SingleIn(SessionScope::class)
+class DefaultSessionPreferencesStore @Inject constructor(
+    @ApplicationContext context: Context,
+    currentSessionIdHolder: CurrentSessionIdHolder,
+) : SessionPreferencesStore {
+    private val sendPublicReadReceiptsKey = booleanPreferencesKey("sendPublicReadReceipts")
+    private val hashedUserId = currentSessionIdHolder.current.value.hash().take(16)
+
+    private val dataStoreFile = context.preferencesDataStoreFile("session_${hashedUserId}_preferences")
+    private val store = PreferenceDataStoreFactory.create { dataStoreFile }
+
+    override suspend fun setSendPublicReadReceipts(enabled: Boolean) = update(sendPublicReadReceiptsKey, enabled)
+    override fun isSendPublicReadReceiptsEnabled(): Flow<Boolean> = get(sendPublicReadReceiptsKey, true)
+
+    override suspend fun clear() {
+        dataStoreFile.safeDelete()
+    }
+
+    private suspend fun <T> update(key: Preferences.Key<T>, value: T) {
+        store.edit { prefs -> prefs[key] = value }
+    }
+
+    private fun <T> get(key: Preferences.Key<T>, default: T): Flow<T> {
+        return store.data.map { prefs -> prefs[key] ?: default }
+    }
+}

libraries/preferences/test/src/main/kotlin/io/element/android/libraries/featureflag/test/InMemoryAppPreferencesStore.kt

@@ -16,16 +16,16 @@
 
 package io.element.android.libraries.featureflag.test
 
-import io.element.android.features.preferences.api.store.PreferencesStore
+import io.element.android.features.preferences.api.store.AppPreferencesStore
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
 
-class InMemoryPreferencesStore(
+class InMemoryAppPreferencesStore(
     isRichTextEditorEnabled: Boolean = false,
     isDeveloperModeEnabled: Boolean = false,
     customElementCallBaseUrl: String? = null,
     theme: String? = null,
-) : PreferencesStore {
+) : AppPreferencesStore {
     private val isRichTextEditorEnabled = MutableStateFlow(isRichTextEditorEnabled)
     private val isDeveloperModeEnabled = MutableStateFlow(isDeveloperModeEnabled)
     private val customElementCallBaseUrl = MutableStateFlow(customElementCallBaseUrl)

libraries/preferences/test/src/main/kotlin/io/element/android/libraries/featureflag/test/InMemorySessionPreferencesStore.kt

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2024 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.featureflag.test
+
+import io.element.android.features.preferences.api.store.SessionPreferencesStore
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.MutableStateFlow
+
+class InMemorySessionPreferencesStore(
+    isSendPublicReadReceiptsEnabled: Boolean = true,
+) : SessionPreferencesStore {
+    private val isSendPublicReadReceiptsEnabled = MutableStateFlow(isSendPublicReadReceiptsEnabled)
+    var clearCallCount = 0
+        private set
+
+    override suspend fun setSendPublicReadReceipts(enabled: Boolean) {
+        isSendPublicReadReceiptsEnabled.tryEmit(enabled)
+    }
+    override fun isSendPublicReadReceiptsEnabled(): Flow<Boolean> {
+        return isSendPublicReadReceiptsEnabled
+    }
+
+    override suspend fun clear() {
+        clearCallCount++
+        isSendPublicReadReceiptsEnabled.tryEmit(true)
+    }
+}