matrix-rust-sdk

public

Star0

Fork 0

Watch0

40 commits 4 branches 0 tags 0 releases16.6 MiB

Commit `2eb08d9cad52`

tarball

atagen <boss@atagen.co>2026-10-26 09:19 UTC

4 files changed+28-3

timeline: log each step of a timeline build and history operation

A device trace showed build() never returning on the first launch after an upgrade, with nothing saying whether it waited on the room caches lock, the history coordinator, the event cache subscribe or the encryption state.

Modified file: crates/matrix-sdk-ui/src/timeline/builder.rs+7 additions−1 deletions@@ -18,7 +18,7 @@ use matrix_sdk::Room;
 use matrix_sdk_base::{SendOutsideWasm, SyncOutsideWasm};
 use ruma::{events::AnySyncTimelineEvent, room_version_rules::RoomVersionRules};
 use tokio::sync::mpsc;
-use tracing::{Instrument, Span, info_span};
+use tracing::{Instrument, Span, debug, info_span};
 
 use super::{
     DateDividerMode, Error, Timeline, TimelineDropHandle, TimelineFocus,
@@ -162,13 +162,17 @@ impl TimelineBuilder {
         // Subscribe the event cache to sync responses, in case we hadn't done it yet.
         room.client().event_cache().subscribe()?;
 
+        debug!("timeline build: getting the room event cache");
         let (room_event_cache, event_cache_drop) = room.event_cache().await?;
         if matches!(focus, TimelineFocus::Live { .. }) {
+            debug!("timeline build: loading retained history");
             room_event_cache.load_retained_history().await?;
         }
+        debug!("timeline build: subscribing to the event cache");
         let (initial_events, initial_gaps, event_subscriber) =
             room_event_cache.subscribe_with_history().await?;
 
+        debug!("timeline build: reading the encryption state");
         let is_room_encrypted = room
             .latest_encryption_state()
             .await
@@ -185,6 +189,7 @@ impl TimelineBuilder {
             settings,
         );
 
+        debug!("timeline build: initialising the focus");
         let InitFocusResult { focus_task, has_events } = controller
             .init_focus(&focus, &room_event_cache, (initial_events, initial_gaps))
             .await?;
@@ -223,6 +228,7 @@ impl TimelineBuilder {
 
         let local_echo_listener_handle = {
             let timeline_controller = controller.clone();
+            debug!("timeline build: subscribing to the send queue");
             let (local_echoes, send_queue_stream) = room.send_queue().subscribe().await?;
 
             room.client()

Modified file: crates/matrix-sdk-ui/tests/integration/timeline/mod.rs+1 additions−1 deletions@@ -56,8 +56,8 @@ mod queue;
 mod reactions;
 mod read_receipts;
 mod redecryption;
-mod segmented_history;
 mod replies;
+mod segmented_history;
 mod subscribe;
 mod thread;
 

Modified file: crates/matrix-sdk/src/event_cache/caches/room/history.rs+16 additions@@ -104,6 +104,19 @@ enum HistoryOperation {
     Barrier,
 }
 
+impl HistoryOperation {
+    fn name(&self) -> &'static str {
+        match self {
+            Self::Recent => "recent",
+            Self::Fill(_) => "fill",
+            Self::SpendBudget(_) => "spend budget",
+            Self::Append(..) => "append",
+            Self::Restore => "restore",
+            Self::Barrier => "barrier",
+        }
+    }
+}
+
 #[derive(Clone)]
 enum HistoryResponse {
     Recent(RecentHistoryOutcome),
@@ -134,6 +147,8 @@ async fn coordinate_history(
         };
         let cache = RoomEventCache { inner };
         let recent = matches!(operation, HistoryOperation::Recent);
+        let name = operation.name();
+        tracing::debug!(room_id = %cache.room_id(), operation = name, "history operation started");
         let mut waiters = vec![reply];
         let (cancel, cancellation) = watch::channel(false);
         let operation = async {
@@ -174,6 +189,7 @@ async fn coordinate_history(
             };
             match action {
                 Action::Complete(result) => {
+                    tracing::debug!(room_id = %cache.room_id(), operation = name, ok = result.is_ok(), "history operation finished");
                     for reply in waiters {
                         let _ = reply.send(result.clone());
                     }

Modified file: crates/matrix-sdk/src/event_cache/mod.rs+4 additions−1 deletions@@ -48,7 +48,7 @@ use tokio::sync::{
     broadcast::{Receiver, Sender, channel},
     mpsc,
 };
-use tracing::{error, instrument, trace};
+use tracing::{debug, error, instrument, trace};
 
 use crate::{
     Client,
@@ -673,6 +673,7 @@ impl EventCacheInner {
             Err(by_room_guard) => {
                 // Slow-path: the entry doesn't exist; let's acquire a write lock.
                 drop(by_room_guard);
+                debug!(%room_id, "waiting for the room caches lock to create a room's caches");
                 let by_room_guard = self.by_room.clone().write_owned().await;
 
                 // In the meanwhile, some other caller might have obtained write access and done
@@ -685,6 +686,7 @@ impl EventCacheInner {
                         Err(by_room_guard) => by_room_guard,
                     };
 
+                debug!(%room_id, "creating a room's caches");
                 let caches = Caches::new(
                     &self.client,
                     room_id,
@@ -699,6 +701,7 @@ impl EventCacheInner {
                     self.automatic_pagination.get().cloned(),
                 )
                 .await?;
+                debug!(%room_id, "created a room's caches");
 
                 by_room_guard.insert(room_id.to_owned(), caches);

matrix-rust-sdk

Commit 2eb08d9cad52

Commit `2eb08d9cad52`