matrix-rust-sdk/matrix_sdk_base/src/models/message.rs

//! 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::{time::SystemTime, vec::IntoIter};

use matrix_sdk_common::{
    events::AnyPossiblyRedactedSyncMessageEvent,
    identifiers::{EventId, UserId},
};
use serde::{de, ser, Serialize};

/// Exposes some of the field access methods found in the event held by
/// `AnyPossiblyRedacted*` enums.
///
/// This is just an extension trait to ease the use of certain event enums.
pub trait PossiblyRedactedExt {
    /// Access the redacted or full event's `event_id` field.
    fn event_id(&self) -> &EventId;
    /// Access the redacted or full event's `origin_server_ts` field.
    fn origin_server_ts(&self) -> &SystemTime;
    /// Access the redacted or full event's `sender` field.
    fn sender(&self) -> &UserId;
}

impl PossiblyRedactedExt for AnyPossiblyRedactedSyncMessageEvent {
    /// Access the underlying event's `event_id`.
    fn event_id(&self) -> &EventId {
        match self {
            Self::Regular(e) => e.event_id(),
            Self::Redacted(e) => e.event_id(),
        }
    }

    /// Access the underlying event's `origin_server_ts`.
    fn origin_server_ts(&self) -> &SystemTime {
        match self {
            Self::Regular(e) => e.origin_server_ts(),
            Self::Redacted(e) => e.origin_server_ts(),
        }
    }

    /// Access the underlying event's `sender`.
    fn sender(&self) -> &UserId {
        match self {
            Self::Regular(e) => e.sender(),
            Self::Redacted(e) => e.sender(),
        }
    }
}

const MESSAGE_QUEUE_CAP: usize = 35;

/// A queue that holds the 35 most recent messages received from the server.
#[derive(Clone, Debug, Default)]
pub struct MessageQueue {
    pub(crate) msgs: Vec<AnyPossiblyRedactedSyncMessageEvent>,
}

impl MessageQueue {
    /// Create a new empty `MessageQueue`.
    pub fn new() -> Self {
        Self {
            msgs: Vec::with_capacity(45),
        }
    }

    /// 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: AnyPossiblyRedactedSyncMessageEvent) -> 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;
            }
        }

        if self.msgs.iter().all(|old| old.event_id() != msg.event_id()) {
            self.msgs.push(msg)
        }

        if self.msgs.len() > MESSAGE_QUEUE_CAP {
            self.msgs.pop();
        }
        true
    }

    /// Iterate over the messages in the queue.
    pub fn iter(&self) -> impl Iterator<Item = &AnyPossiblyRedactedSyncMessageEvent> {
        self.msgs.iter()
    }

    /// Iterate over each message mutably.
    pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut AnyPossiblyRedactedSyncMessageEvent> {
        self.msgs.iter_mut()
    }
}

impl PartialEq for MessageQueue {
    fn eq(&self, other: &MessageQueue) -> bool {
        self.msgs
            .iter()
            .zip(other.msgs.iter())
            .all(|(a, b)| a.event_id() == b.event_id())
    }
}

impl IntoIterator for MessageQueue {
    type Item = AnyPossiblyRedactedSyncMessageEvent;
    type IntoIter = IntoIter<Self::Item>;

    fn into_iter(self) -> Self::IntoIter {
        self.msgs.into_iter()
    }
}

pub(crate) mod ser_deser {
    use std::fmt;

    use super::*;

    struct MessageQueueDeserializer;

    impl<'de> de::Visitor<'de> for MessageQueueDeserializer {
        type Value = MessageQueue;

        fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
            formatter.write_str("an array of message events")
        }

        fn visit_seq<S>(self, mut access: S) -> Result<Self::Value, S::Error>
        where
            S: de::SeqAccess<'de>,
        {
            let mut msgs = Vec::with_capacity(access.size_hint().unwrap_or(0));

            while let Some(msg) = access.next_element::<AnyPossiblyRedactedSyncMessageEvent>()? {
                msgs.push(msg);
            }

            Ok(MessageQueue { msgs })
        }
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<MessageQueue, D::Error>
    where
        D: de::Deserializer<'de>,
    {
        deserializer.deserialize_seq(MessageQueueDeserializer)
    }

    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 std::collections::HashMap;

    use matrix_sdk_common::{
        events::{AnyPossiblyRedactedSyncMessageEvent, AnySyncMessageEvent},
        identifiers::{room_id, user_id, RoomId},
    };
    use matrix_sdk_test::test_json;
    #[cfg(target_arch = "wasm32")]
    use wasm_bindgen_test::*;

    use super::*;
    use crate::Room;

    #[test]
    fn serialize() {
        let id = room_id!("!roomid:example.com");
        let user = user_id!("@example:example.com");

        let mut room = Room::new(&id, &user);

        let json: &serde_json::Value = &test_json::MESSAGE_TEXT;
        let msg = AnyPossiblyRedactedSyncMessageEvent::Regular(
            serde_json::from_value::<AnySyncMessageEvent>(json.clone()).unwrap(),
        );

        let mut msgs = MessageQueue::new();
        msgs.push(msg.clone());
        room.messages = msgs;
        let mut joined_rooms = HashMap::new();
        joined_rooms.insert(id, room);

        assert_eq!(
            serde_json::json!({
                "!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,
                    "joined_members": {},
                    "invited_members": {},
                    "messages": [ msg ],
                    "typing_users": [],
                    "power_levels": null,
                    "encrypted": null,
                    "unread_highlight": null,
                    "unread_notifications": null,
                    "tombstone": null
                }
            }),
            serde_json::to_value(&joined_rooms).unwrap()
        );
    }

    #[test]
    fn deserialize() {
        let id = room_id!("!roomid:example.com");
        let user = user_id!("@example:example.com");

        let mut room = Room::new(&id, &user);

        let json: &serde_json::Value = &test_json::MESSAGE_TEXT;
        let msg = AnyPossiblyRedactedSyncMessageEvent::Regular(
            serde_json::from_value::<AnySyncMessageEvent>(json.clone()).unwrap(),
        );

        let mut msgs = MessageQueue::new();
        msgs.push(msg.clone());
        room.messages = msgs;

        let mut joined_rooms = HashMap::new();
        joined_rooms.insert(id, room);

        let json = serde_json::json!({
            "!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,
                "joined_members": {},
                "invited_members": {},
                "messages": [ msg ],
                "typing_users": [],
                "power_levels": null,
                "encrypted": null,
                "unread_highlight": null,
                "unread_notifications": null,
                "tombstone": null
            }
        });
        assert_eq!(
            joined_rooms,
            serde_json::from_value::<HashMap<RoomId, Room>>(json).unwrap()
        );
    }
}