feat(send_queue): report progress for media uploads

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

@@ -303,6 +303,9 @@ struct QueueThumbnailInfo {
 
     /// The thumbnail's mime type.
     content_type: Mime,
+
+    /// The thumbnail's file size in bytes.
+    file_size: usize,
 }
 
 /// A specific room's send queue ran into an error, and it has disabled itself.
@@ -964,6 +967,10 @@ struct QueueStorage {
 
     /// To which room is this storage related.
     room_id: OwnedRoomId,
+
+    /// In-memory mapping of media transaction IDs to thumbnail sizes for the
+    /// purpose of progress reporting.
+    thumbnail_size_cache: Arc<Mutex<HashMap<OwnedTransactionId, Vec<Option<usize>>>>>,
 }
 
 impl QueueStorage {
@@ -975,7 +982,11 @@ impl QueueStorage {
 
     /// Create a new queue for queuing requests to be sent later.
     fn new(client: WeakClient, room: OwnedRoomId) -> Self {
-        Self { room_id: room, store: StoreLock { client, being_sent: Default::default() } }
+        Self {
+            room_id: room,
+            store: StoreLock { client, being_sent: Default::default() },
+            thumbnail_size_cache: Arc::new(Mutex::new(HashMap::new())),
+        }
     }
 
     /// Push a new event to be sent in the queue, with a default priority of 0.
@@ -1132,6 +1143,8 @@ impl QueueStorage {
             warn!(txn_id = %transaction_id, "request marked as sent was missing from storage");
         }
 
+        self.thumbnail_size_cache.lock().await.remove(transaction_id);
+
         Ok(())
     }
 
@@ -1172,6 +1185,8 @@ impl QueueStorage {
             .remove_send_queue_request(&self.room_id, transaction_id)
             .await?;
 
+        self.thumbnail_size_cache.lock().await.remove(transaction_id);
+
         Ok(removed)
     }
 
@@ -1234,6 +1249,8 @@ impl QueueStorage {
         let client = guard.client()?;
         let store = client.state_store();
 
+        let media_sizes = vec![thumbnail.as_ref().map(|t| t.file_size)];
+
         let thumbnail_info = self
             .push_thumbnail_and_media_uploads(
                 store,
@@ -1251,7 +1268,7 @@ impl QueueStorage {
             .save_dependent_queued_request(
                 &self.room_id,
                 &upload_file_txn,
-                send_event_txn.into(),
+                send_event_txn.clone().into(),
                 created_at,
                 DependentQueuedRequestKind::FinishUpload {
                     local_echo: Box::new(event),
@@ -1261,6 +1278,8 @@ impl QueueStorage {
             )
             .await?;
 
+        self.thumbnail_size_cache.lock().await.insert(send_event_txn, media_sizes);
+
         Ok(())
     }
 
@@ -1281,6 +1300,7 @@ impl QueueStorage {
         let store = client.state_store();
 
         let mut finish_item_infos = Vec::with_capacity(item_queue_infos.len());
+        let mut media_sizes = Vec::with_capacity(item_queue_infos.len());
 
         let Some((first, rest)) = item_queue_infos.split_first() else {
             return Ok(());
@@ -1303,6 +1323,7 @@ impl QueueStorage {
 
         finish_item_infos
             .push(FinishGalleryItemInfo { file_upload: upload_file_txn.clone(), thumbnail_info });
+        media_sizes.push(thumbnail.as_ref().map(|t| t.file_size));
 
         let mut last_upload_file_txn = upload_file_txn.clone();
 
@@ -1367,6 +1388,7 @@ impl QueueStorage {
                 file_upload: upload_file_txn.clone(),
                 thumbnail_info: thumbnail_info.cloned(),
             });
+            media_sizes.push(thumbnail.as_ref().map(|t| t.file_size));
 
             last_upload_file_txn = upload_file_txn.clone();
         }
@@ -1377,7 +1399,7 @@ impl QueueStorage {
             .save_dependent_queued_request(
                 &self.room_id,
                 &last_upload_file_txn,
-                send_event_txn.into(),
+                send_event_txn.clone().into(),
                 created_at,
                 DependentQueuedRequestKind::FinishGallery {
                     local_echo: Box::new(event),
@@ -1386,6 +1408,8 @@ impl QueueStorage {
             )
             .await?;
 
+        self.thumbnail_size_cache.lock().await.insert(send_event_txn, media_sizes);
+
         Ok(())
     }
 

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

@@ -445,6 +445,7 @@ impl RoomSendQueue {
             // Create the information required for filling the thumbnail section of the
             // event.
             let (data, content_type, thumbnail_info) = thumbnail.into_parts();
+            let file_size = data.len();
 
             // Cache thumbnail in the cache store.
             let thumbnail_media_request = Media::make_local_file_media_request(&txn);
@@ -472,6 +473,7 @@ impl RoomSendQueue {
                     },
                     media_request_parameters: thumbnail_media_request,
                     content_type,
+                    file_size,
                 }),
             })
         } else {