misc: Use filename for the send queue and gallery too

Author: jmartinesp

crates/matrix-sdk-base/src/store/send_queue.rs

@@ -109,6 +109,9 @@ pub enum QueuedRequestKind {
         #[cfg(feature = "unstable-msc4274")]
         #[serde(default)]
         accumulated: Vec<AccumulatedSentMediaInfo>,
+
+        /// The name of the file to upload, if known or public.
+        filename: Option<String>,
     },
 }
 
@@ -241,6 +244,9 @@ pub enum DependentQueuedRequestKind {
         #[cfg(feature = "unstable-msc4274")]
         #[serde(default = "default_parent_is_thumbnail_upload")]
         parent_is_thumbnail_upload: bool,
+
+        /// The name of the file to upload, if known.
+        filename: Option<String>,
     },
 
     /// Finish an upload by updating references to the media cache and sending

crates/matrix-sdk/src/send_queue/mod.rs

@@ -158,7 +158,7 @@ use ruma::{
         reaction::ReactionEventContent,
         relation::Annotation,
         room::{
-            message::{FormattedBody, RoomMessageEventContent},
+            message::{FormattedBody, MessageType, RoomMessageEventContent},
             MediaSource,
         },
         AnyMessageLikeEventContent, EventContent as _, Mentions,
@@ -753,6 +753,7 @@ impl RoomSendQueue {
                 related_to: relates_to,
                 #[cfg(feature = "unstable-msc4274")]
                 accumulated,
+                filename,
             } => {
                 trace!(%relates_to, "uploading media related to event");
 
@@ -788,8 +789,11 @@ impl RoomSendQueue {
                         trace!("upload will be in clear text (room without encryption)");
                         let request_config = RequestConfig::short_retry()
                             .timeout(Media::reasonable_upload_timeout(&data));
-                        let res =
-                            room.client().media().upload(&mime, data, Some(request_config)).await?;
+                        let res = room
+                            .client()
+                            .media()
+                            .upload(&mime, data, filename, Some(request_config))
+                            .await?;
                         MediaSource::Plain(res.content_uri)
                     };
 
@@ -1279,10 +1283,25 @@ impl QueueStorage {
         let client = guard.client()?;
         let store = client.state_store();
 
+        let mut filename = match &event.msgtype {
+            MessageType::Image(msgtype) => msgtype.filename.clone(),
+            MessageType::Audio(msgtype) => msgtype.filename.clone(),
+            MessageType::Video(msgtype) => msgtype.filename.clone(),
+            MessageType::File(msgtype) => msgtype.filename.clone(),
+            _ => None,
+        };
+
+        // If there is no filename, use the `body` if it's not empty, since for media
+        // events with no captions it'll contain the filename
+        if filename.is_none() && !event.body().is_empty() {
+            filename = Some(event.body().to_owned());
+        }
+
         let thumbnail_info = self
             .push_thumbnail_and_media_uploads(
                 store,
                 &content_type,
+                filename,
                 send_event_txn.clone(),
                 created_at,
                 upload_file_txn.clone(),
@@ -1331,13 +1350,19 @@ impl QueueStorage {
             return Ok(());
         };
 
-        let GalleryItemQueueInfo { content_type, upload_file_txn, file_media_request, thumbnail } =
-            first;
+        let GalleryItemQueueInfo {
+            content_type,
+            upload_file_txn,
+            file_media_request,
+            filename,
+            thumbnail,
+        } = first;
 
         let thumbnail_info = self
             .push_thumbnail_and_media_uploads(
                 store,
                 content_type,
+                filename.clone(),
                 send_event_txn.clone(),
                 created_at,
                 upload_file_txn.clone(),
@@ -1356,6 +1381,7 @@ impl QueueStorage {
                 content_type,
                 upload_file_txn,
                 file_media_request,
+                filename,
                 thumbnail,
             } = item_queue_info;
 
@@ -1378,6 +1404,7 @@ impl QueueStorage {
                                 cache_key: thumbnail_media_request.clone(),
                                 related_to: send_event_txn.clone(),
                                 parent_is_thumbnail_upload: false,
+                                filename: filename.clone().map(|name| format!("thumbnail-{name}")),
                             },
                         )
                         .await?;
@@ -1401,6 +1428,7 @@ impl QueueStorage {
                         cache_key: file_media_request.clone(),
                         related_to: send_event_txn.clone(),
                         parent_is_thumbnail_upload: thumbnail.is_some(),
+                        filename: filename.clone(),
                     },
                 )
                 .await?;
@@ -1441,6 +1469,7 @@ impl QueueStorage {
         &self,
         store: &DynStateStore,
         content_type: &Mime,
+        filename: Option<String>,
         send_event_txn: OwnedTransactionId,
         created_at: MilliSecondsSinceUnixEpoch,
         upload_file_txn: OwnedTransactionId,
@@ -1463,6 +1492,7 @@ impl QueueStorage {
                         related_to: send_event_txn.clone(),
                         #[cfg(feature = "unstable-msc4274")]
                         accumulated: vec![],
+                        filename: filename.clone().map(|name| format!("thumbnail-{name}")),
                     },
                     Self::LOW_PRIORITY,
                 )
@@ -1481,6 +1511,7 @@ impl QueueStorage {
                         related_to: send_event_txn,
                         #[cfg(feature = "unstable-msc4274")]
                         parent_is_thumbnail_upload: true,
+                        filename,
                     },
                 )
                 .await?;
@@ -1500,6 +1531,7 @@ impl QueueStorage {
                         related_to: send_event_txn,
                         #[cfg(feature = "unstable-msc4274")]
                         accumulated: vec![],
+                        filename,
                     },
                     Self::LOW_PRIORITY,
                 )
@@ -1873,7 +1905,9 @@ impl QueueStorage {
                 related_to,
                 #[cfg(feature = "unstable-msc4274")]
                 parent_is_thumbnail_upload,
+                filename,
             } => {
+                warn!("Saving send queue request for filename {filename:?}");
                 let Some(parent_key) = parent_key else {
                     // Not finished yet, we should retry later => false.
                     return Ok(false);
@@ -1898,6 +1932,7 @@ impl QueueStorage {
                     cache_key,
                     related_to,
                     parent_is_thumbnail_upload,
+                    filename,
                 )
                 .await?;
             }
@@ -2039,6 +2074,7 @@ struct GalleryItemQueueInfo {
     content_type: Mime,
     upload_file_txn: OwnedTransactionId,
     file_media_request: MediaRequestParameters,
+    filename: Option<String>,
     thumbnail: Option<(FinishUploadThumbnailInfo, MediaRequestParameters, Mime)>,
 }
 

crates/matrix-sdk/src/send_queue/upload.rs

@@ -344,7 +344,7 @@ impl RoomSendQueue {
 
             item_types.push(Room::make_gallery_item_type(
                 &content_type,
-                filename,
+                filename.clone(),
                 file_media_request.source.clone(),
                 item_info.caption,
                 item_info.formatted_caption,
@@ -356,6 +356,7 @@ impl RoomSendQueue {
                 content_type,
                 upload_file_txn: upload_file_txn.clone(),
                 file_media_request,
+                filename: Some(filename),
                 thumbnail: queue_thumbnail_info,
             });
 
@@ -609,6 +610,7 @@ impl QueueStorage {
         cache_key: MediaRequestParameters,
         event_txn: OwnedTransactionId,
         parent_is_thumbnail_upload: bool,
+        filename: Option<String>,
     ) -> Result<(), RoomSendQueueError> {
         // The previous file or thumbnail has been sent, now transform the dependent
         // file or thumbnail upload request into a ready one.
@@ -657,6 +659,7 @@ impl QueueStorage {
             related_to: event_txn,
             #[cfg(feature = "unstable-msc4274")]
             accumulated,
+            filename,
         };
 
         client

crates/matrix-sdk/tests/integration/send_queue.rs

@@ -110,10 +110,18 @@ async fn queue_attachment_with_thumbnail(q: &RoomSendQueue) -> (SendHandle, &'st
 fn mock_jpeg_upload<'a>(
     mock: &'a MatrixMockServer,
     mxc: &MxcUri,
+    filename: Option<String>,
     lock: Arc<Mutex<()>>,
 ) -> MatrixMock<'a> {
     let mxc = mxc.to_owned();
-    mock.mock_upload().expect_mime_type("image/jpeg").respond_with(move |_req: &Request| {
+    let mut mocked_upload = mock.mock_upload().expect_mime_type("image/jpeg");
+    mocked_upload = if let Some(filename) = filename {
+        mocked_upload.expect_filename(&filename)
+    } else {
+        mocked_upload
+    };
+
+    mocked_upload.respond_with(move |_req: &Request| {
         // Wait for the signal from the main task that we can process this query.
         let mock_lock = lock.clone();
         std::thread::spawn(move || {
@@ -1903,14 +1911,19 @@ async fn test_media_uploads() {
     let allow_upload_lock = Arc::new(Mutex::new(()));
     let block_upload = allow_upload_lock.lock().await;
 
-    mock_jpeg_upload(&mock, mxc_uri!("mxc://sdk.rs/thumbnail"), allow_upload_lock.clone())
-        .mock_once()
-        .mount()
-        .await;
-    mock_jpeg_upload(&mock, mxc_uri!("mxc://sdk.rs/media"), allow_upload_lock.clone())
+    mock_jpeg_upload(&mock, mxc_uri!("mxc://sdk.rs/thumbnail"), None, allow_upload_lock.clone())
         .mock_once()
         .mount()
         .await;
+    mock_jpeg_upload(
+        &mock,
+        mxc_uri!("mxc://sdk.rs/media"),
+        Some(filename.to_owned()),
+        allow_upload_lock.clone(),
+    )
+    .mock_once()
+    .mount()
+    .await;
 
     // ----------------------
     // Send the media.
@@ -2200,22 +2213,42 @@ async fn test_gallery_uploads() {
     let allow_upload_lock = Arc::new(Mutex::new(()));
     let block_upload = allow_upload_lock.lock().await;
 
-    mock_jpeg_upload(&mock, mxc_uri!("mxc://sdk.rs/thumbnail1"), allow_upload_lock.clone())
-        .mock_once()
-        .mount()
-        .await;
-    mock_jpeg_upload(&mock, mxc_uri!("mxc://sdk.rs/media1"), allow_upload_lock.clone())
-        .mock_once()
-        .mount()
-        .await;
-    mock_jpeg_upload(&mock, mxc_uri!("mxc://sdk.rs/thumbnail2"), allow_upload_lock.clone())
-        .mock_once()
-        .mount()
-        .await;
-    mock_jpeg_upload(&mock, mxc_uri!("mxc://sdk.rs/media2"), allow_upload_lock.clone())
-        .mock_once()
-        .mount()
-        .await;
+    mock_jpeg_upload(
+        &mock,
+        mxc_uri!("mxc://sdk.rs/thumbnail1"),
+        None,
+        allow_upload_lock.clone(),
+    )
+    .mock_once()
+    .mount()
+    .await;
+    mock_jpeg_upload(
+        &mock,
+        mxc_uri!("mxc://sdk.rs/media1"),
+        Some(filename1.to_owned()),
+        allow_upload_lock.clone(),
+    )
+    .mock_once()
+    .mount()
+    .await;
+    mock_jpeg_upload(
+        &mock,
+        mxc_uri!("mxc://sdk.rs/thumbnail2"),
+        None,
+        allow_upload_lock.clone(),
+    )
+    .mock_once()
+    .mount()
+    .await;
+    mock_jpeg_upload(
+        &mock,
+        mxc_uri!("mxc://sdk.rs/media2"),
+        Some(filename2.to_owned()),
+        allow_upload_lock.clone(),
+    )
+    .mock_once()
+    .mount()
+    .await;
 
     // ----------------------
     // Send the media.