Report the combined upload progress across thumbnail and media as a percentage

Author: Johennes

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

@@ -224,6 +224,19 @@ impl From<matrix_sdk::TransmissionProgress> for TransmissionProgress {
     }
 }
 
+/// Progress of sending or receiving a payload in percent.
+#[derive(Clone, Copy, uniffi::Record)]
+pub struct RelativeTransmissionProgress {
+    /// The completion percentage as a number between 0 and 1.
+    pub percentage: f32,
+}
+
+impl From<matrix_sdk::RelativeTransmissionProgress> for RelativeTransmissionProgress {
+    fn from(value: matrix_sdk::RelativeTransmissionProgress) -> Self {
+        Self { percentage: value.percentage }
+    }
+}
+
 #[derive(uniffi::Object)]
 pub struct Client {
     pub(crate) inner: AsyncRuntimeDropped<MatrixClient>,

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

@@ -67,7 +67,7 @@ use uuid::Uuid;
 use self::content::TimelineItemContent;
 pub use self::msg_like::MessageContent;
 use crate::{
-    client::{ProgressWatcher, TransmissionProgress},
+    client::{ProgressWatcher, RelativeTransmissionProgress},
     error::{ClientError, RoomError},
     event::EventOrTransactionId,
     helpers::unwrap_or_clone_arc,
@@ -280,19 +280,17 @@ pub enum EventSendProgress {
         /// thumbnail share the same index.
         index: u64,
 
-        /// Is the media a thumbnail?
-        is_thumbnail: bool,
-
-        /// The current upload progress.
-        progress: TransmissionProgress,
+        /// The current combined upload progress for both the file and,
+        /// if it exists, its thumbnail.
+        progress: RelativeTransmissionProgress,
     },
 }
 
 impl From<SdkEventSendProgress> for EventSendProgress {
     fn from(value: SdkEventSendProgress) -> Self {
         match value {
-            SdkEventSendProgress::MediaUpload { index, is_thumbnail, progress } => {
-                Self::MediaUpload { index, is_thumbnail, progress: progress.into() }
+            SdkEventSendProgress::MediaUpload { index, progress } => {
+                Self::MediaUpload { index, progress: progress.into() }
             }
         }
     }

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

@@ -110,9 +110,21 @@ pub enum QueuedRequestKind {
         #[serde(default)]
         accumulated: Vec<AccumulatedSentMediaInfo>,
 
-        /// Is this a thumbnail upload?
-        #[serde(default = "default_is_thumbnail")]
-        is_thumbnail: bool,
+        /// The number of bytes in the unencrypted file (or thumbnail) to be
+        /// uploaded by this request.
+        #[serde(default)]
+        file_size: usize,
+
+        /// If this is a media file upload and a related thumbnail was
+        /// previously, uploaded, the number of bytes in the unencrypted
+        /// thumbnail.
+        #[serde(default)]
+        thumbnail_file_size: Option<usize>,
+
+        /// If this is a thumbnail upload, the number of bytes in the
+        /// unencrypted media file to be uploaded subsequently.
+        #[serde(default)]
+        media_file_size: Option<usize>,
     },
 }
 
@@ -247,9 +259,21 @@ pub enum DependentQueuedRequestKind {
         #[serde(default = "default_parent_is_thumbnail_upload")]
         parent_is_thumbnail_upload: bool,
 
-        /// Is this a thumbnail upload?
-        #[serde(default = "default_is_thumbnail")]
-        is_thumbnail: bool,
+        /// The number of bytes in the unencrypted file (or thumbnail) to be
+        /// uploaded by this request.
+        #[serde(default)]
+        file_size: usize,
+
+        /// If this is a media file upload and a related thumbnail was
+        /// previously, uploaded, the number of bytes in the unencrypted
+        /// thumbnail.
+        #[serde(default)]
+        thumbnail_file_size: Option<usize>,
+
+        /// If this is a thumbnail upload, the number of bytes in the
+        /// unencrypted media file to be uploaded subsequently.
+        #[serde(default)]
+        media_file_size: Option<usize>,
     },
 
     /// Finish an upload by updating references to the media cache and sending
@@ -289,12 +313,6 @@ fn default_parent_is_thumbnail_upload() -> bool {
     true
 }
 
-/// We don't really have a way to infer the value if it hasn't been set on an
-/// old request, so we just default to false.
-fn default_is_thumbnail() -> bool {
-    false
-}
-
 /// Detailed record about a thumbnail used when finishing a media upload.
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct FinishUploadThumbnailInfo {

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

@@ -1340,17 +1340,11 @@ impl<P: RoomDataProvider, D: Decryptor> TimelineController<P, D> {
                     .await;
             }
 
-            RoomSendQueueUpdate::MediaUpload {
-                related_to, index, is_thumbnail, progress, ..
-            } => {
+            RoomSendQueueUpdate::MediaUpload { related_to, index, progress, .. } => {
                 self.update_event_send_state(
                     &related_to,
                     EventSendState::NotSentYet {
-                        progress: Some(EventSendProgress::MediaUpload {
-                            index,
-                            is_thumbnail,
-                            progress,
-                        }),
+                        progress: Some(EventSendProgress::MediaUpload { index, progress }),
                     },
                 )
                 .await;

crates/matrix-sdk-ui/src/timeline/event_item/local.rs

@@ -15,7 +15,7 @@
 use std::sync::Arc;
 
 use as_variant::as_variant;
-use matrix_sdk::{send_queue::SendHandle, Error, TransmissionProgress};
+use matrix_sdk::{send_queue::SendHandle, Error, RelativeTransmissionProgress};
 use ruma::{EventId, OwnedEventId, OwnedTransactionId};
 
 use super::TimelineEventItemId;
@@ -97,10 +97,8 @@ pub enum EventSendProgress {
         /// thumbnail share the same index.
         index: u64,
 
-        /// Is the media a thumbnail?
-        is_thumbnail: bool,
-
-        /// The current upload progress.
-        progress: TransmissionProgress,
+        /// The current combined upload progress for both the file and,
+        /// if it exists, its thumbnail.
+        progress: RelativeTransmissionProgress,
     },
 }

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

@@ -231,6 +231,13 @@ pub struct TransmissionProgress {
     pub total: usize,
 }
 
+/// Progress of sending or receiving a payload in percent.
+#[derive(Clone, Copy, Debug, Default)]
+pub struct RelativeTransmissionProgress {
+    /// The completion percentage as a number between 0 and 1.
+    pub percentage: f32,
+}
+
 async fn response_to_http_response(
     mut response: reqwest::Response,
 ) -> Result<http::Response<Bytes>, reqwest::Error> {

crates/matrix-sdk/src/lib.rs

@@ -72,7 +72,7 @@ pub use error::{
     Error, HttpError, HttpResult, NotificationSettingsError, RefreshTokenError, Result,
     RumaApiError,
 };
-pub use http_client::TransmissionProgress;
+pub use http_client::{RelativeTransmissionProgress, TransmissionProgress};
 #[cfg(all(feature = "e2e-encryption", feature = "sqlite"))]
 pub use matrix_sdk_sqlite::SqliteCryptoStore;
 #[cfg(feature = "sqlite")]