summaryrefslogtreecommitdiff
path: root/src/channel/app.rs
blob: 7b02300e35e7f354dce3287dc37b7b3698a212c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
use std::collections::{hash_map::Entry, HashMap};
use std::sync::{Arc, Mutex};

use futures::{
    stream::{self, StreamExt as _, TryStreamExt as _},
    Stream,
};
use sqlx::sqlite::SqlitePool;
use tokio::sync::broadcast::{channel, Sender};
use tokio_stream::wrappers::BroadcastStream;

use super::repo::{
    channels::{Id as ChannelId, Provider as _},
    messages::{Message, Provider as _},
};
use crate::{clock::DateTime, error::BoxedError, login::repo::logins::Login};

pub struct Channels<'a> {
    db: &'a SqlitePool,
    broadcaster: &'a Broadcaster,
}

impl<'a> Channels<'a> {
    pub fn new(db: &'a SqlitePool, broadcaster: &'a Broadcaster) -> Self {
        Self { db, broadcaster }
    }

    pub async fn create(&self, name: &str) -> Result<(), BoxedError> {
        let mut tx = self.db.begin().await?;
        let channel = tx.channels().create(name).await?;
        tx.commit().await?;

        self.broadcaster.register_channel(&channel)?;
        Ok(())
    }

    pub async fn send(
        &self,
        login: &Login,
        channel: &ChannelId,
        body: &str,
        sent_at: &DateTime,
    ) -> Result<(), BoxedError> {
        let mut tx = self.db.begin().await?;
        let message = tx
            .messages()
            .create(&login.id, channel, body, sent_at)
            .await?;
        tx.commit().await?;

        self.broadcaster.broadcast(channel, message)?;
        Ok(())
    }

    pub async fn events(
        &self,
        channel: &ChannelId,
    ) -> Result<impl Stream<Item = Result<Message, BoxedError>>, BoxedError> {
        let live_messages = self.broadcaster.listen(channel)?.map_err(BoxedError::from);

        let mut tx = self.db.begin().await?;
        let stored_messages = tx.messages().all(channel).await?;
        tx.commit().await?;

        let stored_messages = stream::iter(stored_messages.into_iter().map(Ok));

        Ok(stored_messages.chain(live_messages))
    }
}

// Clones will share the same senders collection.
#[derive(Clone)]
pub struct Broadcaster {
    // The use of std::sync::Mutex, and not tokio::sync::Mutex, follows Tokio's
    // own advice: <https://tokio.rs/tokio/tutorial/shared-state>. Methods that
    // lock it must be sync.
    senders: Arc<Mutex<HashMap<ChannelId, Sender<Message>>>>,
}

impl Broadcaster {
    pub async fn from_database(db: &SqlitePool) -> Result<Broadcaster, BoxedError> {
        let mut tx = db.begin().await?;
        let channels = tx.channels().all().await?;
        tx.commit().await?;

        let channels = channels.iter().map(|c| &c.id);
        let broadcaster = Broadcaster::new(channels);
        Ok(broadcaster)
    }

    fn new<'i>(channels: impl IntoIterator<Item = &'i ChannelId>) -> Self {
        let senders: HashMap<_, _> = channels
            .into_iter()
            .cloned()
            .map(|id| (id, Self::make_sender()))
            .collect();

        Self {
            senders: Arc::new(Mutex::new(senders)),
        }
    }

    pub fn register_channel(&self, channel: &ChannelId) -> Result<(), RegisterError> {
        match self.senders.lock().unwrap().entry(channel.clone()) {
            Entry::Occupied(_) => Err(RegisterError::Duplicate),
            vacant => {
                vacant.or_insert_with(Self::make_sender);
                Ok(())
            }
        }
    }

    pub fn broadcast(&self, channel: &ChannelId, message: Message) -> Result<(), BroadcastError> {
        let lock = self.senders.lock().unwrap();
        let tx = lock.get(channel).ok_or(BroadcastError::Unregistered)?;

        // Per the Tokio docs, the returned error is only used to indicate that
        // there are no receivers. In this use case, that's fine; a lack of
        // listening consumers (chat clients) when a message is sent isn't an
        // error.
        let _ = tx.send(message);
        Ok(())
    }

    pub fn listen(&self, channel: &ChannelId) -> Result<BroadcastStream<Message>, BroadcastError> {
        let lock = self.senders.lock().unwrap();
        let tx = lock.get(channel).ok_or(BroadcastError::Unregistered)?;
        let rx = tx.subscribe();
        let stream = BroadcastStream::from(rx);

        Ok(stream)
    }

    fn make_sender() -> Sender<Message> {
        // Queue depth of 16 chosen entirely arbitrarily. Don't read too much
        // into it.
        let (tx, _) = channel(16);
        tx
    }
}

#[derive(Debug, thiserror::Error)]
pub enum RegisterError {
    #[error("duplicate channel registered")]
    Duplicate,
}

#[derive(Debug, thiserror::Error)]
pub enum BroadcastError {
    #[error("requested channel not registered")]
    Unregistered,
}