feat(cache, model, gateway): add gateway ratelimited event (#2483)

Co-authored-by: Erk <[email protected]>

Author: HTGAzureX1212

twilight-cache-inmemory/src/lib.rs

@@ -1038,6 +1038,7 @@ impl<CacheModels: CacheableModels> UpdateCache<CacheModels> for Event {
             | Event::InviteDelete(_)
             | Event::MessagePollVoteAdd(_)
             | Event::MessagePollVoteRemove(_)
+            | Event::RateLimited(_)
             | Event::Resumed
             | Event::ThreadMembersUpdate(_)
             | Event::ThreadMemberUpdate(_)

twilight-gateway/src/event.rs

@@ -195,6 +195,9 @@ bitflags! {
         const VOICE_STATE_UPDATE = 1 << 43;
         /// Webhook in a guild has been updated.
         const WEBHOOKS_UPDATE = 1 << 44;
+        /// The shard encountered a gateway rate limit for an event, e.g.
+        /// request guild members.
+        const RATE_LIMITED = 1 << 79;
 
         /// All [`EventTypeFlags`] in [`Intents::AUTO_MODERATION_CONFIGURATION`].
         ///
@@ -384,6 +387,7 @@ impl From<EventType> for EventTypeFlags {
             EventType::MessagePollVoteRemove => Self::MESSAGE_POLL_VOTE_REMOVE,
             EventType::MessageUpdate => Self::MESSAGE_UPDATE,
             EventType::PresenceUpdate => Self::PRESENCE_UPDATE,
+            EventType::RateLimited => Self::RATE_LIMITED,
             EventType::ReactionAdd => Self::REACTION_ADD,
             EventType::ReactionRemove => Self::REACTION_REMOVE,
             EventType::ReactionRemoveAll => Self::REACTION_REMOVE_ALL,

twilight-model/src/gateway/event/dispatch.rs

@@ -57,6 +57,7 @@ pub enum DispatchEvent {
     MessagePollVoteRemove(MessagePollVoteRemove),
     MessageUpdate(Box<MessageUpdate>),
     PresenceUpdate(Box<PresenceUpdate>),
+    RateLimited(RateLimited),
     ReactionAdd(Box<ReactionAdd>),
     ReactionRemove(Box<ReactionRemove>),
     ReactionRemoveAll(ReactionRemoveAll),
@@ -130,6 +131,7 @@ impl DispatchEvent {
             Self::MessagePollVoteRemove(_) => EventType::MessagePollVoteRemove,
             Self::MessageUpdate(_) => EventType::MessageUpdate,
             Self::PresenceUpdate(_) => EventType::PresenceUpdate,
+            Self::RateLimited(_) => EventType::RateLimited,
             Self::ReactionAdd(_) => EventType::ReactionAdd,
             Self::ReactionRemove(_) => EventType::ReactionRemove,
             Self::ReactionRemoveAll(_) => EventType::ReactionRemoveAll,
@@ -389,6 +391,7 @@ impl<'de> DeserializeSeed<'de> for DispatchEventWithTypeDeserializer<'_> {
             "PRESENCE_UPDATE" => {
                 DispatchEvent::PresenceUpdate(Box::new(PresenceUpdate::deserialize(deserializer)?))
             }
+            "RATE_LIMITED" => DispatchEvent::RateLimited(RateLimited::deserialize(deserializer)?),
             "READY" => DispatchEvent::Ready(Ready::deserialize(deserializer)?),
             "RESUMED" => {
                 deserializer.deserialize_ignored_any(IgnoredAny)?;

twilight-model/src/gateway/event/kind.rs

@@ -60,6 +60,7 @@ pub enum EventType {
     MessagePollVoteRemove,
     MessageUpdate,
     PresenceUpdate,
+    RateLimited,
     #[serde(rename = "MESSAGE_REACTION_ADD")]
     ReactionAdd,
     #[serde(rename = "MESSAGE_REACTION_REMOVE")]
@@ -139,6 +140,7 @@ impl EventType {
             Self::MessagePollVoteAdd => Some("MESSAGE_POLL_VOTE_ADD"),
             Self::MessagePollVoteRemove => Some("MESSAGE_POLL_VOTE_REMOVE"),
             Self::PresenceUpdate => Some("PRESENCE_UPDATE"),
+            Self::RateLimited => Some("RATE_LIMITED"),
             Self::ReactionAdd => Some("MESSAGE_REACTION_ADD"),
             Self::ReactionRemove => Some("MESSAGE_REACTION_REMOVE"),
             Self::ReactionRemoveAll => Some("MESSAGE_REACTION_REMOVE_ALL"),
@@ -222,6 +224,7 @@ impl<'a> TryFrom<&'a str> for EventType {
             "MESSAGE_REACTION_REMOVE" => Ok(Self::ReactionRemove),
             "MESSAGE_REACTION_REMOVE_ALL" => Ok(Self::ReactionRemoveAll),
             "MESSAGE_REACTION_REMOVE_EMOJI" => Ok(Self::ReactionRemoveEmoji),
+            "RATE_LIMITED" => Ok(Self::RateLimited),
             "READY" => Ok(Self::Ready),
             "RESUMED" => Ok(Self::Resumed),
             "GUILD_ROLE_CREATE" => Ok(Self::RoleCreate),
@@ -349,6 +352,7 @@ mod tests {
         assert_variant(EventType::MessagePollVoteAdd, "MESSAGE_POLL_VOTE_ADD");
         assert_variant(EventType::MessagePollVoteRemove, "MESSAGE_POLL_VOTE_REMOVE");
         assert_variant(EventType::PresenceUpdate, "PRESENCE_UPDATE");
+        assert_variant(EventType::RateLimited, "RATE_LIMITED");
         assert_variant(EventType::ReactionAdd, "MESSAGE_REACTION_ADD");
         assert_variant(EventType::ReactionRemove, "MESSAGE_REACTION_REMOVE");
         assert_variant(EventType::ReactionRemoveAll, "MESSAGE_REACTION_REMOVE_ALL");

twilight-model/src/gateway/event/mod.rs

@@ -12,6 +12,7 @@ pub use self::{
 };
 
 use super::{CloseFrame, payload::incoming::*};
+use crate::gateway::payload::incoming::rate_limited::RateLimitMetadata;
 use crate::id::{Id, marker::GuildMarker};
 use std::error::Error;
 use std::fmt::{Debug, Display, Formatter, Result as FmtResult};
@@ -129,6 +130,8 @@ pub enum Event {
     MessageUpdate(Box<MessageUpdate>),
     /// A user's active presence (such as game or online status) was updated.
     PresenceUpdate(Box<PresenceUpdate>),
+    /// A shard was rate limited for a gateway opcode.
+    RateLimited(RateLimited),
     /// A reaction was added to a message.
     ReactionAdd(Box<ReactionAdd>),
     /// A reaction was removed from a message.
@@ -225,6 +228,10 @@ impl Event {
             Event::MessagePollVoteAdd(e) => e.guild_id,
             Event::MessagePollVoteRemove(e) => e.guild_id,
             Event::PresenceUpdate(e) => Some(e.0.guild_id),
+            Event::RateLimited(RateLimited {
+                meta: RateLimitMetadata::RequestGuildMembers { guild_id, .. },
+                ..
+            }) => Some(*guild_id),
             Event::ReactionAdd(e) => e.0.guild_id,
             Event::ReactionRemove(e) => e.0.guild_id,
             Event::ReactionRemoveAll(e) => e.guild_id,
@@ -312,6 +319,7 @@ impl Event {
             Self::MessagePollVoteRemove(_) => EventType::MessagePollVoteRemove,
             Self::MessageUpdate(_) => EventType::MessageUpdate,
             Self::PresenceUpdate(_) => EventType::PresenceUpdate,
+            Self::RateLimited(_) => EventType::RateLimited,
             Self::ReactionAdd(_) => EventType::ReactionAdd,
             Self::ReactionRemove(_) => EventType::ReactionRemove,
             Self::ReactionRemoveAll(_) => EventType::ReactionRemoveAll,
@@ -393,6 +401,7 @@ impl From<DispatchEvent> for Event {
             DispatchEvent::MessagePollVoteRemove(v) => Self::MessagePollVoteRemove(v),
             DispatchEvent::MessageUpdate(v) => Self::MessageUpdate(v),
             DispatchEvent::PresenceUpdate(v) => Self::PresenceUpdate(v),
+            DispatchEvent::RateLimited(v) => Self::RateLimited(v),
             DispatchEvent::ReactionAdd(v) => Self::ReactionAdd(v),
             DispatchEvent::ReactionRemove(v) => Self::ReactionRemove(v),
             DispatchEvent::ReactionRemoveAll(v) => Self::ReactionRemoveAll(v),
@@ -464,7 +473,7 @@ impl Error for EventConversionError {}
 
 #[cfg(test)]
 mod tests {
-    //! `EVENT_THRESHOLD` is equivalent to 192 bytes. This was decided based on
+    //! `EVENT_THRESHOLD` is equivalent to 312 bytes. This was decided based on
     //! the size of `Event` at the time of writing. The assertions here are to
     //! ensure that in the case the events themselves grow or shrink past the
     //! threshold, they are properly boxed or unboxed respectively.
@@ -534,6 +543,7 @@ mod tests {
     const_assert!(mem::size_of::<MessageDelete>() <= EVENT_THRESHOLD);
     const_assert!(mem::size_of::<MessageDeleteBulk>() <= EVENT_THRESHOLD);
     const_assert!(mem::size_of::<MemberRemove>() <= EVENT_THRESHOLD);
+    const_assert!(mem::size_of::<RateLimited>() <= EVENT_THRESHOLD);
     const_assert!(mem::size_of::<Ready>() <= EVENT_THRESHOLD);
     const_assert!(mem::size_of::<ReactionRemoveAll>() <= EVENT_THRESHOLD);
     const_assert!(mem::size_of::<RoleCreate>() <= EVENT_THRESHOLD);

twilight-model/src/gateway/payload/incoming/mod.rs

@@ -12,6 +12,7 @@
 //! [1]: https://discord.com/developers/docs/topics/gateway#commands-and-events-gateway-events
 
 pub mod invite_create;
+pub mod rate_limited;
 pub mod reaction_remove_emoji;
 
 mod auto_moderation_action_execution;
@@ -105,12 +106,12 @@ pub use self::{
     message_create::MessageCreate, message_delete::MessageDelete,
     message_delete_bulk::MessageDeleteBulk, message_poll_vote_add::MessagePollVoteAdd,
     message_poll_vote_remove::MessagePollVoteRemove, message_update::MessageUpdate,
-    presence_update::PresenceUpdate, reaction_add::ReactionAdd, reaction_remove::ReactionRemove,
-    reaction_remove_all::ReactionRemoveAll, reaction_remove_emoji::ReactionRemoveEmoji,
-    ready::Ready, role_create::RoleCreate, role_delete::RoleDelete, role_update::RoleUpdate,
-    stage_instance_create::StageInstanceCreate, stage_instance_delete::StageInstanceDelete,
-    stage_instance_update::StageInstanceUpdate, thread_create::ThreadCreate,
-    thread_delete::ThreadDelete, thread_list_sync::ThreadListSync,
+    presence_update::PresenceUpdate, rate_limited::RateLimited, reaction_add::ReactionAdd,
+    reaction_remove::ReactionRemove, reaction_remove_all::ReactionRemoveAll,
+    reaction_remove_emoji::ReactionRemoveEmoji, ready::Ready, role_create::RoleCreate,
+    role_delete::RoleDelete, role_update::RoleUpdate, stage_instance_create::StageInstanceCreate,
+    stage_instance_delete::StageInstanceDelete, stage_instance_update::StageInstanceUpdate,
+    thread_create::ThreadCreate, thread_delete::ThreadDelete, thread_list_sync::ThreadListSync,
     thread_member_update::ThreadMemberUpdate, thread_members_update::ThreadMembersUpdate,
     thread_update::ThreadUpdate, typing_start::TypingStart, unavailable_guild::UnavailableGuild,
     user_update::UserUpdate, voice_server_update::VoiceServerUpdate,

twilight-model/src/gateway/payload/incoming/rate_limited.rs

@@ -0,0 +1,22 @@
+use crate::{
+    gateway::OpCode,
+    id::{Id, marker::GuildMarker},
+};
+use serde::{Deserialize, Serialize};
+
+#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
+pub struct RateLimited {
+    pub opcode: OpCode,
+    pub retry_after: f32,
+    pub meta: RateLimitMetadata,
+}
+
+#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
+#[non_exhaustive]
+pub enum RateLimitMetadata {
+    RequestGuildMembers {
+        guild_id: Id<GuildMarker>,
+        #[serde(skip_serializing_if = "Option::is_none")]
+        nonce: Option<String>,
+    },
+}