chore: Re-use the existing track_read_receipts setting to hide receipts on state events.

# Conflicts:
#	bindings/matrix-sdk-ffi/CHANGELOG.md

Author: pixlwave

benchmarks/benches/timeline.rs

@@ -1,7 +1,7 @@
 use criterion::{BenchmarkId, Criterion, Throughput, criterion_group, criterion_main};
 use matrix_sdk::test_utils::mocks::MatrixMockServer;
 use matrix_sdk_test::{JoinedRoomBuilder, StateTestEvent, event_factory::EventFactory};
-use matrix_sdk_ui::timeline::TimelineBuilder;
+use matrix_sdk_ui::timeline::{TimelineBuilder, TimelineReadReceiptTracking};
 use ruma::{
     EventId, events::room::message::RoomMessageEventContentWithoutRelation, owned_room_id,
     owned_user_id,
@@ -103,7 +103,7 @@ pub fn create_timeline_with_initial_events(c: &mut Criterion) {
         |b| {
             b.to_async(&runtime).iter(|| async {
                 let timeline = TimelineBuilder::new(&room)
-                    .track_read_marker_and_receipts()
+                    .track_read_marker_and_receipts(TimelineReadReceiptTracking::AllEvents)
                     .build()
                     .await
                     .expect("Could not create timeline");

bindings/matrix-sdk-ffi/CHANGELOG.md

@@ -8,6 +8,9 @@ All notable changes to this project will be documented in this file.
 
 ### Breaking changes
 
+- `TimelineConfiguration::track_read_receipts`'s type is now an enum to allow tracking to be enabled for all events
+  (like before) or only for message-like events (which prevents read receipts from being placed on state events).
+  ([#5900](https://github.com/matrix-org/matrix-rust-sdk/pull/5900))
 - `Client::reset_server_info()` has been split into `reset_supported_versions()`
   and `reset_well_known()`.
   ([#5910](https://github.com/matrix-org/matrix-rust-sdk/pull/5910))

bindings/matrix-sdk-ffi/src/room/mod.rs

@@ -234,11 +234,7 @@ impl Room {
         builder = builder
             .with_focus(configuration.focus.try_into()?)
             .with_date_divider_mode(configuration.date_divider_mode.into())
-            .state_events_can_show_read_receipts(configuration.state_events_can_show_read_receipts);
-
-        if configuration.track_read_receipts {
-            builder = builder.track_read_marker_and_receipts();
-        }
+            .track_read_marker_and_receipts(configuration.track_read_receipts);
 
         match configuration.filter {
             TimelineFilter::All => {

bindings/matrix-sdk-ffi/src/timeline/configuration.rs

@@ -1,6 +1,9 @@
 use std::sync::Arc;
 
-use matrix_sdk_ui::timeline::event_type_filter::TimelineEventTypeFilter as InnerTimelineEventTypeFilter;
+use matrix_sdk_ui::timeline::{
+    event_type_filter::TimelineEventTypeFilter as InnerTimelineEventTypeFilter,
+    TimelineReadReceiptTracking,
+};
 use ruma::{
     events::{AnySyncTimelineEvent, TimelineEventType},
     EventId,
@@ -164,9 +167,6 @@ pub struct TimelineConfiguration {
     /// How should we filter out events from the timeline?
     pub filter: TimelineFilter,
 
-    /// Can read receipts be shown on state events or only on messages?
-    pub state_events_can_show_read_receipts: bool,
-
     /// An optional String that will be prepended to
     /// all the timeline item's internal IDs, making it possible to
     /// distinguish different timeline instances from each other.
@@ -176,11 +176,11 @@ pub struct TimelineConfiguration {
     pub date_divider_mode: DateDividerMode,
 
     /// Should the read receipts and read markers be tracked for the timeline
-    /// items in this instance?
+    /// items in this instance and on which event types?
     ///
     /// As this has a non negligible performance impact, make sure to enable it
     /// only when you need it.
-    pub track_read_receipts: bool,
+    pub track_read_receipts: TimelineReadReceiptTracking,
 
     /// Whether this timeline instance should report UTDs through the client's
     /// delegate.

crates/matrix-sdk-ui/CHANGELOG.md

@@ -6,6 +6,13 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased] - ReleaseDate
 
+### Features
+
+- [**breaking**] `TimelineBuilder::track_read_marker_and_receipts` now takes a parameter to allow tracking to be enabled
+  for all events (like before) or only for message-like events (which prevents read receipts from being placed on state
+  events).
+  ([#5900](https://github.com/matrix-org/matrix-rust-sdk/pull/5900))
+
 ## [0.15.0] - 2025-11-27
 
 ### Features

crates/matrix-sdk-ui/src/timeline/builder.rs

@@ -25,6 +25,7 @@ use super::{
 };
 use crate::{
     timeline::{
+        TimelineReadReceiptTracking,
         controller::spawn_crypto_tasks,
         tasks::{
             pinned_events_task, room_event_cache_updates_task, room_send_queue_update_task,
@@ -91,17 +92,17 @@ impl TimelineBuilder {
         self
     }
 
-    /// Chose when to insert the date separators, either in between each day
+    /// Choose when to insert the date separators, either in between each day
     /// or each month.
     pub fn with_date_divider_mode(mut self, mode: DateDividerMode) -> Self {
         self.settings.date_divider_mode = mode;
         self
     }
 
-    /// Enable tracking of the fully-read marker and the read receipts on the
-    /// timeline.
-    pub fn track_read_marker_and_receipts(mut self) -> Self {
-        self.settings.track_read_receipts = true;
+    /// Choose whether to enable tracking of the fully-read marker and the read
+    /// receipts and on which event types.
+    pub fn track_read_marker_and_receipts(mut self, tracking: TimelineReadReceiptTracking) -> Self {
+        self.settings.track_read_receipts = tracking;
         self
     }
 
@@ -141,11 +142,6 @@ impl TimelineBuilder {
         self
     }
 
-    pub fn state_events_can_show_read_receipts(mut self, show: bool) -> Self {
-        self.settings.state_events_can_show_read_receipts = show;
-        self
-    }
-
     /// Whether to add events that failed to deserialize to the timeline.
     ///
     /// Defaults to `true`.
@@ -159,7 +155,7 @@ impl TimelineBuilder {
         skip(self),
         fields(
             room_id = ?self.room.room_id(),
-            track_read_receipts = self.settings.track_read_receipts,
+            track_read_receipts = ?self.settings.track_read_receipts,
         )
     )]
     pub async fn build(self) -> Result<Timeline, Error> {

crates/matrix-sdk-ui/src/timeline/controller/mod.rs

@@ -61,7 +61,8 @@ pub(super) use self::{
 use super::{
     DateDividerMode, EmbeddedEvent, Error, EventSendState, EventTimelineItem, InReplyToDetails,
     MediaUploadProgress, PaginationError, Profile, TimelineDetails, TimelineEventItemId,
-    TimelineFocus, TimelineItem, TimelineItemContent, TimelineItemKind, VirtualTimelineItem,
+    TimelineFocus, TimelineItem, TimelineItemContent, TimelineItemKind,
+    TimelineReadReceiptTracking, VirtualTimelineItem,
     algorithms::{rfind_event_by_id, rfind_event_item},
     event_item::{ReactionStatus, RemoteEventOrigin},
     item::TimelineUniqueId,
@@ -265,11 +266,9 @@ pub(super) struct TimelineController<P: RoomDataProvider = Room> {
 
 #[derive(Clone)]
 pub(super) struct TimelineSettings {
-    /// Should the read receipts and read markers be handled?
-    pub(super) track_read_receipts: bool,
-
-    /// Whether state events can show read receipts.
-    pub(super) state_events_can_show_read_receipts: bool,
+    /// Should the read receipts and read markers be handled and on which event
+    /// types?
+    pub(super) track_read_receipts: TimelineReadReceiptTracking,
 
     /// Event filter that controls what's rendered as a timeline item (and thus
     /// what can carry read receipts).
@@ -287,7 +286,6 @@ impl fmt::Debug for TimelineSettings {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         f.debug_struct("TimelineSettings")
             .field("track_read_receipts", &self.track_read_receipts)
-            .field("state_events_can_show_read_receipts", &self.state_events_can_show_read_receipts)
             .field("add_failed_to_parse", &self.add_failed_to_parse)
             .finish_non_exhaustive()
     }
@@ -296,8 +294,7 @@ impl fmt::Debug for TimelineSettings {
 impl Default for TimelineSettings {
     fn default() -> Self {
         Self {
-            track_read_receipts: false,
-            state_events_can_show_read_receipts: true,
+            track_read_receipts: TimelineReadReceiptTracking::Disabled,
             event_filter: Arc::new(default_event_filter),
             add_failed_to_parse: true,
             date_divider_mode: DateDividerMode::Daily,
@@ -986,8 +983,8 @@ impl<P: RoomDataProvider> TimelineController<P> {
     {
         let mut state = self.state.write().await;
 
-        let track_read_markers = self.settings.track_read_receipts;
-        if track_read_markers {
+        let track_read_markers = &self.settings.track_read_receipts;
+        if track_read_markers.is_enabled() {
             state.populate_initial_user_receipt(&self.room_data_provider, ReceiptType::Read).await;
             state
                 .populate_initial_user_receipt(&self.room_data_provider, ReceiptType::ReadPrivate)
@@ -1011,7 +1008,7 @@ impl<P: RoomDataProvider> TimelineController<P> {
                 .await;
         }
 
-        if track_read_markers {
+        if track_read_markers.is_enabled() {
             if let Some(fully_read_event_id) =
                 self.room_data_provider.load_fully_read_marker().await
             {

crates/matrix-sdk-ui/src/timeline/controller/state_transaction.rs

@@ -33,7 +33,8 @@ use super::{
         event_item::RemoteEventOrigin,
         traits::RoomDataProvider,
     },
-    ObservableItems, ObservableItemsTransaction, TimelineMetadata, TimelineSettings,
+    ObservableItems, ObservableItemsTransaction, TimelineMetadata, TimelineReadReceiptTracking,
+    TimelineSettings,
     metadata::EventMeta,
 };
 use crate::timeline::{
@@ -468,8 +469,12 @@ impl<'a, P: RoomDataProvider> TimelineStateTransaction<'a, P> {
         event: &AnySyncTimelineEvent,
     ) -> bool {
         match event {
-            AnySyncTimelineEvent::State(_) => settings.state_events_can_show_read_receipts,
-            AnySyncTimelineEvent::MessageLike(_) => true,
+            AnySyncTimelineEvent::State(_) => {
+                settings.track_read_receipts == TimelineReadReceiptTracking::AllEvents
+            }
+            AnySyncTimelineEvent::MessageLike(_) => {
+                settings.track_read_receipts != TimelineReadReceiptTracking::Disabled
+            }
         }
     }
 
@@ -735,7 +740,7 @@ impl<'a, P: RoomDataProvider> TimelineStateTransaction<'a, P> {
                 sender,
                 sender_profile,
                 timestamp,
-                read_receipts: if settings.track_read_receipts
+                read_receipts: if settings.track_read_receipts.is_enabled()
                     && should_add
                     && can_show_read_receipts
                 {
@@ -920,7 +925,7 @@ impl<'a, P: RoomDataProvider> TimelineStateTransaction<'a, P> {
                     event.visible = event_meta.visible;
                     event.can_show_read_receipts = event_meta.can_show_read_receipts;
 
-                    if settings.track_read_receipts {
+                    if settings.track_read_receipts.is_enabled() {
                         // Since the event's visibility changed, we need to update the read
                         // receipts of the previous visible event.
                         self.maybe_update_read_receipts_of_prev_event(&event_meta.event_id);
@@ -929,7 +934,7 @@ impl<'a, P: RoomDataProvider> TimelineStateTransaction<'a, P> {
             }
         }
 
-        if settings.track_read_receipts
+        if settings.track_read_receipts.is_enabled()
             && matches!(
                 position,
                 TimelineItemPosition::Start { .. }

crates/matrix-sdk-ui/src/timeline/mod.rs

@@ -1103,3 +1103,26 @@ impl TryFrom<GalleryItemInfo> for matrix_sdk::attachment::GalleryItemInfo {
         })
     }
 }
+
+#[derive(Clone, Debug, PartialEq)]
+#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
+/// The level of read receipt tracking for the timeline.
+pub enum TimelineReadReceiptTracking {
+    /// Track read receipts for all events.
+    AllEvents,
+    /// Track read receipts only for message-like events.
+    MessageLikeEvents,
+    /// Disable read receipt tracking.
+    Disabled,
+}
+
+impl TimelineReadReceiptTracking {
+    /// Whether or not read receipt tracking is enabled.
+    pub fn is_enabled(&self) -> bool {
+        match self {
+            TimelineReadReceiptTracking::AllEvents => true,
+            TimelineReadReceiptTracking::MessageLikeEvents => true,
+            TimelineReadReceiptTracking::Disabled => false,
+        }
+    }
+}

crates/matrix-sdk-ui/src/timeline/tests/basic.rs

@@ -42,7 +42,7 @@ use stream_assert::{assert_next_matches, assert_pending};
 use super::TestTimeline;
 use crate::timeline::{
     MembershipChange, MsgLikeContent, MsgLikeKind, RoomExt, TimelineDetails, TimelineFocus,
-    TimelineItemContent, TimelineItemKind, VirtualTimelineItem,
+    TimelineItemContent, TimelineItemKind, TimelineReadReceiptTracking, VirtualTimelineItem,
     controller::TimelineSettings,
     event_item::{AnyOtherFullStateEventContent, RemoteEventOrigin},
     tests::{ReadReceiptMap, TestRoomDataProvider, TestTimelineBuilder},
@@ -99,8 +99,7 @@ async fn test_replace_with_initial_events_and_read_marker() {
                 .with_initial_user_receipts(receipts),
         )
         .settings(TimelineSettings {
-            track_read_receipts: true,
-            state_events_can_show_read_receipts: true,
+            track_read_receipts: TimelineReadReceiptTracking::AllEvents,
             ..Default::default()
         })
         .build();
@@ -527,7 +526,7 @@ async fn test_latest_event_id_in_main_timeline() {
     let timeline = room
         .timeline_builder()
         .with_focus(TimelineFocus::Live { hide_threaded_events: true })
-        .track_read_marker_and_receipts()
+        .track_read_marker_and_receipts(TimelineReadReceiptTracking::AllEvents)
         .build()
         .await
         .expect("Could not build live timeline");