nikita
/
lavina
forked from lavina/lavina
1
0
Fork 0
Code Pull Requests Activity

add some docs

This commit is contained in:
Nikita Vilunov 2024-03-25 23:55:33 +01:00
parent 878ec33cbb
commit 2da79c0f7e
5 changed files with 74 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
crates/lavina-core/src/player.rs
View File

@ -14,10 +14,7 @@ use std::{
use prometheus::{IntGauge, Registry as MetricsRegistry}; use prometheus::{IntGauge, Registry as MetricsRegistry};
use serde::Serialize; use serde::Serialize;
use tokio::{ use tokio::sync::mpsc::{channel, Receiver, Sender};
sync::mpsc::{channel, Receiver, Sender},
task::JoinHandle,
};
use crate::prelude::*; use crate::prelude::*;
use crate::room::{RoomHandle, RoomId, RoomInfo, RoomRegistry}; use crate::room::{RoomHandle, RoomId, RoomInfo, RoomRegistry};
@ -45,9 +42,13 @@ impl PlayerId {
} }
} }
/// Node-local identifier of a connection. It is used to address a connection within a player actor.
#[derive(Debug, Clone, PartialEq, Eq, Hash)] #[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ConnectionId(pub AnonKey); pub struct ConnectionId(pub AnonKey);
/// Representation of an authenticated client connection.
///
/// The connection is used to send commands to the player actor and to receive updates that might be sent to the client.
pub struct PlayerConnection { pub struct PlayerConnection {
pub connection_id: ConnectionId, pub connection_id: ConnectionId,
pub receiver: Receiver<Updates>, pub receiver: Receiver<Updates>,
@ -55,42 +56,44 @@ pub struct PlayerConnection {
} }
impl PlayerConnection { impl PlayerConnection {
pub async fn send_message(&mut self, room_id: RoomId, body: Str) -> Result<()> { pub async fn send_message(&mut self, room_id: RoomId, body: Str) -> Result<()> {
self.player_handle.send_message(room_id, self.connection_id.clone(), body).await let (promise, deferred) = oneshot();
let cmd = ClientCommand::SendMessage { room_id, body, promise };
self.player_handle.send(ActorCommand::ClientCommand(cmd, self.connection_id.clone())).await;
Ok(deferred.await?)
} }
pub async fn join_room(&mut self, room_id: RoomId) -> Result<JoinResult> { pub async fn join_room(&mut self, room_id: RoomId) -> Result<JoinResult> {
self.player_handle.join_room(room_id, self.connection_id.clone()).await let (promise, deferred) = oneshot();
let cmd = ClientCommand::JoinRoom { room_id, promise };
self.player_handle.send(ActorCommand::ClientCommand(cmd, self.connection_id.clone())).await;
Ok(deferred.await?)
} }
pub async fn change_topic(&mut self, room_id: RoomId, new_topic: Str) -> Result<()> { pub async fn change_topic(&mut self, room_id: RoomId, new_topic: Str) -> Result<()> {
let (promise, deferred) = oneshot(); let (promise, deferred) = oneshot();
let cmd = Cmd::ChangeTopic { let cmd = ClientCommand::ChangeTopic {
room_id, room_id,
new_topic, new_topic,
promise, promise,
}; };
self.player_handle.send(PlayerCommand::Cmd(cmd, self.connection_id.clone())).await; self.player_handle.send(ActorCommand::ClientCommand(cmd, self.connection_id.clone())).await;
Ok(deferred.await?) Ok(deferred.await?)
} }
pub async fn leave_room(&mut self, room_id: RoomId) -> Result<()> { pub async fn leave_room(&mut self, room_id: RoomId) -> Result<()> {
let (promise, deferred) = oneshot(); let (promise, deferred) = oneshot();
self.player_handle let cmd = ClientCommand::LeaveRoom { room_id, promise };
.send(PlayerCommand::Cmd( self.player_handle.send(ActorCommand::ClientCommand(cmd, self.connection_id.clone())).await;
Cmd::LeaveRoom { room_id, promise },
self.connection_id.clone(),
))
.await;
Ok(deferred.await?) Ok(deferred.await?)
} }
pub async fn terminate(self) { pub async fn terminate(self) {
self.player_handle.send(PlayerCommand::TerminateConnection(self.connection_id)).await; self.player_handle.send(ActorCommand::TerminateConnection(self.connection_id)).await;
} }
pub async fn get_rooms(&self) -> Result<Vec<RoomInfo>> { pub async fn get_rooms(&self) -> Result<Vec<RoomInfo>> {
let (promise, deferred) = oneshot(); let (promise, deferred) = oneshot();
self.player_handle.send(PlayerCommand::GetRooms(promise)).await; self.player_handle.send(ActorCommand::GetRooms(promise)).await;
Ok(deferred.await?) Ok(deferred.await?)
} }
} }
@ -98,13 +101,13 @@ impl PlayerConnection {
/// Handle to a player actor. /// Handle to a player actor.
#[derive(Clone)] #[derive(Clone)]
pub struct PlayerHandle { pub struct PlayerHandle {
tx: Sender<PlayerCommand>, tx: Sender<ActorCommand>,
} }
impl PlayerHandle { impl PlayerHandle {
pub async fn subscribe(&self) -> PlayerConnection { pub async fn subscribe(&self) -> PlayerConnection {
let (sender, receiver) = channel(32); let (sender, receiver) = channel(32);
let (promise, deferred) = oneshot(); let (promise, deferred) = oneshot();
let cmd = PlayerCommand::AddConnection { sender, promise }; let cmd = ActorCommand::AddConnection { sender, promise };
let _ = self.tx.send(cmd).await; let _ = self.tx.send(cmd).await;
let connection_id = deferred.await.unwrap(); let connection_id = deferred.await.unwrap();
PlayerConnection { PlayerConnection {
@ -114,45 +117,36 @@ impl PlayerHandle {
} }
} }
pub async fn send_message(&self, room_id: RoomId, connection_id: ConnectionId, body: Str) -> Result<()> { async fn send(&self, command: ActorCommand) {
let (promise, deferred) = oneshot(); // TODO either handle the error or doc why it is safe to ignore
let cmd = Cmd::SendMessage { room_id, body, promise };
let _ = self.tx.send(PlayerCommand::Cmd(cmd, connection_id)).await;
Ok(deferred.await?)
}
pub async fn join_room(&self, room_id: RoomId, connection_id: ConnectionId) -> Result<JoinResult> {
let (promise, deferred) = oneshot();
let cmd = Cmd::JoinRoom { room_id, promise };
let _ = self.tx.send(PlayerCommand::Cmd(cmd, connection_id)).await;
Ok(deferred.await?)
}
async fn send(&self, command: PlayerCommand) {
let _ = self.tx.send(command).await; let _ = self.tx.send(command).await;
} }
pub async fn update(&self, update: Updates) { pub async fn update(&self, update: Updates) {
self.send(PlayerCommand::Update(update)).await; self.send(ActorCommand::Update(update)).await;
} }
} }
enum PlayerCommand { /// Messages sent to the player actor.
/** Commands from connections */ enum ActorCommand {
/// Establish a new connection.
AddConnection { AddConnection {
sender: Sender<Updates>, sender: Sender<Updates>,
promise: Promise<ConnectionId>, promise: Promise<ConnectionId>,
}, },
/// Terminate an existing connection.
TerminateConnection(ConnectionId), TerminateConnection(ConnectionId),
Cmd(Cmd, ConnectionId), /// Player-issued command.
ClientCommand(ClientCommand, ConnectionId),
/// Query - responds with a list of rooms the player is a member of. /// Query - responds with a list of rooms the player is a member of.
GetRooms(Promise<Vec<RoomInfo>>), GetRooms(Promise<Vec<RoomInfo>>),
/** Events from rooms */ /// Update which is sent from a room the player is member of.
Update(Updates), Update(Updates),
Stop, Stop,
} }
pub enum Cmd { /// Client-issued command sent to the player actor. The actor will respond with by fulfilling the promise.
pub enum ClientCommand {
JoinRoom { JoinRoom {
room_id: RoomId, room_id: RoomId,
promise: Promise<JoinResult>, promise: Promise<JoinResult>,
@ -237,7 +231,7 @@ impl PlayerRegistry {
pub async fn shutdown_all(&mut self) -> Result<()> { pub async fn shutdown_all(&mut self) -> Result<()> {
let mut inner = self.0.write().unwrap(); let mut inner = self.0.write().unwrap();
for (i, (k, j)) in inner.players.drain() { for (i, (k, j)) in inner.players.drain() {
k.send(PlayerCommand::Stop).await; k.send(ActorCommand::Stop).await;
drop(k); drop(k);
j.await?; j.await?;
log::debug!("Player stopped #{i:?}") log::debug!("Player stopped #{i:?}")
@ -260,7 +254,7 @@ struct Player {
connections: AnonTable<Sender<Updates>>, connections: AnonTable<Sender<Updates>>,
my_rooms: HashMap<RoomId, RoomHandle>, my_rooms: HashMap<RoomId, RoomHandle>,
banned_from: HashSet<RoomId>, banned_from: HashSet<RoomId>,
rx: Receiver<PlayerCommand>, rx: Receiver<ActorCommand>,
handle: PlayerHandle, handle: PlayerHandle,
rooms: RoomRegistry, rooms: RoomRegistry,
} }
@ -285,24 +279,24 @@ impl Player {
async fn main_loop(mut self) -> Self { async fn main_loop(mut self) -> Self {
while let Some(cmd) = self.rx.recv().await { while let Some(cmd) = self.rx.recv().await {
match cmd { match cmd {
PlayerCommand::AddConnection { sender, promise } => { ActorCommand::AddConnection { sender, promise } => {
let connection_id = self.connections.insert(sender); let connection_id = self.connections.insert(sender);
if let Err(connection_id) = promise.send(ConnectionId(connection_id)) { if let Err(connection_id) = promise.send(ConnectionId(connection_id)) {
log::warn!("Connection {connection_id:?} terminated before finalization"); log::warn!("Connection {connection_id:?} terminated before finalization");
self.terminate_connection(connection_id); self.terminate_connection(connection_id);
} }
} }
PlayerCommand::TerminateConnection(connection_id) => { ActorCommand::TerminateConnection(connection_id) => {
self.terminate_connection(connection_id); self.terminate_connection(connection_id);
} }
PlayerCommand::GetRooms(promise) => { ActorCommand::GetRooms(promise) => {
let mut response = vec![]; let mut response = vec![];
for (_, handle) in &self.my_rooms { for (_, handle) in &self.my_rooms {
response.push(handle.get_room_info().await); response.push(handle.get_room_info().await);
} }
let _ = promise.send(response); let _ = promise.send(response);
} }
PlayerCommand::Update(update) => { ActorCommand::Update(update) => {
log::info!( log::info!(
"Player received an update, broadcasting to {} connections", "Player received an update, broadcasting to {} connections",
self.connections.len() self.connections.len()
@ -318,8 +312,8 @@ impl Player {
let _ = connection.send(update.clone()).await; let _ = connection.send(update.clone()).await;
} }
} }
PlayerCommand::Cmd(cmd, connection_id) => self.handle_cmd(cmd, connection_id).await, ActorCommand::ClientCommand(cmd, connection_id) => self.handle_cmd(cmd, connection_id).await,
PlayerCommand::Stop => break, ActorCommand::Stop => break,
} }
} }
log::debug!("Shutting down player actor #{:?}", self.player_id); log::debug!("Shutting down player actor #{:?}", self.player_id);
@ -332,9 +326,9 @@ impl Player {
} }
} }
async fn handle_cmd(&mut self, cmd: Cmd, connection_id: ConnectionId) { async fn handle_cmd(&mut self, cmd: ClientCommand, connection_id: ConnectionId) {
match cmd { match cmd {
Cmd::JoinRoom { room_id, promise } => { ClientCommand::JoinRoom { room_id, promise } => {
if self.banned_from.contains(&room_id) { if self.banned_from.contains(&room_id) {
let _ = promise.send(JoinResult::Banned); let _ = promise.send(JoinResult::Banned);
return; return;
@ -357,7 +351,7 @@ impl Player {
}; };
self.broadcast_update(update, connection_id).await; self.broadcast_update(update, connection_id).await;
} }
Cmd::LeaveRoom { room_id, promise } => { ClientCommand::LeaveRoom { room_id, promise } => {
let room = self.my_rooms.remove(&room_id); let room = self.my_rooms.remove(&room_id);
if let Some(room) = room { if let Some(room) = room {
room.unsubscribe(&self.player_id).await; room.unsubscribe(&self.player_id).await;
@ -370,7 +364,7 @@ impl Player {
}; };
self.broadcast_update(update, connection_id).await; self.broadcast_update(update, connection_id).await;
} }
Cmd::SendMessage { room_id, body, promise } => { ClientCommand::SendMessage { room_id, body, promise } => {
let room = self.rooms.get_room(&room_id).await; let room = self.rooms.get_room(&room_id).await;
if let Some(room) = room { if let Some(room) = room {
room.send_message(self.player_id.clone(), body.clone()).await; room.send_message(self.player_id.clone(), body.clone()).await;
@ -385,7 +379,7 @@ impl Player {
}; };
self.broadcast_update(update, connection_id).await; self.broadcast_update(update, connection_id).await;
} }
Cmd::ChangeTopic { ClientCommand::ChangeTopic {
room_id, room_id,
new_topic, new_topic,
promise, promise,
@ -403,6 +397,10 @@ impl Player {
} }
} }
/// Broadcasts an update to all connections except the one with the given id.
///
/// This is called after handling a client command.
/// Sending the update to the connection which sent the command is handled by the connection itself.
async fn broadcast_update(&self, update: Updates, except: ConnectionId) { async fn broadcast_update(&self, update: Updates, except: ConnectionId) {
for (a, b) in &self.connections { for (a, b) in &self.connections {
if ConnectionId(a) == except { if ConnectionId(a) == except {

8
crates/lavina-core/src/room.rs
View File

@ -160,9 +160,13 @@ impl RoomHandle {
} }
struct Room { struct Room {
/// The numeric node-local id of the room as it is stored in the database.
storage_id: u32, storage_id: u32,
/// The cluster-global id of the room.
room_id: RoomId, room_id: RoomId,
/// Player actors on the local node which are subscribed to this room's updates.
subscriptions: HashMap<PlayerId, PlayerHandle>, subscriptions: HashMap<PlayerId, PlayerHandle>,
/// The total number of messages. Used to calculate the id of the new message.
message_count: u32, message_count: u32,
topic: Str, topic: Str,
storage: Storage, storage: Storage,
@ -191,6 +195,10 @@ impl Room {
Ok(()) Ok(())
} }
/// Broadcasts an update to all players except the one who caused the update.
///
/// This is called after handling a client command.
/// Sending the update to the player who sent the command is handled by the player actor.
async fn broadcast_update(&self, update: Updates, except: &PlayerId) { async fn broadcast_update(&self, update: Updates, except: &PlayerId) {
tracing::debug!("Broadcasting an update to {} subs", self.subscriptions.len()); tracing::debug!("Broadcasting an update to {} subs", self.subscriptions.len());
for (player_id, sub) in &self.subscriptions { for (player_id, sub) in &self.subscriptions {

2
crates/projection-irc/src/lib.rs
View File

@ -44,7 +44,7 @@ struct RegisteredUser {
/** /**
* Username is mostly unused in modern IRC. * Username is mostly unused in modern IRC.
* *
* [https://stackoverflow.com/questions/31666247/what-is-the-difference-between-the-nick-username-and-real-name-in-irc-and-wha] * <https://stackoverflow.com/questions/31666247/what-is-the-difference-between-the-nick-username-and-real-name-in-irc-and-wha>
*/ */
username: Str, username: Str,
realname: Str, realname: Str,

24
crates/proto-irc/src/client.rs
View File

@ -7,42 +7,42 @@ use nonempty::NonEmpty;
/// Client-to-server command. /// Client-to-server command.
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq)]
pub enum ClientMessage { pub enum ClientMessage {
/// CAP. Capability-related commands. /// `CAP`. Capability-related commands.
Capability { Capability {
subcommand: CapabilitySubcommand, subcommand: CapabilitySubcommand,
}, },
/// PING <token> /// `PING <token>`
Ping { Ping {
token: Str, token: Str,
}, },
/// PONG <token> /// `PONG <token>`
Pong { Pong {
token: Str, token: Str,
}, },
/// NICK <nickname> /// `NICK <nickname>`
Nick { Nick {
nickname: Str, nickname: Str,
}, },
/// PASS <password> /// `PASS <password>`
Pass { Pass {
password: Str, password: Str,
}, },
/// USER <username> 0 * :<realname> /// `USER <username> 0 * :<realname>`
User { User {
username: Str, username: Str,
realname: Str, realname: Str,
}, },
/// JOIN <chan> /// `JOIN <chan>`
Join(Chan), Join(Chan),
/// MODE <target> /// `MODE <target>`
Mode { Mode {
target: Recipient, target: Recipient,
}, },
/// WHO <target> /// `WHO <target>`
Who { Who {
target: Recipient, // aka mask target: Recipient, // aka mask
}, },
/// TOPIC <chan> :<topic> /// `TOPIC <chan> :<topic>`
Topic { Topic {
chan: Chan, chan: Chan,
topic: Str, topic: Str,
@ -51,12 +51,12 @@ pub enum ClientMessage {
chan: Chan, chan: Chan,
message: Str, message: Str,
}, },
/// PRIVMSG <target> :<msg> /// `PRIVMSG <target> :<msg>`
PrivateMessage { PrivateMessage {
recipient: Recipient, recipient: Recipient,
body: Str, body: Str,
}, },
/// QUIT :<reason> /// `QUIT :<reason>`
Quit { Quit {
reason: Str, reason: Str,
}, },

4
crates/proto-irc/src/lib.rs
View File

@ -36,9 +36,9 @@ fn params(input: &str) -> IResult<&str, &str> {
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq)]
pub enum Chan { pub enum Chan {
/// #<name> — network-global channel, available from any server in the network. /// `#<name>` — network-global channel, available from any server in the network.
Global(Str), Global(Str),
/// &<name> — server-local channel, available only to connections to the same server. Rarely used in practice. /// `&<name>` — server-local channel, available only to connections to the same server. Rarely used in practice.
Local(Str), Local(Str),
} }
impl Chan { impl Chan {