xmpp: unit-tests for resource bind it and muc presence

Reviewed-on: lavina/lavina#64
Co-authored-by: Mikhail <mikhail@liamets.dev>
Co-committed-by: Mikhail <mikhail@liamets.dev>

crates/lavina-core/src/room.rs

@@ -159,6 +159,8 @@ impl RoomHandle {
         let room_storage_id = lock.storage_id;
         if !lock.storage.is_room_member(room_storage_id, player_storage_id).await.unwrap() {
             lock.storage.add_room_member(room_storage_id, player_storage_id).await.unwrap();
+        } else {
+            tracing::warn!("User {:#?} has already been added to the room.", player_id);
         }
         lock.members.insert(player_id.clone());
         let update = Updates::RoomJoined {

crates/projection-xmpp/src/iq.rs

@@ -3,8 +3,8 @@
 use quick_xml::events::Event;
 
 use lavina_core::room::{RoomId, RoomRegistry};
-use proto_xmpp::bind::{BindResponse, Jid, Name, Server};
-use proto_xmpp::client::{Iq, IqError, IqErrorType, IqType, Message, MessageType};
+use proto_xmpp::bind::{BindRequest, BindResponse, Jid, Name, Server};
+use proto_xmpp::client::{Iq, IqError, IqErrorType, IqType};
 use proto_xmpp::disco::{Feature, Identity, InfoQuery, Item, ItemQuery};
 use proto_xmpp::mam::{Fin, Set};
 use proto_xmpp::roster::RosterQuery;
@@ -17,17 +17,13 @@ use crate::XmppConnection;
 impl<'a> XmppConnection<'a> {
     pub async fn handle_iq(&self, output: &mut Vec<Event<'static>>, iq: Iq<IqClientBody>) {
         match iq.body {
-            IqClientBody::Bind(_) => {
+            IqClientBody::Bind(req) => {
                 let req = Iq {
                     from: None,
                     id: iq.id,
                     to: None,
                     r#type: IqType::Result,
-                    body: BindResponse(Jid {
-                        name: Some(self.user.xmpp_name.clone()),
-                        server: Server(self.hostname.clone()),
-                        resource: Some(self.user.xmpp_resource.clone()),
-                    }),
+                    body: self.bind(&req).await,
                 };
                 req.serialize(output);
             }
@@ -114,6 +110,14 @@ impl<'a> XmppConnection<'a> {
         }
     }
 
+    pub(crate) async fn bind(&self, req: &BindRequest) -> BindResponse {
+        BindResponse(Jid {
+            name: Some(self.user.xmpp_name.clone()),
+            server: Server(self.hostname.clone()),
+            resource: Some(self.user.xmpp_resource.clone()),
+        })
+    }
+
     async fn disco_info(&self, to: Option<&Jid>, req: &InfoQuery) -> Result<InfoQuery, IqError> {
         let identity;
         let feature;

crates/projection-xmpp/src/lib.rs

@@ -41,6 +41,9 @@ mod message;
 mod presence;
 mod updates;
 
+#[cfg(test)]
+mod testkit;
+
 #[derive(Deserialize, Debug, Clone)]
 pub struct ServerConfig {
     pub listen_on: SocketAddr,

crates/projection-xmpp/src/presence.rs

@@ -22,7 +22,8 @@ impl<'a> XmppConnection<'a> {
                 // resources in MUCs are members' personas – not implemented (yet?)
                 resource: Some(_),
             }) if server.0 == self.hostname_rooms => {
-                self.muc_presence(name, output).await?;
+                let response = self.muc_presence(&name).await?;
+                response.serialize(output);
             }
             _ => {
                 // TODO other presence cases
@@ -58,7 +59,8 @@ impl<'a> XmppConnection<'a> {
         }
     }
 
-    async fn muc_presence(&mut self, name: Name, output: &mut Vec<Event<'static>>) -> Result<()> {
+    // todo: return Presence and serialize on the outside.
+    async fn muc_presence(&mut self, name: &Name) -> Result<(Presence<()>)> {
         let a = self.user_handle.join_room(RoomId::from(name.0.clone())?).await?;
         // TODO handle bans
         let response = Presence::<()> {
@@ -74,7 +76,101 @@ impl<'a> XmppConnection<'a> {
             }),
             ..Default::default()
         };
-        response.serialize(output);
-        Ok(())
+        Ok(response)
+    }
+}
+
+// todo: set up so that the user has been previously joined.
+// todo: first call to muc_presence is OK, next one is OK too.
+
+#[cfg(test)]
+mod tests {
+    use crate::testkit::{expect_user_authenticated, TestServer};
+    use crate::{Authenticated, XmppConnection};
+    use lavina_core::player::PlayerId;
+    use proto_xmpp::bind::{BindRequest, BindResponse, Jid, Name, Resource, Server};
+    use proto_xmpp::client::Presence;
+
+    #[tokio::test]
+    async fn test_muc_joining() {
+        let server = TestServer::start().await.unwrap();
+
+        server.storage.create_user("tester").await.unwrap();
+
+        let player_id = PlayerId::from("tester").unwrap();
+        let user = Authenticated {
+            player_id,
+            xmpp_name: Name("tester".into()),
+            xmpp_resource: Resource("tester".into()),
+            xmpp_muc_name: Resource("tester".into()),
+        };
+
+        let mut player_conn = server.core.players.connect_to_player(&user.player_id).await;
+        let mut conn = expect_user_authenticated(&server, &user, &mut player_conn).await.unwrap();
+
+        let response = conn.muc_presence(&user.xmpp_name).await.unwrap();
+        let expected = Presence::<()> {
+            to: Some(Jid {
+                name: Some(conn.user.xmpp_name.clone()),
+                server: Server(conn.hostname.clone()),
+                resource: Some(conn.user.xmpp_resource.clone()),
+            }),
+            from: Some(Jid {
+                name: Some(user.xmpp_name.clone()),
+                server: Server(conn.hostname_rooms.clone()),
+                resource: Some(conn.user.xmpp_muc_name.clone()),
+            }),
+            ..Default::default()
+        };
+        assert_eq!(expected, response);
+
+        server.shutdown().await.unwrap();
+    }
+
+    // Test that joining a room second time after a server restart,
+    // i.e. in-memory cache of memberships is cleaned, does not cause any issues.
+    #[tokio::test]
+    async fn test_muc_joining_twice() {
+        let server = TestServer::start().await.unwrap();
+
+        server.storage.create_user("tester").await.unwrap();
+
+        let player_id = PlayerId::from("tester").unwrap();
+        let user = Authenticated {
+            player_id,
+            xmpp_name: Name("tester".into()),
+            xmpp_resource: Resource("tester".into()),
+            xmpp_muc_name: Resource("tester".into()),
+        };
+
+        let mut player_conn = server.core.players.connect_to_player(&user.player_id).await;
+        let mut conn = expect_user_authenticated(&server, &user, &mut player_conn).await.unwrap();
+
+        let response = conn.muc_presence(&user.xmpp_name).await.unwrap();
+        let expected = Presence::<()> {
+            to: Some(Jid {
+                name: Some(conn.user.xmpp_name.clone()),
+                server: Server(conn.hostname.clone()),
+                resource: Some(conn.user.xmpp_resource.clone()),
+            }),
+            from: Some(Jid {
+                name: Some(user.xmpp_name.clone()),
+                server: Server(conn.hostname_rooms.clone()),
+                resource: Some(conn.user.xmpp_muc_name.clone()),
+            }),
+            ..Default::default()
+        };
+        assert_eq!(expected, response);
+
+        drop(conn);
+        let server = server.reboot().await.unwrap();
+
+        let mut player_conn = server.core.players.connect_to_player(&user.player_id).await;
+        let mut conn = expect_user_authenticated(&server, &user, &mut player_conn).await.unwrap();
+
+        let response = conn.muc_presence(&user.xmpp_name).await.unwrap();
+        assert_eq!(expected, response);
+
+        server.shutdown().await.unwrap();
     }
 }

crates/projection-xmpp/src/testkit.rs

@@ -0,0 +1,66 @@
+use crate::{Authenticated, XmppConnection};
+use lavina_core::player::{PlayerConnection, PlayerId};
+use lavina_core::repo::{Storage, StorageConfig};
+use lavina_core::LavinaCore;
+use prometheus::Registry as MetricsRegistry;
+use proto_xmpp::bind::{BindRequest, BindResponse, Jid, Name, Resource, Server};
+
+pub(crate) struct TestServer {
+    pub metrics: MetricsRegistry,
+    pub storage: Storage,
+    pub core: LavinaCore,
+}
+
+impl TestServer {
+    pub async fn start() -> anyhow::Result<TestServer> {
+        let _ = tracing_subscriber::fmt::try_init();
+        let metrics = MetricsRegistry::new();
+        let storage = Storage::open(StorageConfig {
+            db_path: ":memory:".into(),
+        })
+        .await?;
+        let core = LavinaCore::new(metrics.clone(), storage.clone()).await?;
+        Ok(TestServer { metrics, storage, core })
+    }
+
+    pub async fn reboot(self) -> anyhow::Result<TestServer> {
+        self.core.shutdown().await?;
+
+        let metrics = MetricsRegistry::new();
+        let core = LavinaCore::new(metrics.clone(), self.storage.clone()).await?;
+
+        Ok(TestServer {
+            metrics,
+            storage: self.storage.clone(),
+            core,
+        })
+    }
+
+    pub async fn shutdown(self) -> anyhow::Result<()> {
+        self.core.shutdown().await?;
+        self.storage.close().await?;
+        Ok(())
+    }
+}
+
+pub async fn expect_user_authenticated<'a>(
+    server: &'a TestServer,
+    user: &'a Authenticated,
+    conn: &'a mut PlayerConnection,
+) -> anyhow::Result<XmppConnection<'a>> {
+    let conn = XmppConnection {
+        user: &user,
+        user_handle: conn,
+        rooms: &server.core.rooms,
+        hostname: "localhost".into(),
+        hostname_rooms: "rooms.localhost".into(),
+    };
+    let result = conn.bind(&BindRequest(Resource("whatever".into()))).await;
+    let expected = BindResponse(Jid {
+        name: Some(Name("tester".into())),
+        server: Server("localhost".into()),
+        resource: Some(Resource("tester".into())),
+    });
+    assert_eq!(expected, result);
+    Ok(conn)
+}

crates/proto-xmpp/src/bind.rs

@@ -127,12 +127,16 @@ impl FromXml for BindRequest {
     }
 }
 
+#[derive(PartialEq, Eq, Debug)]
 pub struct BindResponse(pub Jid);
 
 impl ToXml for BindResponse {
     fn serialize(&self, events: &mut Vec<Event<'static>>) {
         events.extend_from_slice(&[
-            Event::Start(BytesStart::new(r#"bind xmlns="urn:ietf:params:xml:ns:xmpp-bind""#)),
+            Event::Start(BytesStart::from_content(
+                r#"bind xmlns="urn:ietf:params:xml:ns:xmpp-bind""#,
+                4,
+            )),
             Event::Start(BytesStart::new(r#"jid"#)),
             Event::Text(BytesText::new(self.0.to_string().as_str()).into_owned()),
             Event::End(BytesEnd::new("jid")),