Fix: pass mid-connection WS events to task (#269)

Discord will send `GatewayEvent::Speaking` (opcode 5) messages
after the Hello+Ready exchange, but will happily interleave
them with crypto mode negotiation. We were previously not expecting
such messages and dropping them -- this hurts receive-based bots'
ability to map SSRCs to UserIds when joining a call with existing
users.

This PR feeds all unexpected messages into the WS task directly,
which will handle them once all tasks are fully started.
This commit is contained in:
Kyle Simpson
2024-11-26 00:51:52 +00:00
committed by GitHub
parent 71535c5e87
commit 17993bc0d0
4 changed files with 29 additions and 12 deletions

View File

@@ -251,8 +251,10 @@ async fn join(ctx: &Context, msg: &Message, mut args: Args) -> CommandResult {
.expect("Songbird Voice client placed in at initialisation.")
.clone();
if let Ok(handler_lock) = manager.join(guild_id, connect_to).await {
// NOTE: this skips listening for the actual connection result.
// Some events relating to voice receive fire *while joining*.
// We must make sure that any event handlers are installed before we attempt to join.
{
let handler_lock = manager.get_or_insert(guild_id);
let mut handler = handler_lock.lock().await;
let evt_receiver = Receiver::new();
@@ -262,13 +264,18 @@ async fn join(ctx: &Context, msg: &Message, mut args: Args) -> CommandResult {
handler.add_global_event(CoreEvent::RtcpPacket.into(), evt_receiver.clone());
handler.add_global_event(CoreEvent::ClientDisconnect.into(), evt_receiver.clone());
handler.add_global_event(CoreEvent::VoiceTick.into(), evt_receiver);
}
if let Ok(handler_lock) = manager.join(guild_id, connect_to).await {
check_msg(
msg.channel_id
.say(&ctx.http, &format!("Joined {}", connect_to.mention()))
.await,
);
} else {
// Although we failed to join, we need to clear out existing event handlers on the call.
_ = manager.remove(guild_id).await;
check_msg(
msg.channel_id
.say(&ctx.http, "Error joining the channel")