timeline: clarify in some names that events are remote

This commit is contained in:
Benjamin Bouvier
2024-05-27 14:50:30 +02:00
parent ec95ca6ed1
commit 8101879799
4 changed files with 19 additions and 13 deletions

View File

@@ -202,7 +202,7 @@ impl TimelineBuilder {
// current timeline.
match room_event_cache.subscribe().await {
Ok((events, _)) => {
inner.replace_with_initial_events(events, RemoteEventOrigin::Sync).await;
inner.replace_with_initial_remote_events(events, RemoteEventOrigin::Sync).await;
}
Err(err) => {
warn!("Error when re-inserting initial events into the timeline: {err}");

View File

@@ -298,7 +298,7 @@ impl<P: RoomDataProvider> TimelineInner<P> {
let has_events = !events.is_empty();
self.replace_with_initial_events(events, RemoteEventOrigin::Cache).await;
self.replace_with_initial_remote_events(events, RemoteEventOrigin::Cache).await;
Ok(has_events)
}
@@ -314,7 +314,7 @@ impl<P: RoomDataProvider> TimelineInner<P> {
let has_events = !start_from_result.events.is_empty();
self.replace_with_initial_events(
self.replace_with_initial_remote_events(
start_from_result.events.into_iter().map(Into::into).collect(),
RemoteEventOrigin::Pagination,
)
@@ -550,7 +550,13 @@ impl<P: RoomDataProvider> TimelineInner<P> {
let mut state = self.state.write().await;
state
.add_events_at(events, position, origin, &self.room_data_provider, &self.settings)
.add_remote_events_at(
events,
position,
origin,
&self.room_data_provider,
&self.settings,
)
.await
}
@@ -565,7 +571,7 @@ impl<P: RoomDataProvider> TimelineInner<P> {
///
/// This is all done with a single lock guard, since we don't want the state
/// to be modified between the clear and re-insertion of new events.
pub(super) async fn replace_with_initial_events(
pub(super) async fn replace_with_initial_remote_events(
&self,
events: Vec<SyncTimelineEvent>,
origin: RemoteEventOrigin,
@@ -584,7 +590,7 @@ impl<P: RoomDataProvider> TimelineInner<P> {
if !events.is_empty() {
state
.add_events_at(
.add_remote_events_at(
events,
TimelineEnd::Back,
origin,
@@ -619,7 +625,7 @@ impl<P: RoomDataProvider> TimelineInner<P> {
pub(super) async fn handle_live_event(&self, event: SyncTimelineEvent) {
let mut state = self.state.write().await;
state
.add_events_at(
.add_remote_events_at(
vec![event],
TimelineEnd::Back,
RemoteEventOrigin::Sync,

View File

@@ -92,13 +92,13 @@ impl TimelineInnerState {
}
}
/// Add the given events at the given end of the timeline.
/// Add the given remove events at the given end of the timeline.
///
/// Note: when the `position` is [`TimelineEnd::Front`], prepended events
/// should be ordered in *reverse* topological order, that is, `events[0]`
/// is the most recent.
#[tracing::instrument(skip(self, events, room_data_provider, settings))]
pub(super) async fn add_events_at<P: RoomDataProvider>(
pub(super) async fn add_remote_events_at<P: RoomDataProvider>(
&mut self,
events: Vec<impl Into<SyncTimelineEvent>>,
position: TimelineEnd,
@@ -112,7 +112,7 @@ impl TimelineInnerState {
let mut txn = self.transaction();
let handle_many_res =
txn.add_events_at(events, position, origin, room_data_provider, settings).await;
txn.add_remote_events_at(events, position, origin, room_data_provider, settings).await;
txn.commit();
handle_many_res
@@ -397,13 +397,13 @@ pub(in crate::timeline) struct TimelineInnerStateTransaction<'a> {
}
impl TimelineInnerStateTransaction<'_> {
/// Add the given events at the given end of the timeline.
/// Add the given remote events at the given end of the timeline.
///
/// Note: when the `position` is [`TimelineEnd::Front`], prepended events
/// should be ordered in *reverse* topological order, that is, `events[0]`
/// is the most recent.
#[tracing::instrument(skip(self, events, room_data_provider, settings))]
pub(super) async fn add_events_at<P: RoomDataProvider>(
pub(super) async fn add_remote_events_at<P: RoomDataProvider>(
&mut self,
events: Vec<impl Into<SyncTimelineEvent>>,
position: TimelineEnd,

View File

@@ -111,7 +111,7 @@ async fn test_replace_with_initial_events_and_read_marker() {
assert_eq!(items[1].as_event().unwrap().content().as_message().unwrap().body(), "hey");
let ev = factory.text_msg("yo").sender(*BOB).into_sync();
timeline.inner.replace_with_initial_events(vec![ev], RemoteEventOrigin::Sync).await;
timeline.inner.replace_with_initial_remote_events(vec![ev], RemoteEventOrigin::Sync).await;
let items = timeline.inner.items().await;
assert_eq!(items.len(), 2);