refactor: Rename new_latest_event to latest_event.

This patch removes the “new_” prefix to the latest event API.

Author: Hywan

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

@@ -302,8 +302,8 @@ impl Room {
             .unwrap_or(false)
     }
 
-    async fn new_latest_event(&self) -> LatestEventValue {
-        self.inner.new_latest_event().await.into()
+    async fn latest_event(&self) -> LatestEventValue {
+        self.inner.latest_event().await.into()
     }
 
     pub async fn latest_encryption_state(&self) -> Result<EncryptionState, ClientError> {

crates/matrix-sdk-base/src/room/latest_event.rs

@@ -20,19 +20,19 @@ use crate::latest_event::LatestEventValue;
 impl Room {
     /// Return the [`LatestEventValue`] of this room.
     ///
-    /// Note that it clones the [`LatestEventValue`]! This can be add pressure
+    /// Note that it clones the [`LatestEventValue`]! This can add pressure
     /// on the memory if used in a hot path.
-    pub fn new_latest_event(&self) -> LatestEventValue {
-        self.info.read().new_latest_event.clone()
+    pub fn latest_event(&self) -> LatestEventValue {
+        self.info.read().latest_event_value.clone()
     }
 
     /// Return the value of [`LatestEventValue::timestamp`].
-    pub fn new_latest_event_timestamp(&self) -> Option<MilliSecondsSinceUnixEpoch> {
-        self.info.read().new_latest_event.timestamp()
+    pub fn latest_event_timestamp(&self) -> Option<MilliSecondsSinceUnixEpoch> {
+        self.info.read().latest_event_value.timestamp()
     }
 
     /// Return the value of [`LatestEventValue::is_local`].
-    pub fn new_latest_event_is_local(&self) -> bool {
-        self.info.read().new_latest_event.is_local()
+    pub fn latest_event_is_local(&self) -> bool {
+        self.info.read().latest_event_value.is_local()
     }
 }

crates/matrix-sdk-base/src/room/room_info.rs

@@ -463,10 +463,8 @@ pub struct RoomInfo {
     pub(crate) encryption_state_synced: bool,
 
     /// The latest event value of this room.
-    ///
-    /// TODO(@hywan): Rename to `latest_event`.
     #[serde(default)]
-    pub(crate) new_latest_event: LatestEventValue,
+    pub(crate) latest_event_value: LatestEventValue,
 
     /// Information about read receipts for this room.
     #[serde(default)]
@@ -534,7 +532,7 @@ impl RoomInfo {
             last_prev_batch: None,
             sync_info: SyncInfo::NoState,
             encryption_state_synced: false,
-            new_latest_event: LatestEventValue::default(),
+            latest_event_value: LatestEventValue::default(),
             read_receipts: Default::default(),
             base_info: Box::new(BaseRoomInfo::new()),
             warned_about_unknown_room_version_rules: Arc::new(false.into()),
@@ -1034,8 +1032,8 @@ impl RoomInfo {
     }
 
     /// Sets the new [`LatestEventValue`].
-    pub fn set_new_latest_event(&mut self, new_value: LatestEventValue) {
-        self.new_latest_event = new_value;
+    pub fn set_latest_event(&mut self, new_value: LatestEventValue) {
+        self.latest_event_value = new_value;
     }
 
     /// Updates the recency stamp of this room.
@@ -1308,7 +1306,7 @@ mod tests {
             last_prev_batch: Some("pb".to_owned()),
             sync_info: SyncInfo::FullySynced,
             encryption_state_synced: true,
-            new_latest_event: LatestEventValue::None,
+            latest_event_value: LatestEventValue::None,
             base_info: Box::new(
                 assign!(BaseRoomInfo::new(), { pinned_events: Some(RoomPinnedEventsEventContent::new(vec![owned_event_id!("$a")])) }),
             ),
@@ -1341,14 +1339,7 @@ mod tests {
             "last_prev_batch": "pb",
             "sync_info": "FullySynced",
             "encryption_state_synced": true,
-            "latest_event": {
-                "event": {
-                    "kind": {"PlainText": {"event": {"sender": "@u:i.uk"}}},
-                    "thread_summary": "None",
-                    "timestamp": null,
-                },
-            },
-            "new_latest_event": "None",
+            "latest_event_value": "None",
             "base_info": {
                 "avatar": null,
                 "canonical_alias": null,
@@ -1543,7 +1534,7 @@ mod tests {
         assert_eq!(info.last_prev_batch, Some("pb".to_owned()));
         assert_eq!(info.sync_info, SyncInfo::FullySynced);
         assert!(info.encryption_state_synced);
-        assert_matches!(info.new_latest_event, LatestEventValue::None);
+        assert_matches!(info.latest_event_value, LatestEventValue::None);
         assert!(info.base_info.avatar.is_none());
         assert!(info.base_info.canonical_alias.is_none());
         assert!(info.base_info.create.is_none());

crates/matrix-sdk-base/src/store/migration_helpers.rs

@@ -115,7 +115,7 @@ impl RoomInfoV1 {
             last_prev_batch,
             sync_info,
             encryption_state_synced,
-            new_latest_event: LatestEventValue::None,
+            latest_event_value: LatestEventValue::None,
             read_receipts: Default::default(),
             base_info: base_info.migrate(create),
             warned_about_unknown_room_version_rules: Arc::new(false.into()),

crates/matrix-sdk-ui/src/room_list_service/room_list.rs

@@ -420,10 +420,10 @@ pub struct RoomListItem {
     /// The inner room.
     inner: Room,
 
-    /// Cache of `Room::new_latest_event_timestamp`.
+    /// Cache of `Room::latest_event_timestamp`.
     pub(super) cached_latest_event_timestamp: Option<MilliSecondsSinceUnixEpoch>,
 
-    /// Cache of `Room::new_latest_event_is_local`.
+    /// Cache of `Room::latest_event_is_local`.
     pub(super) cached_latest_event_is_local: bool,
 
     /// Cache of `Room::recency_stamp`.
@@ -447,8 +447,8 @@ impl RoomListItem {
 
     /// Refresh the cached data.
     pub(super) fn refresh_cached_data(&mut self) {
-        self.cached_latest_event_timestamp = self.inner.new_latest_event_timestamp();
-        self.cached_latest_event_is_local = self.inner.new_latest_event_is_local();
+        self.cached_latest_event_timestamp = self.inner.latest_event_timestamp();
+        self.cached_latest_event_is_local = self.inner.latest_event_is_local();
         self.cached_recency_stamp = self.inner.recency_stamp();
         self.cached_display_name = self.inner.cached_display_name().map(|name| name.to_string());
         self.cached_is_space = self.inner.is_space();
@@ -458,8 +458,8 @@ impl RoomListItem {
 
 impl From<Room> for RoomListItem {
     fn from(inner: Room) -> Self {
-        let cached_latest_event_timestamp = inner.new_latest_event_timestamp();
-        let cached_latest_event_is_local = inner.new_latest_event_is_local();
+        let cached_latest_event_timestamp = inner.latest_event_timestamp();
+        let cached_latest_event_is_local = inner.latest_event_is_local();
         let cached_recency_stamp = inner.recency_stamp();
         let cached_display_name = inner.cached_display_name().map(|name| name.to_string());
         let cached_is_space = inner.is_space();

crates/matrix-sdk-ui/src/room_list_service/sorters/latest_event.rs

@@ -59,9 +59,9 @@ where
 pub fn new_sorter() -> impl Sorter {
     let latest_events = |left: &RoomListItem, right: &RoomListItem| {
         // Be careful. This method is called **a lot** in the context of a sorter. Using
-        // `Room::new_latest_event` would be dramatic as it returns a clone of the
+        // `Room::latest_event` would be dramatic as it returns a clone of the
         // `LatestEventValue`. It's better to use the more specific method
-        // `Room::new_latest_event_is_local`, where the value is cached in this module's
+        // `Room::latest_event_is_local`, where the value is cached in this module's
         // `Room` type.
         (left.cached_latest_event_is_local, right.cached_latest_event_is_local)
     };

crates/matrix-sdk-ui/src/room_list_service/sorters/recency.rs

@@ -34,12 +34,12 @@ fn cmp_impl(a: Option<Score>, b: Option<Score>) -> Ordering {
 }
 
 /// Create a new sorter that will sort two [`RoomListItem`] by “recency score”,
-/// i.e. by comparing their [`RoomInfo::new_latest_event`]'s timestamp value, or
-/// their [`RoomInfo::recency_stamp`] value. The `Room` with the newest “recency
-/// score” comes first, i.e. newest < oldest.
+/// i.e. by comparing their [`RoomInfo::latest_event_value`]'s timestamp value,
+/// or their [`RoomInfo::recency_stamp`] value. The `Room` with the newest
+/// “recency score” comes first, i.e. newest < oldest.
 ///
 /// [`RoomInfo::recency_stamp`]: matrix_sdk_base::RoomInfo::recency_stamp
-/// [`RoomInfo::new_latest_event`]: matrix_sdk_base::RoomInfo::new_latest_event
+/// [`RoomInfo::latest_event_value`]: matrix_sdk_base::RoomInfo::latest_event_value
 pub fn new_sorter() -> impl Sorter {
     |left, right| -> Ordering { cmp(extract_scores, left, right) }
 }
@@ -49,21 +49,24 @@ pub fn new_sorter() -> impl Sorter {
 /// stamp of the room). This type hides `u64` for the sake of semantics.
 type Score = u64;
 
-/// Extract the recency _scores_ from either the [`RoomInfo::new_latest_event`]
-/// or from [`RoomInfo::recency_stamp`].
+/// Extract the recency _scores_ from either the
+/// [`RoomInfo::latest_event_value`] or from [`RoomInfo::recency_stamp`].
 ///
 /// We must be very careful to return data of the same nature: either a
 /// _score_ from the [`LatestEventValue`]'s timestamp, or from the
 /// [`RoomInfo::recency_stamp`], but we **must never** mix both. The
 /// `RoomInfo::recency_stamp` is not a timestamp, while `LatestEventValue` uses
 /// a timestamp.
+///
+/// [`RoomInfo::recency_stamp`]: matrix_sdk_base::RoomInfo::recency_stamp
+/// [`RoomInfo::latest_event_value`]: matrix_sdk_base::RoomInfo::latest_event_value
 fn extract_scores(left: &RoomListItem, right: &RoomListItem) -> (Option<Score>, Option<Score>) {
     // Warning 1.
     //
     // Be careful. This method is called **a lot** in the context of a sorter. Using
-    // `Room::new_latest_event` would be dramatic as it returns a clone of the
+    // `Room::latest_event` would be dramatic as it returns a clone of the
     // `LatestEventValue`. It's better to use the more specific method
-    // `Room::new_latest_event_timestamp`, where the value is cached in
+    // `Room::latest_event_timestamp`, where the value is cached in
     // `RoomListItem::cached_latest_event_timestamp`.
 
     // Warning 2.
@@ -162,7 +165,7 @@ mod tests {
 
     fn set_latest_event_value(room: &mut RoomListItem, latest_event_value: LatestEventValue) {
         let mut room_info = room.clone_info();
-        room_info.set_new_latest_event(latest_event_value);
+        room_info.set_latest_event(latest_event_value);
         room.set_room_info(room_info, RoomInfoNotableUpdateReasons::LATEST_EVENT);
         room.refresh_cached_data();
     }

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

@@ -61,7 +61,7 @@ pub trait RoomExt {
     fn timeline_builder(&self) -> TimelineBuilder;
 
     /// Return a [`LatestEventValue`] corresponding to this room's latest event.
-    fn new_latest_event(&self) -> impl Future<Output = LatestEventValue>;
+    fn latest_event(&self) -> impl Future<Output = LatestEventValue>;
 }
 
 impl RoomExt for Room {
@@ -74,9 +74,9 @@ impl RoomExt for Room {
             .track_read_marker_and_receipts(TimelineReadReceiptTracking::AllEvents)
     }
 
-    async fn new_latest_event(&self) -> LatestEventValue {
+    async fn latest_event(&self) -> LatestEventValue {
         LatestEventValue::from_base_latest_event_value(
-            (**self).new_latest_event(),
+            (**self).latest_event(),
             self,
             &self.client(),
         )

crates/matrix-sdk-ui/tests/integration/room_list_service.rs

@@ -2644,7 +2644,7 @@ async fn test_room_latest_event() -> Result<(), Error> {
     latest_events.listen_to_room(room_id).await.unwrap();
 
     // The latest event does not exist.
-    assert_matches!(room.new_latest_event().await, LatestEventValue::None);
+    assert_matches!(room.latest_event().await, LatestEventValue::None);
 
     sync_then_assert_request_and_fake_response! {
         [server, room_list, sync]
@@ -2665,7 +2665,7 @@ async fn test_room_latest_event() -> Result<(), Error> {
     yield_now().await;
 
     // The latest event exists.
-    assert_matches!(room.new_latest_event().await, LatestEventValue::Remote { .. });
+    assert_matches!(room.latest_event().await, LatestEventValue::Remote { .. });
 
     // Insert a local event in the `Timeline`.
     timeline.send(RoomMessageEventContent::text_plain("Hello, World!").into()).await.unwrap();
@@ -2674,7 +2674,7 @@ async fn test_room_latest_event() -> Result<(), Error> {
     yield_now().await;
 
     // The latest event has been updated.
-    assert_matches!(room.new_latest_event().await, LatestEventValue::Local { .. });
+    assert_matches!(room.latest_event().await, LatestEventValue::Local { .. });
 
     Ok(())
 }

crates/matrix-sdk/src/latest_events/latest_event.rs

@@ -159,7 +159,7 @@ impl LatestEvent {
 
         // Compute a new `RoomInfo`.
         let mut room_info = room.clone_info();
-        room_info.set_new_latest_event(new_value);
+        room_info.set_latest_event(new_value);
 
         let mut state_changes = StateChanges::default();
         state_changes.add_room(room_info.clone());
@@ -437,7 +437,7 @@ mod tests_latest_event {
 
             // Check there is no `LatestEventValue` for the moment.
             {
-                let latest_event = room.new_latest_event();
+                let latest_event = room.latest_event();
 
                 assert_matches!(latest_event, LatestEventValue::None);
             }
@@ -463,7 +463,7 @@ mod tests_latest_event {
 
             // Check it's in the `RoomInfo` and in `Room`.
             {
-                let latest_event = room.new_latest_event();
+                let latest_event = room.latest_event();
 
                 assert_matches!(latest_event, LatestEventValue::Remote(_));
             }
@@ -478,7 +478,7 @@ mod tests_latest_event {
                 .build()
                 .await;
             let room = client.get_room(&room_id).unwrap();
-            let latest_event = room.new_latest_event();
+            let latest_event = room.latest_event();
 
             assert_matches!(latest_event, LatestEventValue::Remote(_));
         }