discord-ferris 0.0.2

discord-ferris is a Discord API Rust library under development 🦀
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
use futures_util::{SinkExt, StreamExt};
use rustls::{ClientConfig, RootCertStore};
use serde::Deserialize;
use serde_json::value::RawValue;
use std::sync::Arc;
use tokio::sync::{mpsc, watch};
use tokio_tungstenite::{Connector, connect_async_tls_with_config, tungstenite::protocol::Message};

use crate::gateway::Gateway;
use crate::log;
use crate::models::gateway::{
    GatewayDispatch, GatewayDispatchEvents as GwEvt, GatewayIntents, GatewayOpcodes,
};

const DISCORD_GATEWAY_URL: &str = "wss://gateway.discord.gg/?v=10&encoding=json";

#[derive(thiserror::Error, Debug)]
pub enum ResumeError {
    #[error("invalid session on resume (resumable={resumable})")]
    InvalidSession { resumable: bool },
    #[error(transparent)]
    Transport(#[from] anyhow::Error),
}

#[derive(Deserialize)]
struct FrameBorrowed<'a> {
    op: i64,
    #[serde(default)]
    s: Option<i64>,
    #[serde(default)]
    t: Option<&'a str>,
    /// Borrowed raw payload slice.
    #[serde(borrow)]
    d: Option<&'a RawValue>,
}

#[derive(Deserialize)]
struct HelloD {
    heartbeat_interval: u64,
}

fn map_event(name: &str) -> Option<GwEvt> {
    serde_json::from_str::<GwEvt>(&format!("\"{name}\"")).ok()
}

pub async fn connect(token: &str, intents: GatewayIntents) -> anyhow::Result<Gateway> {
    log!("GW", "connecting to discord gateway");

    // TLS
    let provider = rustls::crypto::ring::default_provider().into();
    let mut root_store = RootCertStore::empty();
    root_store.extend(webpki_roots::TLS_SERVER_ROOTS.iter().cloned());

    let config = ClientConfig::builder_with_provider(provider)
        .with_safe_default_protocol_versions()?
        .with_root_certificates(root_store)
        .with_no_client_auth();

    let connector = Connector::Rustls(Arc::new(config));

    // WS
    let (ws_stream, _) =
        connect_async_tls_with_config(DISCORD_GATEWAY_URL, None, true, Some(connector)).await?;
    log!("OK", "connection established");
    let (mut write, mut read) = ws_stream.split();

    // Single writer task
    let (writer_tx, mut writer_rx) = mpsc::unbounded_channel::<Message>();
    tokio::spawn(async move {
        while let Some(msg) = writer_rx.recv().await {
            if let Err(e) = write.send(msg).await {
                log!("ERR", "[writer] send error: {e}");
                break;
            }
        }
    });

    // Aux channels
    let (immediate_tx, immediate_rx) = mpsc::channel::<()>(8);
    let (last_seq_tx, last_seq_rx) = watch::channel::<Option<i64>>(None);
    let (shutdown_tx, shutdown_rx) = watch::channel(false);

    // 1) HELLO
    let heartbeat_interval_ms = loop {
        let Some(frame) = read.next().await else {
            let _ = shutdown_tx.send(true);
            anyhow::bail!("gateway closed before HELLO");
        };
        let Message::Text(text) = frame? else {
            continue;
        };
        let Ok(f) = serde_json::from_str::<FrameBorrowed>(&text) else {
            continue;
        };
        if f.op == 10 {
            let d = f.d.ok_or_else(|| anyhow::anyhow!("HELLO without d"))?;
            let hello = serde_json::from_str::<HelloD>(d.get())?;
            log!(
                "OK",
                "received HELLO, heartbeat_interval={}ms",
                hello.heartbeat_interval
            );
            break hello.heartbeat_interval;
        }
    };

    // 2) heartbeat
    tokio::spawn(crate::gateway::heartbeat::run_heartbeat(
        writer_tx.clone(),
        heartbeat_interval_ms,
        immediate_rx,
        last_seq_rx.clone(),
        shutdown_rx,
    ));

    // 3) IDENTIFY
    let identify = serde_json::json!({
        "op": 2,
        "d": {
            "token": token,
            "intents": intents.bits(),
            "properties": { "os": "linux", "browser": "discord-ferris", "device": "discord-ferris" }
        }
    });
    writer_tx.send(Message::Text(identify.to_string().into()))?;
    log!("GW", "payload op2 (identify) queued");

    // Dispatch channel (raw `d`)
    let (events_tx, events_rx) = mpsc::unbounded_channel::<GatewayDispatch<Box<RawValue>>>();

    // 4) Read until READY
    let mut session_id: Option<String> = None;
    let mut resume_gateway_url: Option<String> = None;

    loop {
        let Some(msg) = read.next().await else {
            let _ = shutdown_tx.send(true);
            anyhow::bail!("gateway closed before READY");
        };
        let Message::Text(text) = msg? else { continue };
        let Ok(f) = serde_json::from_str::<FrameBorrowed>(&text) else {
            continue;
        };

        if let Some(s) = f.s {
            let _ = last_seq_tx.send_replace(Some(s));
        }

        match f.op {
            0 => {
                let Some(t) = f.t else { continue };
                if t == "READY" {
                    if let Some(d) = f.d {
                        #[derive(Deserialize)]
                        struct ReadyD<'a> {
                            session_id: &'a str,
                            #[serde(default)]
                            resume_gateway_url: Option<&'a str>,
                        }
                        if let Ok(r) = serde_json::from_str::<ReadyD>(d.get()) {
                            session_id = Some(r.session_id.to_string());
                            resume_gateway_url = Some(
                                r.resume_gateway_url
                                    .unwrap_or(DISCORD_GATEWAY_URL)
                                    .to_string(),
                            );
                        }
                    }
                    log!("EVT", "READY");
                    let ev = GatewayDispatch {
                        op: GatewayOpcodes::Dispatch,
                        t: GwEvt::Ready,
                        s: f.s.unwrap_or(0),
                        d: Box::from(RawValue::from_string(f.d.unwrap().get().to_owned()).unwrap()),
                    };
                    let _ = events_tx.send(ev);
                    break;
                } else if let Some(evt) = map_event(t) {
                    let ev = GatewayDispatch {
                        op: GatewayOpcodes::Dispatch,
                        t: evt,
                        s: f.s.unwrap_or(0),
                        d: Box::from(RawValue::from_string(f.d.unwrap().get().to_owned()).unwrap()),
                    };
                    let _ = events_tx.send(ev);
                }
            }
            1 => {
                let _ = immediate_tx.try_send(());
            } // HEARTBEAT request
            7 => {
                log!("WARN", "[gw] RECONNECT requested");
            }
            9 => {
                log!("WARN", "[gw] INVALID_SESSION: {:?}", f.d.map(|d| d.get()));
            }
            11 => {}
            _ => {}
        }
    }

    let session_id = session_id.unwrap_or_default();
    let resume_gateway_url = resume_gateway_url.unwrap_or_else(|| DISCORD_GATEWAY_URL.to_string());

    // Background reader after READY
    let events_tx_bg = events_tx.clone();
    let last_seq_tx_bg = last_seq_tx.clone();
    let immediate_tx_bg = immediate_tx.clone();
    tokio::spawn(async move {
        while let Some(msg) = read.next().await {
            let Ok(Message::Text(text)) = msg else {
                continue;
            };
            let Ok(f) = serde_json::from_str::<FrameBorrowed>(&text) else {
                continue;
            };

            if let Some(s) = f.s {
                let _ = last_seq_tx_bg.send_replace(Some(s));
            }

            match f.op {
                0 => {
                    if let (Some(t), Some(d)) = (f.t, f.d) {
                        if let Some(evt) = map_event(t) {
                            let ev = GatewayDispatch {
                                op: GatewayOpcodes::Dispatch,
                                t: evt,
                                s: f.s.unwrap_or(0),
                                d: Box::from(RawValue::from_string(d.get().to_owned()).unwrap()),
                            };
                            let _ = events_tx_bg.send(ev);
                        }
                    }
                }
                1 => {
                    let _ = immediate_tx_bg.try_send(());
                }
                7 => {
                    log!("WARN", "[gw] RECONNECT requested");
                }
                9 => {
                    log!("WARN", "[gw] INVALID_SESSION during running");
                }
                11 => {}
                _ => {}
            }
        }
        log!("WARN", "[reader] stream closed");
    });

    Ok(Gateway {
        session_id,
        resume_gateway_url,
        writer_tx,
        events_rx,
        last_seq_rx,
        shutdown_tx,
    })
}

pub async fn resume(
    token: &str,
    session_id: &str,
    resume_gateway_url: &str,
    last_seq: Option<i64>,
) -> Result<Gateway, ResumeError> {
    log!(
        "GW",
        "resuming session_id={} at {}",
        session_id,
        resume_gateway_url
    );

    // TLS
    let provider = rustls::crypto::ring::default_provider().into();
    let mut root_store = RootCertStore::empty();
    root_store.extend(webpki_roots::TLS_SERVER_ROOTS.iter().cloned());

    let config = ClientConfig::builder_with_provider(provider)
        .with_safe_default_protocol_versions()
        .map_err(|e| ResumeError::Transport(anyhow::anyhow!(e)))?
        .with_root_certificates(root_store)
        .with_no_client_auth();

    let connector = Connector::Rustls(Arc::new(config));

    // WS
    let resume_url = normalize_gateway_url(resume_gateway_url);
    let (ws_stream, _) = connect_async_tls_with_config(resume_url, None, true, Some(connector))
        .await
        .map_err(|e| ResumeError::Transport(anyhow::anyhow!(e)))?;
    log!("OK", "reconnected websocket");
    let (mut write, mut read) = ws_stream.split();

    // Writer
    let (writer_tx, mut writer_rx) = mpsc::unbounded_channel::<Message>();
    tokio::spawn(async move {
        while let Some(msg) = writer_rx.recv().await {
            if let Err(e) = write.send(msg).await {
                log!("ERR", "[writer] send error: {e}");
                break;
            }
        }
    });

    // Aux channels
    let (immediate_tx, immediate_rx) = mpsc::channel::<()>(8);
    let (last_seq_tx, last_seq_rx) = watch::channel::<Option<i64>>(last_seq);
    let (shutdown_tx, shutdown_rx) = watch::channel(false);

    // HELLO
    let heartbeat_interval_ms = loop {
        let Some(frame) = read.next().await else {
            let _ = shutdown_tx.send(true);
            return Err(ResumeError::Transport(anyhow::anyhow!(
                "gateway closed before HELLO (resume)"
            )));
        };
        let Message::Text(text) = frame.map_err(|e| ResumeError::Transport(anyhow::anyhow!(e)))?
        else {
            continue;
        };
        let Ok(f) = serde_json::from_str::<FrameBorrowed>(&text) else {
            continue;
        };
        if f.op == 10 {
            let d =
                f.d.ok_or_else(|| ResumeError::Transport(anyhow::anyhow!("HELLO without d")))?;
            let hello = serde_json::from_str::<HelloD>(d.get())
                .map_err(|e| ResumeError::Transport(anyhow::anyhow!(e)))?;
            log!(
                "OK",
                "received HELLO (resume), heartbeat_interval={}ms",
                hello.heartbeat_interval
            );
            break hello.heartbeat_interval;
        }
    };

    // Heartbeat before RESUME
    tokio::spawn(crate::gateway::heartbeat::run_heartbeat(
        writer_tx.clone(),
        heartbeat_interval_ms,
        immediate_rx,
        last_seq_rx.clone(),
        shutdown_rx,
    ));

    // RESUME
    let resume_payload = serde_json::json!({
        "op": 6,
        "d": { "token": token, "session_id": session_id, "seq": last_seq }
    });
    writer_tx
        .send(Message::Text(resume_payload.to_string().into()))
        .map_err(|e| ResumeError::Transport(anyhow::anyhow!("failed to queue RESUME: {e}")))?;
    log!("GW", "payload op6 (resume) queued with seq={last_seq:?}");

    // Dispatch channel
    let (events_tx, events_rx) = mpsc::unbounded_channel::<GatewayDispatch<Box<RawValue>>>();

    // Wait until RESUMED
    loop {
        let Some(msg) = read.next().await else {
            let _ = shutdown_tx.send(true);
            return Err(ResumeError::Transport(anyhow::anyhow!(
                "gateway closed before RESUMED"
            )));
        };
        let Message::Text(text) = msg.map_err(|e| ResumeError::Transport(anyhow::anyhow!(e)))?
        else {
            continue;
        };
        let Ok(f) = serde_json::from_str::<FrameBorrowed>(&text) else {
            continue;
        };

        if let Some(s) = f.s {
            let _ = last_seq_tx.send_replace(Some(s));
        }

        match f.op {
            0 => {
                if let Some("RESUMED") = f.t {
                    log!("EVT", "RESUMED");
                    let ev = GatewayDispatch {
                        op: GatewayOpcodes::Dispatch,
                        t: GwEvt::Resumed,
                        s: f.s.unwrap_or(0),
                        d: Box::from(RawValue::from_string(f.d.unwrap().get().to_owned()).unwrap()),
                    };
                    let _ = events_tx.send(ev);
                    break;
                } else if let (Some(t), Some(d)) = (f.t, f.d) {
                    if let Some(evt) = map_event(t) {
                        let ev = GatewayDispatch {
                            op: GatewayOpcodes::Dispatch,
                            t: evt,
                            s: f.s.unwrap_or(0),
                            d: Box::from(RawValue::from_string(d.get().to_owned()).unwrap()),
                        };
                        let _ = events_tx.send(ev);
                    }
                }
            }
            1 => {
                let _ = immediate_tx.try_send(());
            }
            7 => {
                log!("WARN", "[gw] RECONNECT requested during RESUME");
            }
            9 => {
                let resumable =
                    f.d.and_then(|v| v.get().parse::<bool>().ok())
                        .unwrap_or(false);
                log!("WARN", "[gw] INVALID_SESSION during RESUME: {resumable}");
                let _ = shutdown_tx.send(true);
                return Err(ResumeError::InvalidSession { resumable });
            }
            11 => {}
            _ => {}
        }
    }

    // Background reader after RESUMED
    let events_tx_bg = events_tx.clone();
    let last_seq_tx_bg = last_seq_tx.clone();
    let immediate_tx_bg = immediate_tx.clone();
    tokio::spawn(async move {
        while let Some(msg) = read.next().await {
            let Ok(Message::Text(text)) = msg else {
                continue;
            };
            let Ok(f) = serde_json::from_str::<FrameBorrowed>(&text) else {
                continue;
            };

            if let Some(s) = f.s {
                let _ = last_seq_tx_bg.send_replace(Some(s));
            }

            match f.op {
                0 => {
                    if let (Some(t), Some(d)) = (f.t, f.d) {
                        if let Some(evt) = map_event(t) {
                            let ev = GatewayDispatch {
                                op: GatewayOpcodes::Dispatch,
                                t: evt,
                                s: f.s.unwrap_or(0),
                                d: Box::from(RawValue::from_string(d.get().to_owned()).unwrap()),
                            };
                            let _ = events_tx_bg.send(ev);
                        }
                    }
                }
                1 => {
                    let _ = immediate_tx_bg.try_send(());
                }
                7 => {
                    log!("WARN", "[gw] RECONNECT requested");
                }
                9 => {
                    log!("WARN", "[gw] INVALID_SESSION during running");
                }
                11 => {}
                _ => {}
            }
        }
        log!("WARN", "[reader] stream closed (resumed)");
    });

    Ok(Gateway {
        session_id: session_id.to_string(),
        resume_gateway_url: resume_gateway_url.to_string(),
        writer_tx,
        events_rx,
        last_seq_rx,
        shutdown_tx,
    })
}

fn normalize_gateway_url(base: &str) -> String {
    if base.contains('?') {
        base.to_string()
    } else if base.ends_with('/') {
        format!("{base}?v=10&encoding=json")
    } else {
        format!("{base}/?v=10&encoding=json")
    }
}