chore(send_queue): collect thumbnail-related metadata in a dedicated QueueThumbnailInfo struct for easier extension

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>

Author: Johennes

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

@@ -291,6 +291,20 @@ impl SendQueue {
     }
 }
 
+/// Metadata about a thumbnail needed when pushing media uploads to the send
+/// queue.
+#[derive(Clone, Debug)]
+struct QueueThumbnailInfo {
+    /// Metadata about the thumbnail needed when finishing a media upload.
+    finish_upload_thumbnail_info: FinishUploadThumbnailInfo,
+
+    /// The parameters for the request to retrieve the thumbnail data.
+    media_request_parameters: MediaRequestParameters,
+
+    /// The thumbnail's mime type.
+    content_type: Mime,
+}
+
 /// A specific room's send queue ran into an error, and it has disabled itself.
 #[derive(Clone, Debug)]
 pub struct SendQueueRoomError {
@@ -1214,7 +1228,7 @@ impl QueueStorage {
         created_at: MilliSecondsSinceUnixEpoch,
         upload_file_txn: OwnedTransactionId,
         file_media_request: MediaRequestParameters,
-        thumbnail: Option<(FinishUploadThumbnailInfo, MediaRequestParameters, Mime)>,
+        thumbnail: Option<QueueThumbnailInfo>,
     ) -> Result<(), RoomSendQueueStorageError> {
         let guard = self.store.lock().await;
         let client = guard.client()?;
@@ -1300,35 +1314,38 @@ impl QueueStorage {
                 thumbnail,
             } = item_queue_info;
 
-            let thumbnail_info =
-                if let Some((thumbnail_info, thumbnail_media_request, thumbnail_content_type)) =
-                    thumbnail
-                {
-                    let upload_thumbnail_txn = thumbnail_info.txn.clone();
+            let thumbnail_info = if let Some(QueueThumbnailInfo {
+                finish_upload_thumbnail_info: thumbnail_info,
+                media_request_parameters: thumbnail_media_request,
+                content_type: thumbnail_content_type,
+                ..
+            }) = thumbnail
+            {
+                let upload_thumbnail_txn = thumbnail_info.txn.clone();
 
-                    // Save the thumbnail upload request as a dependent request of the last file
-                    // upload.
-                    store
-                        .save_dependent_queued_request(
-                            &self.room_id,
-                            &last_upload_file_txn,
-                            upload_thumbnail_txn.clone().into(),
-                            created_at,
-                            DependentQueuedRequestKind::UploadFileOrThumbnail {
-                                content_type: thumbnail_content_type.to_string(),
-                                cache_key: thumbnail_media_request.clone(),
-                                related_to: send_event_txn.clone(),
-                                parent_is_thumbnail_upload: false,
-                            },
-                        )
-                        .await?;
+                // Save the thumbnail upload request as a dependent request of the last file
+                // upload.
+                store
+                    .save_dependent_queued_request(
+                        &self.room_id,
+                        &last_upload_file_txn,
+                        upload_thumbnail_txn.clone().into(),
+                        created_at,
+                        DependentQueuedRequestKind::UploadFileOrThumbnail {
+                            content_type: thumbnail_content_type.to_string(),
+                            cache_key: thumbnail_media_request.clone(),
+                            related_to: send_event_txn.clone(),
+                            parent_is_thumbnail_upload: false,
+                        },
+                    )
+                    .await?;
 
-                    last_upload_file_txn = upload_thumbnail_txn;
+                last_upload_file_txn = upload_thumbnail_txn;
 
-                    Some(thumbnail_info)
-                } else {
-                    None
-                };
+                Some(thumbnail_info)
+            } else {
+                None
+            };
 
             // Save the file upload as a dependent request of the previous upload.
             store
@@ -1386,9 +1403,15 @@ impl QueueStorage {
         created_at: MilliSecondsSinceUnixEpoch,
         upload_file_txn: OwnedTransactionId,
         file_media_request: MediaRequestParameters,
-        thumbnail: Option<(FinishUploadThumbnailInfo, MediaRequestParameters, Mime)>,
+        thumbnail: Option<QueueThumbnailInfo>,
     ) -> Result<Option<FinishUploadThumbnailInfo>, RoomSendQueueStorageError> {
-        if let Some((thumbnail_info, thumbnail_media_request, thumbnail_content_type)) = thumbnail {
+        if let Some(QueueThumbnailInfo {
+            finish_upload_thumbnail_info: thumbnail_info,
+            media_request_parameters: thumbnail_media_request,
+            content_type: thumbnail_content_type,
+            ..
+        }) = thumbnail
+        {
             let upload_thumbnail_txn = thumbnail_info.txn.clone();
 
             // Save the thumbnail upload request.
@@ -1980,7 +2003,7 @@ struct GalleryItemQueueInfo {
     content_type: Mime,
     upload_file_txn: OwnedTransactionId,
     file_media_request: MediaRequestParameters,
-    thumbnail: Option<(FinishUploadThumbnailInfo, MediaRequestParameters, Mime)>,
+    thumbnail: Option<QueueThumbnailInfo>,
 }
 
 /// The content of a local echo.

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

@@ -46,7 +46,7 @@ use ruma::{
 };
 use tracing::{debug, error, instrument, trace, warn, Span};
 
-use super::{QueueStorage, RoomSendQueue, RoomSendQueueError};
+use super::{QueueStorage, QueueThumbnailInfo, RoomSendQueue, RoomSendQueueError};
 use crate::{
     attachment::{AttachmentConfig, Thumbnail},
     room::edit::update_media_caption,
@@ -170,7 +170,7 @@ fn update_gallery_event_after_upload(
 struct MediaCacheResult {
     upload_thumbnail_txn: Option<OwnedTransactionId>,
     event_thumbnail_info: Option<(MediaSource, Box<ThumbnailInfo>)>,
-    queue_thumbnail_info: Option<(FinishUploadThumbnailInfo, MediaRequestParameters, Mime)>,
+    queue_thumbnail_info: Option<QueueThumbnailInfo>,
 }
 
 impl RoomSendQueue {
@@ -464,11 +464,15 @@ impl RoomSendQueue {
                     thumbnail_media_request.source.clone(),
                     thumbnail_info,
                 )),
-                queue_thumbnail_info: Some((
-                    FinishUploadThumbnailInfo { txn, width: None, height: None },
-                    thumbnail_media_request,
+                queue_thumbnail_info: Some(QueueThumbnailInfo {
+                    finish_upload_thumbnail_info: FinishUploadThumbnailInfo {
+                        txn,
+                        width: None,
+                        height: None,
+                    },
+                    media_request_parameters: thumbnail_media_request,
                     content_type,
-                )),
+                }),
             })
         } else {
             Ok(Default::default())