ouch: include the event origin in the timeline position/end

and don't assume inserting to the end means it's coming from sync — not
true for forward pagination anymore

Author: bnjbvr

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

@@ -30,7 +30,7 @@ use super::{
     queue::send_queued_messages,
     Error, Timeline, TimelineDropHandle, TimelineFocus,
 };
-use crate::unable_to_decrypt_hook::UtdHookManager;
+use crate::{timeline::event_item::RemoteEventOrigin, unable_to_decrypt_hook::UtdHookManager};
 
 /// Builder that allows creating and configuring various parts of a
 /// [`Timeline`].
@@ -158,7 +158,9 @@ impl TimelineBuilder {
                 inner
                     .add_events_at(
                         initial_events,
-                        crate::timeline::inner::TimelineEnd::Back { from_cache: true },
+                        crate::timeline::inner::TimelineEnd::Back {
+                            origin: RemoteEventOrigin::Cache,
+                        },
                     )
                     .await;
             }

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

@@ -212,15 +212,16 @@ impl TimelineEventKind {
 pub(super) enum TimelineItemPosition {
     /// One or more items are prepended to the timeline (i.e. they're the
     /// oldest).
-    ///
-    /// Usually this means items coming from back-pagination.
-    Start,
+    Start {
+        /// What's the origin of this event?
+        origin: RemoteEventOrigin,
+    },
 
     /// One or more items are appended to the timeline (i.e. they're the most
     /// recent).
     End {
-        /// Whether this event is coming from a local cache.
-        from_cache: bool,
+        /// What's the origin of this event?
+        origin: RemoteEventOrigin,
     },
 
     /// A single item is updated.
@@ -825,16 +826,12 @@ impl<'a, 'o> TimelineEventHandler<'a, 'o> {
                     }
                 }
 
-                let origin = match position {
-                    TimelineItemPosition::Start => RemoteEventOrigin::Pagination,
-
-                    // We only paginate backwards for now, so End only happens for syncs
-                    TimelineItemPosition::End { from_cache: true } => RemoteEventOrigin::Cache,
-
-                    TimelineItemPosition::End { from_cache: false } => RemoteEventOrigin::Sync,
+                let origin = match *position {
+                    TimelineItemPosition::Start { origin }
+                    | TimelineItemPosition::End { origin, .. } => origin,
 
                     #[cfg(feature = "e2e-encryption")]
-                    TimelineItemPosition::Update(idx) => self.items[*idx]
+                    TimelineItemPosition::Update(idx) => self.items[idx]
                         .as_event()
                         .and_then(|ev| Some(ev.as_remote()?.origin))
                         .unwrap_or_else(|| {
@@ -868,7 +865,7 @@ impl<'a, 'o> TimelineEventHandler<'a, 'o> {
                 self.items.push_back(item);
             }
 
-            Flow::Remote { position: TimelineItemPosition::Start, event_id, .. } => {
+            Flow::Remote { position: TimelineItemPosition::Start { .. }, event_id, .. } => {
                 if self
                     .items
                     .iter()

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

@@ -64,7 +64,7 @@ use tracing::{field, info_span, Instrument as _};
 use super::traits::Decryptor;
 use super::{
     error::PaginationError,
-    event_item::EventItemIdentifier,
+    event_item::{EventItemIdentifier, RemoteEventOrigin},
     reactions::ReactionToggleResult,
     traits::RoomDataProvider,
     util::{rfind_event_by_id, rfind_event_item, RelativePosition},
@@ -338,7 +338,7 @@ impl<P: RoomDataProvider> TimelineInner<P> {
 
         self.clear().await;
         let (events, _) = event_cache.subscribe().await.map_err(Error::EventCacheError)?;
-        self.add_events_at(events, TimelineEnd::Back { from_cache: true }).await;
+        self.add_events_at(events, TimelineEnd::Back { origin: RemoteEventOrigin::Cache }).await;
 
         Ok(())
     }
@@ -358,7 +358,11 @@ impl<P: RoomDataProvider> TimelineInner<P> {
             .map_err(PaginationError::Paginator)?;
 
         self.clear().await;
-        self.add_events_at(response.events, TimelineEnd::Back { from_cache: false }).await;
+        self.add_events_at(
+            response.events,
+            TimelineEnd::Back { origin: RemoteEventOrigin::Pagination },
+        )
+        .await;
 
         Ok(())
     }
@@ -384,7 +388,11 @@ impl<P: RoomDataProvider> TimelineInner<P> {
             }
         };
 
-        self.add_events_at(outcome.events, TimelineEnd::Front).await;
+        self.add_events_at(
+            outcome.events,
+            TimelineEnd::Front { origin: RemoteEventOrigin::Pagination },
+        )
+        .await;
 
         status.set(if outcome.hit_end_of_timeline {
             PaginationStatus::TimelineEndReached
@@ -416,7 +424,11 @@ impl<P: RoomDataProvider> TimelineInner<P> {
             }
         };
 
-        self.add_events_at(outcome.events, TimelineEnd::Back { from_cache: false }).await;
+        self.add_events_at(
+            outcome.events,
+            TimelineEnd::Back { origin: RemoteEventOrigin::Pagination },
+        )
+        .await;
 
         status.set(if outcome.hit_end_of_timeline {
             PaginationStatus::TimelineEndReached
@@ -652,7 +664,7 @@ impl<P: RoomDataProvider> TimelineInner<P> {
         state
             .add_events_at(
                 vec![event],
-                TimelineEnd::Back { from_cache: false },
+                TimelineEnd::Back { origin: RemoteEventOrigin::Sync },
                 &self.room_data_provider,
                 &self.settings,
             )

crates/matrix-sdk-ui/src/timeline/inner/state.rs

@@ -41,7 +41,7 @@ use crate::{
             Flow, HandleEventResult, TimelineEventContext, TimelineEventHandler, TimelineEventKind,
             TimelineItemPosition,
         },
-        event_item::EventItemIdentifier,
+        event_item::{EventItemIdentifier, RemoteEventOrigin},
         polls::PollPendingEvents,
         reactions::{ReactionToggleResult, Reactions},
         read_receipts::ReadReceipts,
@@ -60,11 +60,14 @@ use crate::{
 #[derive(Debug)]
 pub(crate) enum TimelineEnd {
     /// Event should be prepended to the front of the timeline.
-    Front,
+    Front {
+        /// What's the origin of this event?
+        origin: RemoteEventOrigin,
+    },
     /// Event should appended to the back of the timeline.
     Back {
-        /// Did the event come from the cache?
-        from_cache: bool,
+        /// What's the origin of this event?
+        origin: RemoteEventOrigin,
     },
 }
 
@@ -133,7 +136,7 @@ impl TimelineInnerState {
 
         txn.add_events_at(
             events,
-            TimelineEnd::Back { from_cache: false },
+            TimelineEnd::Back { origin: RemoteEventOrigin::Sync },
             room_data_provider,
             settings,
         )
@@ -452,8 +455,8 @@ impl TimelineInnerStateTransaction<'_> {
         let mut total = HandleManyEventsResult::default();
 
         let position = match position {
-            TimelineEnd::Front => TimelineItemPosition::Start,
-            TimelineEnd::Back { from_cache } => TimelineItemPosition::End { from_cache },
+            TimelineEnd::Front { origin } => TimelineItemPosition::Start { origin },
+            TimelineEnd::Back { origin } => TimelineItemPosition::End { origin },
         };
 
         let mut day_divider_adjuster = DayDividerAdjuster::default();
@@ -678,7 +681,9 @@ impl TimelineInnerStateTransaction<'_> {
         settings: &TimelineInnerSettings,
     ) {
         match position {
-            TimelineItemPosition::Start => self.meta.all_events.push_front(event_meta.base_meta()),
+            TimelineItemPosition::Start { .. } => {
+                self.meta.all_events.push_front(event_meta.base_meta())
+            }
             TimelineItemPosition::End { .. } => {
                 // Handle duplicated event.
                 if let Some(pos) =
@@ -708,7 +713,10 @@ impl TimelineInnerStateTransaction<'_> {
         }
 
         if settings.track_read_receipts
-            && matches!(position, TimelineItemPosition::Start | TimelineItemPosition::End { .. })
+            && matches!(
+                position,
+                TimelineItemPosition::Start { .. } | TimelineItemPosition::End { .. }
+            )
         {
             self.load_read_receipts_for_event(event_meta.event_id, room_data_provider).await;
 

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

@@ -20,7 +20,7 @@ use ruma::OwnedEventId;
 use tracing::{instrument, trace, warn};
 
 use super::Error;
-use crate::timeline::inner::TimelineEnd;
+use crate::timeline::{event_item::RemoteEventOrigin, inner::TimelineEnd};
 
 impl super::Timeline {
     /// Assuming the timeline is focused on an event, starts a forwards
@@ -88,8 +88,13 @@ impl super::Timeline {
                         let num_events = events.len();
                         trace!("Back-pagination succeeded with {num_events} events");
 
-                        let handle_many_res =
-                            self.inner.add_events_at(events, TimelineEnd::Front).await;
+                        let handle_many_res = self
+                            .inner
+                            .add_events_at(
+                                events,
+                                TimelineEnd::Front { origin: RemoteEventOrigin::Pagination },
+                            )
+                            .await;
 
                         if reached_start {
                             back_pagination_status

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

@@ -34,8 +34,9 @@ use stream_assert::assert_next_matches;
 
 use super::TestTimeline;
 use crate::timeline::{
-    event_item::AnyOtherFullStateEventContent, inner::TimelineEnd, MembershipChange,
-    TimelineDetails, TimelineItemContent, TimelineItemKind, VirtualTimelineItem,
+    event_item::{AnyOtherFullStateEventContent, RemoteEventOrigin},
+    inner::TimelineEnd,
+    MembershipChange, TimelineDetails, TimelineItemContent, TimelineItemKind, VirtualTimelineItem,
 };
 
 #[async_test]
@@ -58,7 +59,7 @@ async fn test_initial_events() {
                         .make_sync_message_event(*BOB, RoomMessageEventContent::text_plain("B")),
                 ),
             ],
-            TimelineEnd::Back { from_cache: false },
+            TimelineEnd::Back { origin: RemoteEventOrigin::Sync },
         )
         .await;
 
@@ -251,7 +252,7 @@ async fn test_dedup_initial() {
                 // … and a new event also came in
                 event_c,
             ],
-            TimelineEnd::Back { from_cache: false },
+            TimelineEnd::Back { origin: RemoteEventOrigin::Sync },
         )
         .await;
 

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

@@ -247,7 +247,12 @@ impl TestTimeline {
 
     async fn handle_back_paginated_custom_event(&self, event: Raw<AnyTimelineEvent>) {
         let timeline_event = TimelineEvent::new(event.cast());
-        self.inner.add_events_at(vec![timeline_event], TimelineEnd::Front).await;
+        self.inner
+            .add_events_at(
+                vec![timeline_event],
+                TimelineEnd::Front { origin: super::event_item::RemoteEventOrigin::Pagination },
+            )
+            .await;
     }
 
     async fn handle_read_receipts(

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

@@ -27,7 +27,7 @@ use ruma::{
 use stream_assert::assert_next_matches;
 
 use crate::timeline::{
-    event_item::EventItemIdentifier,
+    event_item::{EventItemIdentifier, RemoteEventOrigin},
     inner::ReactionAction,
     reactions::ReactionToggleResult,
     tests::{assert_event_is_updated, assert_no_more_updates, TestTimeline},
@@ -259,7 +259,7 @@ async fn test_initial_reaction_timestamp_is_stored() {
                     RoomMessageEventContent::text_plain("A"),
                 )),
             ],
-            crate::timeline::inner::TimelineEnd::Back { from_cache: false },
+            crate::timeline::inner::TimelineEnd::Back { origin: RemoteEventOrigin::Sync },
         )
         .await;
 

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

@@ -35,7 +35,10 @@ use ruma::{
 use stream_assert::assert_next_matches;
 
 use super::TestTimeline;
-use crate::timeline::{AnyOtherFullStateEventContent, TimelineDetails, TimelineItemContent};
+use crate::timeline::{
+    event_item::RemoteEventOrigin, AnyOtherFullStateEventContent, TimelineDetails,
+    TimelineItemContent,
+};
 
 #[async_test]
 async fn test_redact_state_event() {
@@ -152,7 +155,7 @@ async fn test_reaction_redaction_timeline_filter() {
                     .event_builder
                     .make_sync_redacted_message_event(*ALICE, RedactedReactionEventContent::new()),
             )],
-            crate::timeline::inner::TimelineEnd::Back { from_cache: false },
+            crate::timeline::inner::TimelineEnd::Back { origin: RemoteEventOrigin::Sync },
         )
         .await;
     // Timeline items are actually empty.