review: Move ProcessedToDeviceEvent to crypto types mod

Author: BillCarsonFr

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

@@ -17,7 +17,7 @@ use std::{collections::BTreeMap, fmt};
 #[cfg(doc)]
 use ruma::events::AnyTimelineEvent;
 use ruma::{
-    events::{AnyMessageLikeEvent, AnySyncTimelineEvent, AnyToDeviceEvent},
+    events::{AnyMessageLikeEvent, AnySyncTimelineEvent},
     push::Action,
     serde::{
         AsRefStr, AsStrAsRefStr, DebugAsRefStr, DeserializeFromCowStr, FromString, JsonObject, Raw,
@@ -615,38 +615,6 @@ impl fmt::Debug for DecryptedRoomEvent {
     }
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
-pub enum ProcessedToDeviceEvent {
-    /// A successfully-decrypted encrypted event.
-    Decrypted {
-        /// The decrypted to device event
-        decrypted_event: Raw<AnyToDeviceEvent>,
-    },
-
-    /// An encrypted event which could not be decrypted.
-    UnableToDecrypt {
-        /// The `m.room.encrypted` to device event.
-        event: Raw<AnyToDeviceEvent>,
-    },
-
-    /// An unencrypted event.
-    PlainText(Raw<AnyToDeviceEvent>),
-
-    /// An invalid to device event that was ignored
-    NotProcessed(Raw<AnyToDeviceEvent>),
-}
-
-impl ProcessedToDeviceEvent {
-    pub fn to_raw(&self) -> Raw<AnyToDeviceEvent> {
-        match self {
-            ProcessedToDeviceEvent::Decrypted { decrypted_event, .. } => decrypted_event.clone(),
-            ProcessedToDeviceEvent::UnableToDecrypt { event } => event.clone(),
-            ProcessedToDeviceEvent::PlainText(event) => event.clone(),
-            ProcessedToDeviceEvent::NotProcessed(event) => event.clone(),
-        }
-    }
-}
-
 /// The location of an event bundled in an `unsigned` object.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
 pub enum UnsignedEventLocation {

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

@@ -22,7 +22,7 @@ use itertools::Itertools;
 use matrix_sdk_common::{
     deserialized_responses::{
         AlgorithmInfo, DecryptedRoomEvent, DeviceLinkProblem, EncryptionInfo,
-        ProcessedToDeviceEvent, UnableToDecryptInfo, UnableToDecryptReason,
+        UnableToDecryptInfo, UnableToDecryptReason,
         UnsignedDecryptionResult, UnsignedEventLocation, VerificationLevel, VerificationState,
     },
     locks::RwLock as StdRwLock,
@@ -102,6 +102,7 @@ use crate::{
     CollectStrategy, CrossSigningKeyExport, CryptoStoreError, DecryptionSettings, DeviceData,
     LocalTrust, RoomEventDecryptionResult, SignatureError, TrustRequirement,
 };
+use crate::types::ProcessedToDeviceEvent;
 
 /// State machine implementation of the Olm/Megolm encryption protocol used for
 /// Matrix end to end encryption.

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

@@ -17,7 +17,7 @@ use std::{fmt::Debug, iter, pin::Pin};
 use assert_matches::assert_matches;
 use futures_core::Stream;
 use futures_util::{FutureExt, StreamExt};
-use matrix_sdk_common::deserialized_responses::ProcessedToDeviceEvent;
+use crate::types::ProcessedToDeviceEvent;
 use matrix_sdk_test::async_test;
 use ruma::{room_id, user_id, RoomId, TransactionId, UserId};
 use serde::Serialize;

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

@@ -18,7 +18,7 @@ use assert_matches2::{assert_let, assert_matches};
 use futures_util::{pin_mut, FutureExt, StreamExt};
 use itertools::Itertools;
 use matrix_sdk_common::deserialized_responses::{
-    AlgorithmInfo, ProcessedToDeviceEvent, UnableToDecryptInfo, UnableToDecryptReason,
+    AlgorithmInfo, UnableToDecryptInfo, UnableToDecryptReason,
     UnsignedDecryptionResult, UnsignedEventLocation, VerificationLevel, VerificationState,
     WithheldCode,
 };
@@ -78,6 +78,7 @@ use crate::{
     Account, DecryptionSettings, DeviceData, EncryptionSettings, LocalTrust, MegolmError, OlmError,
     RoomEventDecryptionResult, TrustRequirement,
 };
+use crate::types::ProcessedToDeviceEvent;
 
 mod decryption_verification_state;
 mod interactive_verification;

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

@@ -18,7 +18,7 @@ use std::{
 };
 
 use assert_matches2::assert_let;
-use matrix_sdk_common::deserialized_responses::ProcessedToDeviceEvent;
+use crate::types::ProcessedToDeviceEvent;
 use matrix_sdk_test::async_test;
 use ruma::{
     device_id,

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

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 use assert_matches2::{assert_let, assert_matches};
-use matrix_sdk_common::deserialized_responses::ProcessedToDeviceEvent;
+use crate::types::ProcessedToDeviceEvent;
 use matrix_sdk_test::async_test;
 use ruma::{events::AnyToDeviceEvent, serde::Raw, to_device::DeviceIdOrAllDevices};
 use serde_json::{json, value::to_raw_value};

crates/matrix-sdk-crypto/src/session_manager/group_sessions/mod.rs

@@ -1031,7 +1031,7 @@ mod tests {
     };
 
     use assert_matches2::assert_let;
-    use matrix_sdk_common::deserialized_responses::{ProcessedToDeviceEvent, WithheldCode};
+    use matrix_sdk_common::deserialized_responses::WithheldCode;
     use matrix_sdk_test::{async_test, ruma_response_from_json};
     use ruma::{
         api::client::{
@@ -1067,6 +1067,7 @@ mod tests {
         },
         EncryptionSettings, LocalTrust, OlmMachine,
     };
+    use crate::types::ProcessedToDeviceEvent;
 
     fn alice_id() -> &'static UserId {
         user_id!("@alice:example.org")

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

@@ -41,6 +41,8 @@ use ruma::{
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 use vodozemac::{Curve25519PublicKey, Ed25519PublicKey, Ed25519Signature, KeyError};
 use zeroize::{Zeroize, ZeroizeOnDrop};
+use ruma::serde::Raw;
+use ruma::events::AnyToDeviceEvent;
 
 mod backup;
 mod cross_signing;
@@ -626,3 +628,37 @@ mod test {
         assert_json_snapshot!(secret_bundle);
     }
 }
+
+/// Represents a to-device event after it has been processed by the olm machine.
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub enum ProcessedToDeviceEvent {
+    /// A successfully-decrypted encrypted event.
+    Decrypted {
+        /// The decrypted to device event
+        decrypted_event: Raw<AnyToDeviceEvent>,
+    },
+
+    /// An encrypted event which could not be decrypted.
+    UnableToDecrypt {
+        /// The `m.room.encrypted` to device event.
+        event: Raw<AnyToDeviceEvent>,
+    },
+
+    /// An unencrypted event.
+    PlainText(Raw<AnyToDeviceEvent>),
+
+    /// An invalid to device event that was ignored
+    NotProcessed(Raw<AnyToDeviceEvent>),
+}
+
+impl ProcessedToDeviceEvent {
+    /// Converts a ProcessedToDeviceEvent to the Raw<AnyToDeviceEvent> it encapsulates
+    pub fn to_raw(&self) -> Raw<AnyToDeviceEvent> {
+        match self {
+            ProcessedToDeviceEvent::Decrypted { decrypted_event, .. } => decrypted_event.clone(),
+            ProcessedToDeviceEvent::UnableToDecrypt { event } => event.clone(),
+            ProcessedToDeviceEvent::PlainText(event) => event.clone(),
+            ProcessedToDeviceEvent::NotProcessed(event) => event.clone(),
+        }
+    }
+}