331 lines
9.2 KiB
Rust
331 lines
9.2 KiB
Rust
//! A queue that holds at most ten of the most recent messages.
|
|
//!
|
|
//! The `Room` struct optionally holds a `MessageQueue` if the "messages"
|
|
//! feature is enabled.
|
|
|
|
use std::cmp::Ordering;
|
|
use std::ops::Deref;
|
|
use std::vec::IntoIter;
|
|
|
|
use crate::events::room::message::MessageEvent;
|
|
use crate::events::EventJson;
|
|
|
|
use serde::{de, ser, Serialize};
|
|
|
|
/// A queue that holds the 10 most recent messages received from the server.
|
|
#[derive(Clone, Debug, Default)]
|
|
pub struct MessageQueue {
|
|
msgs: Vec<MessageWrapper>,
|
|
}
|
|
|
|
#[derive(Clone, Debug, Serialize)]
|
|
pub struct MessageWrapper(MessageEvent);
|
|
|
|
impl Deref for MessageWrapper {
|
|
type Target = MessageEvent;
|
|
|
|
fn deref(&self) -> &Self::Target {
|
|
&self.0
|
|
}
|
|
}
|
|
|
|
impl PartialEq for MessageWrapper {
|
|
fn eq(&self, other: &MessageWrapper) -> bool {
|
|
self.0.event_id == other.0.event_id
|
|
}
|
|
}
|
|
|
|
impl Eq for MessageWrapper {}
|
|
|
|
impl PartialOrd for MessageWrapper {
|
|
fn partial_cmp(&self, other: &MessageWrapper) -> Option<Ordering> {
|
|
Some(self.0.origin_server_ts.cmp(&other.0.origin_server_ts))
|
|
}
|
|
}
|
|
|
|
impl Ord for MessageWrapper {
|
|
fn cmp(&self, other: &MessageWrapper) -> Ordering {
|
|
self.partial_cmp(other).unwrap_or(Ordering::Equal)
|
|
}
|
|
}
|
|
|
|
impl PartialEq for MessageQueue {
|
|
fn eq(&self, other: &MessageQueue) -> bool {
|
|
self.msgs.len() == other.msgs.len()
|
|
&& self
|
|
.msgs
|
|
.iter()
|
|
.zip(other.msgs.iter())
|
|
.all(|(msg_a, msg_b)| msg_a.event_id == msg_b.event_id)
|
|
}
|
|
}
|
|
|
|
impl MessageQueue {
|
|
/// Create a new empty `MessageQueue`.
|
|
pub fn new() -> Self {
|
|
Self {
|
|
msgs: Vec::with_capacity(20),
|
|
}
|
|
}
|
|
|
|
/// Inserts a `MessageEvent` into `MessageQueue`, sorted by by `origin_server_ts`.
|
|
///
|
|
/// Removes the oldest element in the queue if there are more than 10 elements.
|
|
pub fn push(&mut self, msg: MessageEvent) -> bool {
|
|
// only push new messages into the queue
|
|
if let Some(latest) = self.msgs.last() {
|
|
if msg.origin_server_ts < latest.origin_server_ts && self.msgs.len() >= 10 {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
let message = MessageWrapper(msg);
|
|
match self.msgs.binary_search_by(|m| m.cmp(&message)) {
|
|
Ok(pos) => {
|
|
if self.msgs[pos] != message {
|
|
self.msgs.insert(pos, message)
|
|
}
|
|
}
|
|
Err(pos) => self.msgs.insert(pos, message),
|
|
}
|
|
if self.msgs.len() > 10 {
|
|
self.msgs.remove(0);
|
|
}
|
|
true
|
|
}
|
|
|
|
pub fn iter(&self) -> impl Iterator<Item = &MessageWrapper> {
|
|
self.msgs.iter()
|
|
}
|
|
}
|
|
|
|
impl IntoIterator for MessageQueue {
|
|
type Item = MessageWrapper;
|
|
type IntoIter = IntoIter<Self::Item>;
|
|
|
|
fn into_iter(self) -> Self::IntoIter {
|
|
self.msgs.into_iter()
|
|
}
|
|
}
|
|
|
|
pub(crate) mod ser_deser {
|
|
use super::*;
|
|
|
|
pub fn deserialize<'de, D>(deserializer: D) -> Result<MessageQueue, D::Error>
|
|
where
|
|
D: de::Deserializer<'de>,
|
|
{
|
|
use serde::de::Error;
|
|
|
|
let messages: Vec<EventJson<MessageEvent>> = de::Deserialize::deserialize(deserializer)?;
|
|
|
|
let mut msgs = vec![];
|
|
for json in messages {
|
|
let msg = json.deserialize().map_err(D::Error::custom)?;
|
|
msgs.push(MessageWrapper(msg));
|
|
}
|
|
|
|
Ok(MessageQueue { msgs })
|
|
}
|
|
|
|
pub fn serialize<S>(msgs: &MessageQueue, serializer: S) -> Result<S::Ok, S::Error>
|
|
where
|
|
S: ser::Serializer,
|
|
{
|
|
msgs.msgs.serialize(serializer)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
use std::collections::HashMap;
|
|
use std::convert::TryFrom;
|
|
|
|
#[cfg(target_arch = "wasm32")]
|
|
use wasm_bindgen_test::*;
|
|
|
|
use crate::events::{collections::all::RoomEvent, EventJson};
|
|
use crate::identifiers::{RoomId, UserId};
|
|
use crate::Room;
|
|
|
|
#[test]
|
|
fn serialize() {
|
|
let id = RoomId::try_from("!roomid:example.com").unwrap();
|
|
let user = UserId::try_from("@example:example.com").unwrap();
|
|
|
|
let mut room = Room::new(&id, &user);
|
|
|
|
let json = std::fs::read_to_string("../test_data/events/message_text.json").unwrap();
|
|
let event = serde_json::from_str::<EventJson<RoomEvent>>(&json).unwrap();
|
|
|
|
let mut msgs = MessageQueue::new();
|
|
if let Ok(ev) = event.deserialize() {
|
|
if let RoomEvent::RoomMessage(msg) = ev {
|
|
msgs.push(msg);
|
|
}
|
|
}
|
|
room.messages = msgs;
|
|
|
|
let mut joined_rooms = HashMap::new();
|
|
joined_rooms.insert(id, room);
|
|
|
|
// println!("{}", serde_json::to_string_pretty(&joined_rooms).unwrap());
|
|
|
|
// this is the correct JSON string changes to `ruma-events` have not been released
|
|
// that would fix the doubling of fields
|
|
// TODO uncomment when fixed
|
|
// assert_eq!(
|
|
// r#"{
|
|
// "!roomid:example.com": {
|
|
// "room_id": "!roomid:example.com",
|
|
// "room_name": {
|
|
// "name": null,
|
|
// "canonical_alias": null,
|
|
// "aliases": [],
|
|
// "heroes": [],
|
|
// "joined_member_count": null,
|
|
// "invited_member_count": null
|
|
// },
|
|
// "own_user_id": "@example:example.com",
|
|
// "creator": null,
|
|
// "members": {},
|
|
// "messages": [
|
|
// {
|
|
// "type": "m.room.message",
|
|
// "content": {
|
|
// "body": "is dancing",
|
|
// "format": "org.matrix.custom.html",
|
|
// "formatted_body": "<strong>is dancing</strong>",
|
|
// "msgtype": "m.text"
|
|
// },
|
|
// "event_id": "$152037280074GZeOm:localhost",
|
|
// "origin_server_ts": 1520372800469,
|
|
// "sender": "@example:localhost",
|
|
// "unsigned": {
|
|
// "age": 598971425
|
|
// }
|
|
// }
|
|
// ],
|
|
// "typing_users": [],
|
|
// "power_levels": null,
|
|
// "encrypted": false,
|
|
// "unread_highlight": null,
|
|
// "unread_notifications": null,
|
|
// "tombstone": null
|
|
// }
|
|
// }"#,
|
|
// serde_json::to_string_pretty(&joined_rooms).unwrap()
|
|
// );
|
|
assert_eq!(
|
|
r#"{
|
|
"!roomid:example.com": {
|
|
"room_id": "!roomid:example.com",
|
|
"room_name": {
|
|
"name": null,
|
|
"canonical_alias": null,
|
|
"aliases": [],
|
|
"heroes": [],
|
|
"joined_member_count": null,
|
|
"invited_member_count": null
|
|
},
|
|
"own_user_id": "@example:example.com",
|
|
"creator": null,
|
|
"members": {},
|
|
"messages": [
|
|
{
|
|
"content": {
|
|
"msgtype": "m.text",
|
|
"msgtype": "m.text",
|
|
"body": "is dancing",
|
|
"format": "org.matrix.custom.html",
|
|
"formatted_body": "<strong>is dancing</strong>"
|
|
},
|
|
"event_id": "$152037280074GZeOm:localhost",
|
|
"origin_server_ts": 1520372800469,
|
|
"sender": "@example:localhost",
|
|
"unsigned": {
|
|
"age": 598971425
|
|
}
|
|
}
|
|
],
|
|
"typing_users": [],
|
|
"power_levels": null,
|
|
"encrypted": false,
|
|
"unread_highlight": null,
|
|
"unread_notifications": null,
|
|
"tombstone": null
|
|
}
|
|
}"#,
|
|
serde_json::to_string_pretty(&joined_rooms).unwrap()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn deserialize() {
|
|
let id = RoomId::try_from("!roomid:example.com").unwrap();
|
|
let user = UserId::try_from("@example:example.com").unwrap();
|
|
|
|
let mut room = Room::new(&id, &user);
|
|
|
|
let json = std::fs::read_to_string("../test_data/events/message_text.json").unwrap();
|
|
let event = serde_json::from_str::<EventJson<RoomEvent>>(&json).unwrap();
|
|
|
|
let mut msgs = MessageQueue::new();
|
|
if let Ok(ev) = event.deserialize() {
|
|
if let RoomEvent::RoomMessage(msg) = ev {
|
|
msgs.push(msg);
|
|
}
|
|
}
|
|
room.messages = msgs;
|
|
|
|
let mut joined_rooms = HashMap::new();
|
|
joined_rooms.insert(id, room.clone());
|
|
|
|
let json = r#"{
|
|
"!roomid:example.com": {
|
|
"room_id": "!roomid:example.com",
|
|
"room_name": {
|
|
"name": null,
|
|
"canonical_alias": null,
|
|
"aliases": [],
|
|
"heroes": [],
|
|
"joined_member_count": null,
|
|
"invited_member_count": null
|
|
},
|
|
"own_user_id": "@example:example.com",
|
|
"creator": null,
|
|
"members": {},
|
|
"messages": [
|
|
{
|
|
"type": "m.room.message",
|
|
"content": {
|
|
"body": "is dancing",
|
|
"format": "org.matrix.custom.html",
|
|
"formatted_body": "<strong>is dancing</strong>",
|
|
"msgtype": "m.text"
|
|
},
|
|
"event_id": "$152037280074GZeOm:localhost",
|
|
"origin_server_ts": 1520372800469,
|
|
"sender": "@example:localhost",
|
|
"unsigned": {
|
|
"age": 598971425
|
|
}
|
|
}
|
|
],
|
|
"typing_users": [],
|
|
"power_levels": null,
|
|
"encrypted": false,
|
|
"unread_highlight": null,
|
|
"unread_notifications": null,
|
|
"tombstone": null
|
|
}
|
|
}"#;
|
|
assert_eq!(
|
|
joined_rooms,
|
|
serde_json::from_str::<HashMap<RoomId, Room>>(json).unwrap()
|
|
);
|
|
}
|
|
}
|