ruvolt 0.5.0

An API wrapper for Revolt written in Rust.
Documentation 
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

use {
    futures_util::{SinkExt, StreamExt},
    std::time::{Duration, Instant},
    tokio::net::TcpStream,
    tokio_tungstenite::{connect_async, tungstenite::Message, MaybeTlsStream, WebSocketStream},
    tracing::info,
};

use crate::{
    error::Error,
    models::events::{ClientEvent, ServerEvent},
    Result,
};

#[cfg(not(feature = "msgpack"))]
const BONFIRE_API: &str = "wss://ws.revolt.chat";
#[cfg(feature = "msgpack")]
const BONFIRE_API: &str = "wss://ws.revolt.chat/?format=msgpack";

#[derive(Debug)]
pub struct WebSocketClient {
    stream: WebSocketStream<MaybeTlsStream<TcpStream>>,
    heartbeat_dur: Duration,
    last_heartbeat: (Instant, Instant),
}

impl WebSocketClient {
    pub async fn connect() -> Result<Self> {
        let (stream, _) = connect_async(BONFIRE_API).await?;
        let now = Instant::now();

        Ok(Self {
            stream,
            heartbeat_dur: Duration::from_secs(25),
            last_heartbeat: (now, now),
        })
    }

    pub async fn send(&mut self, event: ClientEvent) -> Result {
        #[cfg(not(feature = "msgpack"))]
        let msg = Message::Text(serde_json::to_string(&event).unwrap());
        #[cfg(feature = "msgpack")]
        let msg = Message::Binary(rmp_serde::to_vec(&event).unwrap());

        self.stream.send(msg).await?;

        Ok(())
    }

    pub async fn accept(&mut self) -> Option<Result<ServerEvent>> {
        match self.stream.next().await? {
            Ok(msg) => match msg {
                #[cfg(not(feature = "msgpack"))]
                Message::Text(text) => {
                    let event = serde_json::from_str(&text).map_err(|_| {
                        Error::Unknown(format!(
                            "Cannot deserialize a websocket message: {:?}",
                            text
                        ))
                    });

                    match event {
                        Ok(event) => {
                            self.check_pong(&event);

                            Some(Ok(event))
                        }
                        Err(err) => Some(Err(err)),
                    }
                }
                #[cfg(feature = "msgpack")]
                Message::Binary(buf) => {
                    let event = rmp_serde::from_read_ref(&buf).map_err(|_| {
                        Error::Unknown("Cannot deserialize a binary websocket message".into())
                    });

                    match event {
                        Ok(event) => {
                            self.check_pong(&event);

                            Some(Ok(event))
                        }
                        Err(err) => Some(Err(err)),
                    }
                }
                Message::Close(_) => None,
                _ => unreachable!(),
            },
            Err(err) => Some(Err(err.into())),
        }
    }

    pub fn latency(&self) -> Option<Duration> {
        if self.last_heartbeat.0 < self.last_heartbeat.1 {
            return Some(self.last_heartbeat.1 - self.last_heartbeat.0);
        }

        None
    }

    pub async fn close(&mut self) -> Result {
        info!(target: "WebSocketClient", "Closing the connection");
        self.stream.close(None).await?;

        Ok(())
    }

    pub async fn check_heartbeat(&mut self) -> Result {
        let dur = Instant::now() - self.last_heartbeat.0;

        if dur >= self.heartbeat_dur {
            self.heartbeat().await?;
        }

        Ok(())
    }

    async fn heartbeat(&mut self) -> Result {
        self.send(ClientEvent::Ping { data: 0 }).await?;

        self.last_heartbeat.0 = Instant::now();

        Ok(())
    }

    fn check_pong(&mut self, event: &ServerEvent) {
        if let ServerEvent::Pong = event {
            self.last_heartbeat.1 = Instant::now();
        }
    }
}