feat!(timeline): infer the reply type automatically when sending a media gallery

Author: bnjbvr

bindings/matrix-sdk-ffi/CHANGELOG.md

@@ -8,6 +8,11 @@ All notable changes to this project will be documented in this file.
 
 ### Features:
 
+- [**breaking**] [`GalleryUploadParameters::reply`] and [`UploadParameters::reply`] have been both
+  replaced with a new optional `in_reply_to` field, that's a string which will be parsed into an
+  `OwnedEventId` when sending the event. The thread relationship will be automatically filled in,
+  based on the timeline focus.
+  ([5427](https://github.com/matrix-org/matrix-rust-sdk/pull/5427))
 - [**breaking**] [`Timeline::send_reply()`] now automatically fills in the thread relationship,
   based on the timeline focus. As a result, it only takes an `OwnedEventId` parameter, instead of
   the `Reply` type. The proper way to start a thread is now thus to create a threaded-focused

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

@@ -24,10 +24,7 @@ use matrix_sdk::{
     },
     deserialized_responses::{ShieldState as SdkShieldState, ShieldStateCode},
     event_cache::RoomPaginationStatus,
-    room::{
-        edit::EditedContent as SdkEditedContent,
-        reply::{EnforceThread, Reply},
-    },
+    room::edit::EditedContent as SdkEditedContent,
 };
 use matrix_sdk_common::{
     executor::{AbortHandle, JoinHandle},
@@ -51,8 +48,7 @@ use ruma::{
             },
         },
         room::message::{
-            LocationMessageEventContent, MessageType, ReplyWithinThread,
-            RoomMessageEventContentWithoutRelation,
+            LocationMessageEventContent, MessageType, RoomMessageEventContentWithoutRelation,
         },
         AnyMessageLikeEventContent,
     },
@@ -245,37 +241,6 @@ impl From<UploadSource> for AttachmentSource {
     }
 }
 
-#[derive(uniffi::Record)]
-pub struct ReplyParameters {
-    /// The ID of the event to reply to.
-    event_id: String,
-    /// Whether to enforce a thread relation.
-    enforce_thread: bool,
-    /// If enforcing a threaded relation, whether the message is a reply on a
-    /// thread.
-    reply_within_thread: bool,
-}
-
-impl TryInto<Reply> for ReplyParameters {
-    type Error = RoomError;
-
-    fn try_into(self) -> Result<Reply, Self::Error> {
-        let event_id =
-            EventId::parse(&self.event_id).map_err(|_| RoomError::InvalidRepliedToEventId)?;
-        let enforce_thread = if self.enforce_thread {
-            EnforceThread::Threaded(if self.reply_within_thread {
-                ReplyWithinThread::Yes
-            } else {
-                ReplyWithinThread::No
-            })
-        } else {
-            EnforceThread::MaybeThreaded
-        };
-
-        Ok(Reply { event_id, enforce_thread })
-    }
-}
-
 #[matrix_sdk_ffi_macros::export]
 impl Timeline {
     pub async fn add_listener(&self, listener: Box<dyn TimelineListener>) -> Arc<TaskHandle> {
@@ -1401,14 +1366,15 @@ mod galleries {
     use matrix_sdk_common::executor::{AbortHandle, JoinHandle};
     use matrix_sdk_ui::timeline::GalleryConfig;
     use mime::Mime;
+    use ruma::EventId;
     use tokio::sync::Mutex;
     use tracing::error;
 
     use crate::{
         error::RoomError,
         ruma::{AudioInfo, FileInfo, FormattedBody, ImageInfo, Mentions, VideoInfo},
         runtime::get_runtime_handle,
-        timeline::{build_thumbnail_info, ReplyParameters, Timeline},
+        timeline::{build_thumbnail_info, Timeline},
     };
 
     #[derive(uniffi::Record)]
@@ -1419,8 +1385,8 @@ mod galleries {
         formatted_caption: Option<FormattedBody>,
         /// Optional intentional mentions to be sent with the gallery.
         mentions: Option<Mentions>,
-        /// Optional parameters for sending the media as (threaded) reply.
-        reply_params: Option<ReplyParameters>,
+        /// Optional Event ID to reply to.
+        in_reply_to: Option<String>,
     }
 
     #[derive(uniffi::Enum)]
@@ -1605,11 +1571,18 @@ mod galleries {
                 params.formatted_caption.map(Into::into),
             );
 
+            let in_reply_to = params
+                .in_reply_to
+                .as_ref()
+                .map(|event_id| EventId::parse(event_id))
+                .transpose()
+                .map_err(|_| RoomError::InvalidRepliedToEventId)?;
+
             let mut gallery_config = GalleryConfig::new()
                 .caption(params.caption)
                 .formatted_caption(formatted_caption)
                 .mentions(params.mentions.map(Into::into))
-                .reply(params.reply_params.map(|p| p.try_into()).transpose()?);
+                .in_reply_to(in_reply_to);
 
             for item_info in item_infos {
                 gallery_config = gallery_config.add_item(item_info.try_into()?);

crates/matrix-sdk-ui/CHANGELOG.md

@@ -8,6 +8,13 @@ All notable changes to this project will be documented in this file.
 
 ### Features
 
+- [**breaking**] [`Timeline::send_gallery()`] now automatically fills in the thread relationship,
+  based on the timeline focus. As a result, the `GalleryConfig::reply()` builder method has been
+  replaced with `GalleryConfig::in_reply_to`, and only takes an optional event id (the event that is
+  effectively replied to) instead of the `Reply` type. The proper way to start a thread with a
+  gallery event is now thus to create a threaded-focused timeline, and then use
+  `Timeline::send_gallery()`.
+  ([5427](https://github.com/matrix-org/matrix-rust-sdk/pull/5427))
 - [**breaking**] [`Timeline::send_attachment()`] now automatically fills in the thread
   relationship, based on the timeline focus. As a result, there's a new
   `matrix_sdk_ui::timeline::AttachmentConfig` type in town, that has a simplified optional parameter

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

@@ -141,9 +141,30 @@ mod galleries {
             let Self { timeline, gallery, tracing_span } = self;
 
             let fut = async move {
-                let send_queue = timeline.room().send_queue();
-                let fut = send_queue.send_gallery(gallery.try_into()?);
-                fut.await.map_err(|_| Error::FailedSendingAttachment)?;
+                let reply = timeline.infer_reply(gallery.in_reply_to).await;
+
+                let mut config = matrix_sdk::attachment::GalleryConfig::new();
+
+                if let Some(txn_id) = gallery.txn_id {
+                    config = config.txn_id(txn_id);
+                }
+
+                for item in gallery.items {
+                    config = config.add_item(item.try_into()?);
+                }
+
+                config = config
+                    .caption(gallery.caption)
+                    .formatted_caption(gallery.formatted_caption)
+                    .mentions(gallery.mentions)
+                    .reply(reply);
+
+                timeline
+                    .room()
+                    .send_queue()
+                    .send_gallery(config)
+                    .await
+                    .map_err(|_| Error::FailedSendingAttachment)?;
 
                 Ok(())
             };

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

@@ -958,7 +958,7 @@ pub struct GalleryConfig {
     pub(crate) caption: Option<String>,
     pub(crate) formatted_caption: Option<FormattedBody>,
     pub(crate) mentions: Option<Mentions>,
-    pub(crate) reply: Option<Reply>,
+    pub(crate) in_reply_to: Option<OwnedEventId>,
 }
 
 #[cfg(feature = "unstable-msc4274")]
@@ -1026,9 +1026,9 @@ impl GalleryConfig {
     ///
     /// # Arguments
     ///
-    /// * `reply` - The reply information of the message.
-    pub fn reply(mut self, reply: Option<Reply>) -> Self {
-        self.reply = reply;
+    /// * `event_id` - The event ID to reply to.
+    pub fn in_reply_to(mut self, event_id: Option<OwnedEventId>) -> Self {
+        self.in_reply_to = event_id;
         self
     }
 
@@ -1043,30 +1043,6 @@ impl GalleryConfig {
     }
 }
 
-#[cfg(feature = "unstable-msc4274")]
-impl TryFrom<GalleryConfig> for matrix_sdk::attachment::GalleryConfig {
-    type Error = Error;
-
-    fn try_from(value: GalleryConfig) -> Result<Self, Self::Error> {
-        let mut config = matrix_sdk::attachment::GalleryConfig::new();
-
-        if let Some(txn_id) = value.txn_id {
-            config = config.txn_id(txn_id);
-        }
-
-        for item in value.items {
-            config = config.add_item(item.try_into()?);
-        }
-
-        config = config.caption(value.caption);
-        config = config.formatted_caption(value.formatted_caption);
-        config = config.mentions(value.mentions);
-        config = config.reply(value.reply);
-
-        Ok(config)
-    }
-}
-
 #[cfg(feature = "unstable-msc4274")]
 #[derive(Debug)]
 /// Metadata for a gallery item