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

@@ -300,8 +300,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

@@ -17,7 +17,7 @@ use crate::latest_event::LatestEventValue;
 
 impl Room {
     /// Return the [`LatestEventValue`] of this room.
-    pub fn new_latest_event(&self) -> LatestEventValue {
-        self.inner.read().new_latest_event.clone()
+    pub fn latest_event(&self) -> LatestEventValue {
+        self.inner.read().latest_event_value.clone()
     }
 }

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

@@ -451,10 +451,11 @@ pub struct RoomInfo {
     pub(crate) encryption_state_synced: bool,
 
     /// The latest event value of this room.
-    ///
-    /// TODO(@hywan): Rename to `latest_event`.
+    //
+    // Note: Why `latest_event_value` and `latest_event`? Because `latest_event` existed before, we
+    // don't want to collide.
     #[serde(default)]
-    pub(crate) new_latest_event: LatestEventValue,
+    pub(crate) latest_event_value: LatestEventValue,
 
     /// Information about read receipts for this room.
     #[serde(default)]
@@ -512,7 +513,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()),
@@ -1011,14 +1012,14 @@ impl RoomInfo {
             .collect()
     }
 
-    /// Return the new [`LatestEventValue`].
-    pub fn new_latest_event(&self) -> &LatestEventValue {
-        &self.new_latest_event
+    /// Return the [`LatestEventValue`].
+    pub fn latest_event(&self) -> &LatestEventValue {
+        &self.latest_event_value
     }
 
-    /// Sets the new [`LatestEventValue`].
-    pub fn set_new_latest_event(&mut self, new_value: LatestEventValue) {
-        self.new_latest_event = new_value;
+    /// Set the [`LatestEventValue`].
+    pub fn set_latest_event(&mut self, new_value: LatestEventValue) {
+        self.latest_event_value = new_value;
     }
 
     /// Updates the recency stamp of this room.
@@ -1273,7 +1274,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")])) }),
             ),
@@ -1306,13 +1307,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"
-                },
-            },
-            "new_latest_event": "None",
+            "latest_event_value": "None",
             "base_info": {
                 "avatar": null,
                 "canonical_alias": null,
@@ -1507,7 +1502,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/timeline/traits.rs

@@ -64,7 +64,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 {
@@ -76,9 +76,9 @@ impl RoomExt for Room {
         TimelineBuilder::new(self).track_read_marker_and_receipts()
     }
 
-    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

@@ -2584,7 +2584,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]
@@ -2606,7 +2606,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();
@@ -2615,7 +2615,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

@@ -146,7 +146,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());
@@ -426,7 +426,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);
             }
@@ -452,7 +452,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(_));
             }
@@ -467,7 +467,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(_));
         }

testing/matrix-sdk-integration-testing/src/tests/sliding_sync/room.rs

@@ -499,12 +499,12 @@ async fn test_room_notification_count() -> Result<()> {
             update_observer.next().await.expect("we should get an update when Bob joins the room");
 
         assert_eq!(update.joined_members_count(), 2);
-        assert_matches!(update.new_latest_event(), LatestEventValue::None);
+        assert_matches!(update.latest_event(), LatestEventValue::None);
 
         assert_eq!(alice_room.num_unread_messages(), 0);
         assert_eq!(alice_room.num_unread_mentions(), 0);
         assert_eq!(alice_room.num_unread_notifications(), 0);
-        assert_matches!((*alice_room).new_latest_event(), LatestEventValue::None);
+        assert_matches!((*alice_room).latest_event(), LatestEventValue::None);
 
         update_observer.assert_is_pending();
     }
@@ -520,12 +520,12 @@ async fn test_room_notification_count() -> Result<()> {
             .await
             .expect("we should get an update when Bob sent a non-mention message");
 
-        assert_matches!(update.new_latest_event(), LatestEventValue::Remote(_));
+        assert_matches!(update.latest_event(), LatestEventValue::Remote(_));
 
         assert_eq!(alice_room.num_unread_messages(), 1);
         assert_eq!(alice_room.num_unread_notifications(), 1);
         assert_eq!(alice_room.num_unread_mentions(), 0);
-        assert_matches!((*alice_room).new_latest_event(), LatestEventValue::Remote(_));
+        assert_matches!((*alice_room).latest_event(), LatestEventValue::Remote(_));
 
         update_observer.assert_is_pending();
     }