feat(crypto): Store sender in RoomKeyWithheldEntry::Bundle.

Author: kaylendog

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

@@ -77,8 +77,9 @@ use crate::{
         Session, StaticAccountData,
     },
     types::{
-        events::room_key_withheld::MegolmV1AesSha2WithheldContent, BackupSecrets,
-        CrossSigningSecrets, MegolmBackupV1Curve25519AesSha2Secrets, RoomKeyExport, SecretsBundle,
+        events::room_key_withheld::{MegolmV1AesSha2WithheldContent, RoomKeyWithheldEntry},
+        BackupSecrets, CrossSigningSecrets, MegolmBackupV1Curve25519AesSha2Secrets, RoomKeyExport,
+        SecretsBundle,
     },
     verification::VerificationMachine,
     CrossSigningStatus, OwnUserIdentityData, RoomKeyImportResult,
@@ -1692,11 +1693,13 @@ impl Store {
                 | MegolmV1AesSha2WithheldContent::Unavailable(c),
             ) = withheld
             {
-                changes
-                    .withheld_session_info
-                    .entry(c.room_id.to_owned())
-                    .or_default()
-                    .insert(c.session_id.to_owned(), withheld.to_owned().into());
+                changes.withheld_session_info.entry(c.room_id.to_owned()).or_default().insert(
+                    c.session_id.to_owned(),
+                    RoomKeyWithheldEntry::Bundle {
+                        sender: bundle_info.sender_user.clone(),
+                        content: withheld.to_owned(),
+                    },
+                );
             }
         }
         self.save_changes(changes).await?;
@@ -2079,9 +2082,12 @@ mod tests {
 
         assert_matches!(
             bob.store().get_withheld_info(room_id, sessions[1].session_id()).await.unwrap(),
-            Some(RoomKeyWithheldEntry::Bundle(RoomKeyWithheldContent::MegolmV1AesSha2(
-                MegolmV1AesSha2WithheldContent::Unauthorised(_)
-            )))
+            Some(RoomKeyWithheldEntry::Bundle {
+                content: RoomKeyWithheldContent::MegolmV1AesSha2(
+                    MegolmV1AesSha2WithheldContent::Unauthorised(_)
+                ),
+                ..
+            })
         );
     }
 

crates/matrix-sdk-crypto/src/types/events/room_key_withheld.rs

@@ -17,7 +17,10 @@
 use std::collections::BTreeMap;
 
 use matrix_sdk_common::deserialized_responses::WithheldCode;
-use ruma::{events::AnyToDeviceEventContent, serde::JsonCastable, OwnedDeviceId, OwnedRoomId};
+use ruma::{
+    events::AnyToDeviceEventContent, serde::JsonCastable, OwnedDeviceId, OwnedRoomId, OwnedUserId,
+    UserId,
+};
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
 use vodozemac::Curve25519PublicKey;
@@ -33,15 +36,28 @@ pub enum RoomKeyWithheldEntry {
     /// A to-device event containing withheld room key information.
     ToDevice(RoomKeyWithheldEvent),
     /// Content held within a room key bundle.
-    Bundle(RoomKeyWithheldContent),
+    Bundle {
+        /// The ID of the user who sent the bundle.
+        sender: OwnedUserId,
+        /// The contents of a single withheld entry in the bundle.
+        content: RoomKeyWithheldContent,
+    },
 }
 
 impl RoomKeyWithheldEntry {
     /// Returns a reference to the underlying `RoomKeyWithheldContent`.
     pub fn content(&self) -> &RoomKeyWithheldContent {
         match self {
             RoomKeyWithheldEntry::ToDevice(ev) => &ev.content,
-            RoomKeyWithheldEntry::Bundle(content) => content,
+            RoomKeyWithheldEntry::Bundle { content, .. } => content,
+        }
+    }
+
+    /// Returns the sender's user ID, if available.
+    pub fn sender(&self) -> &UserId {
+        match self {
+            RoomKeyWithheldEntry::ToDevice(ev) => &ev.sender,
+            RoomKeyWithheldEntry::Bundle { sender, .. } => sender,
         }
     }
 }
@@ -52,12 +68,6 @@ impl From<RoomKeyWithheldEvent> for RoomKeyWithheldEntry {
     }
 }
 
-impl From<RoomKeyWithheldContent> for RoomKeyWithheldEntry {
-    fn from(value: RoomKeyWithheldContent) -> Self {
-        Self::Bundle(value)
-    }
-}
-
 /// The `m.room_key_request` to-device event.
 pub type RoomKeyWithheldEvent = ToDeviceEvent<RoomKeyWithheldContent>;