refactor(sdk): Use TimelineDetails for sender profile

… as it's not available when members for the room aren't synced.

Author: jplatte

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

@@ -93,8 +93,8 @@ mod uniffi_types {
             EmoteMessageContent, EncryptedMessage, EventTimelineItem, FileInfo, FileMessageContent,
             FormattedBody, ImageInfo, ImageMessageContent, InsertAtData,
             LocalEventTimelineItemSendState, MembershipChange, Message, MessageFormat, MessageType,
-            NoticeMessageContent, OtherState, Profile, Reaction, TextMessageContent, ThumbnailInfo,
-            TimelineChange, TimelineDiff, TimelineItem, TimelineItemContent,
+            NoticeMessageContent, 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]
@@ -225,7 +226,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()
     }
 
@@ -281,19 +282,23 @@ 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> },
+}
+
+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),
+            },
         }
     }
 }

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

@@ -47,7 +47,8 @@ use super::{
         RemoteEventTimelineItem, RoomMembershipChange, Sticker,
     },
     find_read_marker, rfind_event_by_id, rfind_event_item, EventTimelineItem, Message,
-    ReactionGroup, TimelineInnerMetadata, TimelineItem, TimelineItemContent, VirtualTimelineItem,
+    ReactionGroup, TimelineDetails, TimelineInnerMetadata, TimelineItem, TimelineItemContent,
+    VirtualTimelineItem,
 };
 use crate::{events::SyncTimelineEventWithoutContent, room::timeline::MembershipChange};
 
@@ -67,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>,
@@ -525,7 +526,10 @@ 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 = match &self.meta.sender_profile {
+            Some(profile) => TimelineDetails::Ready(profile.clone()),
+            None => TimelineDetails::Unavailable,
+        };
         let mut reactions = self.pending_reactions().unwrap_or_default();
 
         let item = match &self.flow {

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

@@ -137,7 +137,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,
@@ -231,7 +231,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.
@@ -273,7 +273,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.

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

@@ -402,7 +402,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]
@@ -411,8 +411,12 @@ impl ProfileProvider for room::Common {
         (**self).own_user_id()
     }
 
-    async fn profile(&self, user_id: &UserId) -> Profile {
-        match self.get_member_no_sync(user_id).await {
+    async fn profile(&self, user_id: &UserId) -> Option<Profile> {
+        if !self.are_members_synced() {
+            return None;
+        }
+
+        let profile = match self.get_member_no_sync(user_id).await {
             Ok(Some(member)) => Profile {
                 display_name: member.display_name().map(ToOwned::to_owned),
                 display_name_ambiguous: member.name_ambiguous(),
@@ -425,7 +429,8 @@ impl ProfileProvider for room::Common {
                 error!(%user_id, "Failed to getch room member information: {e}");
                 Profile { display_name: None, display_name_ambiguous: false, avatar_url: None }
             }
-        }
+        };
+        Some(profile)
     }
 }
 

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

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