ruma-events 0.34.0

Serializable types for the events in the Matrix specification.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

//! Types for the `m.stream` namespace ([MSC4471]).
//!
//! [MSC4471]: https://github.com/matrix-org/matrix-spec-proposals/pull/4471

use std::time::Duration;

use ruma_common::OwnedDeviceId;
use serde::{Deserialize, Serialize};

pub mod cancel;
pub mod subscribe;
pub mod update;

/// A descriptor advertising that a room event has a live event stream.
///
/// See [MSC4471] for the proposal.
///
/// [MSC4471]: https://github.com/matrix-org/matrix-spec-proposals/pull/4471
#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
pub struct StreamDescriptor {
    /// The publisher device, owned by the sender of the room event containing the descriptor.
    pub device_id: OwnedDeviceId,

    /// The lifetime of the descriptor in milliseconds, counted from the room
    /// event's `origin_server_ts`.
    #[serde(
        with = "ruma_common::serde::duration::opt_ms",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub expiry_ms: Option<Duration>,
}

impl StreamDescriptor {
    /// Creates a new `StreamDescriptor` for the given publisher device.
    pub fn new(device_id: OwnedDeviceId) -> Self {
        Self { device_id, expiry_ms: None }
    }
}

#[cfg(test)]
mod tests {
    use std::time::Duration;

    use ruma_common::{canonical_json::assert_to_canonical_json_eq, owned_device_id, serde::Raw};
    use serde_json::json;

    use super::StreamDescriptor;
    use crate::room::message::{RoomMessageEventContent, RoomMessageEventContentWithoutRelation};

    #[test]
    fn descriptor_round_trips_inside_room_message() {
        let mut content = RoomMessageEventContent::text_plain("Hello");
        content.stream = Some(StreamDescriptor {
            device_id: owned_device_id!("DEVICEID"),
            expiry_ms: Some(Duration::from_millis(1_800_000)),
        });

        assert_to_canonical_json_eq!(
            content,
            json!({
                "msgtype": "m.text",
                "body": "Hello",
                "org.matrix.msc4471.stream": {
                    "device_id": "DEVICEID",
                    "expiry_ms": 1_800_000,
                },
            })
        );

        let raw = Raw::new(&content).unwrap();
        let deserialized: RoomMessageEventContent = raw.deserialize().unwrap();
        let stream = deserialized.stream.unwrap();
        assert_eq!(stream.device_id, "DEVICEID");
        assert_eq!(stream.expiry_ms, Some(Duration::from_millis(1_800_000)));
    }

    #[test]
    fn replacement_drops_stream() {
        let mut content = RoomMessageEventContent::text_plain("Hello");
        content.stream = Some(StreamDescriptor::new(owned_device_id!("DEVICEID")));

        content.apply_replacement(RoomMessageEventContentWithoutRelation::text_plain("Done"));

        assert!(content.stream.is_none());
        assert_to_canonical_json_eq!(
            content,
            json!({
                "msgtype": "m.text",
                "body": "Done",
            })
        );
    }

    #[test]
    fn replacement_keeps_stream() {
        let mut content = RoomMessageEventContent::text_plain("Hello");
        content.stream = Some(StreamDescriptor::new(owned_device_id!("DEVICEONE")));

        let mut new_content = RoomMessageEventContentWithoutRelation::text_plain("world");
        new_content.stream = Some(StreamDescriptor::new(owned_device_id!("DEVICETWO")));
        content.apply_replacement(new_content);

        let stream = content.stream.as_ref().unwrap();
        assert_eq!(stream.device_id, "DEVICETWO");
        assert_to_canonical_json_eq!(
            content,
            json!({
                "msgtype": "m.text",
                "body": "world",
                "org.matrix.msc4471.stream": {
                    "device_id": "DEVICETWO",
                },
            })
        );
    }
}