Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(model)!: incoming heartbeat has null data #2420

Merged
merged 1 commit into from
Feb 20, 2025
Merged

fix(model)!: incoming heartbeat has null data #2420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion twilight-cache-inmemory/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1027,7 +1027,7 @@ impl<CacheModels: CacheableModels> UpdateCache<CacheModels> for Event {
| Event::EntitlementDelete(_)
| Event::EntitlementUpdate(_)
| Event::GatewayClose(_)
| Event::GatewayHeartbeat(_)
| Event::GatewayHeartbeat
| Event::GatewayHeartbeatAck
| Event::GatewayHello(_)
| Event::GatewayInvalidateSession(_)
Expand Down
23 changes: 9 additions & 14 deletions twilight-model/src/gateway/event/gateway.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ use std::{
#[derive(Clone, Debug)]
pub enum GatewayEvent {
Dispatch(u64, DispatchEvent),
Heartbeat(u64),
Heartbeat,
HeartbeatAck,
Hello(Hello),
InvalidateSession(bool),
Expand All @@ -33,7 +33,7 @@ impl TryFrom<Event> for GatewayEvent {

fn try_from(event: Event) -> Result<Self, Self::Error> {
Ok(match event {
Event::GatewayHeartbeat(v) => Self::Heartbeat(v),
Event::GatewayHeartbeat => Self::Heartbeat,
Event::GatewayHeartbeatAck => Self::HeartbeatAck,
Event::GatewayHello(v) => Self::Hello(v),
Event::GatewayInvalidateSession(v) => Self::InvalidateSession(v),
Expand Down Expand Up @@ -298,11 +298,9 @@ impl<'de> Visitor<'de> for GatewayEventVisitor<'_> {
GatewayEvent::Dispatch(s, d)
}
OpCode::Heartbeat => {
let seq = Self::field(&mut map, Field::D)?;

Self::ignore_all(&mut map)?;

GatewayEvent::Heartbeat(seq)
GatewayEvent::Heartbeat
}
OpCode::HeartbeatAck => {
Self::ignore_all(&mut map)?;
Expand Down Expand Up @@ -365,7 +363,7 @@ impl Serialize for GatewayEvent {
const fn opcode(gateway_event: &GatewayEvent) -> OpCode {
match gateway_event {
GatewayEvent::Dispatch(_, _) => OpCode::Dispatch,
GatewayEvent::Heartbeat(_) => OpCode::Heartbeat,
GatewayEvent::Heartbeat => OpCode::Heartbeat,
GatewayEvent::HeartbeatAck => OpCode::HeartbeatAck,
GatewayEvent::Hello(_) => OpCode::Hello,
GatewayEvent::InvalidateSession(_) => OpCode::InvalidSession,
Expand All @@ -391,16 +389,13 @@ impl Serialize for GatewayEvent {

match self {
Self::Dispatch(_, _) => unreachable!("dispatch already handled"),
Self::Heartbeat(sequence) => {
s.serialize_field("d", &sequence)?;
}
Self::Hello(hello) => {
s.serialize_field("d", &hello)?;
}
Self::InvalidateSession(invalidate) => {
s.serialize_field("d", &invalidate)?;
}
Self::HeartbeatAck | Self::Reconnect => {
Self::Heartbeat | Self::HeartbeatAck | Self::Reconnect => {
s.serialize_field("d", &None::<u64>)?;
}
}
Expand Down Expand Up @@ -621,14 +616,14 @@ mod tests {
"t": null,
"s": null,
"op": 1,
"d": 123
"d": null
}"#;

let deserializer = GatewayEventDeserializer::from_json(input).unwrap();
let mut json_deserializer = Deserializer::from_str(input);
let event = deserializer.deserialize(&mut json_deserializer).unwrap();

assert!(matches!(event, GatewayEvent::Heartbeat(123)));
assert!(matches!(event, GatewayEvent::Heartbeat));
}

#[test]
Expand Down Expand Up @@ -781,7 +776,7 @@ mod tests {
#[test]
fn serialize_heartbeat() {
serde_test::assert_ser_tokens(
&GatewayEvent::Heartbeat(1024),
&GatewayEvent::Heartbeat,
&[
Token::Struct {
name: "GatewayEvent",
Expand All @@ -794,7 +789,7 @@ mod tests {
Token::Str("op"),
Token::U8(OpCode::Heartbeat as u8),
Token::Str("d"),
Token::U64(1024),
Token::None,
Token::StructEnd,
],
);
Expand Down
10 changes: 5 additions & 5 deletions twilight-model/src/gateway/event/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ pub enum Event {
/// Close message with an optional frame including information about the
/// reason for the close.
GatewayClose(Option<CloseFrame<'static>>),
/// A heartbeat was sent to or received from the gateway.
GatewayHeartbeat(u64),
/// A heartbeat was received from the gateway.
GatewayHeartbeat,
/// A heartbeat acknowledgement was received from the gateway.
GatewayHeartbeatAck,
/// A "hello" packet was received from the gateway.
Expand Down Expand Up @@ -250,7 +250,7 @@ impl Event {
| Event::EntitlementCreate(_)
| Event::EntitlementDelete(_)
| Event::EntitlementUpdate(_)
| Event::GatewayHeartbeat(_)
| Event::GatewayHeartbeat
| Event::GatewayHeartbeatAck
| Event::GatewayHello(_)
| Event::GatewayInvalidateSession(_)
Expand Down Expand Up @@ -278,7 +278,7 @@ impl Event {
Self::EntitlementDelete(_) => EventType::EntitlementDelete,
Self::EntitlementUpdate(_) => EventType::EntitlementUpdate,
Self::GatewayClose(_) => EventType::GatewayClose,
Self::GatewayHeartbeat(_) => EventType::GatewayHeartbeat,
Self::GatewayHeartbeat => EventType::GatewayHeartbeat,
Self::GatewayHeartbeatAck => EventType::GatewayHeartbeatAck,
Self::GatewayHello(_) => EventType::GatewayHello,
Self::GatewayInvalidateSession(_) => EventType::GatewayInvalidateSession,
Expand Down Expand Up @@ -422,7 +422,7 @@ impl From<GatewayEvent> for Event {
fn from(event: GatewayEvent) -> Self {
match event {
GatewayEvent::Dispatch(_, e) => Self::from(e),
GatewayEvent::Heartbeat(interval) => Self::GatewayHeartbeat(interval),
GatewayEvent::Heartbeat => Self::GatewayHeartbeat,
GatewayEvent::HeartbeatAck => Self::GatewayHeartbeatAck,
GatewayEvent::Hello(interval) => Self::GatewayHello(interval),
GatewayEvent::InvalidateSession(r) => Self::GatewayInvalidateSession(r),
Expand Down