feat: Add visible history alert to encrypted rooms.

kaylendog · kaylendog · commit b0189d2449d7 · 2025-11-10T11:51:57.000Z
- Adds a dismissable alert that is displayed whenever the user opens a room with `history_visibility` != `joined`. When cleared, this is recorded in the app's data store. - When opening a room with `history_visibility` = `joined`, this flag is cleared.` Issue: element-hq/element-meta#2875
diff --git a/appconfig/src/main/kotlin/io/element/android/appconfig/LearnMoreConfig.kt b/appconfig/src/main/kotlin/io/element/android/appconfig/LearnMoreConfig.kt
@@ -12,4 +12,5 @@ object LearnMoreConfig {
     const val DEVICE_VERIFICATION_URL: String = "https://element.io/help#encryption-device-verification"
     const val SECURE_BACKUP_URL: String = "https://element.io/help#encryption5"
     const val IDENTITY_CHANGE_URL: String = "https://element.io/help#encryption18"
+    const val HISTORY_VISIBLE_URL: String = "https://example.com"
 }
diff --git a/features/messages/impl/build.gradle.kts b/features/messages/impl/build.gradle.kts
@@ -66,6 +66,7 @@ dependencies {
     implementation(libs.jsoup)
     implementation(libs.androidx.constraintlayout)
     implementation(libs.androidx.constraintlayout.compose)
+    implementation(libs.androidx.datastore.preferences)
     implementation(libs.androidx.media3.exoplayer)
     implementation(libs.androidx.media3.ui)
     implementation(libs.sigpwned.emoji4j)
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesPresenter.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesPresenter.kt
@@ -31,6 +31,7 @@ import io.element.android.features.messages.api.timeline.HtmlConverterProvider
 import io.element.android.features.messages.impl.actionlist.ActionListEvents
 import io.element.android.features.messages.impl.actionlist.ActionListState
 import io.element.android.features.messages.impl.actionlist.model.TimelineItemAction
+import io.element.android.features.messages.impl.crypto.historyvisible.HistoryVisibleState
 import io.element.android.features.messages.impl.crypto.identity.IdentityChangeState
 import io.element.android.features.messages.impl.link.LinkState
 import io.element.android.features.messages.impl.messagecomposer.MessageComposerEvents
@@ -106,6 +107,7 @@ class MessagesPresenter(
     @Assisted private val timelinePresenter: Presenter<TimelineState>,
     private val timelineProtectionPresenter: Presenter<TimelineProtectionState>,
     private val identityChangeStatePresenter: Presenter<IdentityChangeState>,
+    private val historyVisibleStatePresenter: Presenter<HistoryVisibleState>,
     private val linkPresenter: Presenter<LinkState>,
     @Assisted private val actionListPresenter: Presenter<ActionListState>,
     private val customReactionPresenter: Presenter<CustomReactionState>,
@@ -157,6 +159,7 @@ class MessagesPresenter(
         val timelineState = timelinePresenter.present()
         val timelineProtectionState = timelineProtectionPresenter.present()
         val identityChangeState = identityChangeStatePresenter.present()
+        val historyVisibleState = historyVisibleStatePresenter.present()
         val actionListState = actionListPresenter.present()
         val linkState = linkPresenter.present()
         val customReactionState = customReactionPresenter.present()
@@ -277,6 +280,7 @@ class MessagesPresenter(
             timelineState = timelineState,
             timelineProtectionState = timelineProtectionState,
             identityChangeState = identityChangeState,
+            historyVisibleState = historyVisibleState,
             linkState = linkState,
             actionListState = actionListState,
             customReactionState = customReactionState,
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesState.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesState.kt
@@ -10,6 +10,7 @@ package io.element.android.features.messages.impl
 import io.element.android.features.messages.api.timeline.voicemessages.composer.VoiceMessageComposerState
 import io.element.android.features.messages.impl.actionlist.ActionListState
 import io.element.android.features.messages.impl.crypto.identity.IdentityChangeState
+import io.element.android.features.messages.impl.crypto.historyvisible.HistoryVisibleState
 import io.element.android.features.messages.impl.link.LinkState
 import io.element.android.features.messages.impl.messagecomposer.MessageComposerState
 import io.element.android.features.messages.impl.pinned.banner.PinnedMessagesBannerState
@@ -39,6 +40,7 @@ data class MessagesState(
     val timelineState: TimelineState,
     val timelineProtectionState: TimelineProtectionState,
     val identityChangeState: IdentityChangeState,
+    val historyVisibleState: HistoryVisibleState,
     val linkState: LinkState,
     val actionListState: ActionListState,
     val customReactionState: CustomReactionState,
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesStateProvider.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesStateProvider.kt
@@ -13,6 +13,8 @@ import io.element.android.features.messages.api.timeline.voicemessages.composer.
 import io.element.android.features.messages.api.timeline.voicemessages.composer.aVoiceMessagePreviewState
 import io.element.android.features.messages.impl.actionlist.ActionListState
 import io.element.android.features.messages.impl.actionlist.anActionListState
+import io.element.android.features.messages.impl.crypto.historyvisible.HistoryVisibleState
+import io.element.android.features.messages.impl.crypto.historyvisible.aHistoryVisibleState
 import io.element.android.features.messages.impl.crypto.identity.IdentityChangeState
 import io.element.android.features.messages.impl.crypto.identity.anIdentityChangeState
 import io.element.android.features.messages.impl.link.LinkState
@@ -102,6 +104,7 @@ fun aMessagesState(
     ),
     timelineProtectionState: TimelineProtectionState = aTimelineProtectionState(),
     identityChangeState: IdentityChangeState = anIdentityChangeState(),
+    historyVisibleState: HistoryVisibleState = aHistoryVisibleState(),
     linkState: LinkState = aLinkState(),
     readReceiptBottomSheetState: ReadReceiptBottomSheetState = aReadReceiptBottomSheetState(),
     actionListState: ActionListState = anActionListState(),
@@ -124,6 +127,7 @@ fun aMessagesState(
     voiceMessageComposerState = voiceMessageComposerState,
     timelineProtectionState = timelineProtectionState,
     identityChangeState = identityChangeState,
+    historyVisibleState = historyVisibleState,
     linkState = linkState,
     timelineState = timelineState,
     readReceiptBottomSheetState = readReceiptBottomSheetState,
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesView.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/MessagesView.kt
@@ -46,6 +46,7 @@ import io.element.android.features.messages.api.timeline.voicemessages.composer.
 import io.element.android.features.messages.impl.actionlist.ActionListEvents
 import io.element.android.features.messages.impl.actionlist.ActionListView
 import io.element.android.features.messages.impl.actionlist.model.TimelineItemAction
+import io.element.android.features.messages.impl.crypto.historyvisible.HistoryVisibleStateView
 import io.element.android.features.messages.impl.crypto.identity.IdentityChangeStateView
 import io.element.android.features.messages.impl.link.LinkEvents
 import io.element.android.features.messages.impl.link.LinkView
@@ -470,6 +471,10 @@ private fun MessagesViewComposerBottomSheetContents(
                         state = state.identityChangeState,
                         onLinkClick = onLinkClick,
                     )
+                    HistoryVisibleStateView(
+                        state = state.historyVisibleState,
+                        onLinkClick = onLinkClick,
+                    )
                 }
                 val verificationViolation = state.identityChangeState.roomMemberIdentityStateChanges.firstOrNull {
                     it.identityState == IdentityState.VerificationViolation
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleAcknowledgementRepository.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleAcknowledgementRepository.kt
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.features.messages.impl.crypto.historyvisible
+
+import androidx.datastore.preferences.core.booleanPreferencesKey
+import androidx.datastore.preferences.core.edit
+import dev.zacsweers.metro.ContributesBinding
+import io.element.android.libraries.di.SessionScope
+import io.element.android.libraries.matrix.api.core.RoomId
+import io.element.android.libraries.preferences.api.store.PreferenceDataStoreFactory
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.map
+
+interface HistoryVisibleAcknowledgementRepository {
+    fun hasAcknowledged(roomId: RoomId): Flow<Boolean>
+    suspend fun setAcknowledged(roomId: RoomId, value: Boolean)
+}
+
+@ContributesBinding(SessionScope::class)
+class DefaultHistoryVisibleAcknowledgementRepository(
+    preferenceDataStoreFactory: PreferenceDataStoreFactory,
+) : HistoryVisibleAcknowledgementRepository {
+    val store = preferenceDataStoreFactory.create("elementx_historyvisible")
+
+    override fun hasAcknowledged(roomId: RoomId): Flow<Boolean> {
+        return store.data.map { prefs ->
+            val acknowledged = prefs[booleanPreferencesKey(roomId.value)] ?: false
+            acknowledged
+        }
+    }
+
+    override suspend fun setAcknowledged(roomId: RoomId, value: Boolean) {
+        store.edit { prefs ->
+            prefs[booleanPreferencesKey(roomId.value)] = value
+        }
+    }
+}
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleEvent.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleEvent.kt
@@ -0,0 +1,12 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.features.messages.impl.crypto.historyvisible
+
+sealed interface HistoryVisibleEvent {
+    data object Acknowledge : HistoryVisibleEvent
+}
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleState.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleState.kt
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.features.messages.impl.crypto.historyvisible
+
+import io.element.android.libraries.matrix.api.room.history.RoomHistoryVisibility
+
+data class HistoryVisibleState(
+    val roomHistoryVisibility: RoomHistoryVisibility,
+    val roomIsEncrypted: Boolean,
+    val acknowledged: Boolean,
+    val eventSink: (HistoryVisibleEvent) -> Unit,
+)
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleStatePresenter.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleStatePresenter.kt
@@ -0,0 +1,54 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.features.messages.impl.crypto.historyvisible
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.collectAsState
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.rememberCoroutineScope
+import dev.zacsweers.metro.Inject
+import io.element.android.libraries.architecture.Presenter
+import io.element.android.libraries.matrix.api.room.JoinedRoom
+import io.element.android.libraries.matrix.api.room.history.RoomHistoryVisibility
+import kotlinx.coroutines.launch
+
+@Inject
+class HistoryVisibleStatePresenter(
+    private val repository: HistoryVisibleAcknowledgementRepository,
+    private val room: JoinedRoom,
+) : Presenter<HistoryVisibleState> {
+    @Composable
+    override fun present(): HistoryVisibleState {
+        val roomInfo by room.roomInfoFlow.collectAsState()
+        // Implicitly acknowledge the initial event to avoid flashes in UI.
+        val acknowledged by repository.hasAcknowledged(room.roomId).collectAsState(initial = true)
+
+        val coroutineScope = rememberCoroutineScope()
+
+        LaunchedEffect(roomInfo.historyVisibility) {
+            if (roomInfo.historyVisibility == RoomHistoryVisibility.Joined && acknowledged) {
+                repository.setAcknowledged(room.roomId, false)
+            }
+        }
+
+        return HistoryVisibleState(
+            roomHistoryVisibility = roomInfo.historyVisibility,
+            roomIsEncrypted = roomInfo.isEncrypted == true,
+            acknowledged = acknowledged,
+            eventSink = { event ->
+                when (event) {
+                    is HistoryVisibleEvent.Acknowledge ->
+                        coroutineScope.launch {
+                            repository.setAcknowledged(room.roomId, true)
+                        }
+                }
+            }
+        )
+    }
+}
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleStateProvider.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleStateProvider.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.features.messages.impl.crypto.historyvisible
+
+import androidx.compose.ui.tooling.preview.PreviewParameterProvider
+import io.element.android.libraries.matrix.api.room.history.RoomHistoryVisibility
+
+class HistoryVisibleStateProvider : PreviewParameterProvider<HistoryVisibleState> {
+    override val values: Sequence<HistoryVisibleState>
+        get() = sequenceOf(
+            aHistoryVisibleState(RoomHistoryVisibility.Joined, roomIsEncrypted = false, acknowledged = false),
+            aHistoryVisibleState(RoomHistoryVisibility.Shared, roomIsEncrypted = true, acknowledged = false),
+            aHistoryVisibleState(RoomHistoryVisibility.Shared, roomIsEncrypted = true, acknowledged = true)
+        )
+}
+
+internal fun aHistoryVisibleState(
+    roomHistoryVisibility: RoomHistoryVisibility = RoomHistoryVisibility.Joined,
+    roomIsEncrypted: Boolean = false,
+    acknowledged: Boolean = false,
+    eventSink: (HistoryVisibleEvent) -> Unit = {},
+) = HistoryVisibleState(
+    roomHistoryVisibility = roomHistoryVisibility,
+    roomIsEncrypted = roomIsEncrypted,
+    acknowledged = acknowledged,
+    eventSink = eventSink,
+)
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleStateView.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleStateView.kt
@@ -0,0 +1,94 @@
+/*
+ * Copyright 2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.features.messages.impl.crypto.historyvisible
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.text.LinkAnnotation
+import androidx.compose.ui.text.SpanStyle
+import androidx.compose.ui.text.buildAnnotatedString
+import androidx.compose.ui.text.font.FontWeight
+import androidx.compose.ui.text.style.TextDecoration
+import androidx.compose.ui.tooling.preview.PreviewParameter
+import io.element.android.appconfig.LearnMoreConfig
+import io.element.android.compound.theme.ElementTheme
+import io.element.android.libraries.designsystem.atomic.molecules.ComposerAlertMolecule
+import io.element.android.libraries.matrix.api.room.history.RoomHistoryVisibility
+import io.element.android.libraries.ui.strings.CommonStrings
+import io.element.android.features.messages.impl.R
+import io.element.android.libraries.designsystem.atomic.molecules.ComposerAlertLevel
+import io.element.android.libraries.designsystem.preview.ElementPreview
+import io.element.android.libraries.designsystem.preview.PreviewsDayNight
+
+@Composable
+fun HistoryVisibleStateView(
+    state: HistoryVisibleState,
+    onLinkClick: (String, Boolean) -> Unit,
+    modifier: Modifier = Modifier,
+) {
+    // Ignore non-encrypted rooms.
+    if (!state.roomIsEncrypted) {
+        return
+    }
+
+    // Ignore rooms with `history_visibility = joined`.
+    if (state.roomHistoryVisibility == RoomHistoryVisibility.Joined) {
+        return
+    }
+
+    // Ignore non-joined rooms we have acknowledged.
+    if (state.acknowledged) {
+        return
+    }
+
+    ComposerAlertMolecule(
+        modifier = modifier,
+        avatar = null,
+        showIcon = true,
+        level = ComposerAlertLevel.Info,
+        content = buildAnnotatedString {
+            val learnMoreStr = stringResource(CommonStrings.action_learn_more)
+            val fullText = stringResource(R.string.crypto_history_visible, learnMoreStr)
+            append(fullText)
+            val learnMoreStartIndex = fullText.lastIndexOf(learnMoreStr)
+            addStyle(
+                style = SpanStyle(
+                    textDecoration = TextDecoration.Underline,
+                    fontWeight = FontWeight.Bold,
+                    color = ElementTheme.colors.textPrimary
+                ),
+                start = learnMoreStartIndex,
+                end = learnMoreStartIndex + learnMoreStr.length,
+            )
+            addLink(
+                url = LinkAnnotation.Url(
+                    url = LearnMoreConfig.HISTORY_VISIBLE_URL,
+                    linkInteractionListener = {
+                        onLinkClick(LearnMoreConfig.HISTORY_VISIBLE_URL, true)
+                    }
+                ),
+                start = learnMoreStartIndex,
+                end = learnMoreStartIndex + learnMoreStr.length,
+            )
+        },
+        submitText = stringResource(CommonStrings.action_dismiss),
+        onSubmitClick = { state.eventSink(HistoryVisibleEvent.Acknowledge) },
+    )
+}
+
+@PreviewsDayNight
+@Composable
+internal fun HistoryVisibleStateViewPreview(
+    @PreviewParameter(HistoryVisibleStateProvider::class) state: HistoryVisibleState,
+) = ElementPreview {
+    HistoryVisibleStateView(
+        state = state,
+        onLinkClick = { _, _ -> },
+    )
+}
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/MessagesViewWithHistoryVisiblePreview.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/MessagesViewWithHistoryVisiblePreview.kt
diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/di/MessagesBindsModule.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/di/MessagesBindsModule.kt
diff --git a/features/messages/impl/src/main/res/values/temporary.xml b/features/messages/impl/src/main/res/values/temporary.xml
diff --git a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/MessagesPresenterTest.kt b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/MessagesPresenterTest.kt
diff --git a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/FakeHistoryVisibleAcknowledgementRepository.kt b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/FakeHistoryVisibleAcknowledgementRepository.kt
diff --git a/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleStatePresenterTest.kt b/features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/crypto/historyvisible/HistoryVisibleStatePresenterTest.kt

Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,5 @@ object LearnMoreConfig {`
`12`	`12`	`const val DEVICE_VERIFICATION_URL: String = "https://element.io/help#encryption-device-verification"`
`13`	`13`	`const val SECURE_BACKUP_URL: String = "https://element.io/help#encryption5"`
`14`	`14`	`const val IDENTITY_CHANGE_URL: String = "https://element.io/help#encryption18"`
	`15`	`+ const val HISTORY_VISIBLE_URL: String = "https://example.com"`
`15`	`16`	`}`