chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add struct UnsignedData and update unsigned fields to use it

Browse Source
This commit is contained in:
Jonas Platte 2020-04-28 00:03:42 +02:00
parent 66cecdac6b
commit 55340d18c8
No known key found for this signature in database
GPG Key ID: 7D261D771D915378
15 changed files with 110 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CHANGELOG.md
View File

@ -1,5 +1,13 @@
# [unreleased]
Breaking changes:
* Add `struct UnsignedData` and update all `unsigned` fields types from
`BTreeMap<String, Value>` to this new type.
* To access any additional fields of the `unsigned` property of an event,
deserialize the `EventJson` to another type that captures the field(s) you
are interested in.
Improvements:
* Add a encrypted variant to the room `MessageEventContent` enum.

6
ruma-events-macros/src/gen.rs
View File

@ -153,7 +153,7 @@ impl ToTokens for RumaEvent {
}
/// Additional key-value pairs not signed by the homeserver.
fn unsigned(&self) -> &std::collections::BTreeMap<String, serde_json::Value> {
fn unsigned(&self) -> &ruma_events::UnsignedData {
&self.unsigned
}
}
@ -295,8 +295,8 @@ fn populate_room_event_fields(content_name: Ident, fields: Vec<Field>) -> Vec<Fi
pub sender: ruma_identifiers::UserId,
/// Additional key-value pairs not signed by the homeserver.
#[serde(default, skip_serializing_if = "std::collections::BTreeMap::is_empty")]
pub unsigned: std::collections::BTreeMap<String, serde_json::Value>,
#[serde(skip_serializing_if = "ruma_events::UnsignedData::is_empty")]
pub unsigned: ruma_events::UnsignedData,
};
fields.extend(punctuated_fields.into_iter().map(|p| p.field));

27
src/custom.rs
View File

@ -1,8 +1,8 @@
//! Types for custom events outside of the Matrix specification.
use std::{collections::BTreeMap, time::SystemTime};
use std::time::SystemTime;
use crate::{Event, EventType, RoomEvent, StateEvent};
use crate::{Event, EventType, RoomEvent, StateEvent, UnsignedData};
use ruma_events_macros::FromRaw;
use ruma_identifiers::{EventId, RoomId, UserId};
@ -55,8 +55,8 @@ pub struct CustomRoomEvent {
/// The unique identifier for the user who sent this event.
pub sender: UserId,
/// Additional key-value pairs not signed by the homeserver.
#[serde(skip_serializing_if = "std::collections::BTreeMap::is_empty")]
pub unsigned: BTreeMap<String, JsonValue>,
#[serde(skip_serializing_if = "UnsignedData::is_empty")]
pub unsigned: UnsignedData,
}
/// The payload for `CustomRoomEvent`.
@ -102,7 +102,7 @@ impl RoomEvent for CustomRoomEvent {
}
/// Additional key-value pairs not signed by the homeserver.
fn unsigned(&self) -> &BTreeMap<String, JsonValue> {
fn unsigned(&self) -> &UnsignedData {
&self.unsigned
}
}
@ -129,8 +129,8 @@ pub struct CustomStateEvent {
/// A key that determines which piece of room state the event represents.
pub state_key: String,
/// Additional key-value pairs not signed by the homeserver.
#[serde(skip_serializing_if = "std::collections::BTreeMap::is_empty")]
pub unsigned: BTreeMap<String, JsonValue>,
#[serde(skip_serializing_if = "UnsignedData::is_empty")]
pub unsigned: UnsignedData,
}
/// The payload for `CustomStateEvent`.
@ -176,7 +176,7 @@ impl RoomEvent for CustomStateEvent {
}
/// Additional key-value pairs not signed by the homeserver.
fn unsigned(&self) -> &BTreeMap<String, JsonValue> {
fn unsigned(&self) -> &UnsignedData {
&self.unsigned
}
}
@ -194,13 +194,14 @@ impl StateEvent for CustomStateEvent {
}
pub(crate) mod raw {
use std::{collections::BTreeMap, time::SystemTime};
use std::time::SystemTime;
use ruma_identifiers::{EventId, RoomId, UserId};
use serde::Deserialize;
use serde_json::Value as JsonValue;
use super::{CustomEventContent, CustomRoomEventContent, CustomStateEventContent};
use super::{
CustomEventContent, CustomRoomEventContent, CustomStateEventContent, UnsignedData,
};
/// A custom event not covered by the Matrix specification.
#[derive(Clone, Debug, PartialEq, Deserialize)]
@ -231,7 +232,7 @@ pub(crate) mod raw {
pub sender: UserId,
/// Additional key-value pairs not signed by the homeserver.
#[serde(default)]
pub unsigned: BTreeMap<String, JsonValue>,
pub unsigned: UnsignedData,
}
/// A custom state event not covered by the Matrix specification.
@ -257,6 +258,6 @@ pub(crate) mod raw {
pub state_key: String,
/// Additional key-value pairs not signed by the homeserver.
#[serde(default)]
pub unsigned: BTreeMap<String, JsonValue>,
pub unsigned: UnsignedData,
}
}

6
src/json.rs
View File

@ -96,6 +96,12 @@ impl<T> Debug for EventJson<T> {
}
}
impl<T> PartialEq for EventJson<T> {
fn eq(&self, other: &Self) -> bool {
self.json.get() == other.json.get()
}
}
impl<'de, T> Deserialize<'de> for EventJson<T> {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where

38
src/lib.rs
View File

@ -114,11 +114,13 @@
// Since we support Rust 1.36.0, we can't apply this suggestion yet
#![allow(clippy::use_self)]
use std::{collections::BTreeMap, fmt::Debug, time::SystemTime};
use std::{fmt::Debug, time::SystemTime};
use js_int::Int;
use ruma_identifiers::{EventId, RoomId, UserId};
use serde::Serialize;
use serde_json::Value;
use serde::{Deserialize, Serialize};
use self::room::redaction::RedactionEvent;
pub use self::{
custom::{CustomEvent, CustomRoomEvent, CustomStateEvent},
@ -209,7 +211,7 @@ pub trait RoomEvent: Event {
fn sender(&self) -> &UserId;
/// Additional key-value pairs not signed by the homeserver.
fn unsigned(&self) -> &BTreeMap<String, Value>;
fn unsigned(&self) -> &UnsignedData;
}
/// An event that describes persistent state about a room.
@ -220,3 +222,31 @@ pub trait StateEvent: RoomEvent {
/// A key that determines which piece of room state the event represents.
fn state_key(&self) -> &str;
}
/// Extra information about an event that is not incorporated into the event's
/// hash.
#[derive(Clone, Debug, Default, PartialEq, Deserialize, Serialize)]
pub struct UnsignedData {
/// The time in milliseconds that has elapsed since the event was sent. This
/// field is generated by the local homeserver, and may be incorrect if the
/// local time on at least one of the two servers is out of sync, which can
/// cause the age to either be negative or greater than it actually is.
age: Option<Int>,
/// The event that redacted this event, if any.
redacted_because: Option<EventJson<RedactionEvent>>,
/// The client-supplied transaction ID, if the client being given the event
/// is the same one which sent it.
transaction_id: Option<String>,
}
impl UnsignedData {
/// Whether this unsigned data is empty (all fields are `None`).
///
/// This method is used to determine whether to skip serializing the
/// `unsigned` field in room events. Do not use it to determine whether
/// an incoming `unsigned` field was present - it could still have been
/// present but contained none of the known fields.
pub fn is_empty(&self) -> bool {
self.age.is_none() && self.redacted_because.is_none() && self.transaction_id.is_none()
}
}

2
src/macros.rs
View File

@ -72,7 +72,7 @@ macro_rules! impl_room_event {
}
/// Additional key-value pairs not signed by the homeserver.
fn unsigned(&self) -> &::std::collections::BTreeMap<String, ::serde_json::Value> {
fn unsigned(&self) -> &::ruma_events::UnsignedData {
&self.unsigned
}
}

15
src/room/canonical_alias.rs
View File

@ -1,7 +1,6 @@
//! Types for the *m.room.canonical_alias* event.
use std::{
collections::BTreeMap,
convert::TryFrom,
time::{SystemTime, UNIX_EPOCH},
};
@ -11,9 +10,8 @@ use serde::{
ser::{Error, SerializeStruct},
Deserialize, Serialize, Serializer,
};
use serde_json::Value;
use crate::{util::empty_string_as_none, Event, EventType, FromRaw};
use crate::{util::empty_string_as_none, Event, EventType, FromRaw, UnsignedData};
/// Informs the room as to which alias is the canonical one.
#[derive(Clone, Debug, PartialEq)]
@ -40,7 +38,7 @@ pub struct CanonicalAliasEvent {
pub state_key: String,
/// Additional key-value pairs not signed by the homeserver.
pub unsigned: BTreeMap<String, Value>,
pub unsigned: UnsignedData,
}
/// The payload for `CanonicalAliasEvent`.
@ -122,7 +120,7 @@ impl Serialize for CanonicalAliasEvent {
state.serialize_field("state_key", &self.state_key)?;
state.serialize_field("type", &self.event_type())?;
if !self.unsigned.is_empty() {
if self.unsigned != UnsignedData::default() {
state.serialize_field("unsigned", &self.unsigned)?;
}
@ -166,7 +164,7 @@ pub(crate) mod raw {
/// Additional key-value pairs not signed by the homeserver.
#[serde(default)]
pub unsigned: BTreeMap<String, Value>,
pub unsigned: UnsignedData,
}
/// The payload of a `CanonicalAliasEvent`.
@ -186,7 +184,6 @@ pub(crate) mod raw {
#[cfg(test)]
mod tests {
use std::{
collections::BTreeMap,
convert::TryFrom,
time::{Duration, UNIX_EPOCH},
};
@ -195,7 +192,7 @@ mod tests {
use serde_json::{from_value as from_json_value, json, to_value as to_json_value};
use super::{CanonicalAliasEvent, CanonicalAliasEventContent};
use crate::EventJson;
use crate::{EventJson, UnsignedData};
#[test]
fn serialization_with_optional_fields_as_none() {
@ -209,7 +206,7 @@ mod tests {
room_id: None,
sender: UserId::try_from("@carl:example.com").unwrap(),
state_key: "".to_string(),
unsigned: BTreeMap::new(),
unsigned: UnsignedData::default(),
};
let actual = to_json_value(&canonical_alias_event).unwrap();

8
src/room/encrypted.rs
View File

@ -7,7 +7,7 @@ use ruma_identifiers::{DeviceId, EventId, RoomId, UserId};
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use serde_json::{from_value, Value};
use crate::{Algorithm, EventType, FromRaw};
use crate::{Algorithm, EventType, FromRaw, UnsignedData};
/// This event type is used when sending encrypted events.
///
@ -34,8 +34,8 @@ pub struct EncryptedEvent {
pub sender: UserId,
/// Additional key-value pairs not signed by the homeserver.
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub unsigned: BTreeMap<String, Value>,
#[serde(skip_serializing_if = "ruma_serde::is_default")]
pub unsigned: UnsignedData,
}
/// The payload for `EncryptedEvent`.
@ -134,7 +134,7 @@ pub(crate) mod raw {
/// Additional key-value pairs not signed by the homeserver.
#[serde(default)]
pub unsigned: BTreeMap<String, Value>,
pub unsigned: UnsignedData,
}
/// The payload for `EncryptedEvent`.

10
src/room/member.rs
View File

@ -230,7 +230,7 @@ mod tests {
use serde_json::json;
use super::*;
use crate::util::serde_json_eq_try_from_raw;
use crate::{util::serde_json_eq_try_from_raw, UnsignedData};
#[test]
fn serde_with_no_prev_content() {
@ -247,7 +247,7 @@ mod tests {
room_id: Some(RoomId::try_from("!n8f893n9:example.com").unwrap()),
sender: UserId::try_from("@carl:example.com").unwrap(),
state_key: "example.com".to_string(),
unsigned: BTreeMap::new(),
unsigned: UnsignedData::default(),
prev_content: None,
};
let json = json!({
@ -279,7 +279,7 @@ mod tests {
room_id: Some(RoomId::try_from("!n8f893n9:example.com").unwrap()),
sender: UserId::try_from("@carl:example.com").unwrap(),
state_key: "example.com".to_string(),
unsigned: BTreeMap::new(),
unsigned: UnsignedData::default(),
prev_content: Some(MemberEventContent {
avatar_url: None,
displayname: None,
@ -335,7 +335,7 @@ mod tests {
room_id: Some(RoomId::try_from("!jEsUZKDJdhlrceRyVU:example.org").unwrap()),
sender: UserId::try_from("@alice:example.org").unwrap(),
state_key: "@alice:example.org".to_string(),
unsigned: BTreeMap::new(),
unsigned: UnsignedData::default(),
prev_content: None,
};
let json = json!({
@ -390,7 +390,7 @@ mod tests {
room_id: Some(RoomId::try_from("!jEsUZKDJdhlrceRyVU:example.org").unwrap()),
sender: UserId::try_from("@alice:example.org").unwrap(),
state_key: "@alice:example.org".to_string(),
unsigned: BTreeMap::new(),
unsigned: UnsignedData::default(),
prev_content: Some(MemberEventContent {
avatar_url: Some("mxc://example.org/SEsfnsuifSDFSSEF".to_owned()),
displayname: Some("Alice Margatroid".to_owned()),

10
src/room/message.rs
View File

@ -1,6 +1,6 @@
//! Types for the *m.room.message* event.
use std::{collections::BTreeMap, time::SystemTime};
use std::time::SystemTime;
use js_int::UInt;
use ruma_identifiers::{EventId, RoomId, UserId};
@ -8,7 +8,7 @@ use serde::{ser::SerializeStruct, Deserialize, Deserializer, Serialize, Serializ
use serde_json::{from_value, Value};
use super::{encrypted::EncryptedEventContent, EncryptedFile, ImageInfo, ThumbnailInfo};
use crate::{EventType, FromRaw};
use crate::{EventType, FromRaw, UnsignedData};
pub mod feedback;
@ -34,8 +34,8 @@ pub struct MessageEvent {
pub sender: UserId,
/// Additional key-value pairs not signed by the homeserver.
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub unsigned: BTreeMap<String, Value>,
#[serde(skip_serializing_if = "UnsignedData::is_empty")]
pub unsigned: UnsignedData,
}
/// The payload for `MessageEvent`.
@ -168,7 +168,7 @@ pub(crate) mod raw {
/// Additional key-value pairs not signed by the homeserver.
#[serde(default)]
pub unsigned: BTreeMap<String, Value>,
pub unsigned: UnsignedData,
}
/// The payload for `MessageEvent`.

16
src/room/name.rs
View File

@ -1,12 +1,11 @@
//! Types for the *m.room.name* event.
use std::{collections::BTreeMap, time::SystemTime};
use std::time::SystemTime;
use ruma_identifiers::{EventId, RoomId, UserId};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use crate::{util::empty_string_as_none, EventType, InvalidInput, TryFromRaw};
use crate::{util::empty_string_as_none, EventType, InvalidInput, TryFromRaw, UnsignedData};
/// A human-friendly room name designed to be displayed to the end-user.
#[derive(Clone, Debug, PartialEq, Serialize)]
@ -37,8 +36,8 @@ pub struct NameEvent {
pub state_key: String,
/// Additional key-value pairs not signed by the homeserver.
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub unsigned: BTreeMap<String, Value>,
#[serde(skip_serializing_if = "ruma_serde::is_default")]
pub unsigned: UnsignedData,
}
/// The payload for `NameEvent`.
@ -136,7 +135,7 @@ pub(crate) mod raw {
/// Additional key-value pairs not signed by the homeserver.
#[serde(default)]
pub unsigned: BTreeMap<String, Value>,
pub unsigned: UnsignedData,
}
/// The payload of a `NameEvent`.
@ -154,7 +153,6 @@ pub(crate) mod raw {
#[cfg(test)]
mod tests {
use std::{
collections::BTreeMap,
convert::TryFrom,
iter::FromIterator,
time::{Duration, UNIX_EPOCH},
@ -163,7 +161,7 @@ mod tests {
use ruma_identifiers::{EventId, RoomId, UserId};
use serde_json::{from_value as from_json_value, json, to_value as to_json_value};
use crate::EventJson;
use crate::{EventJson, UnsignedData};
use super::{NameEvent, NameEventContent};
@ -179,7 +177,7 @@ mod tests {
room_id: None,
sender: UserId::try_from("@carl:example.com").unwrap(),
state_key: "".to_string(),
unsigned: BTreeMap::new(),
unsigned: UnsignedData::default(),
};
let actual = to_json_value(&name_event).unwrap();

9
src/room/pinned_events.rs
View File

@ -17,17 +17,14 @@ ruma_event! {
#[cfg(test)]
mod tests {
use std::{
collections::BTreeMap,
time::{Duration, UNIX_EPOCH},
};
use std::time::{Duration, UNIX_EPOCH};
use ruma_identifiers::{EventId, RoomId, UserId};
use serde_json::to_string;
use crate::{
room::pinned_events::{PinnedEventsEvent, PinnedEventsEventContent},
Event, EventJson, RoomEvent, StateEvent,
Event, EventJson, RoomEvent, StateEvent, UnsignedData,
};
#[test]
@ -45,7 +42,7 @@ mod tests {
room_id: Some(RoomId::new("example.com").unwrap()),
sender: UserId::new("example.com").unwrap(),
state_key: "".to_string(),
unsigned: BTreeMap::new(),
unsigned: UnsignedData::default(),
};
let serialized_event = to_string(&event).unwrap();

13
src/room/power_levels.rs
View File

@ -5,9 +5,8 @@ use std::{collections::BTreeMap, time::SystemTime};
use js_int::Int;
use ruma_identifiers::{EventId, RoomId, UserId};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use crate::{EventType, FromRaw};
use crate::{EventType, FromRaw, UnsignedData};
/// Defines the power levels (privileges) of users in the room.
#[derive(Clone, Debug, PartialEq, Serialize)]
@ -32,8 +31,8 @@ pub struct PowerLevelsEvent {
pub room_id: Option<RoomId>,
/// Additional key-value pairs not signed by the homeserver.
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub unsigned: BTreeMap<String, Value>,
#[serde(skip_serializing_if = "ruma_serde::is_default")]
pub unsigned: UnsignedData,
/// The unique identifier for the user who sent this event.
pub sender: UserId,
@ -158,7 +157,7 @@ pub(crate) mod raw {
/// Additional key-value pairs not signed by the homeserver.
#[serde(default)]
pub unsigned: BTreeMap<String, Value>,
pub unsigned: UnsignedData,
/// The unique identifier for the user who sent this event.
pub sender: UserId,
@ -276,7 +275,7 @@ mod tests {
use super::{
default_power_level, NotificationPowerLevels, PowerLevelsEvent, PowerLevelsEventContent,
};
use crate::EventType;
use crate::{EventType,UnsignedData};
#[test]
fn serialization_with_optional_fields_as_none() {
@ -299,7 +298,7 @@ mod tests {
origin_server_ts: UNIX_EPOCH + Duration::from_millis(1),
prev_content: None,
room_id: None,
unsigned: BTreeMap::new(),
unsigned: UnsignedData::default(),
sender: UserId::try_from("@carl:example.com").unwrap(),
state_key: "".to_string(),
};

11
src/room/server_acl.rs
View File

@ -1,12 +1,11 @@
//! Types for the *m.room.server_acl* event.
use std::{collections::BTreeMap, time::SystemTime};
use std::time::SystemTime;
use ruma_identifiers::{EventId, RoomId, UserId};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use crate::{util::default_true, EventType, FromRaw};
use crate::{util::default_true, EventType, FromRaw, UnsignedData};
/// An event to indicate which servers are permitted to participate in the room.
#[derive(Clone, Debug, PartialEq, Serialize)]
@ -37,8 +36,8 @@ pub struct ServerAclEvent {
pub state_key: String,
/// Additional key-value pairs not signed by the homeserver.
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub unsigned: BTreeMap<String, Value>,
#[serde(skip_serializing_if = "UnsignedData::is_empty")]
pub unsigned: UnsignedData,
}
/// The payload for `ServerAclEvent`.
@ -129,7 +128,7 @@ pub(crate) mod raw {
/// Additional key-value pairs not signed by the homeserver.
#[serde(default)]
pub unsigned: BTreeMap<String, Value>,
pub unsigned: UnsignedData,
/// The unique identifier for the user who sent this event.
pub sender: UserId,

5
tests/ruma_events_macros.rs
View File

@ -5,6 +5,7 @@ use std::{
};
use ruma_events::util::serde_json_eq_try_from_raw;
use ruma_events::UnsignedData;
use ruma_events_macros::ruma_event;
use ruma_identifiers::{EventId, RoomAliasId, RoomId, UserId};
use serde_json::json;
@ -37,7 +38,7 @@ mod common_case {
room_id: None,
sender: UserId::try_from("@carl:example.com").unwrap(),
state_key: "example.com".to_string(),
unsigned: std::collections::BTreeMap::new(),
unsigned: UnsignedData::default(),
};
let json = json!({
"content": {
@ -66,7 +67,7 @@ mod common_case {
room_id: Some(RoomId::try_from("!n8f893n9:example.com").unwrap()),
sender: UserId::try_from("@carl:example.com").unwrap(),
state_key: "example.com".to_string(),
unsigned: std::collections::BTreeMap::new(),
unsigned: UnsignedData::default(),
};
let json = json!({
"content": {