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 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
//! Primary logic and implementation details of Discord gateway websocket
//! connections.
//!
//! Shards are, at their heart, a websocket connection with some state for
//! maintaining an identified session with the Discord gateway. For more
//! information about what a shard is in the context of Discord's gateway API,
//! refer to the documentation for [`Shard`].
#[cfg(any(feature = "zlib-stock", feature = "zlib-simd"))]
use crate::inflater::Inflater;
use crate::{
channel::{MessageChannel, MessageSender},
error::{ReceiveMessageError, ReceiveMessageErrorType},
json,
latency::Latency,
queue::{InMemoryQueue, Queue},
ratelimiter::CommandRatelimiter,
session::Session,
Command, Config, Message, ShardId, API_VERSION,
};
use futures_core::Stream;
use futures_sink::Sink;
use serde::{de::DeserializeOwned, Deserialize};
#[cfg(any(
feature = "native-tls",
feature = "rustls-native-roots",
feature = "rustls-webpki-roots"
))]
use std::io::ErrorKind as IoErrorKind;
use std::{
env::consts::OS,
fmt,
future::Future,
pin::Pin,
str,
task::{ready, Context, Poll},
};
use tokio::{
net::TcpStream,
sync::oneshot,
time::{self, Duration, Instant, Interval, MissedTickBehavior},
};
use tokio_websockets::{ClientBuilder, Error as WebsocketError, Limits, MaybeTlsStream};
use twilight_model::gateway::{
event::GatewayEventDeserializer,
payload::{
incoming::Hello,
outgoing::{
identify::{IdentifyInfo, IdentifyProperties},
Heartbeat, Identify, Resume,
},
},
CloseCode, CloseFrame, Intents, OpCode,
};
/// URL of the Discord gateway.
const GATEWAY_URL: &str = "wss://gateway.discord.gg";
/// Query argument with zlib-stream enabled.
#[cfg(any(feature = "zlib-stock", feature = "zlib-simd"))]
const COMPRESSION_FEATURES: &str = "&compress=zlib-stream";
/// No query arguments due to compression being disabled.
#[cfg(not(any(feature = "zlib-stock", feature = "zlib-simd")))]
const COMPRESSION_FEATURES: &str = "";
/// [`tokio_websockets`] library Websocket connection.
type Connection = tokio_websockets::WebSocketStream<MaybeTlsStream<TcpStream>>;
/// Wrapper struct around an `async fn` with a `Debug` implementation.
struct ConnectionFuture(Pin<Box<dyn Future<Output = Result<Connection, WebsocketError>> + Send>>);
impl fmt::Debug for ConnectionFuture {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_tuple("ConnectionFuture")
.field(&"<async fn>")
.finish()
}
}
/// Close initiator of a websocket connection.
#[derive(Clone, Debug)]
enum CloseInitiator {
/// Gateway initiated the close.
///
/// Contains an optional close code.
Gateway(Option<u16>),
/// Shard initiated the close.
///
/// Contains a close code.
Shard(CloseFrame<'static>),
/// Transport error initiated the close.
Transport,
}
/// Current state of a [Shard].
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ShardState {
/// Shard is connected to the gateway with an active session.
Active,
/// Shard is disconnected from the gateway but may reconnect in the future.
///
/// The websocket connection may still be open.
Disconnected {
/// Number of reconnection attempts that have been made.
reconnect_attempts: u8,
},
/// Shard has fatally closed.
///
/// Possible reasons may be due to [failed authentication],
/// [invalid intents], or other reasons. Refer to the documentation for
/// [`CloseCode`] for possible reasons.
///
/// [failed authentication]: CloseCode::AuthenticationFailed
/// [invalid intents]: CloseCode::InvalidIntents
FatallyClosed,
/// Shard is waiting to establish or resume a session.
Identifying,
/// Shard is replaying missed dispatch events.
///
/// The shard is considered identified whilst resuming.
Resuming,
}
impl ShardState {
/// Determine the connection status from the close code.
///
/// Defers to [`CloseCode::can_reconnect`] to determine whether the
/// connection can be reconnected, defaulting to [`Self::Disconnected`] if
/// the close code is unknown.
fn from_close_code(close_code: Option<u16>) -> Self {
match close_code.map(CloseCode::try_from) {
Some(Ok(close_code)) if !close_code.can_reconnect() => Self::FatallyClosed,
_ => Self::Disconnected {
reconnect_attempts: 0,
},
}
}
/// Whether the shard has disconnected but may reconnect in the future.
const fn is_disconnected(self) -> bool {
matches!(self, Self::Disconnected { .. })
}
/// Whether the shard is identified with an active session.
///
/// `true` if the status is [`Active`] or [`Resuming`].
///
/// [`Active`]: Self::Active
/// [`Resuming`]: Self::Resuming
pub const fn is_identified(self) -> bool {
matches!(self, Self::Active | Self::Resuming)
}
}
/// Gateway event with only minimal required data.
#[derive(Deserialize)]
struct MinimalEvent<T> {
/// Attached data of the gateway event.
#[serde(rename = "d")]
data: T,
}
/// Minimal [`Ready`] for light deserialization.
///
/// [`Ready`]: twilight_model::gateway::payload::incoming::Ready
#[derive(Deserialize)]
struct MinimalReady {
/// Used for resuming connections.
resume_gateway_url: Box<str>,
/// ID of the new identified session.
session_id: String,
}
/// Pending outgoing message indicator.
#[derive(Debug)]
struct Pending {
/// The pending message, if not already sent.
gateway_event: Option<Message>,
/// Whether the pending gateway event is a heartbeat.
is_heartbeat: bool,
}
impl Pending {
/// Constructor for a pending gateway event.
const fn text(json: String, is_heartbeat: bool) -> Option<Self> {
Some(Self {
gateway_event: Some(Message::Text(json)),
is_heartbeat,
})
}
}
/// Gateway API client responsible for up to 2500 guilds.
///
/// Shards are responsible for maintaining the gateway connection by processing
/// events relevant to the operation of shards---such as requests from the
/// gateway to re-connect or invalidate a session---and then to pass them on to
/// the user.
///
/// Shards start out disconnected, but will on the first successful call to
/// [`poll_next`] try to reconnect to the gateway. [`poll_next`] must then
/// be repeatedly called in order for the shard to maintain its connection and
/// update its internal state.
///
/// Shards go through an [identify queue][`queue`] that rate limits concurrent
/// `Identify` events (across all shards) per 5 seconds. Exceeding this limit
/// invalidates the shard's session and it is therefore **very important** to
/// reuse the same queue for all shards.
///
/// # Sharding
///
/// A shard may not be connected to more than 2500 guilds, so large bots must
/// split themselves across multiple shards. See the
/// [Discord Docs/Sharding][docs:sharding] and [`ShardId`] documentation for
/// more info.
///
/// # Examples
///
/// Create and start a shard and print new and deleted messages:
///
/// ```no_run
/// use std::env;
/// use twilight_gateway::{Event, EventTypeFlags, Intents, Shard, ShardId, StreamExt as _};
///
/// # #[tokio::main] async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// // Use the value of the "DISCORD_TOKEN" environment variable as the bot's
/// // token. Of course, this value may be passed into the program however is
/// // preferred.
/// let token = env::var("DISCORD_TOKEN")?;
/// let wanted_event_types = EventTypeFlags::MESSAGE_CREATE | EventTypeFlags::MESSAGE_DELETE;
///
/// let mut shard = Shard::new(ShardId::ONE, token, Intents::GUILD_MESSAGES);
///
/// while let Some(item) = shard.next_event(EventTypeFlags::all()).await {
/// let Ok(event) = item else {
/// tracing::warn!(source = ?item.unwrap_err(), "error receiving event");
///
/// continue;
/// };
///
/// match event {
/// Event::MessageCreate(message) => {
/// println!("message received with content: {}", message.content);
/// }
/// Event::MessageDelete(message) => {
/// println!("message with ID {} deleted", message.id);
/// }
/// _ => {}
/// }
/// }
/// # Ok(()) }
/// ```
///
/// [docs:sharding]: https://discord.com/developers/docs/topics/gateway#sharding
/// [gateway commands]: Shard::command
/// [`poll_next`]: Shard::poll_next
/// [`queue`]: crate::queue
#[derive(Debug)]
pub struct Shard<Q = InMemoryQueue> {
/// User provided configuration.
///
/// Configurations are provided or created in shard initializing via
/// [`Shard::new`] or [`Shard::with_config`].
config: Config<Q>,
/// Future to establish a WebSocket connection with the Gateway.
connection_future: Option<ConnectionFuture>,
/// Websocket connection, which may be connected to Discord's gateway.
///
/// The connection should only be dropped after it has returned `Ok(None)`
/// to comply with the WebSocket protocol.
connection: Option<Connection>,
/// Interval of how often the gateway would like the shard to send
/// heartbeats.
///
/// The interval is received in the [`GatewayEvent::Hello`] event when
/// first opening a new [connection].
///
/// [`GatewayEvent::Hello`]: twilight_model::gateway::event::GatewayEvent::Hello
/// [connection]: Self::connection
heartbeat_interval: Option<Interval>,
/// Whether an event has been received in the current heartbeat interval.
heartbeat_interval_event: bool,
/// ID of the shard.
id: ShardId,
/// Identify queue receiver.
identify_rx: Option<oneshot::Receiver<()>>,
/// Zlib decompressor.
#[cfg(any(feature = "zlib-stock", feature = "zlib-simd"))]
inflater: Inflater,
/// Potentially pending outgoing message.
pending: Option<Pending>,
/// Recent heartbeat latency statistics.
///
/// The latency is reset on receiving [`GatewayEvent::Hello`] as the host
/// may have changed, invalidating previous latency statistic.
///
/// [`GatewayEvent::Hello`]: twilight_model::gateway::event::GatewayEvent::Hello
latency: Latency,
/// Command ratelimiter, if it was enabled via
/// [`Config::ratelimit_messages`].
ratelimiter: Option<CommandRatelimiter>,
/// Used for resuming connections.
resume_url: Option<Box<str>>,
/// Active session of the shard.
///
/// The shard may not have an active session if it hasn't yet identified and
/// received a `READY` dispatch event response.
session: Option<Session>,
/// Current state of the shard.
state: ShardState,
/// Messages from the user to be relayed and sent over the Websocket
/// connection.
user_channel: MessageChannel,
}
impl Shard {
/// Create a new shard with the default configuration.
pub fn new(id: ShardId, token: String, intents: Intents) -> Self {
Self::with_config(id, Config::new(token, intents))
}
}
impl<Q> Shard<Q> {
/// Create a new shard with the provided configuration.
pub fn with_config(shard_id: ShardId, mut config: Config<Q>) -> Self {
let session = config.take_session();
let mut resume_url = config.take_resume_url();
//ensure resume_url is only used if we have a session to resume
if session.is_none() {
resume_url = None;
}
Self {
config,
connection_future: None,
connection: None,
heartbeat_interval: None,
heartbeat_interval_event: false,
id: shard_id,
identify_rx: None,
#[cfg(any(feature = "zlib-stock", feature = "zlib-simd"))]
inflater: Inflater::new(),
pending: None,
latency: Latency::new(),
ratelimiter: None,
resume_url,
session,
state: ShardState::Disconnected {
reconnect_attempts: 0,
},
user_channel: MessageChannel::new(),
}
}
/// Immutable reference to the configuration used to instantiate this shard.
pub const fn config(&self) -> &Config<Q> {
&self.config
}
/// ID of the shard.
pub const fn id(&self) -> ShardId {
self.id
}
/// Zlib decompressor statistics.
///
/// Reset when reconnecting to the gateway.
#[cfg(any(feature = "zlib-stock", feature = "zlib-simd"))]
pub const fn inflater(&self) -> &Inflater {
&self.inflater
}
/// State of the shard.
pub const fn state(&self) -> ShardState {
self.state
}
/// Shard latency statistics, including average latency and recent heartbeat
/// latency times.
///
/// Reset when reconnecting to the gateway.
pub const fn latency(&self) -> &Latency {
&self.latency
}
/// Statistics about the number of available commands and when the command
/// ratelimiter will refresh.
///
/// This won't be present if ratelimiting was disabled via
/// [`ConfigBuilder::ratelimit_messages`] or if the shard is disconnected.
///
/// [`ConfigBuilder::ratelimit_messages`]: crate::ConfigBuilder::ratelimit_messages
pub const fn ratelimiter(&self) -> Option<&CommandRatelimiter> {
self.ratelimiter.as_ref()
}
/// Immutable reference to the gateways current resume URL.
///
/// A resume URL might not be present if the shard had its session
/// invalidated and has not yet reconnected.
pub fn resume_url(&self) -> Option<&str> {
self.resume_url.as_deref()
}
/// Immutable reference to the active gateway session.
///
/// An active session may not be present if the shard had its session
/// invalidated and has not yet reconnected.
pub const fn session(&self) -> Option<&Session> {
self.session.as_ref()
}
/// Queue a command to be sent to the gateway.
///
/// Serializes the command and then calls [`send`].
///
/// [`send`]: Self::send
#[allow(clippy::missing_panics_doc)]
pub fn command(&self, command: &impl Command) {
self.send(json::to_string(command).expect("serialization cannot fail"));
}
/// Queue a JSON encoded gateway event to be sent to the gateway.
#[allow(clippy::missing_panics_doc)]
pub fn send(&self, json: String) {
self.user_channel
.command_tx
.send(json)
.expect("channel open");
}
/// Queue a websocket close frame.
///
/// Invalidates the session and shows the application's bot as offline if
/// the close frame code is `1000` or `1001`. Otherwise Discord will
/// continue showing the bot as online until its presence times out.
///
/// To read all remaining messages, continue calling [`poll_next`] until it
/// returns [`Message::Close`] or a [`ReceiveMessageErrorType::WebSocket`]
/// error type.
///
/// # Example
///
/// Close the shard and process remaining messages:
///
/// ```no_run
/// # use twilight_gateway::{Intents, Shard, ShardId};
/// # #[tokio::main] async fn main() {
/// # let mut shard = Shard::new(ShardId::ONE, String::new(), Intents::empty());
/// use tokio_stream::StreamExt;
/// use twilight_gateway::{error::ReceiveMessageErrorType, CloseFrame, Message};
///
/// shard.close(CloseFrame::NORMAL);
///
/// while let Some(item) = shard.next().await {
/// match item {
/// Ok(Message::Close(_)) => break,
/// Ok(Message::Text(_)) => unimplemented!(),
/// Err(source) if matches!(source.kind(), ReceiveMessageErrorType::WebSocket) => break,
/// Err(source) => unimplemented!(),
/// }
/// }
/// # }
/// ```
///
/// [`poll_next`]: Shard::poll_next
pub fn close(&self, close_frame: CloseFrame<'static>) {
_ = self.user_channel.close_tx.try_send(close_frame);
}
/// Retrieve a channel to send messages over the shard to the gateway.
///
/// This is primarily useful for sending to other tasks and threads where
/// the shard won't be available.
///
/// # Example
///
/// Queue a command in another process:
///
/// ```no_run
/// # use twilight_gateway::{Intents, Shard, ShardId};
/// # #[tokio::main] async fn main() {
/// # let mut shard = Shard::new(ShardId::ONE, String::new(), Intents::empty());
/// use tokio_stream::StreamExt;
///
/// while let Some(item) = shard.next().await {
/// match item {
/// Ok(message) => {
/// let sender = shard.sender();
/// tokio::spawn(async move {
/// let command = unimplemented!();
/// sender.send(command);
/// });
/// }
/// Err(source) => unimplemented!(),
/// }
/// }
/// # }
/// ```
pub fn sender(&self) -> MessageSender {
self.user_channel.sender()
}
/// Update internal state from gateway disconnect.
fn disconnect(&mut self, initiator: CloseInitiator) {
// May not send any additional WebSocket messages.
self.heartbeat_interval = None;
self.ratelimiter = None;
// Abort identify.
self.identify_rx = None;
self.state = match initiator {
CloseInitiator::Gateway(close_code) => ShardState::from_close_code(close_code),
_ => ShardState::Disconnected {
reconnect_attempts: 0,
},
};
if let CloseInitiator::Shard(frame) = initiator {
// Not resuming, drop session and resume URL.
// https://discord.com/developers/docs/topics/gateway#initiating-a-disconnect
if matches!(frame.code, 1000 | 1001) {
self.resume_url = None;
self.session = None;
}
self.pending = Some(Pending {
gateway_event: Some(Message::Close(Some(frame))),
is_heartbeat: false,
});
}
}
/// Parse a JSON message into an event with minimal data for [processing].
///
/// # Errors
///
/// Returns a [`ReceiveMessageErrorType::Deserializing`] error type if the gateway
/// event isn't a recognized structure, which may be the case for new or
/// undocumented events.
///
/// [processing]: Self::process
fn parse_event<T: DeserializeOwned>(
json: &str,
) -> Result<MinimalEvent<T>, ReceiveMessageError> {
json::from_str::<MinimalEvent<T>>(json).map_err(|source| ReceiveMessageError {
kind: ReceiveMessageErrorType::Deserializing {
event: json.to_owned(),
},
source: Some(Box::new(source)),
})
}
/// Send and flush the pending message.
fn poll_flush_pending(
&mut self,
cx: &mut Context<'_>,
) -> Poll<Result<(), ReceiveMessageError>> {
if self.pending.is_none() {
return Poll::Ready(Ok(()));
}
ready!(Pin::new(self.connection.as_mut().unwrap()).poll_ready(cx)).map_err(|source| {
self.disconnect(CloseInitiator::Transport);
self.connection = None;
ReceiveMessageError::from_websocket(source)
})?;
let pending = self.pending.as_mut().unwrap();
if let Some(message) = &pending.gateway_event {
if let Some(ratelimiter) = self.ratelimiter.as_mut() {
if message.is_text() && !pending.is_heartbeat {
ready!(ratelimiter.poll_acquire(cx));
}
}
let ws_message = pending.gateway_event.take().unwrap().into_websocket_msg();
if let Err(source) = Pin::new(self.connection.as_mut().unwrap()).start_send(ws_message)
{
self.disconnect(CloseInitiator::Transport);
self.connection = None;
return Poll::Ready(Err(ReceiveMessageError::from_websocket(source)));
}
}
if let Err(source) = ready!(Pin::new(self.connection.as_mut().unwrap()).poll_flush(cx)) {
self.disconnect(CloseInitiator::Transport);
self.connection = None;
return Poll::Ready(Err(ReceiveMessageError::from_websocket(source)));
}
if pending.is_heartbeat {
self.latency.record_sent();
}
self.pending = None;
Poll::Ready(Ok(()))
}
}
impl<Q: Queue> Shard<Q> {
/// Updates the shard's internal state from a gateway event by recording
/// and/or responding to certain Discord events.
///
/// # Errors
///
/// Returns a [`ReceiveMessageErrorType::Deserializing`] error type if the
/// gateway event isn't a recognized structure.
#[allow(clippy::too_many_lines)]
fn process(&mut self, event: &str) -> Result<(), ReceiveMessageError> {
let (raw_opcode, maybe_sequence, maybe_event_type) =
GatewayEventDeserializer::from_json(event)
.ok_or(ReceiveMessageError {
kind: ReceiveMessageErrorType::Deserializing {
event: event.to_owned(),
},
source: Some("missing opcode".into()),
})?
.into_parts();
if self.latency.sent().is_some() {
self.heartbeat_interval_event = true;
}
match OpCode::from(raw_opcode) {
Some(OpCode::Dispatch) => {
let event_type = maybe_event_type.ok_or(ReceiveMessageError {
kind: ReceiveMessageErrorType::Deserializing {
event: event.to_owned(),
},
source: Some("missing dispatch event type".into()),
})?;
let sequence = maybe_sequence.ok_or(ReceiveMessageError {
kind: ReceiveMessageErrorType::Deserializing {
event: event.to_owned(),
},
source: Some("missing sequence".into()),
})?;
tracing::debug!(%event_type, %sequence, "received dispatch");
match event_type.as_ref() {
"READY" => {
let event = Self::parse_event::<MinimalReady>(event)?;
self.resume_url = Some(event.data.resume_gateway_url);
self.session = Some(Session::new(sequence, event.data.session_id));
self.state = ShardState::Active;
}
"RESUMED" => self.state = ShardState::Active,
_ => {}
}
if let Some(session) = self.session.as_mut() {
session.set_sequence(sequence);
}
}
Some(OpCode::Heartbeat) => {
tracing::debug!("received heartbeat");
self.pending = Pending::text(
json::to_string(&Heartbeat::new(self.session().map(Session::sequence)))
.expect("serialization cannot fail"),
true,
);
}
Some(OpCode::HeartbeatAck) => {
let requested = self.latency.received().is_none() && self.latency.sent().is_some();
if requested {
tracing::debug!("received heartbeat ack");
self.latency.record_received();
} else {
tracing::info!("received unrequested heartbeat ack");
}
}
Some(OpCode::Hello) => {
let event = Self::parse_event::<Hello>(event)?;
let heartbeat_interval = Duration::from_millis(event.data.heartbeat_interval);
// First heartbeat should have some jitter, see
// https://discord.com/developers/docs/topics/gateway#heartbeat-interval
let jitter = heartbeat_interval.mul_f64(fastrand::f64());
tracing::debug!(?heartbeat_interval, ?jitter, "received hello");
if self.config().ratelimit_messages() {
self.ratelimiter = Some(CommandRatelimiter::new(heartbeat_interval));
}
let mut interval = time::interval_at(Instant::now() + jitter, heartbeat_interval);
interval.set_missed_tick_behavior(MissedTickBehavior::Delay);
self.heartbeat_interval = Some(interval);
// Reset `Latency` since the shard might have connected to a new
// remote which invalidates the recorded latencies.
self.latency = Latency::new();
if let Some(session) = &self.session {
self.pending = Pending::text(
json::to_string(&Resume::new(
session.sequence(),
session.id(),
self.config.token(),
))
.expect("serialization cannot fail"),
false,
);
self.state = ShardState::Resuming;
} else {
self.identify_rx = Some(self.config.queue().enqueue(self.id.number()));
}
}
Some(OpCode::InvalidSession) => {
let resumable = Self::parse_event(event)?.data;
tracing::debug!(resumable, "received invalid session");
if resumable {
self.disconnect(CloseInitiator::Shard(CloseFrame::RESUME));
} else {
self.disconnect(CloseInitiator::Shard(CloseFrame::NORMAL));
}
}
Some(OpCode::Reconnect) => {
tracing::debug!("received reconnect");
self.disconnect(CloseInitiator::Shard(CloseFrame::RESUME));
}
_ => tracing::info!("received an unknown opcode: {raw_opcode}"),
}
Ok(())
}
}
impl<Q: Queue + Unpin> Stream for Shard<Q> {
type Item = Result<Message, ReceiveMessageError>;
#[allow(clippy::too_many_lines)]
#[tracing::instrument(fields(id = %self.id), name = "shard", skip_all)]
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let message = loop {
match self.state {
ShardState::FatallyClosed => {
_ = ready!(Pin::new(
self.connection
.as_mut()
.expect("poll_next called after Poll::Ready(None)")
)
.poll_close(cx));
self.connection = None;
return Poll::Ready(None);
}
ShardState::Disconnected { reconnect_attempts } if self.connection.is_none() => {
if self.connection_future.is_none() {
let base_url = self
.resume_url
.as_deref()
.or_else(|| self.config.proxy_url())
.unwrap_or(GATEWAY_URL);
let uri = format!(
"{base_url}/?v={API_VERSION}&encoding=json{COMPRESSION_FEATURES}"
);
tracing::debug!(url = base_url, "connecting to gateway");
let tls = self.config.tls.clone();
self.connection_future = Some(ConnectionFuture(Box::pin(async move {
let secs = 2u8.saturating_pow(reconnect_attempts.into());
time::sleep(Duration::from_secs(secs.into())).await;
Ok(ClientBuilder::new()
.uri(&uri)
.expect("URL should be valid")
.limits(Limits::unlimited())
.connector(&tls)
.connect()
.await?
.0)
})));
}
let res =
ready!(Pin::new(&mut self.connection_future.as_mut().unwrap().0).poll(cx));
self.connection_future = None;
match res {
Ok(connection) => {
self.connection = Some(connection);
self.state = ShardState::Identifying;
#[cfg(any(feature = "zlib-stock", feature = "zlib-simd"))]
self.inflater.reset();
}
Err(source) => {
self.resume_url = None;
self.state = ShardState::Disconnected {
reconnect_attempts: reconnect_attempts + 1,
};
return Poll::Ready(Some(Err(ReceiveMessageError {
kind: ReceiveMessageErrorType::Reconnect,
source: Some(Box::new(source)),
})));
}
}
}
_ => {}
}
ready!(self.poll_flush_pending(cx))?;
if !self.state.is_disconnected() {
if let Poll::Ready(frame) = self.user_channel.close_rx.poll_recv(cx) {
let frame = frame.expect("shard owns channel");
tracing::debug!("sending close frame from user channel");
self.disconnect(CloseInitiator::Shard(frame));
ready!(self.poll_flush_pending(cx))?;
}
}
if self
.heartbeat_interval
.as_mut()
.map_or(false, |heartbeater| heartbeater.poll_tick(cx).is_ready())
{
// Discord never responded after the last heartbeat, connection
// is failed or "zombied", see
// https://discord.com/developers/docs/topics/gateway#heartbeat-interval-example-heartbeat-ack
// Note that unlike documented *any* event is okay; it does not
// have to be a heartbeat ACK.
if self.latency.sent().is_some() && !self.heartbeat_interval_event {
tracing::info!("connection is failed or \"zombied\"");
self.disconnect(CloseInitiator::Shard(CloseFrame::RESUME));
} else {
tracing::debug!("sending heartbeat");
self.pending = Pending::text(
json::to_string(&Heartbeat::new(self.session().map(Session::sequence)))
.expect("serialization cannot fail"),
true,
);
self.heartbeat_interval_event = false;
}
ready!(self.poll_flush_pending(cx))?;
}
let not_ratelimited = self
.ratelimiter
.as_mut()
.map_or(true, |ratelimiter| ratelimiter.poll_ready(cx).is_ready());
if not_ratelimited {
if let Some(Poll::Ready(canceled)) = self
.identify_rx
.as_mut()
.map(|rx| Pin::new(rx).poll(cx).map(|r| r.is_err()))
{
if canceled {
self.identify_rx = Some(self.config.queue().enqueue(self.id.number()));
continue;
}
tracing::debug!("sending identify");
self.pending = Pending::text(
json::to_string(&Identify::new(IdentifyInfo {
compress: false,
intents: self.config.intents(),
large_threshold: self.config.large_threshold(),
presence: self.config.presence().cloned(),
properties: self
.config
.identify_properties()
.cloned()
.unwrap_or_else(default_identify_properties),
shard: Some(self.id),
token: self.config.token().to_owned(),
}))
.expect("serialization cannot fail"),
false,
);
self.identify_rx = None;
ready!(self.poll_flush_pending(cx))?;
}
}
if not_ratelimited && self.state.is_identified() {
if let Poll::Ready(command) = self.user_channel.command_rx.poll_recv(cx) {
let command = command.expect("shard owns channel");
tracing::debug!("sending command from user channel");
self.pending = Pending::text(command, false);
ready!(self.poll_flush_pending(cx))?;
}
}
match ready!(Pin::new(self.connection.as_mut().unwrap()).poll_next(cx)) {
Some(Ok(message)) => {
#[cfg(any(feature = "zlib-stock", feature = "zlib-simd"))]
if message.is_binary() {
if let Some(decompressed) = self
.inflater
.inflate(message.as_payload())
.map_err(ReceiveMessageError::from_compression)?
{
break Message::Text(decompressed);
};
}
if let Some(message) = Message::from_websocket_msg(&message) {
break message;
}
}
// Discord, against recommendations from the WebSocket spec,
// does not send a close_notify prior to shutting down the TCP
// stream. This arm tries to gracefully handle this. The
// connection is considered unusable after encountering an io
// error, returning `None`.
#[cfg(any(
feature = "native-tls",
feature = "rustls-native-roots",
feature = "rustls-webpki-roots"
))]
Some(Err(WebsocketError::Io(e)))
if e.kind() == IoErrorKind::UnexpectedEof
&& self.config.proxy_url().is_none()
&& self.state.is_disconnected() =>
{
continue
}
Some(Err(source)) => {
self.disconnect(CloseInitiator::Transport);
return Poll::Ready(Some(Err(ReceiveMessageError {
kind: ReceiveMessageErrorType::WebSocket,
source: Some(Box::new(source)),
})));
}
None => {
let res = ready!(Pin::new(self.connection.as_mut().unwrap()).poll_close(cx));
tracing::debug!("gateway WebSocket connection closed");
// Unclean closure.
if !self.state.is_disconnected() {
self.disconnect(CloseInitiator::Transport);
}
self.connection = None;
res.map_err(ReceiveMessageError::from_websocket)?;
}
}
};
match &message {
Message::Close(frame) => {
// tokio-websockets automatically replies to the close message.
tracing::debug!(?frame, "received WebSocket close message");
// Don't run `disconnect` if we initiated the close.
if !self.state.is_disconnected() {
self.disconnect(CloseInitiator::Gateway(frame.as_ref().map(|f| f.code)));
}
}
Message::Text(event) => {
self.process(event)?;
}
}
Poll::Ready(Some(Ok(message)))
}
}
/// Default identify properties to use when the user hasn't customized it in
/// [`Config::identify_properties`].
///
/// [`Config::identify_properties`]: Config::identify_properties
fn default_identify_properties() -> IdentifyProperties {
IdentifyProperties::new("twilight.rs", "twilight.rs", OS)
}
#[cfg(test)]
mod tests {
use super::Shard;
use static_assertions::{assert_impl_all, assert_not_impl_any};
use std::fmt::Debug;
assert_impl_all!(Shard: Debug, Send);
assert_not_impl_any!(Shard: Sync);
}