refactor(sdk): Use TimelineDetails for sender profile

Author: jplatte

bindings/matrix-sdk-ffi/src/lib.rs

@@ -93,9 +93,10 @@ mod uniffi_types {
             EmoteMessageContent, EncryptedMessage, EventSendState, EventTimelineItem, FileInfo,
             FileMessageContent, FormattedBody, ImageInfo, ImageMessageContent, InsertAtData,
             MembershipChange, Message, MessageFormat, MessageType, NoticeMessageContent,
-            OtherState, Profile, Reaction, TextMessageContent, ThumbnailInfo, TimelineChange,
-            TimelineDiff, TimelineItem, TimelineItemContent, TimelineItemContentKind, UpdateAtData,
-            VideoInfo, VideoMessageContent, VirtualTimelineItem,
+            OtherState, ProfileTimelineDetails, Reaction, TextMessageContent, ThumbnailInfo,
+            TimelineChange, TimelineDiff, TimelineItem, TimelineItemContent,
+            TimelineItemContentKind, UpdateAtData, VideoInfo, VideoMessageContent,
+            VirtualTimelineItem,
         },
     };
 }

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

@@ -2,6 +2,7 @@ use std::sync::Arc;
 
 use extension_trait::extension_trait;
 use futures_signals::signal_vec::VecDiff;
+use matrix_sdk::room::timeline::{Profile, TimelineDetails};
 pub use matrix_sdk::ruma::events::room::{message::RoomMessageEventContent, MediaSource};
 
 #[uniffi::export]
@@ -223,7 +224,7 @@ impl EventTimelineItem {
         self.0.sender().to_string()
     }
 
-    pub fn sender_profile(&self) -> Profile {
+    pub fn sender_profile(&self) -> ProfileTimelineDetails {
         self.0.sender_profile().into()
     }
 
@@ -279,19 +280,25 @@ impl EventTimelineItem {
     }
 }
 
-#[derive(uniffi::Record)]
-pub struct Profile {
-    display_name: Option<String>,
-    display_name_ambiguous: bool,
-    avatar_url: Option<String>,
-}
-
-impl From<&matrix_sdk::room::timeline::Profile> for Profile {
-    fn from(p: &matrix_sdk::room::timeline::Profile) -> Self {
-        Self {
-            display_name: p.display_name.clone(),
-            display_name_ambiguous: p.display_name_ambiguous,
-            avatar_url: p.avatar_url.as_ref().map(ToString::to_string),
+#[derive(uniffi::Enum)]
+pub enum ProfileTimelineDetails {
+    Unavailable,
+    Pending,
+    Ready { display_name: Option<String>, display_name_ambiguous: bool, avatar_url: Option<String> },
+    Error { message: String },
+}
+
+impl From<&TimelineDetails<Profile>> for ProfileTimelineDetails {
+    fn from(details: &TimelineDetails<Profile>) -> Self {
+        match details {
+            TimelineDetails::Unavailable => Self::Unavailable,
+            TimelineDetails::Pending => Self::Pending,
+            TimelineDetails::Ready(profile) => Self::Ready {
+                display_name: profile.display_name.clone(),
+                display_name_ambiguous: profile.display_name_ambiguous,
+                avatar_url: profile.avatar_url.as_ref().map(ToString::to_string),
+            },
+            TimelineDetails::Error(e) => Self::Error { message: e.to_string() },
         }
     }
 }

crates/matrix-sdk/src/room/timeline/event_handler.rs

@@ -47,8 +47,8 @@ use super::{
         Sticker,
     },
     find_read_marker, rfind_event_by_id, rfind_event_item, EventTimelineItem, InReplyToDetails,
-    Message, ReactionGroup, TimelineInnerMetadata, TimelineItem, TimelineItemContent,
-    VirtualTimelineItem,
+    Message, ReactionGroup, TimelineDetails, TimelineInnerMetadata, TimelineItem,
+    TimelineItemContent, VirtualTimelineItem,
 };
 use crate::{events::SyncTimelineEventWithoutContent, room::timeline::MembershipChange};
 
@@ -68,7 +68,7 @@ pub(super) enum Flow {
 
 pub(super) struct TimelineEventMetadata {
     pub(super) sender: OwnedUserId,
-    pub(super) sender_profile: Profile,
+    pub(super) sender_profile: Option<Profile>,
     pub(super) is_own_event: bool,
     pub(super) relations: BundledRelations,
     pub(super) encryption_info: Option<EncryptionInfo>,
@@ -526,7 +526,7 @@ impl<'a, 'i> TimelineEventHandler<'a, 'i> {
 
         let NewEventTimelineItem { content } = item;
         let sender = self.meta.sender.to_owned();
-        let sender_profile = self.meta.sender_profile.clone();
+        let sender_profile = TimelineDetails::from_initial_value(self.meta.sender_profile.clone());
         let mut reactions = self.pending_reactions().unwrap_or_default();
 
         let item = match &self.flow {

crates/matrix-sdk/src/room/timeline/event_item.rs

@@ -140,7 +140,7 @@ impl EventTimelineItem {
     }
 
     /// Get the profile of the sender.
-    pub fn sender_profile(&self) -> &Profile {
+    pub fn sender_profile(&self) -> &TimelineDetails<Profile> {
         match self {
             Self::Local(local_event) => &local_event.sender_profile,
             Self::Remote(remote_event) => &remote_event.sender_profile,
@@ -238,7 +238,7 @@ pub struct LocalEventTimelineItem {
     /// The sender of the event.
     pub sender: OwnedUserId,
     /// The sender's profile of the event.
-    pub sender_profile: Profile,
+    pub sender_profile: TimelineDetails<Profile>,
     /// The timestamp of the event.
     pub timestamp: MilliSecondsSinceUnixEpoch,
     /// The content of the event.
@@ -275,7 +275,7 @@ pub struct RemoteEventTimelineItem {
     /// The sender of the event.
     pub sender: OwnedUserId,
     /// The sender's profile of the event.
-    pub sender_profile: Profile,
+    pub sender_profile: TimelineDetails<Profile>,
     /// The timestamp of the event.
     pub timestamp: MilliSecondsSinceUnixEpoch,
     /// The content of the event.
@@ -375,6 +375,15 @@ pub enum TimelineDetails<T> {
     Error(Arc<Error>),
 }
 
+impl<T> TimelineDetails<T> {
+    pub(crate) fn from_initial_value(value: Option<T>) -> Self {
+        match value {
+            Some(v) => Self::Ready(v),
+            None => Self::Unavailable,
+        }
+    }
+}
+
 /// The content of an [`EventTimelineItem`].
 #[derive(Clone, Debug)]
 pub enum TimelineItemContent {
@@ -518,7 +527,7 @@ impl InReplyToDetails {
 pub struct RepliedToEvent {
     pub(super) message: Message,
     pub(super) sender: OwnedUserId,
-    pub(super) sender_profile: Profile,
+    pub(super) sender_profile: TimelineDetails<Profile>,
 }
 
 impl RepliedToEvent {
@@ -533,7 +542,7 @@ impl RepliedToEvent {
     }
 
     /// Get the profile of the sender.
-    pub fn sender_profile(&self) -> &Profile {
+    pub fn sender_profile(&self) -> &TimelineDetails<Profile> {
         &self.sender_profile
     }
 
@@ -558,7 +567,8 @@ impl RepliedToEvent {
             edited: event.relations().replace.is_some(),
         };
         let sender = event.sender().to_owned();
-        let sender_profile = profile_provider.profile(&sender).await;
+        let sender_profile =
+            TimelineDetails::from_initial_value(profile_provider.profile(&sender).await);
 
         Ok(Self { message, sender, sender_profile })
     }

crates/matrix-sdk/src/room/timeline/inner.rs

@@ -463,7 +463,7 @@ impl TimelineInner {
 #[async_trait]
 pub(super) trait ProfileProvider {
     fn own_user_id(&self) -> &UserId;
-    async fn profile(&self, user_id: &UserId) -> Profile;
+    async fn profile(&self, user_id: &UserId) -> Option<Profile>;
 }
 
 #[async_trait]
@@ -472,19 +472,22 @@ impl ProfileProvider for room::Common {
         (**self).own_user_id()
     }
 
-    async fn profile(&self, user_id: &UserId) -> Profile {
+    async fn profile(&self, user_id: &UserId) -> Option<Profile> {
         match self.get_member_no_sync(user_id).await {
-            Ok(Some(member)) => Profile {
+            Ok(Some(member)) => Some(Profile {
                 display_name: member.display_name().map(ToOwned::to_owned),
                 display_name_ambiguous: member.name_ambiguous(),
                 avatar_url: member.avatar_url().map(ToOwned::to_owned),
-            },
-            Ok(None) => {
-                Profile { display_name: None, display_name_ambiguous: false, avatar_url: None }
-            }
+            }),
+            Ok(None) if self.are_members_synced() => Some(Profile {
+                display_name: None,
+                display_name_ambiguous: false,
+                avatar_url: None,
+            }),
+            Ok(None) => None,
             Err(e) => {
                 error!(%user_id, "Failed to getch room member information: {e}");
-                Profile { display_name: None, display_name_ambiguous: false, avatar_url: None }
+                None
             }
         }
     }

crates/matrix-sdk/src/room/timeline/tests.rs

@@ -867,8 +867,8 @@ impl ProfileProvider for TestProfileProvider {
         &ALICE
     }
 
-    async fn profile(&self, _user_id: &UserId) -> Profile {
-        Profile { display_name: None, display_name_ambiguous: false, avatar_url: None }
+    async fn profile(&self, _user_id: &UserId) -> Option<Profile> {
+        None
     }
 }