refactor: Wrap EncryptionInfo in Arc

It's >100 bytes large and often optional, so it makes sense to put it
on the heap to reduce the size of structs with such optional fields,
and the stack size of functions with such optional parameters.
It's also cloned in a couple places in the UI crate, so it probably
makes sense to just always refcount it.

This started as a clippy suggestion to box PendingEdit inside
AggregationKind::Edit.

Author: jplatte

Cargo.toml

@@ -79,7 +79,7 @@ ruma = { git = "https://github.com/ruma/ruma", rev = "b4941a991919685345646a230b
 ruma-common = { git = "https://github.com/ruma/ruma", rev = "b4941a991919685345646a230b05b985338ec3f8" }
 sentry = "0.36.0"
 sentry-tracing = "0.36.0"
-serde = "1.0.217"
+serde = { version = "1.0.217", features = ["rc"] }
 serde_html_form = "0.2.7"
 serde_json = "1.0.138"
 sha2 = "0.10.8"

crates/matrix-sdk-base/src/event_cache/store/integration_tests.rs

@@ -14,6 +14,8 @@
 
 //! Trait and macro of integration tests for `EventCacheStore` implementations.
 
+use std::sync::Arc;
+
 use assert_matches::assert_matches;
 use matrix_sdk_common::{
     deserialized_responses::{
@@ -55,7 +57,7 @@ pub fn make_test_event_with_event_id(
     content: &str,
     event_id: Option<&EventId>,
 ) -> TimelineEvent {
-    let encryption_info = EncryptionInfo {
+    let encryption_info = Arc::new(EncryptionInfo {
         sender: (*ALICE).into(),
         sender_device: None,
         algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
@@ -64,7 +66,7 @@ pub fn make_test_event_with_event_id(
             session_id: Some("mysessionid9".to_owned()),
         },
         verification_state: VerificationState::Verified,
-    };
+    });
 
     let mut builder = EventFactory::new().text_msg(content).room(room_id).sender(*ALICE);
     if let Some(event_id) = event_id {

crates/matrix-sdk-common/src/deserialized_responses.rs

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use std::{collections::BTreeMap, fmt};
+use std::{collections::BTreeMap, fmt, sync::Arc};
 
 #[cfg(doc)]
 use ruma::events::AnyTimelineEvent;
@@ -462,7 +462,7 @@ impl TimelineEvent {
 
     /// If the event was a decrypted event that was successfully decrypted, get
     /// its encryption info. Otherwise, `None`.
-    pub fn encryption_info(&self) -> Option<&EncryptionInfo> {
+    pub fn encryption_info(&self) -> Option<&Arc<EncryptionInfo>> {
         self.kind.encryption_info()
     }
 
@@ -569,7 +569,7 @@ impl TimelineEventKind {
 
     /// If the event was a decrypted event that was successfully decrypted, get
     /// its encryption info. Otherwise, `None`.
-    pub fn encryption_info(&self) -> Option<&EncryptionInfo> {
+    pub fn encryption_info(&self) -> Option<&Arc<EncryptionInfo>> {
         match self {
             TimelineEventKind::Decrypted(d) => Some(&d.encryption_info),
             TimelineEventKind::UnableToDecrypt { .. } | TimelineEventKind::PlainText { .. } => None,
@@ -649,7 +649,7 @@ pub struct DecryptedRoomEvent {
     pub event: Raw<AnyMessageLikeEvent>,
 
     /// The encryption info about the event.
-    pub encryption_info: EncryptionInfo,
+    pub encryption_info: Arc<EncryptionInfo>,
 
     /// The encryption info about the events bundled in the `unsigned`
     /// object.
@@ -706,15 +706,15 @@ impl UnsignedEventLocation {
 #[derive(Debug, Clone, Serialize, Deserialize)]
 pub enum UnsignedDecryptionResult {
     /// The event was successfully decrypted.
-    Decrypted(EncryptionInfo),
+    Decrypted(Arc<EncryptionInfo>),
     /// The event failed to be decrypted.
     UnableToDecrypt(UnableToDecryptInfo),
 }
 
 impl UnsignedDecryptionResult {
     /// Returns the encryption info for this bundled event if it was
     /// successfully decrypted.
-    pub fn encryption_info(&self) -> Option<&EncryptionInfo> {
+    pub fn encryption_info(&self) -> Option<&Arc<EncryptionInfo>> {
         match self {
             Self::Decrypted(info) => Some(info),
             Self::UnableToDecrypt(_) => None,
@@ -918,9 +918,10 @@ struct SyncTimelineEventDeserializationHelperV0 {
     /// The actual event.
     event: Raw<AnySyncTimelineEvent>,
 
-    /// The encryption info about the event. Will be `None` if the event
-    /// was not encrypted.
-    encryption_info: Option<EncryptionInfo>,
+    /// The encryption info about the event.
+    ///
+    /// Will be `None` if the event was not encrypted.
+    encryption_info: Option<Arc<EncryptionInfo>>,
 
     /// The push actions associated with this event.
     #[serde(default)]
@@ -966,7 +967,7 @@ impl From<SyncTimelineEventDeserializationHelperV0> for TimelineEvent {
 
 #[cfg(test)]
 mod tests {
-    use std::collections::BTreeMap;
+    use std::{collections::BTreeMap, sync::Arc};
 
     use assert_matches::assert_matches;
     use insta::{assert_json_snapshot, with_settings};
@@ -1118,7 +1119,7 @@ mod tests {
         let room_event = TimelineEvent {
             kind: TimelineEventKind::Decrypted(DecryptedRoomEvent {
                 event: Raw::new(&example_event()).unwrap().cast(),
-                encryption_info: EncryptionInfo {
+                encryption_info: Arc::new(EncryptionInfo {
                     sender: user_id!("@sender:example.com").to_owned(),
                     sender_device: None,
                     algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
@@ -1127,7 +1128,7 @@ mod tests {
                         session_id: Some("xyz".to_owned()),
                     },
                     verification_state: VerificationState::Verified,
-                },
+                }),
                 unsigned_encryption_info: Some(BTreeMap::from([(
                     UnsignedEventLocation::RelationsReplace,
                     UnsignedDecryptionResult::UnableToDecrypt(UnableToDecryptInfo {
@@ -1490,7 +1491,7 @@ mod tests {
         let room_event = TimelineEvent {
             kind: TimelineEventKind::Decrypted(DecryptedRoomEvent {
                 event: Raw::new(&example_event()).unwrap().cast(),
-                encryption_info: EncryptionInfo {
+                encryption_info: Arc::new(EncryptionInfo {
                     sender: user_id!("@sender:example.com").to_owned(),
                     sender_device: Some(device_id!("ABCDEFGHIJ").to_owned()),
                     algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
@@ -1508,7 +1509,7 @@ mod tests {
                         session_id: Some("mysessionid112".to_owned()),
                     },
                     verification_state: VerificationState::Verified,
-                },
+                }),
                 unsigned_encryption_info: Some(BTreeMap::from([(
                     UnsignedEventLocation::RelationsThreadLatestEvent,
                     UnsignedDecryptionResult::UnableToDecrypt(UnableToDecryptInfo {

crates/matrix-sdk-crypto/src/machine/mod.rs

@@ -1760,13 +1760,13 @@ impl OlmMachine {
         &self,
         session: &InboundGroupSession,
         sender: &UserId,
-    ) -> MegolmResult<EncryptionInfo> {
+    ) -> MegolmResult<Arc<EncryptionInfo>> {
         let (verification_state, device_id) =
             self.get_or_update_verification_state(session, sender).await?;
 
         let sender = sender.to_owned();
 
-        Ok(EncryptionInfo {
+        Ok(Arc::new(EncryptionInfo {
             sender,
             sender_device: device_id,
             algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
@@ -1779,7 +1779,7 @@ impl OlmMachine {
                 session_id: Some(session.session_id().to_owned()),
             },
             verification_state,
-        })
+        }))
     }
 
     async fn decrypt_megolm_events(
@@ -1788,7 +1788,7 @@ impl OlmMachine {
         event: &EncryptedEvent,
         content: &SupportedEventEncryptionSchemes<'_>,
         decryption_settings: &DecryptionSettings,
-    ) -> MegolmResult<(JsonObject, EncryptionInfo)> {
+    ) -> MegolmResult<(JsonObject, Arc<EncryptionInfo>)> {
         let session =
             self.get_inbound_group_session_or_error(room_id, content.session_id()).await?;
 
@@ -2200,7 +2200,7 @@ impl OlmMachine {
         &self,
         event: &Raw<EncryptedEvent>,
         room_id: &RoomId,
-    ) -> MegolmResult<EncryptionInfo> {
+    ) -> MegolmResult<Arc<EncryptionInfo>> {
         let event = event.deserialize()?;
 
         let content: SupportedEventEncryptionSchemes<'_> = match &event.content.scheme {
@@ -2233,7 +2233,7 @@ impl OlmMachine {
         room_id: &RoomId,
         session_id: &str,
         sender: &UserId,
-    ) -> MegolmResult<EncryptionInfo> {
+    ) -> MegolmResult<Arc<EncryptionInfo>> {
         let session = self.get_inbound_group_session_or_error(room_id, session_id).await?;
         self.get_encryption_info(&session, sender).await
     }

crates/matrix-sdk-crypto/src/machine/tests/mod.rs

@@ -443,12 +443,12 @@ async fn test_session_encryption_info_can_be_fetched() {
 
     // Then the expected info is returned
     assert_eq!(encryption_info.sender, alice_id());
-    assert_eq!(encryption_info.sender_device.unwrap(), alice_device_id());
+    assert_eq!(encryption_info.sender_device.as_deref(), Some(alice_device_id()));
     assert_matches!(
-        encryption_info.algorithm_info,
+        &encryption_info.algorithm_info,
         AlgorithmInfo::MegolmV1AesSha2 { curve25519_key, .. }
     );
-    assert_eq!(curve25519_key, alice_session.sender_key().to_string());
+    assert_eq!(*curve25519_key, alice_session.sender_key().to_string());
     assert_eq!(
         encryption_info.verification_state,
         VerificationState::Unverified(VerificationLevel::UnsignedDevice)

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

@@ -37,7 +37,7 @@
 //! to cater for the first use case, and to never lose any aggregations in the
 //! second use case.
 
-use std::{borrow::Cow, collections::HashMap};
+use std::{borrow::Cow, collections::HashMap, sync::Arc};
 
 use as_variant::as_variant;
 use matrix_sdk::deserialized_responses::EncryptionInfo;
@@ -82,7 +82,7 @@ pub(in crate::timeline) struct PendingEdit {
     pub edit_json: Option<Raw<AnySyncTimelineEvent>>,
 
     /// The encryption info for this edit.
-    pub encryption_info: Option<EncryptionInfo>,
+    pub encryption_info: Option<Arc<EncryptionInfo>>,
 }
 
 /// Which kind of aggregation (related event) is this?

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

@@ -506,7 +506,7 @@ mod tests {
             read_receipts: Default::default(),
             is_own: false,
             is_highlighted: false,
-            encryption_info: Some(EncryptionInfo {
+            encryption_info: Some(Arc::new(EncryptionInfo {
                 sender: owned_user_id!("@u:s.co"),
                 sender_device: None,
                 algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
@@ -515,7 +515,7 @@ mod tests {
                     session_id: Some(session_id.to_owned()),
                 },
                 verification_state: VerificationState::Verified,
-            }),
+            })),
             original_json: None,
             latest_edit_json: None,
             origin: RemoteEventOrigin::Sync,

crates/matrix-sdk-ui/src/timeline/event_handler.rs

@@ -85,7 +85,7 @@ pub(super) enum Flow {
         /// Where should this be added in the timeline.
         position: TimelineItemPosition,
         /// Information about the encryption for this event.
-        encryption_info: Option<EncryptionInfo>,
+        encryption_info: Option<Arc<EncryptionInfo>>,
     },
 }
 
@@ -150,7 +150,7 @@ pub(super) struct RemoteEventContext<'a> {
     event_id: &'a EventId,
     raw_event: &'a Raw<AnySyncTimelineEvent>,
     relations: BundledMessageLikeRelations<AnySyncMessageLikeEvent>,
-    bundled_edit_encryption_info: Option<EncryptionInfo>,
+    bundled_edit_encryption_info: Option<Arc<EncryptionInfo>>,
 }
 
 /// An action that we want to cause on the timeline.
@@ -195,7 +195,7 @@ impl TimelineAction {
         raw_event: &Raw<AnySyncTimelineEvent>,
         room_data_provider: &P,
         unable_to_decrypt_info: Option<UnableToDecryptInfo>,
-        bundled_edit_encryption_info: Option<EncryptionInfo>,
+        bundled_edit_encryption_info: Option<Arc<EncryptionInfo>>,
         timeline_items: &Vector<Arc<TimelineItem>>,
         meta: &mut TimelineMetadata,
     ) -> Option<Self> {

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

@@ -398,7 +398,7 @@ impl EventTimelineItem {
     pub fn encryption_info(&self) -> Option<&EncryptionInfo> {
         match &self.kind {
             EventTimelineItemKind::Local(_) => None,
-            EventTimelineItemKind::Remote(remote_event) => remote_event.encryption_info.as_ref(),
+            EventTimelineItemKind::Remote(remote_event) => remote_event.encryption_info.as_deref(),
         }
     }
 
@@ -521,7 +521,10 @@ impl EventTimelineItem {
     }
 
     /// Clone the current event item, and update its `encryption_info`.
-    pub(super) fn with_encryption_info(&self, encryption_info: Option<EncryptionInfo>) -> Self {
+    pub(super) fn with_encryption_info(
+        &self,
+        encryption_info: Option<Arc<EncryptionInfo>>,
+    ) -> Self {
         let mut new = self.clone();
         if let EventTimelineItemKind::Remote(r) = &mut new.kind {
             r.encryption_info = encryption_info;

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

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use std::fmt;
+use std::{fmt, sync::Arc};
 
 use indexmap::IndexMap;
 use matrix_sdk::deserialized_responses::EncryptionInfo;
@@ -46,7 +46,7 @@ pub(in crate::timeline) struct RemoteEventTimelineItem {
     pub is_highlighted: bool,
 
     /// Encryption information.
-    pub encryption_info: Option<EncryptionInfo>,
+    pub encryption_info: Option<Arc<EncryptionInfo>>,
 
     /// JSON of the original event.
     ///