chore(monorepo): delta, january, quark

This commit is contained in:
Paul Makles
2022-06-02 00:04:22 +01:00
parent 5d8432e267
commit 2ce610e1e7
232 changed files with 18094 additions and 554 deletions

View File

@@ -0,0 +1,173 @@
use serde::{Deserialize, Serialize};
use crate::models::channel::{FieldsChannel, PartialChannel};
use crate::models::message::{AppendMessage, PartialMessage};
use crate::models::server::{FieldsRole, FieldsServer, PartialRole, PartialServer};
use crate::models::server_member::{FieldsMember, MemberCompositeKey, PartialMember};
use crate::models::user::{FieldsUser, PartialUser, RelationshipStatus};
use crate::models::{Channel, Member, Message, Server, User, UserSettings};
use crate::Error;
/// WebSocket Client Errors
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(tag = "error")]
pub enum WebSocketError {
LabelMe,
InternalError { at: String },
InvalidSession,
OnboardingNotFinished,
AlreadyAuthenticated,
MalformedData { msg: String },
}
/// Ping Packet
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(untagged)]
pub enum Ping {
Binary(Vec<u8>),
Number(usize),
}
/// Untagged Error
#[derive(Serialize)]
#[serde(untagged)]
pub enum ErrorEvent {
Error(WebSocketError),
APIError(Error),
}
/// Protocol Events
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(tag = "type")]
pub enum EventV1 {
/// Multiple events
Bulk { v: Vec<EventV1> },
/// Successfully authenticated
Authenticated,
/// Basic data to cache
Ready {
users: Vec<User>,
servers: Vec<Server>,
channels: Vec<Channel>,
members: Vec<Member>,
},
/// Ping response
Pong { data: Ping },
/// New message
Message(Message),
/// Update existing message
MessageUpdate {
id: String,
channel: String,
data: PartialMessage,
},
/// Append information to existing message
MessageAppend {
id: String,
channel: String,
append: AppendMessage,
},
/// Delete message
MessageDelete { id: String, channel: String },
/// Bulk delete messages
BulkMessageDelete { channel: String, ids: Vec<String> },
/// New channel
ChannelCreate(Channel),
/// Update existing channel
ChannelUpdate {
id: String,
data: PartialChannel,
clear: Vec<FieldsChannel>,
},
/// Delete channel
ChannelDelete { id: String },
/// User joins a group
ChannelGroupJoin { id: String, user: String },
/// User leaves a group
ChannelGroupLeave { id: String, user: String },
/// User started typing in a channel
ChannelStartTyping { id: String, user: String },
/// User stopped typing in a channel
ChannelStopTyping { id: String, user: String },
/// User acknowledged message in channel
ChannelAck {
id: String,
user: String,
message_id: String,
},
/// New server
ServerCreate {
id: String,
server: Server,
channels: Vec<Channel>,
},
/// Update existing server
ServerUpdate {
id: String,
data: PartialServer,
clear: Vec<FieldsServer>,
},
/// Delete server
ServerDelete { id: String },
/// Update existing server member
ServerMemberUpdate {
id: MemberCompositeKey,
data: PartialMember,
clear: Vec<FieldsMember>,
},
/// User joins server
ServerMemberJoin { id: String, user: String },
/// User left server
ServerMemberLeave { id: String, user: String },
/// Server role created or updated
ServerRoleUpdate {
id: String,
role_id: String,
data: PartialRole,
clear: Vec<FieldsRole>,
},
/// Server role deleted
ServerRoleDelete { id: String, role_id: String },
/// Update existing user
UserUpdate {
id: String,
data: PartialUser,
clear: Vec<FieldsUser>,
},
/// Relationship with another user changed
UserRelationship {
id: String,
user: User,
// ! this field can be deprecated
status: RelationshipStatus,
},
/// Settings updated remotely
UserSettingsUpdate { id: String, update: UserSettings },
}

View File

@@ -0,0 +1,557 @@
use std::collections::HashSet;
use crate::{
get_relationship,
models::{
server_member::FieldsMember,
user::{PartialUser, Presence, RelationshipStatus},
Channel, Member, User,
},
perms,
presence::presence_filter_online,
Database, Permission, Result,
};
use super::{
client::EventV1,
state::{Cache, State},
};
/// Cache Manager
impl Cache {
/// Check whether the current user can view a channel
pub async fn can_view_channel(&self, db: &Database, channel: &Channel) -> bool {
match &channel {
Channel::TextChannel { server, .. } | Channel::VoiceChannel { server, .. } => {
let member = self
.members
.iter()
.map(|(_, x)| x)
.find(|x| &x.id.server == server);
let server = self.servers.get(server);
let mut perms = perms(self.users.get(&self.user_id).unwrap()).channel(channel);
if let Some(member) = member {
perms.member.set_ref(member);
}
if let Some(server) = server {
perms.server.set_ref(server);
}
perms
.has_permission(db, Permission::ViewChannel)
.await
.unwrap_or_default()
}
_ => true,
}
}
/// Filter a given vector of channels to only include the ones we can access
pub async fn filter_accessible_channels(
&self,
db: &Database,
channels: Vec<Channel>,
) -> Vec<Channel> {
let mut viewable_channels = vec![];
for channel in channels {
if self.can_view_channel(db, &channel).await {
viewable_channels.push(channel);
}
}
viewable_channels
}
/// Check whether we can subscribe to another user
pub fn can_subscribe_to_user(&self, user_id: &str) -> bool {
if let Some(user) = self.users.get(&self.user_id) {
match get_relationship(user, user_id) {
RelationshipStatus::Friend
| RelationshipStatus::Incoming
| RelationshipStatus::Outgoing
| RelationshipStatus::User => true,
_ => {
let user_id = &user_id.to_string();
for channel in self.channels.values() {
match channel {
Channel::DirectMessage { recipients, .. }
| Channel::Group { recipients, .. } => {
if recipients.contains(user_id) {
return true;
}
}
_ => {}
}
}
false
}
}
} else {
false
}
}
}
/// State Manager
impl State {
/// Generate a Ready packet for the current user
pub async fn generate_ready_payload(&mut self, db: &Database) -> Result<EventV1> {
let mut user = self.clone_user();
// Find all relationships to the user.
let mut user_ids: Vec<String> = user
.relations
.as_ref()
.map(|arr| arr.iter().map(|x| x.id.to_string()).collect())
.unwrap_or_default();
// Fetch all memberships with their corresponding servers.
let members: Vec<Member> = db.fetch_all_memberships(&user.id).await?;
let server_ids: Vec<String> = members.iter().map(|x| x.id.server.clone()).collect();
let servers = db.fetch_servers(&server_ids).await?;
// Collect channel ids from servers.
let mut channel_ids = vec![];
for server in &servers {
channel_ids.append(&mut server.channels.clone());
}
// Fetch DMs and server channels.
let mut channels = db.find_direct_messages(&user.id).await?;
channels.append(&mut db.fetch_channels(&channel_ids).await?);
// Filter server channels by permission.
let channels = self.cache.filter_accessible_channels(db, channels).await;
// Append known user IDs from DMs.
for channel in &channels {
match channel {
Channel::DirectMessage { recipients, .. } | Channel::Group { recipients, .. } => {
user_ids.append(&mut recipients.clone());
}
_ => {}
}
}
// Fetch presence data for known users.
let online_ids = presence_filter_online(&user_ids).await;
user.online = Some(true);
// Fetch user data.
let users = db
.fetch_users(
&user_ids
.into_iter()
.filter(|x| x != &user.id)
.collect::<Vec<String>>(),
)
.await?;
// Copy data into local state cache.
self.cache.users = users.iter().cloned().map(|x| (x.id.clone(), x)).collect();
self.cache
.users
.insert(self.cache.user_id.clone(), user.clone());
self.cache.servers = servers.iter().cloned().map(|x| (x.id.clone(), x)).collect();
self.cache.channels = channels
.iter()
.cloned()
.map(|x| (x.id().to_string(), x))
.collect();
self.cache.members = members
.iter()
.cloned()
.map(|x| (x.id.server.clone(), x))
.collect();
// Make all users appear from our perspective.
let mut users: Vec<User> = users
.into_iter()
.map(|mut x| {
x.online = Some(online_ids.contains(&x.id));
x.with_relationship(&user)
})
.collect();
// Make sure we see our own user correctly.
user.relationship = Some(RelationshipStatus::User);
users.push(user.foreign());
// Set subscription state internally.
self.reset_state();
self.insert_subscription(self.private_topic.clone());
for user in &users {
self.insert_subscription(user.id.clone());
}
for server in &servers {
self.insert_subscription(server.id.clone());
}
for channel in &channels {
self.insert_subscription(channel.id().to_string());
}
Ok(EventV1::Ready {
users,
servers,
channels,
members,
})
}
/// Re-determine the currently accessible server channels
pub async fn recalculate_server(&mut self, db: &Database, id: &str, event: &mut EventV1) {
if let Some(server) = self.cache.servers.get(id) {
let mut channel_ids = HashSet::new();
let mut added_channels = vec![];
let mut removed_channels = vec![];
let id = &id.to_string();
for (channel_id, channel) in &self.cache.channels {
match channel {
Channel::TextChannel { server, .. } | Channel::VoiceChannel { server, .. } => {
if server == id {
channel_ids.insert(channel_id.clone());
if self.cache.can_view_channel(db, channel).await {
added_channels.push(channel_id.clone());
} else {
removed_channels.push(channel_id.clone());
}
}
}
_ => {}
}
}
let known_ids = server.channels.iter().cloned().collect::<HashSet<String>>();
let mut bulk_events = vec![];
for id in added_channels {
self.insert_subscription(id);
}
for id in removed_channels {
self.remove_subscription(&id);
self.cache.channels.remove(&id);
bulk_events.push(EventV1::ChannelDelete { id });
}
// * NOTE: currently all channels should be cached
// * provided that a server was loaded from payload
let unknowns = known_ids
.difference(&channel_ids)
.cloned()
.collect::<Vec<String>>();
if !unknowns.is_empty() {
if let Ok(channels) = db.fetch_channels(&unknowns).await {
let viewable_channels =
self.cache.filter_accessible_channels(db, channels).await;
for channel in viewable_channels {
self.cache
.channels
.insert(channel.id().to_string(), channel.clone());
self.insert_subscription(channel.id().to_string());
bulk_events.push(EventV1::ChannelCreate(channel));
}
}
}
if !bulk_events.is_empty() {
let mut new_event = EventV1::Bulk { v: bulk_events };
std::mem::swap(&mut new_event, event);
if let EventV1::Bulk { v } = event {
v.push(new_event);
}
}
}
}
/// Push presence change to the user and all associated server topics
pub async fn broadcast_presence_change(&self, target: bool) {
if if let Some(status) = &self.cache.users.get(&self.cache.user_id).unwrap().status {
status.presence != Some(Presence::Invisible)
} else {
true
} {
let event = EventV1::UserUpdate {
id: self.cache.user_id.clone(),
data: PartialUser {
online: Some(target),
..Default::default()
},
clear: vec![],
};
for server in self.cache.servers.keys() {
event.clone().p(server.clone()).await;
}
event.p(self.cache.user_id.clone()).await;
}
}
/// Handle an incoming event for protocol version 1
pub async fn handle_incoming_event_v1(&mut self, db: &Database, event: &mut EventV1) -> bool {
/* Superseded by private topics.
if match event {
EventV1::UserRelationship { id, .. }
| EventV1::UserSettingsUpdate { id, .. }
| EventV1::ChannelAck { id, .. } => id != &self.cache.user_id,
EventV1::ServerCreate { server, .. } => server.owner != self.cache.user_id,
EventV1::ChannelCreate(channel) => match channel {
Channel::SavedMessages { user, .. } => user != &self.cache.user_id,
Channel::DirectMessage { recipients, .. } | Channel::Group { recipients, .. } => {
!recipients.contains(&self.cache.user_id)
}
_ => false,
},
_ => false,
} {
return false;
}*/
// An event may trigger recalculation of an entire server's permission.
// Keep track of whether we need to do anything.
let mut queue_server = None;
// It may also need to sub or unsub a single value.
let mut queue_add = None;
let mut queue_remove = None;
match event {
EventV1::ChannelCreate(channel) => {
let id = channel.id().to_string();
self.insert_subscription(id.clone());
self.cache.channels.insert(id, channel.clone());
}
EventV1::ChannelUpdate {
id, data, clear, ..
} => {
let could_view: bool = if let Some(channel) = self.cache.channels.get(id) {
self.cache.can_view_channel(db, channel).await
} else {
true
};
if let Some(channel) = self.cache.channels.get_mut(id) {
for field in clear {
channel.remove(field);
}
channel.apply_options(data.clone());
}
if let Some(channel) = self.cache.channels.get(id) {
let can_view = self.cache.can_view_channel(db, channel).await;
if could_view != can_view {
if can_view {
queue_add = Some(id.clone());
*event = EventV1::ChannelCreate(channel.clone());
} else {
queue_remove = Some(id.clone());
*event = EventV1::ChannelDelete { id: id.clone() };
}
}
}
}
EventV1::ChannelDelete { id } => {
self.remove_subscription(id);
self.cache.channels.remove(id);
}
EventV1::ChannelGroupJoin { user, .. } => {
self.insert_subscription(user.clone());
}
EventV1::ChannelGroupLeave { id, user, .. } => {
if user == &self.cache.user_id {
self.remove_subscription(id);
} else if !self.cache.can_subscribe_to_user(user) {
self.remove_subscription(user);
}
}
EventV1::ServerCreate {
id,
server,
channels,
} => {
self.insert_subscription(id.clone());
self.cache.servers.insert(id.to_string(), server.clone());
for channel in channels {
self.cache
.channels
.insert(channel.id().to_string(), channel.clone());
}
queue_server = Some(id.clone());
}
EventV1::ServerUpdate {
id, data, clear, ..
} => {
if let Some(server) = self.cache.servers.get_mut(id) {
for field in clear {
server.remove(field);
}
server.apply_options(data.clone());
}
if data.default_permissions.is_some() {
queue_server = Some(id.clone());
}
}
EventV1::ServerMemberJoin { .. } => {
// We will always receive ServerCreate when joining a new server.
}
EventV1::ServerMemberLeave { id, user } => {
if user == &self.cache.user_id {
self.remove_subscription(id);
if let Some(server) = self.cache.servers.remove(id) {
for channel in &server.channels {
self.remove_subscription(channel);
self.cache.channels.remove(channel);
}
}
}
}
EventV1::ServerDelete { id } => {
self.remove_subscription(id);
if let Some(server) = self.cache.servers.remove(id) {
for channel in &server.channels {
self.remove_subscription(channel);
self.cache.channels.remove(channel);
}
}
}
EventV1::ServerMemberUpdate { id, data, clear } => {
if id.user == self.cache.user_id {
if let Some(member) = self.cache.members.get_mut(&id.server) {
for field in &clear.clone() {
member.remove(field);
}
member.apply_options(data.clone());
}
if data.roles.is_some() || clear.contains(&FieldsMember::Roles) {
queue_server = Some(id.server.clone());
}
}
}
EventV1::ServerRoleUpdate {
id,
role_id,
data,
clear,
..
} => {
if let Some(server) = self.cache.servers.get_mut(id) {
if let Some(role) = server.roles.get_mut(role_id) {
for field in &clear.clone() {
role.remove(field);
}
role.apply_options(data.clone());
}
}
if data.rank.is_some() || data.permissions.is_some() {
if let Some(member) = self.cache.members.get(id) {
if let Some(roles) = &member.roles {
if roles.contains(role_id) {
queue_server = Some(id.clone());
}
}
}
}
}
EventV1::ServerRoleDelete { id, role_id } => {
if let Some(server) = self.cache.servers.get_mut(id) {
server.roles.remove(role_id);
}
if let Some(member) = self.cache.members.get(id) {
if let Some(roles) = &member.roles {
if roles.contains(role_id) {
queue_server = Some(id.clone());
}
}
}
}
EventV1::UserRelationship { id, user, .. } => {
self.cache.users.insert(id.clone(), user.clone());
if self.cache.can_subscribe_to_user(id) {
self.insert_subscription(id.clone());
} else {
self.remove_subscription(id);
}
}
_ => {}
}
// Calculate server permissions if requested.
if let Some(server_id) = queue_server {
self.recalculate_server(db, &server_id, event).await;
}
// Sub / unsub accordingly.
if let Some(id) = queue_add {
self.insert_subscription(id);
}
if let Some(id) = queue_remove {
self.remove_subscription(&id);
}
true
}
}
impl EventV1 {
/// Publish helper wrapper
pub async fn p(self, channel: String) {
#[cfg(not(debug_assertions))]
redis_kiss::p(channel, self).await;
#[cfg(debug_assertions)]
info!("Publishing event to {channel}: {self:?}");
#[cfg(debug_assertions)]
redis_kiss::publish(channel, self).await.unwrap();
}
/// Publish user event
pub async fn p_user(self, id: String, db: &Database) {
self.clone().p(id.clone()).await;
// ! FIXME: this should be captured by member list in the future
// ! and not immediately fanned out to users
if let Ok(members) = db.fetch_all_memberships(&id).await {
for member in members {
self.clone().p(member.id.server).await;
}
}
}
/// Publish private event
pub async fn private(self, id: String) {
self.p(format!("{}!", id)).await;
}
}

View File

@@ -0,0 +1,4 @@
pub mod client;
pub mod r#impl;
pub mod server;
pub mod state;

View File

@@ -0,0 +1,12 @@
use serde::Deserialize;
use super::client::Ping;
#[derive(Deserialize, Debug)]
#[serde(tag = "type")]
pub enum ClientMessage {
Authenticate { token: String },
BeginTyping { channel: String },
EndTyping { channel: String },
Ping { data: Ping, responded: Option<()> },
}

View File

@@ -0,0 +1,146 @@
use std::collections::{HashMap, HashSet};
use crate::models::{Channel, Member, Server, User};
/// Enumeration representing some change in subscriptions
pub enum SubscriptionStateChange {
/// No change
None,
/// Clear all subscriptions
Reset,
/// Append or remove subscriptions
Change {
add: Vec<String>,
remove: Vec<String>,
},
}
/// Dumb per-state cache implementation
///
/// Ideally this would use a global cache that
/// allows for mutations and could use Rc<> to
/// track usage. If Rc<> == 1, then it only
/// remains in global cache, hence should be
/// dropped.
///
/// ------------------------------------------------
/// We can strip these objects to core information!!
/// ------------------------------------------------
#[derive(Debug, Default)]
pub struct Cache {
pub user_id: String,
pub users: HashMap<String, User>,
pub channels: HashMap<String, Channel>,
pub members: HashMap<String, Member>,
pub servers: HashMap<String, Server>,
}
/// Client state
pub struct State {
pub cache: Cache,
pub private_topic: String,
subscribed: HashSet<String>,
state: SubscriptionStateChange,
}
impl State {
/// Create state from User
pub fn from(user: User) -> State {
let mut subscribed = HashSet::new();
let private_topic = format!("{}!", user.id);
subscribed.insert(private_topic.clone());
subscribed.insert(user.id.clone());
let mut cache: Cache = Cache {
user_id: user.id.clone(),
..Default::default()
};
cache.users.insert(user.id.clone(), user);
State {
cache,
subscribed,
private_topic,
state: SubscriptionStateChange::Reset,
}
}
/// Apply currently queued state
pub fn apply_state(&mut self) -> SubscriptionStateChange {
let state = std::mem::replace(&mut self.state, SubscriptionStateChange::None);
if let SubscriptionStateChange::Change { add, remove } = &state {
for id in add {
self.subscribed.insert(id.clone());
}
for id in remove {
self.subscribed.remove(id);
}
}
state
}
/// Clone the active user
pub fn clone_user(&self) -> User {
self.cache.users.get(&self.cache.user_id).unwrap().clone()
}
/// Iterate through all subscriptions
pub fn iter_subscriptions(&self) -> std::collections::hash_set::Iter<'_, std::string::String> {
self.subscribed.iter()
}
/// Reset the current state
pub fn reset_state(&mut self) {
self.state = SubscriptionStateChange::Reset;
self.subscribed.clear();
}
/// Add a new subscription
pub fn insert_subscription(&mut self, subscription: String) {
if self.subscribed.contains(&subscription) {
return;
}
match &mut self.state {
SubscriptionStateChange::None => {
self.state = SubscriptionStateChange::Change {
add: vec![subscription.clone()],
remove: vec![],
};
}
SubscriptionStateChange::Change { add, .. } => {
add.push(subscription.clone());
}
SubscriptionStateChange::Reset => {}
}
self.subscribed.insert(subscription);
}
/// Remove existing subscription
pub fn remove_subscription(&mut self, subscription: &str) {
if !self.subscribed.contains(&subscription.to_string()) {
return;
}
match &mut self.state {
SubscriptionStateChange::None => {
self.state = SubscriptionStateChange::Change {
add: vec![],
remove: vec![subscription.to_string()],
};
}
SubscriptionStateChange::Change { remove, .. } => {
remove.push(subscription.to_string());
}
SubscriptionStateChange::Reset => panic!("Should not remove during a reset!"),
}
self.subscribed.remove(subscription);
}
}