diff --git a/examples/command_bot.rs b/examples/command_bot.rs new file mode 100644 index 00000000..220b0ea1 --- /dev/null +++ b/examples/command_bot.rs @@ -0,0 +1,118 @@ +use std::sync::Arc; +use std::{env, process::exit}; + +use matrix_sdk::{ + self, + events::room::message::{MessageEvent, MessageEventContent, TextMessageEventContent}, + AsyncClient, AsyncClientConfig, EventEmitter, Room, SyncSettings, +}; +use tokio::sync::RwLock; +use url::Url; + +struct CommandBot { + /// This clone of the `AsyncClient` will send requests to the server, + /// while the other keeps us in sync with the server using `sync_forever`. + client: AsyncClient, +} + +impl CommandBot { + pub fn new(client: AsyncClient) -> Self { + Self { client } + } +} + +#[async_trait::async_trait] +impl EventEmitter for CommandBot { + async fn on_room_message(&self, room: Arc>, event: &MessageEvent) { + let msg_body = if let MessageEvent { + content: MessageEventContent::Text(TextMessageEventContent { body: msg_body, .. }), + .. + } = event + { + msg_body.clone() + } else { + String::new() + }; + + if msg_body.contains("!party") { + let content = MessageEventContent::Text(TextMessageEventContent { + body: "🎉🎊🥳 let's PARTY!! 🥳🎊🎉".to_string(), + format: None, + formatted_body: None, + relates_to: None, + }); + // we clone here to hold the lock for as little time as possible. + let room_id = room.read().await.room_id.clone(); + + println!("sending"); + + self.client + // send our message to the room we found the "!party" command in + // the last parameter is an optional Uuid which we don't care about. + .room_send(&room_id, content, None) + .await + .unwrap(); + + println!("message sent"); + } + } +} + +async fn login_and_sync( + homeserver_url: String, + username: String, + password: String, +) -> Result<(), matrix_sdk::Error> { + let client_config = AsyncClientConfig::new() + .proxy("http://localhost:8080")? + .disable_ssl_verification(); + + let homeserver_url = Url::parse(&homeserver_url)?; + // create a new AsyncClient with the given homeserver url and config + let mut client = AsyncClient::new_with_config(homeserver_url, None, client_config).unwrap(); + + client + .login( + username.clone(), + password, + None, + Some("command bot".to_string()), + ) + .await?; + + println!("logged in as {}", username); + + // initial sync to set up state and so our bot doesn't respond to old messages + client.sync(SyncSettings::default()).await.unwrap(); + // add our CommandBot to be notified of incoming messages, we do this after the initial + // sync to avoid responding to messages before the bot was running. + client + .add_event_emitter(Box::new(CommandBot::new(client.clone()))) + .await; + + // since we called sync before we `sync_forever` we must pass that sync token to + // `sync_forever` + let settings = SyncSettings::default().token(client.sync_token().await.unwrap()); + // this keeps state from the server streaming in to CommandBot via the EventEmitter trait + client.sync_forever(settings, |_| async {}).await; + + Ok(()) +} + +#[tokio::main] +async fn main() -> Result<(), matrix_sdk::Error> { + let (homeserver_url, username, password) = + match (env::args().nth(1), env::args().nth(2), env::args().nth(3)) { + (Some(a), Some(b), Some(c)) => (a, b, c), + _ => { + eprintln!( + "Usage: {} ", + env::args().next().unwrap() + ); + exit(1) + } + }; + + login_and_sync(homeserver_url, username, password).await?; + Ok(()) +} diff --git a/examples/login.rs b/examples/login.rs index e69a9087..150684c7 100644 --- a/examples/login.rs +++ b/examples/login.rs @@ -1,4 +1,3 @@ -use std::ops::Deref; use std::sync::Arc; use std::{env, process::exit}; use url::Url; @@ -8,26 +7,31 @@ use matrix_sdk::{ events::room::message::{MessageEvent, MessageEventContent, TextMessageEventContent}, AsyncClient, AsyncClientConfig, EventEmitter, Room, SyncSettings, }; -use tokio::sync::Mutex; +use tokio::sync::RwLock; struct EventCallback; #[async_trait::async_trait] impl EventEmitter for EventCallback { - async fn on_room_message(&mut self, room: Arc>, event: Arc>) { + async fn on_room_message(&self, room: Arc>, event: &MessageEvent) { if let MessageEvent { content: MessageEventContent::Text(TextMessageEventContent { body: msg_body, .. }), sender, .. - } = event.lock().await.deref() + } = event { - let rooms = room.lock().await; - let member = rooms.members.get(&sender).unwrap(); - println!( - "{}: {}", - member.display_name.as_ref().unwrap_or(&sender.to_string()), - msg_body - ); + let name = { + // any reads should be held for the shortest time possible to + // avoid dead locks + let room = room.read().await; + let member = room.members.get(&sender).unwrap(); + member + .display_name + .as_ref() + .map(ToString::to_string) + .unwrap_or(sender.to_string()) + }; + println!("{}: {}", name, msg_body); } } } @@ -43,9 +47,7 @@ async fn login( let homeserver_url = Url::parse(&homeserver_url)?; let mut client = AsyncClient::new_with_config(homeserver_url, None, client_config).unwrap(); - client - .add_event_emitter(Arc::new(Mutex::new(Box::new(EventCallback)))) - .await; + client.add_event_emitter(Box::new(EventCallback)).await; client .login(username, password, None, Some("rust-sdk".to_string())) diff --git a/src/async_client.rs b/src/async_client.rs index 718e423b..5e298a8b 100644 --- a/src/async_client.rs +++ b/src/async_client.rs @@ -53,6 +53,8 @@ const DEFAULT_SYNC_TIMEOUT: Duration = Duration::from_secs(30); #[derive(Clone)] /// An async/await enabled Matrix client. +/// +/// All of the state is held in an `Arc` so the `AsyncClient` can be cloned freely. pub struct AsyncClient { /// The URL of the homeserver to connect to. homeserver: Url, @@ -273,10 +275,7 @@ impl AsyncClient { /// Add `EventEmitter` to `AsyncClient`. /// /// The methods of `EventEmitter` are called when the respective `RoomEvents` occur. - pub async fn add_event_emitter( - &mut self, - emitter: Arc>>, - ) { + pub async fn add_event_emitter(&mut self, emitter: Box) { self.base_client.write().await.event_emitter = Some(emitter); } @@ -301,7 +300,7 @@ impl AsyncClient { /// Returns the rooms this client knows about. /// /// A `HashMap` of room id to `matrix::models::Room` - pub async fn get_rooms(&self) -> HashMap>> { + pub async fn get_rooms(&self) -> HashMap>> { self.base_client.read().await.joined_rooms.clone() } @@ -319,7 +318,7 @@ impl AsyncClient { /// only if the client also holds the encryption keys for this device. #[instrument(skip(password))] pub async fn login + std::fmt::Debug>( - &mut self, + &self, user: S, password: S, device_id: Option, @@ -369,7 +368,7 @@ impl AsyncClient { /// * alias - The `RoomId` or `RoomAliasId` of the room to be joined. /// An alias looks like this `#name:example.com` pub async fn join_room_by_id_or_alias( - &mut self, + &self, alias: &RoomIdOrAliasId, ) -> Result { let request = join_room_by_id_or_alias::Request { @@ -391,7 +390,7 @@ impl AsyncClient { /// /// * reason - Optional reason why the room member is being kicked out. pub async fn kick_user( - &mut self, + &self, room_id: &RoomId, user_id: &UserId, reason: Option, @@ -412,7 +411,7 @@ impl AsyncClient { /// /// * room_id - The `RoomId` of the room to leave. /// - pub async fn leave_room(&mut self, room_id: &RoomId) -> Result { + pub async fn leave_room(&self, room_id: &RoomId) -> Result { let request = leave_room::Request { room_id: room_id.clone(), }; @@ -429,7 +428,7 @@ impl AsyncClient { /// /// * user_id - The `UserId` of the user to invite to the room. pub async fn invite_user_by_id( - &mut self, + &self, room_id: &RoomId, user_id: &UserId, ) -> Result { @@ -452,7 +451,7 @@ impl AsyncClient { /// /// * invite_id - A third party id of a user to invite to the room. pub async fn invite_user_by_3pid( - &mut self, + &self, room_id: &RoomId, invite_id: &Invite3pid, ) -> Result { @@ -493,7 +492,7 @@ impl AsyncClient { /// # }); /// ``` pub async fn create_room>( - &mut self, + &self, room: R, ) -> Result { let request = room.into(); @@ -537,7 +536,7 @@ impl AsyncClient { /// # }); /// ``` pub async fn room_messages>( - &mut self, + &self, request: R, ) -> Result { let req = request.into(); @@ -550,10 +549,7 @@ impl AsyncClient { /// /// * `sync_settings` - Settings for the sync call. #[instrument] - pub async fn sync( - &mut self, - sync_settings: SyncSettings, - ) -> Result { + pub async fn sync(&self, sync_settings: SyncSettings) -> Result { let request = sync_events::Request { filter: None, since: sync_settings.token, @@ -565,9 +561,8 @@ impl AsyncClient { let mut response = self.send(request).await?; for (room_id, room) in &mut response.rooms.join { - let mut client = self.base_client.write().await; - let _matrix_room = { + let mut client = self.base_client.write().await; for event in &room.state.events { if let EventResult::Ok(e) = event { client.receive_joined_state_event(&room_id, &e).await; @@ -580,12 +575,14 @@ impl AsyncClient { // re looping is not ideal here for event in &mut room.state.events { if let EventResult::Ok(e) = event { + let client = self.base_client.read().await; client.emit_state_event(room_id, e).await; } } for mut event in &mut room.timeline.events { let decrypted_event = { + let mut client = self.base_client.write().await; client .receive_joined_timeline_event(room_id, &mut event) .await @@ -596,6 +593,7 @@ impl AsyncClient { } if let EventResult::Ok(e) = event { + let client = self.base_client.read().await; client.emit_timeline_event(room_id, e).await; } } @@ -604,8 +602,8 @@ impl AsyncClient { for account_data in &mut room.account_data.events { { if let EventResult::Ok(e) = account_data { + let mut client = self.base_client.write().await; client.receive_account_data_event(&room_id, e).await; - client.emit_account_data_event(room_id, e).await; } } @@ -617,6 +615,7 @@ impl AsyncClient { for presence in &mut response.presence.events { { if let EventResult::Ok(e) = presence { + let mut client = self.base_client.write().await; client.receive_presence_event(&room_id, e).await; client.emit_presence_event(room_id, e).await; @@ -627,6 +626,7 @@ impl AsyncClient { for ephemeral in &mut room.ephemeral.events { { if let EventResult::Ok(e) = ephemeral { + let mut client = self.base_client.write().await; client.receive_ephemeral_event(&room_id, e).await; client.emit_ephemeral_event(room_id, e).await; @@ -698,7 +698,7 @@ impl AsyncClient { /// ``` #[instrument(skip(callback))] pub async fn sync_forever( - &mut self, + &self, sync_settings: SyncSettings, callback: impl Fn(sync_events::IncomingResponse) -> C + Send, ) where @@ -810,7 +810,6 @@ impl AsyncClient { } else { request_builder }; - let mut response = request_builder.send().await?; trace!("Got response: {:?}", response); @@ -877,7 +876,7 @@ impl AsyncClient { /// }) /// ``` pub async fn room_send( - &mut self, + &self, room_id: &RoomId, #[allow(unused_mut)] mut content: MessageEventContent, txn_id: Option, @@ -892,7 +891,7 @@ impl AsyncClient { let room = client.joined_rooms.get(room_id); match room { - Some(r) => r.lock().await.is_encrypted(), + Some(r) => r.read().await.is_encrypted(), None => false, } }; @@ -901,7 +900,7 @@ impl AsyncClient { let missing_sessions = { let client = self.base_client.read().await; let room = client.joined_rooms.get(room_id); - let room = room.as_ref().unwrap().lock().await; + let room = room.as_ref().unwrap().read().await; let users = room.members.keys(); self.base_client .read() diff --git a/src/base_client.rs b/src/base_client.rs index 12164686..33a0314f 100644 --- a/src/base_client.rs +++ b/src/base_client.rs @@ -36,7 +36,9 @@ use crate::models::Room; use crate::session::Session; use crate::EventEmitter; +#[cfg(feature = "encryption")] use tokio::sync::Mutex; +use tokio::sync::RwLock; #[cfg(feature = "encryption")] use crate::crypto::{OlmMachine, OneTimeKeys}; @@ -65,14 +67,14 @@ pub struct Client { /// The current sync token that should be used for the next sync call. pub sync_token: Option, /// A map of the rooms our user is joined in. - pub joined_rooms: HashMap>>, + pub joined_rooms: HashMap>>, /// A list of ignored users. pub ignored_users: Vec, /// The push ruleset for the logged in user. pub push_ruleset: Option, /// Any implementor of EventEmitter will act as the callbacks for various /// events. - pub event_emitter: Option>>>, + pub event_emitter: Option>, #[cfg(feature = "encryption")] olm: Arc>>, @@ -125,10 +127,7 @@ impl Client { /// Add `EventEmitter` to `Client`. /// /// The methods of `EventEmitter` are called when the respective `RoomEvents` occur. - pub async fn add_event_emitter( - &mut self, - emitter: Arc>>, - ) { + pub async fn add_event_emitter(&mut self, emitter: Box) { self.event_emitter = Some(emitter); } @@ -160,7 +159,7 @@ impl Client { pub(crate) async fn calculate_room_name(&self, room_id: &RoomId) -> Option { if let Some(room) = self.joined_rooms.get(room_id) { - let room = room.lock().await; + let room = room.read().await; Some(room.room_name.calculate_name(room_id, &room.members)) } else { None @@ -170,17 +169,17 @@ impl Client { pub(crate) async fn calculate_room_names(&self) -> Vec { let mut res = Vec::new(); for (id, room) in &self.joined_rooms { - let room = room.lock().await; + let room = room.read().await; res.push(room.room_name.calculate_name(id, &room.members)) } res } - pub(crate) fn get_or_create_room(&mut self, room_id: &RoomId) -> &mut Arc> { + pub(crate) fn get_or_create_room(&mut self, room_id: &RoomId) -> &mut Arc> { #[allow(clippy::or_fun_call)] self.joined_rooms .entry(room_id.clone()) - .or_insert(Arc::new(Mutex::new(Room::new( + .or_insert(Arc::new(RwLock::new(Room::new( room_id, &self .session @@ -190,7 +189,7 @@ impl Client { )))) } - pub(crate) fn get_room(&self, room_id: &RoomId) -> Option<&Arc>> { + pub(crate) fn get_room(&self, room_id: &RoomId) -> Option<&Arc>> { self.joined_rooms.get(room_id) } @@ -259,7 +258,7 @@ impl Client { } } - let mut room = self.get_or_create_room(&room_id).lock().await; + let mut room = self.get_or_create_room(&room_id).write().await; room.receive_timeline_event(e); decrypted_event } @@ -282,7 +281,7 @@ impl Client { room_id: &RoomId, event: &StateEvent, ) -> bool { - let mut room = self.get_or_create_room(room_id).lock().await; + let mut room = self.get_or_create_room(room_id).write().await; room.receive_state_event(event) } @@ -303,7 +302,7 @@ impl Client { ) -> bool { // this should be the room that was just created in the `Client::sync` loop. if let Some(room) = self.get_room(room_id) { - let mut room = room.lock().await; + let mut room = room.write().await; room.receive_presence_event(event) } else { false @@ -376,7 +375,7 @@ impl Client { // part where we already iterate through the rooms to avoid yet // another room loop. for room in self.joined_rooms.values() { - let room = room.lock().await; + let room = room.write().await; if !room.is_encrypted() { continue; } @@ -459,7 +458,7 @@ impl Client { match &mut *olm { Some(o) => { - let room = room.lock().await; + let room = room.write().await; let members = room.members.keys(); Ok(o.share_group_session(room_id, members).await?) } @@ -573,37 +572,26 @@ impl Client { Ok(()) } - pub(crate) async fn emit_timeline_event(&mut self, room_id: &RoomId, event: &mut RoomEvent) { + pub(crate) async fn emit_timeline_event(&self, room_id: &RoomId, event: &RoomEvent) { match event { RoomEvent::RoomMember(mem) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_room_member(Arc::clone(&room), Arc::new(Mutex::new(mem.clone()))) - .await; + ee.on_room_member(Arc::clone(&room), &mem).await; } } } RoomEvent::RoomName(name) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_room_name(Arc::clone(&room), Arc::new(Mutex::new(name.clone()))) - .await; + ee.on_room_name(Arc::clone(&room), &name).await; } } } RoomEvent::RoomCanonicalAlias(canonical) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_room_canonical_alias( - Arc::clone(&room), - Arc::new(Mutex::new(canonical.clone())), - ) + ee.on_room_canonical_alias(Arc::clone(&room), &canonical) .await; } } @@ -611,45 +599,28 @@ impl Client { RoomEvent::RoomAliases(aliases) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_room_aliases( - Arc::clone(&room), - Arc::new(Mutex::new(aliases.clone())), - ) - .await; + ee.on_room_aliases(Arc::clone(&room), &aliases).await; } } } RoomEvent::RoomAvatar(avatar) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_room_avatar(Arc::clone(&room), Arc::new(Mutex::new(avatar.clone()))) - .await; + ee.on_room_avatar(Arc::clone(&room), &avatar).await; } } } RoomEvent::RoomMessage(msg) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_room_message(Arc::clone(&room), Arc::new(Mutex::new(msg.clone()))) - .await; + ee.on_room_message(Arc::clone(&room), &msg).await; } } } RoomEvent::RoomMessageFeedback(msg_feedback) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_room_message_feedback( - Arc::clone(&room), - Arc::new(Mutex::new(msg_feedback.clone())), - ) + ee.on_room_message_feedback(Arc::clone(&room), &msg_feedback) .await; } } @@ -657,26 +628,14 @@ impl Client { RoomEvent::RoomRedaction(redaction) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_room_redaction( - Arc::clone(&room), - Arc::new(Mutex::new(redaction.clone())), - ) - .await; + ee.on_room_redaction(Arc::clone(&room), &redaction).await; } } } RoomEvent::RoomPowerLevels(power) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_room_power_levels( - Arc::clone(&room), - Arc::new(Mutex::new(power.clone())), - ) - .await; + ee.on_room_power_levels(Arc::clone(&room), &power).await; } } } @@ -684,40 +643,26 @@ impl Client { } } - pub(crate) async fn emit_state_event(&mut self, room_id: &RoomId, event: &mut StateEvent) { + pub(crate) async fn emit_state_event(&self, room_id: &RoomId, event: &StateEvent) { match event { StateEvent::RoomMember(member) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_state_member( - Arc::clone(&room), - Arc::new(Mutex::new(member.clone())), - ) - .await; + ee.on_state_member(Arc::clone(&room), &member).await; } } } StateEvent::RoomName(name) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_state_name(Arc::clone(&room), Arc::new(Mutex::new(name.clone()))) - .await; + ee.on_state_name(Arc::clone(&room), &name).await; } } } StateEvent::RoomCanonicalAlias(canonical) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_state_canonical_alias( - Arc::clone(&room), - Arc::new(Mutex::new(canonical.clone())), - ) + ee.on_state_canonical_alias(Arc::clone(&room), &canonical) .await; } } @@ -725,52 +670,28 @@ impl Client { StateEvent::RoomAliases(aliases) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_state_aliases( - Arc::clone(&room), - Arc::new(Mutex::new(aliases.clone())), - ) - .await; + ee.on_state_aliases(Arc::clone(&room), &aliases).await; } } } StateEvent::RoomAvatar(avatar) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_state_avatar( - Arc::clone(&room), - Arc::new(Mutex::new(avatar.clone())), - ) - .await; + ee.on_state_avatar(Arc::clone(&room), &avatar).await; } } } StateEvent::RoomPowerLevels(power) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_state_power_levels( - Arc::clone(&room), - Arc::new(Mutex::new(power.clone())), - ) - .await; + ee.on_state_power_levels(Arc::clone(&room), &power).await; } } } StateEvent::RoomJoinRules(rules) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_state_join_rules( - Arc::clone(&room), - Arc::new(Mutex::new(rules.clone())), - ) - .await; + ee.on_state_join_rules(Arc::clone(&room), &rules).await; } } } @@ -778,34 +699,19 @@ impl Client { } } - pub(crate) async fn emit_account_data_event( - &mut self, - room_id: &RoomId, - event: &mut NonRoomEvent, - ) { + pub(crate) async fn emit_account_data_event(&self, room_id: &RoomId, event: &NonRoomEvent) { match event { NonRoomEvent::Presence(presence) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_account_presence( - Arc::clone(&room), - Arc::new(Mutex::new(presence.clone())), - ) - .await; + ee.on_account_presence(Arc::clone(&room), &presence).await; } } } NonRoomEvent::IgnoredUserList(ignored) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_account_ignored_users( - Arc::clone(&room), - Arc::new(Mutex::new(ignored.clone())), - ) + ee.on_account_ignored_users(Arc::clone(&room), &ignored) .await; } } @@ -813,25 +719,14 @@ impl Client { NonRoomEvent::PushRules(rules) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_account_push_rules( - Arc::clone(&room), - Arc::new(Mutex::new(rules.clone())), - ) - .await; + ee.on_account_push_rules(Arc::clone(&room), &rules).await; } } } NonRoomEvent::FullyRead(full_read) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_account_data_fully_read( - Arc::clone(&room), - Arc::new(Mutex::new(full_read.clone())), - ) + ee.on_account_data_fully_read(Arc::clone(&room), &full_read) .await; } } @@ -840,34 +735,19 @@ impl Client { } } - pub(crate) async fn emit_ephemeral_event( - &mut self, - room_id: &RoomId, - event: &mut NonRoomEvent, - ) { + pub(crate) async fn emit_ephemeral_event(&self, room_id: &RoomId, event: &NonRoomEvent) { match event { NonRoomEvent::Presence(presence) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_account_presence( - Arc::clone(&room), - Arc::new(Mutex::new(presence.clone())), - ) - .await; + ee.on_account_presence(Arc::clone(&room), &presence).await; } } } NonRoomEvent::IgnoredUserList(ignored) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_account_ignored_users( - Arc::clone(&room), - Arc::new(Mutex::new(ignored.clone())), - ) + ee.on_account_ignored_users(Arc::clone(&room), &ignored) .await; } } @@ -875,25 +755,14 @@ impl Client { NonRoomEvent::PushRules(rules) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_account_push_rules( - Arc::clone(&room), - Arc::new(Mutex::new(rules.clone())), - ) - .await; + ee.on_account_push_rules(Arc::clone(&room), &rules).await; } } } NonRoomEvent::FullyRead(full_read) => { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_account_data_fully_read( - Arc::clone(&room), - Arc::new(Mutex::new(full_read.clone())), - ) + ee.on_account_data_fully_read(Arc::clone(&room), &full_read) .await; } } @@ -902,17 +771,10 @@ impl Client { } } - pub(crate) async fn emit_presence_event( - &mut self, - room_id: &RoomId, - event: &mut PresenceEvent, - ) { + pub(crate) async fn emit_presence_event(&self, room_id: &RoomId, event: &PresenceEvent) { if let Some(ee) = &self.event_emitter { if let Some(room) = self.get_room(&room_id) { - ee.lock() - .await - .on_presence_event(Arc::clone(&room), Arc::new(Mutex::new(event.clone()))) - .await; + ee.on_presence_event(Arc::clone(&room), &event).await; } } } @@ -949,7 +811,7 @@ mod test { .with_body_from_file("tests/data/sync.json") .create(); - let mut client = AsyncClient::new(homeserver, Some(session)).unwrap(); + let client = AsyncClient::new(homeserver, Some(session)).unwrap(); let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000)); diff --git a/src/event_emitter/mod.rs b/src/event_emitter/mod.rs index 0129cadf..2d675521 100644 --- a/src/event_emitter/mod.rs +++ b/src/event_emitter/mod.rs @@ -12,7 +12,6 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. - use std::sync::Arc; use crate::events::{ @@ -33,8 +32,8 @@ use crate::events::{ }, }; use crate::models::Room; +use tokio::sync::RwLock; -use tokio::sync::Mutex; /// This trait allows any type implementing `EventEmitter` to specify event callbacks for each event. /// The `AsyncClient` calls each method when the corresponding event is received. /// @@ -51,29 +50,29 @@ use tokio::sync::Mutex; /// }, /// AsyncClient, AsyncClientConfig, EventEmitter, Room, SyncSettings, /// }; -/// use tokio::sync::Mutex; +/// use tokio::sync::RwLock; /// /// struct EventCallback; /// /// #[async_trait::async_trait] /// impl EventEmitter for EventCallback { -/// async fn on_room_message(&mut self, room: Arc>, event: Arc>) { +/// async fn on_room_message(&self, room: Arc>, event: &MessageEvent) { /// if let MessageEvent { /// content: MessageEventContent::Text(TextMessageEventContent { body: msg_body, .. }), /// sender, /// .. -/// } = event.lock().await.deref() +/// } = event /// { -/// let rooms = room.lock().await; -/// let member = rooms.members.get(&sender).unwrap(); -/// println!( -/// "{}: {}", -/// member -/// .display_name -/// .as_ref() -/// .unwrap_or(&sender.to_string()), -/// msg_body -/// ); +/// let name = { +/// let room = room.read().await; +/// let member = room.members.get(&sender).unwrap(); +/// member +/// .display_name +/// .as_ref() +/// .map(ToString::to_string) +/// .unwrap_or(sender.to_string()) +/// }; +/// println!("{}: {}", name, msg_body); /// } /// } /// } @@ -82,193 +81,128 @@ use tokio::sync::Mutex; pub trait EventEmitter: Send + Sync { // ROOM EVENTS from `IncomingTimeline` /// Fires when `AsyncClient` receives a `RoomEvent::RoomMember` event. - async fn on_room_member(&mut self, _: Arc>, _: Arc>) {} + async fn on_room_member(&self, _: Arc>, _: &MemberEvent) {} /// Fires when `AsyncClient` receives a `RoomEvent::RoomName` event. - async fn on_room_name(&mut self, _: Arc>, _: Arc>) {} + async fn on_room_name(&self, _: Arc>, _: &NameEvent) {} /// Fires when `AsyncClient` receives a `RoomEvent::RoomCanonicalAlias` event. - async fn on_room_canonical_alias( - &mut self, - _: Arc>, - _: Arc>, - ) { - } + async fn on_room_canonical_alias(&self, _: Arc>, _: &CanonicalAliasEvent) {} /// Fires when `AsyncClient` receives a `RoomEvent::RoomAliases` event. - async fn on_room_aliases(&mut self, _: Arc>, _: Arc>) {} + async fn on_room_aliases(&self, _: Arc>, _: &AliasesEvent) {} /// Fires when `AsyncClient` receives a `RoomEvent::RoomAvatar` event. - async fn on_room_avatar(&mut self, _: Arc>, _: Arc>) {} + async fn on_room_avatar(&self, _: Arc>, _: &AvatarEvent) {} /// Fires when `AsyncClient` receives a `RoomEvent::RoomMessage` event. - async fn on_room_message(&mut self, _: Arc>, _: Arc>) {} + async fn on_room_message(&self, _: Arc>, _: &MessageEvent) {} /// Fires when `AsyncClient` receives a `RoomEvent::RoomMessageFeedback` event. - async fn on_room_message_feedback( - &mut self, - _: Arc>, - _: Arc>, - ) { - } + async fn on_room_message_feedback(&self, _: Arc>, _: &FeedbackEvent) {} /// Fires when `AsyncClient` receives a `RoomEvent::RoomRedaction` event. - async fn on_room_redaction(&mut self, _: Arc>, _: Arc>) {} + async fn on_room_redaction(&self, _: Arc>, _: &RedactionEvent) {} /// Fires when `AsyncClient` receives a `RoomEvent::RoomPowerLevels` event. - async fn on_room_power_levels(&mut self, _: Arc>, _: Arc>) { - } + async fn on_room_power_levels(&self, _: Arc>, _: &PowerLevelsEvent) {} // `RoomEvent`s from `IncomingState` /// Fires when `AsyncClient` receives a `StateEvent::RoomMember` event. - async fn on_state_member(&mut self, _: Arc>, _: Arc>) {} + async fn on_state_member(&self, _: Arc>, _: &MemberEvent) {} /// Fires when `AsyncClient` receives a `StateEvent::RoomName` event. - async fn on_state_name(&mut self, _: Arc>, _: Arc>) {} + async fn on_state_name(&self, _: Arc>, _: &NameEvent) {} /// Fires when `AsyncClient` receives a `StateEvent::RoomCanonicalAlias` event. - async fn on_state_canonical_alias( - &mut self, - _: Arc>, - _: Arc>, - ) { - } + async fn on_state_canonical_alias(&self, _: Arc>, _: &CanonicalAliasEvent) {} /// Fires when `AsyncClient` receives a `StateEvent::RoomAliases` event. - async fn on_state_aliases(&mut self, _: Arc>, _: Arc>) {} + async fn on_state_aliases(&self, _: Arc>, _: &AliasesEvent) {} /// Fires when `AsyncClient` receives a `StateEvent::RoomAvatar` event. - async fn on_state_avatar(&mut self, _: Arc>, _: Arc>) {} + async fn on_state_avatar(&self, _: Arc>, _: &AvatarEvent) {} /// Fires when `AsyncClient` receives a `StateEvent::RoomPowerLevels` event. - async fn on_state_power_levels( - &mut self, - _: Arc>, - _: Arc>, - ) { - } + async fn on_state_power_levels(&self, _: Arc>, _: &PowerLevelsEvent) {} /// Fires when `AsyncClient` receives a `StateEvent::RoomJoinRules` event. - async fn on_state_join_rules(&mut self, _: Arc>, _: Arc>) {} + async fn on_state_join_rules(&self, _: Arc>, _: &JoinRulesEvent) {} // `NonRoomEvent` (this is a type alias from ruma_events) from `IncomingAccountData` /// Fires when `AsyncClient` receives a `NonRoomEvent::RoomMember` event. - async fn on_account_presence(&mut self, _: Arc>, _: Arc>) {} + async fn on_account_presence(&self, _: Arc>, _: &PresenceEvent) {} /// Fires when `AsyncClient` receives a `NonRoomEvent::RoomName` event. - async fn on_account_ignored_users( - &mut self, - _: Arc>, - _: Arc>, - ) { - } + async fn on_account_ignored_users(&self, _: Arc>, _: &IgnoredUserListEvent) {} /// Fires when `AsyncClient` receives a `NonRoomEvent::RoomCanonicalAlias` event. - async fn on_account_push_rules(&mut self, _: Arc>, _: Arc>) {} + async fn on_account_push_rules(&self, _: Arc>, _: &PushRulesEvent) {} /// Fires when `AsyncClient` receives a `NonRoomEvent::RoomAliases` event. - async fn on_account_data_fully_read( - &mut self, - _: Arc>, - _: Arc>, - ) { - } + async fn on_account_data_fully_read(&self, _: Arc>, _: &FullyReadEvent) {} // `PresenceEvent` is a struct so there is only the one method /// Fires when `AsyncClient` receives a `NonRoomEvent::RoomAliases` event. - async fn on_presence_event(&mut self, _: Arc>, _: Arc>) {} + async fn on_presence_event(&self, _: Arc>, _: &PresenceEvent) {} } #[cfg(test)] mod test { use super::*; - + use std::sync::Arc; + use tokio::sync::Mutex; + #[derive(Clone)] pub struct EvEmitterTest(Arc>>); #[async_trait::async_trait] impl EventEmitter for EvEmitterTest { - async fn on_room_member(&mut self, _: Arc>, _: Arc>) { + async fn on_room_member(&self, _: Arc>, _: &MemberEvent) { self.0.lock().await.push("member".to_string()) } - async fn on_room_name(&mut self, _: Arc>, _: Arc>) { + async fn on_room_name(&self, _: Arc>, _: &NameEvent) { self.0.lock().await.push("name".to_string()) } - async fn on_room_canonical_alias( - &mut self, - _: Arc>, - _: Arc>, - ) { + async fn on_room_canonical_alias(&self, _: Arc>, _: &CanonicalAliasEvent) { self.0.lock().await.push("canonical".to_string()) } - async fn on_room_aliases(&mut self, _: Arc>, _: Arc>) { + async fn on_room_aliases(&self, _: Arc>, _: &AliasesEvent) { self.0.lock().await.push("aliases".to_string()) } - async fn on_room_avatar(&mut self, _: Arc>, _: Arc>) { + async fn on_room_avatar(&self, _: Arc>, _: &AvatarEvent) { self.0.lock().await.push("avatar".to_string()) } - async fn on_room_message(&mut self, _: Arc>, _: Arc>) { + async fn on_room_message(&self, _: Arc>, _: &MessageEvent) { self.0.lock().await.push("message".to_string()) } - async fn on_room_message_feedback( - &mut self, - _: Arc>, - _: Arc>, - ) { + async fn on_room_message_feedback(&self, _: Arc>, _: &FeedbackEvent) { self.0.lock().await.push("feedback".to_string()) } - async fn on_room_redaction(&mut self, _: Arc>, _: Arc>) { + async fn on_room_redaction(&self, _: Arc>, _: &RedactionEvent) { self.0.lock().await.push("redaction".to_string()) } - async fn on_room_power_levels( - &mut self, - _: Arc>, - _: Arc>, - ) { + async fn on_room_power_levels(&self, _: Arc>, _: &PowerLevelsEvent) { self.0.lock().await.push("power".to_string()) } - async fn on_state_member(&mut self, _: Arc>, _: Arc>) { + async fn on_state_member(&self, _: Arc>, _: &MemberEvent) { self.0.lock().await.push("state member".to_string()) } - async fn on_state_name(&mut self, _: Arc>, _: Arc>) { + async fn on_state_name(&self, _: Arc>, _: &NameEvent) { self.0.lock().await.push("state name".to_string()) } - async fn on_state_canonical_alias( - &mut self, - _: Arc>, - _: Arc>, - ) { + async fn on_state_canonical_alias(&self, _: Arc>, _: &CanonicalAliasEvent) { self.0.lock().await.push("state canonical".to_string()) } - async fn on_state_aliases(&mut self, _: Arc>, _: Arc>) { + async fn on_state_aliases(&self, _: Arc>, _: &AliasesEvent) { self.0.lock().await.push("state aliases".to_string()) } - async fn on_state_avatar(&mut self, _: Arc>, _: Arc>) { + async fn on_state_avatar(&self, _: Arc>, _: &AvatarEvent) { self.0.lock().await.push("state avatar".to_string()) } - async fn on_state_power_levels( - &mut self, - _: Arc>, - _: Arc>, - ) { + async fn on_state_power_levels(&self, _: Arc>, _: &PowerLevelsEvent) { self.0.lock().await.push("state power".to_string()) } - async fn on_state_join_rules( - &mut self, - _: Arc>, - _: Arc>, - ) { + async fn on_state_join_rules(&self, _: Arc>, _: &JoinRulesEvent) { self.0.lock().await.push("state rules".to_string()) } - async fn on_account_presence(&mut self, _: Arc>, _: Arc>) { + async fn on_account_presence(&self, _: Arc>, _: &PresenceEvent) { self.0.lock().await.push("account presence".to_string()) } - async fn on_account_ignored_users( - &mut self, - _: Arc>, - _: Arc>, - ) { + async fn on_account_ignored_users(&self, _: Arc>, _: &IgnoredUserListEvent) { self.0.lock().await.push("account ignore".to_string()) } - async fn on_account_push_rules( - &mut self, - _: Arc>, - _: Arc>, - ) { + async fn on_account_push_rules(&self, _: Arc>, _: &PushRulesEvent) { self.0.lock().await.push("".to_string()) } - async fn on_account_data_fully_read( - &mut self, - _: Arc>, - _: Arc>, - ) { + async fn on_account_data_fully_read(&self, _: Arc>, _: &FullyReadEvent) { self.0.lock().await.push("account read".to_string()) } - async fn on_presence_event(&mut self, _: Arc>, _: Arc>) { + async fn on_presence_event(&self, _: Arc>, _: &PresenceEvent) { self.0.lock().await.push("presence event".to_string()) } } @@ -303,11 +237,9 @@ mod test { let vec = Arc::new(Mutex::new(Vec::new())); let test_vec = Arc::clone(&vec); - let emitter = Arc::new(Mutex::new( - Box::new(EvEmitterTest(vec)) as Box<(dyn EventEmitter)> - )); + let emitter = Box::new(EvEmitterTest(vec)) as Box<(dyn EventEmitter)>; let mut client = AsyncClient::new(homeserver, Some(session)).unwrap(); - client.add_event_emitter(Arc::clone(&emitter)).await; + client.add_event_emitter(emitter).await; let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000)); let _response = client.sync(sync_settings).await.unwrap(); diff --git a/src/models/room.rs b/src/models/room.rs index f307ec93..9701d04a 100644 --- a/src/models/room.rs +++ b/src/models/room.rs @@ -417,7 +417,7 @@ mod test { .with_body_from_file("tests/data/sync.json") .create(); - let mut client = AsyncClient::new(homeserver, Some(session)).unwrap(); + let client = AsyncClient::new(homeserver, Some(session)).unwrap(); let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000)); @@ -427,7 +427,7 @@ mod test { let room = &rooms .get(&RoomId::try_from("!SVkFJHzfwvuaIEawgC:localhost").unwrap()) .unwrap() - .lock() + .read() .await; assert_eq!(2, room.members.len()); diff --git a/src/request_builder.rs b/src/request_builder.rs index 42f088f5..795e8534 100644 --- a/src/request_builder.rs +++ b/src/request_builder.rs @@ -341,7 +341,7 @@ mod test { .room_alias_name("room_alias") .topic("room topic") .visibility(Visibility::Private); - let mut cli = AsyncClient::new(homeserver, Some(session)).unwrap(); + let cli = AsyncClient::new(homeserver, Some(session)).unwrap(); assert!(cli.create_room(builder).await.is_ok()); } @@ -373,7 +373,7 @@ mod test { // TODO this makes ruma error `Err(IntoHttp(IntoHttpError(Query(Custom("unsupported value")))))`?? // .filter(RoomEventFilter::default()); - let mut cli = AsyncClient::new(homeserver, Some(session)).unwrap(); + let cli = AsyncClient::new(homeserver, Some(session)).unwrap(); assert!(cli.room_messages(builder).await.is_ok()); } } diff --git a/tests/async_client_tests.rs b/tests/async_client_tests.rs index b2e72ff7..3c9dacdc 100644 --- a/tests/async_client_tests.rs +++ b/tests/async_client_tests.rs @@ -17,7 +17,7 @@ async fn login() { .with_body_from_file("tests/data/login_response.json") .create(); - let mut client = AsyncClient::new(homeserver, None).unwrap(); + let client = AsyncClient::new(homeserver, None).unwrap(); client .login("example", "wordpass", None, None) @@ -46,7 +46,7 @@ async fn sync() { .with_body_from_file("tests/data/sync.json") .create(); - let mut client = AsyncClient::new(homeserver, Some(session)).unwrap(); + let client = AsyncClient::new(homeserver, Some(session)).unwrap(); let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000)); @@ -75,7 +75,7 @@ async fn room_names() { .with_body_from_file("tests/data/sync.json") .create(); - let mut client = AsyncClient::new(homeserver, Some(session)).unwrap(); + let client = AsyncClient::new(homeserver, Some(session)).unwrap(); let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));