refactor(timeline): only use the publicly exposed content/sender/sender_profile on EmbeddedEvent

Author: bnjbvr

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

@@ -690,9 +690,9 @@ impl Timeline {
             Ok(Some(replied_to)) => Ok(Arc::new(InReplyToDetails::new(
                 event_id_str,
                 EmbeddedEventDetails::Ready {
-                    content: replied_to.content().clone().into(),
-                    sender: replied_to.sender().to_string(),
-                    sender_profile: replied_to.sender_profile().into(),
+                    content: replied_to.content.clone().into(),
+                    sender: replied_to.sender.to_string(),
+                    sender_profile: (&replied_to.sender_profile).into(),
                 },
             ))),
 
@@ -1144,6 +1144,7 @@ pub enum ProfileDetails {
     Error { message: String },
 }
 
+// TODO try to !use &
 impl From<&TimelineDetails<Profile>> for ProfileDetails {
     fn from(details: &TimelineDetails<Profile>) -> Self {
         match details {

bindings/matrix-sdk-ffi/src/timeline/reply.rs

@@ -59,14 +59,11 @@ impl From<TimelineDetails<Box<EmbeddedEvent>>> for EmbeddedEventDetails {
         match event {
             TimelineDetails::Unavailable => EmbeddedEventDetails::Unavailable,
             TimelineDetails::Pending => EmbeddedEventDetails::Pending,
-            TimelineDetails::Ready(event) => {
-                let sender_profile = event.sender_profile().into();
-                EmbeddedEventDetails::Ready {
-                    content: event.content.into(),
-                    sender: event.sender.to_string(),
-                    sender_profile,
-                }
-            }
+            TimelineDetails::Ready(event) => EmbeddedEventDetails::Ready {
+                content: event.content.into(),
+                sender: event.sender.to_string(),
+                sender_profile: (&event.sender_profile).into(),
+            },
             TimelineDetails::Error(err) => EmbeddedEventDetails::Error { message: err.to_string() },
         }
     }

crates/matrix-sdk-ui/src/timeline/event_item/content/reply.rs

@@ -16,7 +16,7 @@ use std::sync::Arc;
 
 use imbl::Vector;
 use matrix_sdk::deserialized_responses::{TimelineEvent, UnsignedEventLocation};
-use ruma::{OwnedEventId, OwnedUserId, UserId};
+use ruma::{OwnedEventId, OwnedUserId};
 use tracing::{debug, instrument, warn};
 
 use super::TimelineItemContent;
@@ -71,22 +71,6 @@ pub struct EmbeddedEvent {
 }
 
 impl EmbeddedEvent {
-    // TODO: remove public getters
-    /// Get the message of this event.
-    pub fn content(&self) -> &TimelineItemContent {
-        &self.content
-    }
-
-    /// Get the sender of this event.
-    pub fn sender(&self) -> &UserId {
-        &self.sender
-    }
-
-    /// Get the profile of the sender.
-    pub fn sender_profile(&self) -> &TimelineDetails<Profile> {
-        &self.sender_profile
-    }
-
     /// Create a [`EmbeddedEvent`] from a loaded event timeline item.
     pub fn from_timeline_item(timeline_item: &EventTimelineItem) -> Self {
         Self {

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

@@ -419,7 +419,7 @@ async fn test_reply() {
     let in_reply_to = in_reply_to.clone().unwrap();
     assert_eq!(in_reply_to.event_id, first_event_id);
     assert_let!(TimelineDetails::Ready(replied_to_event) = &in_reply_to.event);
-    assert_eq!(replied_to_event.sender(), *ALICE);
+    assert_eq!(replied_to_event.sender, *ALICE);
 }
 
 #[async_test]
@@ -461,7 +461,7 @@ async fn test_thread() {
     let in_reply_to = in_reply_to.clone().unwrap();
     assert_eq!(in_reply_to.event_id, first_event_id);
     assert_let!(TimelineDetails::Ready(replied_to_event) = &in_reply_to.event);
-    assert_eq!(replied_to_event.sender(), *ALICE);
+    assert_eq!(replied_to_event.sender, *ALICE);
 }
 
 #[async_test]

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

@@ -873,7 +873,7 @@ async fn test_retry_decryption_updates_response() {
         assert_eq!(reply_details.event_id, original_event_id);
 
         let replied_to = as_variant!(&reply_details.event, TimelineDetails::Ready).unwrap();
-        assert!(replied_to.content().is_unable_to_decrypt());
+        assert!(replied_to.content.is_unable_to_decrypt());
     }
 
     // Import a room key backup.
@@ -908,7 +908,7 @@ async fn test_retry_decryption_updates_response() {
         assert_eq!(reply_details.event_id, original_event_id);
 
         let replied_to = as_variant!(&reply_details.event, TimelineDetails::Ready).unwrap();
-        assert_eq!(replied_to.content().as_message().unwrap().body(), "It's a secret to everybody");
+        assert_eq!(replied_to.content.as_message().unwrap().body(), "It's a secret to everybody");
     }
 
     // The event itself is decrypted.

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

@@ -80,7 +80,7 @@ async fn test_redact_replied_to_event() {
     let msglike = second_item.content().as_msglike().unwrap();
     let in_reply_to = msglike.in_reply_to.clone().unwrap();
     assert_let!(TimelineDetails::Ready(replied_to_event) = &in_reply_to.event);
-    assert!(replied_to_event.content().is_message());
+    assert!(replied_to_event.content.is_message());
 
     timeline.handle_live_event(f.redaction(first_item.event_id().unwrap()).sender(&ALICE)).await;
 
@@ -94,7 +94,7 @@ async fn test_redact_replied_to_event() {
     let msglike = second_item_again.content().as_msglike().unwrap();
     let in_reply_to = msglike.in_reply_to.clone().unwrap();
     assert_let!(TimelineDetails::Ready(replied_to_event) = &in_reply_to.event);
-    assert!(replied_to_event.content().is_redacted());
+    assert!(replied_to_event.content.is_redacted());
 }
 
 #[async_test]

crates/matrix-sdk-ui/tests/integration/timeline/edit.rs

@@ -462,7 +462,7 @@ async fn test_edit_to_replied_updates_reply() {
         assert_eq!(in_reply_to.event_id, eid1);
 
         assert_let!(TimelineDetails::Ready(replied_to) = &in_reply_to.event);
-        assert_eq!(replied_to.content().as_message().unwrap().body(), "bonjour");
+        assert_eq!(replied_to.content.as_message().unwrap().body(), "bonjour");
     });
 
     assert_next_matches!(timeline_stream, VectorDiff::PushBack { value: reply_item } => {
@@ -474,7 +474,7 @@ async fn test_edit_to_replied_updates_reply() {
         assert_eq!(in_reply_to.event_id, eid1);
 
         assert_let!(TimelineDetails::Ready(replied_to) = &in_reply_to.event);
-        assert_eq!(replied_to.content().as_message().unwrap().body(), "bonjour");
+        assert_eq!(replied_to.content.as_message().unwrap().body(), "bonjour");
     });
 
     server.mock_room_send().ok(event_id!("$edit_event")).mock_once().mount().await;
@@ -509,7 +509,7 @@ async fn test_edit_to_replied_updates_reply() {
         let in_reply_to = msglike.in_reply_to.clone().unwrap();
         assert_eq!(in_reply_to.event_id, eid1);
         assert_let!(TimelineDetails::Ready(replied_to) = &in_reply_to.event);
-        assert_eq!(replied_to.content().as_message().unwrap().body(), "hello world");
+        assert_eq!(replied_to.content.as_message().unwrap().body(), "hello world");
     });
 
     assert_next_matches!(timeline_stream, VectorDiff::Set { index: 2, value } => {
@@ -521,7 +521,7 @@ async fn test_edit_to_replied_updates_reply() {
         let in_reply_to = msglike.in_reply_to.clone().unwrap();
         assert_eq!(in_reply_to.event_id, eid1);
         assert_let!(TimelineDetails::Ready(replied_to) = &in_reply_to.event);
-        assert_eq!(replied_to.content().as_message().unwrap().body(), "hello world");
+        assert_eq!(replied_to.content.as_message().unwrap().body(), "hello world");
     });
 
     sleep(Duration::from_millis(200)).await;

crates/matrix-sdk-ui/tests/integration/timeline/replies.rs

@@ -349,9 +349,9 @@ async fn test_fetch_details_utd() {
         // The replied-to event is available, and is a UTD.
         let in_reply_to = in_reply_to.clone().unwrap();
         assert_let!(TimelineDetails::Ready(replied_to) = &in_reply_to.event);
-        assert_eq!(replied_to.sender(), *ALICE);
+        assert_eq!(replied_to.sender, *ALICE);
         assert_matches!(
-            replied_to.content(),
+            replied_to.content,
             TimelineItemContent::MsgLike(MsgLikeContent {
                 kind: MsgLikeKind::UnableToDecrypt(_),
                 ..
@@ -461,8 +461,8 @@ async fn test_fetch_details_poll() {
         // The replied-to event is available, and is the poll.
         let in_reply_to = in_reply_to.clone().unwrap();
         assert_let!(TimelineDetails::Ready(replied_to) = &in_reply_to.event);
-        assert_eq!(replied_to.sender(), *ALICE);
-        assert_let!(Some(poll_state) = replied_to.content().as_poll());
+        assert_eq!(replied_to.sender, *ALICE);
+        assert_let!(Some(poll_state) = replied_to.content.as_poll());
         assert_eq!(
             poll_state.fallback_text().unwrap(),
             "What is the best color? A. Red, B. Blue, C. Green"
@@ -572,8 +572,8 @@ async fn test_fetch_details_sticker() {
         // The replied-to event is available, and is a sticker.
         let in_reply_to = in_reply_to.clone().unwrap();
         assert_let!(TimelineDetails::Ready(replied_to) = &in_reply_to.event);
-        assert_eq!(replied_to.sender(), *ALICE);
-        assert_let!(Some(sticker) = replied_to.content().as_sticker());
+        assert_eq!(replied_to.sender, *ALICE);
+        assert_let!(Some(sticker) = replied_to.content.as_sticker());
         assert_eq!(sticker.content().body, "sticker!");
         assert_matches!(&sticker.content().source, StickerMediaSource::Plain(src) => {
             assert_eq!(*src, media_src);
@@ -894,7 +894,7 @@ async fn test_send_reply_to_threaded() {
     assert_eq!(in_reply_to.event_id, event_id_1);
 
     assert_let!(TimelineDetails::Ready(replied_to_event) = &in_reply_to.event);
-    assert_eq!(replied_to_event.sender(), *BOB);
+    assert_eq!(replied_to_event.sender, *BOB);
 
     // Wait for remote echo.
     let diff = timeout(timeline_stream.next(), Duration::from_secs(1)).await.unwrap().unwrap();
@@ -910,7 +910,7 @@ async fn test_send_reply_to_threaded() {
     assert_eq!(in_reply_to.event_id, event_id_1);
 
     assert_let!(TimelineDetails::Ready(replied_to_event) = &in_reply_to.event);
-    assert_eq!(replied_to_event.sender(), *BOB);
+    assert_eq!(replied_to_event.sender, *BOB);
 }
 
 #[async_test]

crates/matrix-sdk-ui/tests/integration/timeline/thread.rs

@@ -312,7 +312,7 @@ async fn test_new_thread_reply_causes_thread_summary() {
     // info.
     let replied_to_details = value.as_event().unwrap().content().in_reply_to().unwrap().event;
     assert_let!(TimelineDetails::Ready(replied_to_event) = replied_to_details);
-    assert!(replied_to_event.content().thread_summary().is_none());
+    assert!(replied_to_event.content.thread_summary().is_none());
 
     // Since the replied-to item (the thread root) has been updated, all replies get
     // updated too, including the item we just pushed.
@@ -322,7 +322,7 @@ async fn test_new_thread_reply_causes_thread_summary() {
     let replied_to_details = value.as_event().unwrap().content().in_reply_to().unwrap().event;
     assert_let!(TimelineDetails::Ready(replied_to_event) = replied_to_details);
     // Spoiling a bit here…
-    assert!(replied_to_event.content().thread_summary().is_some());
+    assert!(replied_to_event.content.thread_summary().is_some());
 
     // And finally, the thread root event receives a thread summary.
     assert_let!(VectorDiff::Set { index: 1, value } = &timeline_updates[2]);
@@ -378,7 +378,7 @@ async fn test_new_thread_reply_causes_thread_summary() {
     let replied_to_details = value.as_event().unwrap().content().in_reply_to().unwrap().event;
     assert_let!(TimelineDetails::Ready(replied_to_event) = replied_to_details);
     // Spoiling a bit here…
-    assert_eq!(replied_to_event.content().thread_summary().unwrap().num_replies, 2);
+    assert_eq!(replied_to_event.content.thread_summary().unwrap().num_replies, 2);
 
     // Then, we receive an update for the thread root itself, which now has an
     // up-to-date thread summary.