WidgetDriver: add toDevice capability parsing

Author: toger5

crates/matrix-sdk/src/widget/capabilities.rs

@@ -22,7 +22,7 @@ use serde::{ser::SerializeSeq, Deserialize, Deserializer, Serialize, Serializer}
 use tracing::{debug, warn};
 
 use super::{
-    filter::{Filter, FilterInput},
+    filter::{Filter, FilterInput, ToDeviceEventFilter},
     MessageLikeEventFilter, StateEventFilter,
 };
 
@@ -102,11 +102,13 @@ impl Capabilities {
     }
 }
 
-const SEND_EVENT: &str = "org.matrix.msc2762.send.event";
-const READ_EVENT: &str = "org.matrix.msc2762.receive.event";
-const SEND_STATE: &str = "org.matrix.msc2762.send.state_event";
-const READ_STATE: &str = "org.matrix.msc2762.receive.state_event";
-const REQUIRES_CLIENT: &str = "io.element.requires_client";
+pub(super) const SEND_EVENT: &str = "org.matrix.msc2762.send.event";
+pub(super) const READ_EVENT: &str = "org.matrix.msc2762.receive.event";
+pub(super) const SEND_STATE: &str = "org.matrix.msc2762.send.state_event";
+pub(super) const READ_STATE: &str = "org.matrix.msc2762.receive.state_event";
+pub(super) const SEND_TODEVICE: &str = "org.matrix.msc3819.send.to_device";
+pub(super) const READ_TODEVICE: &str = "org.matrix.msc3819.receive.to_device";
+pub(super) const REQUIRES_CLIENT: &str = "io.element.requires_client";
 pub(super) const SEND_DELAYED_EVENT: &str = "org.matrix.msc4157.send.delayed_event";
 pub(super) const UPDATE_DELAYED_EVENT: &str = "org.matrix.msc4157.update_delayed_event";
 
@@ -169,13 +171,15 @@ impl Serialize for Capabilities {
             let name = match filter {
                 Filter::MessageLike(_) => READ_EVENT,
                 Filter::State(_) => READ_STATE,
+                Filter::ToDevice(_) => READ_TODEVICE,
             };
             seq.serialize_element(&format!("{name}:{}", PrintEventFilter(filter)))?;
         }
         for filter in &self.send {
             let name = match filter {
                 Filter::MessageLike(_) => SEND_EVENT,
                 Filter::State(_) => SEND_STATE,
+                Filter::ToDevice(_) => SEND_TODEVICE,
             };
             seq.serialize_element(&format!("{name}:{}", PrintEventFilter(filter)))?;
         }
@@ -227,6 +231,12 @@ impl<'de> Deserialize<'de> for Capabilities {
                     Some((SEND_STATE, filter_s)) => {
                         Ok(Permission::Send(Filter::State(parse_state_event_filter(filter_s))))
                     }
+                    Some((READ_TODEVICE, filter_s)) => Ok(Permission::Read(Filter::ToDevice(
+                        parse_to_device_event_filter(filter_s),
+                    ))),
+                    Some((SEND_TODEVICE, filter_s)) => Ok(Permission::Send(Filter::ToDevice(
+                        parse_to_device_event_filter(filter_s),
+                    ))),
                     _ => {
                         debug!("Unknown capability `{s}`");
                         Ok(Self::Unknown)
@@ -253,6 +263,10 @@ impl<'de> Deserialize<'de> for Capabilities {
             }
         }
 
+        fn parse_to_device_event_filter(s: &str) -> ToDeviceEventFilter {
+            ToDeviceEventFilter::new(s.into())
+        }
+
         let mut capabilities = Capabilities::default();
         for capability in Vec::<Permission>::deserialize(deserializer)? {
             match capability {
@@ -274,6 +288,8 @@ impl<'de> Deserialize<'de> for Capabilities {
 mod tests {
     use ruma::events::StateEventType;
 
+    use crate::widget::filter::ToDeviceEventFilter;
+
     use super::*;
 
     #[test]
@@ -294,8 +310,10 @@ mod tests {
             "org.matrix.msc2762.receive.event:org.matrix.rageshake_request",
             "org.matrix.msc2762.receive.state_event:m.room.member",
             "org.matrix.msc2762.receive.state_event:org.matrix.msc3401.call.member",
+            "org.matrix.msc3819.receive.to_device:io.element.call.encryption_keys",
             "org.matrix.msc2762.send.event:org.matrix.rageshake_request",
             "org.matrix.msc2762.send.state_event:org.matrix.msc3401.call.member#@user:matrix.server",
+            "org.matrix.msc3819.send.to_device:io.element.call.encryption_keys",
             "org.matrix.msc4157.send.delayed_event",
             "org.matrix.msc4157.update_delayed_event"
         ]"#;
@@ -308,6 +326,9 @@ mod tests {
                 )),
                 Filter::State(StateEventFilter::WithType(StateEventType::RoomMember)),
                 Filter::State(StateEventFilter::WithType("org.matrix.msc3401.call.member".into())),
+                Filter::ToDevice(ToDeviceEventFilter::new(
+                    "io.element.call.encryption_keys".into(),
+                )),
             ],
             send: vec![
                 Filter::MessageLike(MessageLikeEventFilter::WithType(
@@ -317,6 +338,9 @@ mod tests {
                     "org.matrix.msc3401.call.member".into(),
                     "@user:matrix.server".into(),
                 )),
+                Filter::ToDevice(ToDeviceEventFilter::new(
+                    "io.element.call.encryption_keys".into(),
+                )),
             ],
             requires_client: true,
             update_delayed_event: true,
@@ -336,13 +360,17 @@ mod tests {
                     "org.matrix.msc3401.call.member".into(),
                     "@user:matrix.server".into(),
                 )),
+                Filter::ToDevice(ToDeviceEventFilter::new(
+                    "io.element.call.encryption_keys".into(),
+                )),
             ],
             send: vec![
                 Filter::MessageLike(MessageLikeEventFilter::WithType("io.element.custom".into())),
                 Filter::State(StateEventFilter::WithTypeAndStateKey(
                     "org.matrix.msc3401.call.member".into(),
                     "@user:matrix.server".into(),
                 )),
+                Filter::ToDevice(ToDeviceEventFilter::new("my.org.other.to_device_event".into())),
             ],
             requires_client: true,
             update_delayed_event: false,

crates/matrix-sdk/src/widget/machine/tests/capabilities.rs

@@ -18,8 +18,12 @@ use ruma::owned_room_id;
 use serde_json::{from_value, json};
 
 use super::{parse_msg, WIDGET_ID};
-use crate::widget::machine::{
-    incoming::MatrixDriverResponse, Action, IncomingMessage, MatrixDriverRequestData, WidgetMachine,
+use crate::widget::{
+    capabilities::{READ_EVENT, READ_STATE, READ_TODEVICE},
+    machine::{
+        incoming::MatrixDriverResponse, Action, IncomingMessage, MatrixDriverRequestData,
+        WidgetMachine,
+    },
 };
 
 #[test]
@@ -191,10 +195,7 @@ pub(super) fn assert_capabilities_dance(
     };
 
     // We get the `Subscribe` command if we requested some reading capabilities.
-    if ["org.matrix.msc2762.receive.state_event", "org.matrix.msc2762.receive.event"]
-        .into_iter()
-        .any(|c| capability.starts_with(c))
-    {
+    if [READ_EVENT, READ_STATE, READ_TODEVICE].into_iter().any(|c| capability.starts_with(c)) {
         let action = actions.remove(0);
         assert_matches!(action, Action::Subscribe);
     }