refactor!(media): inline MediaThumbnailSize into `MediaThumbnailSet…

…tings` Changelog: all the fields of `MediaThumbnailSize` have been inlined into `MediaThumbnailSettings`, and the former type has been removed.
matrix-org · Nov 6, 2024 · 566a13b · 566a13b
1 parent 4bbe620
commit 566a13b
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 57 deletions.
diff --git a/crates/matrix-sdk-base/src/media.rs b/crates/matrix-sdk-base/src/media.rs
@@ -44,9 +44,9 @@ impl UniqueKey for MediaFormat {
     }
 }
 
-/// The requested size of a media thumbnail.
+/// The desired settings of a media thumbnail.
 #[derive(Clone, Debug, Serialize, Deserialize)]
-pub struct MediaThumbnailSize {
+pub struct MediaThumbnailSettings {
     /// The desired resizing method.
     pub method: Method,
 
@@ -57,19 +57,6 @@ pub struct MediaThumbnailSize {
     /// The desired height of the thumbnail. The actual thumbnail may not match
     /// the size specified.
     pub height: UInt,
-}
-
-impl UniqueKey for MediaThumbnailSize {
-    fn unique_key(&self) -> String {
-        format!("{}{UNIQUE_SEPARATOR}{}x{}", self.method, self.width, self.height)
-    }
-}
-
-/// The desired settings of a media thumbnail.
-#[derive(Clone, Debug, Serialize, Deserialize)]
-pub struct MediaThumbnailSettings {
-    /// The desired size of the thumbnail.
-    pub size: MediaThumbnailSize,
 
     /// If we want to request an animated thumbnail from the homeserver.
     ///
@@ -84,13 +71,13 @@ impl MediaThumbnailSettings {
     /// Constructs a new `MediaThumbnailSettings` with the given method, width
     /// and height.
     pub fn new(method: Method, width: UInt, height: UInt) -> Self {
-        Self { size: MediaThumbnailSize { method, width, height }, animated: false }
+        Self { method, width, height, animated: false }
     }
 }
 
 impl UniqueKey for MediaThumbnailSettings {
     fn unique_key(&self) -> String {
-        let mut key = self.size.unique_key();
+        let mut key = format!("{}{UNIQUE_SEPARATOR}{}x{}", self.method, self.width, self.height);
 
         if self.animated {
             key.push_str(UNIQUE_SEPARATOR);

diff --git a/crates/matrix-sdk/src/media.rs b/crates/matrix-sdk/src/media.rs
@@ -437,16 +437,17 @@ impl Media {
 
                 content
             }
+
             MediaSource::Plain(uri) => {
                 if let MediaFormat::Thumbnail(settings) = &request.format {
                     if use_auth {
                         let mut request =
                             authenticated_media::get_content_thumbnail::v1::Request::from_uri(
                                 uri,
-                                settings.size.width,
-                                settings.size.height,
+                                settings.width,
+                                settings.height,
                             )?;
-                        request.method = Some(settings.size.method.clone());
+                        request.method = Some(settings.method.clone());
                         request.animated = Some(settings.animated);
 
                         self.client.send(request, request_config).await?.file
@@ -455,10 +456,10 @@ impl Media {
                         let request = {
                             let mut request = media::get_content_thumbnail::v3::Request::from_url(
                                 uri,
-                                settings.size.width,
-                                settings.size.height,
+                                settings.width,
+                                settings.height,
                             )?;
-                            request.method = Some(settings.size.method.clone());
+                            request.method = Some(settings.method.clone());
                             request.animated = Some(settings.animated);
                             request
                         };

diff --git a/crates/matrix-sdk/src/room/mod.rs b/crates/matrix-sdk/src/room/mod.rs
@@ -41,7 +41,7 @@ use matrix_sdk_base::{
     deserialized_responses::{
         RawAnySyncOrStrippedState, RawSyncOrStrippedState, SyncOrStrippedState, TimelineEvent,
     },
-    media::{MediaThumbnailSettings, MediaThumbnailSize},
+    media::MediaThumbnailSettings,
     store::StateStoreExt,
     ComposerDraft, RoomInfoNotableUpdateReasons, RoomMemberships, StateChanges, StateStoreDataKey,
     StateStoreDataValue,
@@ -2010,11 +2010,9 @@ impl Room {
                 let request = MediaRequest {
                     source: source.clone(),
                     format: MediaFormat::Thumbnail(MediaThumbnailSettings {
-                        size: MediaThumbnailSize {
-                            method: ruma::media::Method::Scale,
-                            width,
-                            height,
-                        },
+                        method: ruma::media::Method::Scale,
+                        width,
+                        height,
                         animated: false,
                     }),
                 };

diff --git a/crates/matrix-sdk/src/send_queue/upload.rs b/crates/matrix-sdk/src/send_queue/upload.rs
@@ -15,7 +15,7 @@
 //! Private implementations of the media upload mechanism.
 
 use matrix_sdk_base::{
-    media::{MediaFormat, MediaRequest, MediaThumbnailSettings, MediaThumbnailSize},
+    media::{MediaFormat, MediaRequest, MediaThumbnailSettings},
     store::{
         ChildTransactionId, FinishUploadThumbnailInfo, QueuedRequestKind, SentMediaInfo,
         SentRequestKey, SerializableEventContent,
@@ -76,7 +76,9 @@ fn make_local_thumbnail_media_request(
     let source =
         MediaSource::Plain(OwnedMxcUri::from(format!("mxc://send-queue.localhost/{}", txn_id)));
     let format = MediaFormat::Thumbnail(MediaThumbnailSettings {
-        size: MediaThumbnailSize { method: Method::Scale, width, height },
+        method: Method::Scale,
+        width,
+        height,
         animated: false,
     });
     MediaRequest { source, format }

diff --git a/crates/matrix-sdk/tests/integration/media.rs b/crates/matrix-sdk/tests/integration/media.rs
@@ -1,7 +1,7 @@
 use matrix_sdk::{
     config::RequestConfig,
     matrix_auth::{MatrixSession, MatrixSessionTokens},
-    media::{MediaFormat, MediaRequest, MediaThumbnailSettings, MediaThumbnailSize},
+    media::{MediaFormat, MediaRequest, MediaThumbnailSettings},
     test_utils::logged_in_client_with_server,
     Client, SessionMeta,
 };
@@ -183,7 +183,9 @@ async fn test_get_media_file_no_auth() {
         .await;
 
     let settings = MediaThumbnailSettings {
-        size: MediaThumbnailSize { method: Method::Crop, width: uint!(100), height: uint!(100) },
+        method: Method::Crop,
+        width: uint!(100),
+        height: uint!(100),
         animated: true,
     };
     client.media().get_thumbnail(&event_content, settings, true).await.unwrap();
@@ -293,7 +295,9 @@ async fn test_get_media_file_with_auth_matrix_1_11() {
         .await;
 
     let settings = MediaThumbnailSettings {
-        size: MediaThumbnailSize { method: Method::Crop, width: uint!(100), height: uint!(100) },
+        method: Method::Crop,
+        width: uint!(100),
+        height: uint!(100),
         animated: true,
     };
     client.media().get_thumbnail(&event_content, settings, true).await.unwrap();
@@ -406,7 +410,9 @@ async fn test_get_media_file_with_auth_matrix_stable_feature() {
         .await;
 
     let settings = MediaThumbnailSettings {
-        size: MediaThumbnailSize { method: Method::Crop, width: uint!(100), height: uint!(100) },
+        method: Method::Crop,
+        width: uint!(100),
+        height: uint!(100),
         animated: true,
     };
     client.media().get_thumbnail(&event_content, settings, true).await.unwrap();

diff --git a/crates/matrix-sdk/tests/integration/room/attachment/mod.rs b/crates/matrix-sdk/tests/integration/room/attachment/mod.rs
@@ -6,7 +6,7 @@ use matrix_sdk::{
         Thumbnail,
     },
     config::SyncSettings,
-    media::{MediaFormat, MediaRequest, MediaThumbnailSettings, MediaThumbnailSize},
+    media::{MediaFormat, MediaRequest, MediaThumbnailSettings},
     test_utils::logged_in_client_with_server,
 };
 use matrix_sdk_test::{async_test, mocks::mock_encryption_state, test_json, DEFAULT_TEST_ROOM_ID};
@@ -249,11 +249,9 @@ async fn test_room_attachment_send_info_thumbnail() {
     let thumbnail_request = MediaRequest {
         source: MediaSource::Plain(thumbnail_mxc.clone()),
         format: MediaFormat::Thumbnail(MediaThumbnailSettings {
-            size: MediaThumbnailSize {
-                method: ruma::media::Method::Scale,
-                width: uint!(480),
-                height: uint!(360),
-            },
+            method: ruma::media::Method::Scale,
+            width: uint!(480),
+            height: uint!(360),
             animated: false,
         }),
     };
@@ -312,11 +310,9 @@ async fn test_room_attachment_send_info_thumbnail() {
     let thumbnail_request = MediaRequest {
         source: MediaSource::Plain(thumbnail_mxc),
         format: MediaFormat::Thumbnail(MediaThumbnailSettings {
-            size: MediaThumbnailSize {
-                method: ruma::media::Method::Scale,
-                width: uint!(42),
-                height: uint!(1337),
-            },
+            method: ruma::media::Method::Scale,
+            width: uint!(42),
+            height: uint!(1337),
             animated: false,
         }),
     };

diff --git a/crates/matrix-sdk/tests/integration/send_queue.rs b/crates/matrix-sdk/tests/integration/send_queue.rs
@@ -11,7 +11,7 @@ use assert_matches2::{assert_let, assert_matches};
 use matrix_sdk::{
     attachment::{AttachmentConfig, AttachmentInfo, BaseImageInfo, BaseThumbnailInfo, Thumbnail},
     config::{RequestConfig, StoreConfig},
-    media::{MediaFormat, MediaRequest, MediaThumbnailSettings, MediaThumbnailSize},
+    media::{MediaFormat, MediaRequest, MediaThumbnailSettings},
     send_queue::{
         LocalEcho, LocalEchoContent, RoomSendQueueError, RoomSendQueueStorageError,
         RoomSendQueueUpdate,
@@ -2150,11 +2150,9 @@ async fn test_media_uploads() {
                 // TODO: extract this reasonable query into a helper function shared across the
                 // codebase
                 format: MediaFormat::Thumbnail(MediaThumbnailSettings {
-                    size: MediaThumbnailSize {
-                        height: tinfo.height.unwrap(),
-                        width: tinfo.width.unwrap(),
-                        method: Method::Scale,
-                    },
+                    height: tinfo.height.unwrap(),
+                    width: tinfo.width.unwrap(),
+                    method: Method::Scale,
                     animated: false,
                 }),
             },
@@ -2224,11 +2222,9 @@ async fn test_media_uploads() {
                 // TODO: extract this reasonable query into a helper function shared across the
                 // codebase
                 format: MediaFormat::Thumbnail(MediaThumbnailSettings {
-                    size: MediaThumbnailSize {
-                        height: tinfo.height.unwrap(),
-                        width: tinfo.width.unwrap(),
-                        method: Method::Scale,
-                    },
+                    height: tinfo.height.unwrap(),
+                    width: tinfo.width.unwrap(),
+                    method: Method::Scale,
                     animated: false,
                 }),
             },