discord_radio: presence follows voice; name the reason a voice join fails
Live symptom: the radio bot shows "Listening to <system>" but is not in the voice channel. - Presence was set once on the first successful join and never cleared, so a bot whose voice dropped (or whose rejoin kept failing) still looked healthy. Presence is now synced at the end of every reconcile: set only while a voice connection for that bot is up, cleared otherwise. - Pre-check the bot's permissions (View Channel, Connect, Speak) and the channel's user limit before joining. Discord silently ignores a join the bot may not make; discord.py then times out after 30s and the admin page read "Could not connect to the voice channel (TimeoutError: )". Now: code missing_permissions / channel_full with the missing permission named. - A connect timeout gets its own code (connect_timeout) and readable text. - requirements: discord.py[voice]>=2.7 — Discord has required DAVE E2EE voice since 2026-03-01 and 2.7 is the first discord.py with it (the extra pulls davey). Today's resolution was already 2.7.1 + davey 0.1.6; this stops an older resolution from ever being accepted. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
44e41b3dd8
commit
786e06a7a3
@@ -74,6 +74,39 @@ class _Voice:
|
|||||||
code: Optional[str] = None
|
code: Optional[str] = None
|
||||||
|
|
||||||
|
|
||||||
|
def _join_refusal(guild, channel) -> Optional[tuple[str, str]]:
|
||||||
|
"""Why Discord would refuse this bot's voice join, or None.
|
||||||
|
|
||||||
|
Discord does not answer a join the bot lacks permission for — the gateway
|
||||||
|
just never sends the voice-server update, discord.py times out after 30s,
|
||||||
|
and the admin page used to read "(TimeoutError: )". Checking first turns
|
||||||
|
that into an instruction. Best effort: if the bot's own member or the
|
||||||
|
permission data is not cached, let the join go ahead.
|
||||||
|
"""
|
||||||
|
me = getattr(guild, "me", None)
|
||||||
|
permissions_for = getattr(channel, "permissions_for", None)
|
||||||
|
if me is None or permissions_for is None:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
perms = permissions_for(me)
|
||||||
|
except Exception:
|
||||||
|
return None
|
||||||
|
missing = [label for attr, label in (("view_channel", "View Channel"), ("connect", "Connect"))
|
||||||
|
if not getattr(perms, attr, True)]
|
||||||
|
if getattr(channel, "type", None) == discord.ChannelType.voice and not getattr(perms, "speak", True):
|
||||||
|
missing.append("Speak")
|
||||||
|
if missing:
|
||||||
|
return ("missing_permissions",
|
||||||
|
f"The radio bot lacks {', '.join(missing)} on that voice channel — "
|
||||||
|
"allow it in the channel's permission settings in Discord.")
|
||||||
|
limit = getattr(channel, "user_limit", 0) or 0
|
||||||
|
members = getattr(channel, "members", None) or []
|
||||||
|
if limit and len(members) >= limit and not getattr(perms, "move_members", False):
|
||||||
|
return ("channel_full", f"That voice channel is full ({len(members)}/{limit}) — "
|
||||||
|
"raise its user limit or free a slot.")
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
def _default_client_factory():
|
def _default_client_factory():
|
||||||
intents = discord.Intents.none()
|
intents = discord.Intents.none()
|
||||||
intents.guilds = True
|
intents.guilds = True
|
||||||
@@ -220,6 +253,10 @@ class RadioManager:
|
|||||||
v.error = self._session_errors.get(d["token_id"], "The radio bot could not log in to Discord.")
|
v.error = self._session_errors.get(d["token_id"], "The radio bot could not log in to Discord.")
|
||||||
continue
|
continue
|
||||||
await self._ensure_voice(sess, v, d)
|
await self._ensure_voice(sess, v, d)
|
||||||
|
# 4) presence follows voice: "Listening to <system>" only while a
|
||||||
|
# voice connection for that bot is actually up.
|
||||||
|
for sess in list(self._sessions.values()):
|
||||||
|
await self._sync_presence(sess, target)
|
||||||
|
|
||||||
async def _ensure_session(self, token_id: str) -> Optional[_Session]:
|
async def _ensure_session(self, token_id: str) -> Optional[_Session]:
|
||||||
sess = self._sessions.get(token_id)
|
sess = self._sessions.get(token_id)
|
||||||
@@ -275,7 +312,12 @@ class RadioManager:
|
|||||||
if not vc.is_playing():
|
if not vc.is_playing():
|
||||||
self._play(v)
|
self._play(v)
|
||||||
v.state, v.error, v.code = "connected", None, None
|
v.state, v.error, v.code = "connected", None, None
|
||||||
await self._set_presence(sess, d.get("system_name"))
|
return
|
||||||
|
refusal = _join_refusal(guild, channel)
|
||||||
|
if refusal:
|
||||||
|
if v.error != refusal[1]: # once per change, not every watchdog pass
|
||||||
|
logger.error(f"Stream {v.stream_id}: {refusal[1]}")
|
||||||
|
v.state, v.code, v.error = "error", refusal[0], refusal[1]
|
||||||
return
|
return
|
||||||
v.state = "connecting"
|
v.state = "connecting"
|
||||||
try:
|
try:
|
||||||
@@ -287,11 +329,20 @@ class RadioManager:
|
|||||||
if existing is not None:
|
if existing is not None:
|
||||||
await existing.disconnect(force=True)
|
await existing.disconnect(force=True)
|
||||||
v.vc = await channel.connect()
|
v.vc = await channel.connect()
|
||||||
|
except asyncio.TimeoutError:
|
||||||
|
# discord.py's TimeoutError has no message, so the old text read
|
||||||
|
# "(TimeoutError: )" — useless on the admin page.
|
||||||
|
v.vc = None
|
||||||
|
v.state, v.code = "error", "connect_timeout"
|
||||||
|
v.error = ("Discord never completed the voice join (timed out). Check the channel's "
|
||||||
|
"permission overrides for the radio bot and that Discord voice is healthy.")
|
||||||
|
logger.error(f"Stream {v.stream_id}: voice connect timed out")
|
||||||
|
return
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
v.vc = None
|
v.vc = None
|
||||||
v.state, v.code = "error", "connect_failed"
|
v.state, v.code = "error", "connect_failed"
|
||||||
v.error = f"Could not connect to the voice channel ({type(e).__name__}: {str(e)[:120]})."
|
v.error = f"Could not connect to the voice channel ({type(e).__name__}: {str(e)[:120]})."
|
||||||
logger.error(f"Stream {v.stream_id}: voice connect failed: {e}")
|
logger.error(f"Stream {v.stream_id}: voice connect failed: {type(e).__name__}: {e}")
|
||||||
return
|
return
|
||||||
# Bounded wait for the shared PulseAudio socket (op25 container creates it).
|
# Bounded wait for the shared PulseAudio socket (op25 container creates it).
|
||||||
if not await pulse.wait_until_ready():
|
if not await pulse.wait_until_ready():
|
||||||
@@ -300,15 +351,27 @@ class RadioManager:
|
|||||||
return
|
return
|
||||||
self._play(v, pulse_checked=True)
|
self._play(v, pulse_checked=True)
|
||||||
v.state, v.error, v.code = "connected", None, None
|
v.state, v.error, v.code = "connected", None, None
|
||||||
await self._set_presence(sess, d.get("system_name"))
|
|
||||||
logger.info(f"Stream {v.stream_id} connected (bot {v.token_id})")
|
logger.info(f"Stream {v.stream_id} connected (bot {v.token_id})")
|
||||||
|
|
||||||
async def _set_presence(self, sess: _Session, name: Optional[str]) -> None:
|
async def _sync_presence(self, sess: _Session, target: dict[str, dict]) -> None:
|
||||||
if not name or sess.presence == name:
|
"""Show "Listening to <system>" only while this bot is really in voice.
|
||||||
|
|
||||||
|
It used to be set once on the first successful join and never cleared,
|
||||||
|
so a bot whose voice later dropped (or kept failing to rejoin) still
|
||||||
|
looked healthy in Discord's member list.
|
||||||
|
"""
|
||||||
|
name = None
|
||||||
|
for sid, v in sorted(self._voices.items()):
|
||||||
|
if (v.token_id == sess.token_id and v.state == "connected"
|
||||||
|
and v.vc is not None and v.vc.is_connected()):
|
||||||
|
name = (target.get(sid) or {}).get("system_name") or name
|
||||||
|
if name:
|
||||||
|
break
|
||||||
|
if sess.presence == name:
|
||||||
return
|
return
|
||||||
try:
|
try:
|
||||||
await sess.client.change_presence(
|
activity = discord.Activity(type=discord.ActivityType.listening, name=name) if name else None
|
||||||
activity=discord.Activity(type=discord.ActivityType.listening, name=name))
|
await sess.client.change_presence(activity=activity)
|
||||||
sess.presence = name
|
sess.presence = name
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
logger.warning(f"Presence update failed: {e}")
|
logger.warning(f"Presence update failed: {e}")
|
||||||
|
|||||||
@@ -3,7 +3,9 @@ uvicorn[standard]
|
|||||||
pydantic-settings
|
pydantic-settings
|
||||||
paho-mqtt>=2.0.0
|
paho-mqtt>=2.0.0
|
||||||
httpx
|
httpx
|
||||||
discord.py[voice]
|
# >=2.7: Discord requires DAVE (E2EE) voice since 2026-03-01; 2.7 is the first
|
||||||
|
# discord.py with it (the [voice] extra pulls `davey`). Older releases cannot join voice.
|
||||||
|
discord.py[voice]>=2.7
|
||||||
PyNaCl
|
PyNaCl
|
||||||
python-multipart
|
python-multipart
|
||||||
pytest
|
pytest
|
||||||
|
|||||||
@@ -47,8 +47,18 @@ class FakeVC:
|
|||||||
class FakeChannel:
|
class FakeChannel:
|
||||||
def __init__(self, guild, cid, kind=discord.ChannelType.voice):
|
def __init__(self, guild, cid, kind=discord.ChannelType.voice):
|
||||||
self.guild, self.id, self.type = guild, cid, kind
|
self.guild, self.id, self.type = guild, cid, kind
|
||||||
|
self.perms = discord.Permissions(view_channel=True, connect=True, speak=True)
|
||||||
|
self.user_limit = 0
|
||||||
|
self.members = []
|
||||||
|
self.connect_error = None
|
||||||
|
|
||||||
|
def permissions_for(self, member):
|
||||||
|
assert member is self.guild.me
|
||||||
|
return self.perms
|
||||||
|
|
||||||
async def connect(self):
|
async def connect(self):
|
||||||
|
if self.connect_error:
|
||||||
|
raise self.connect_error
|
||||||
vc = FakeVC(self)
|
vc = FakeVC(self)
|
||||||
self.guild.voice_client = vc
|
self.guild.voice_client = vc
|
||||||
return vc
|
return vc
|
||||||
@@ -57,6 +67,7 @@ class FakeChannel:
|
|||||||
class FakeGuild:
|
class FakeGuild:
|
||||||
def __init__(self, gid, channel_ids):
|
def __init__(self, gid, channel_ids):
|
||||||
self.id = gid
|
self.id = gid
|
||||||
|
self.me = object()
|
||||||
self.voice_client = None
|
self.voice_client = None
|
||||||
self.channels = {c: FakeChannel(self, c) for c in channel_ids}
|
self.channels = {c: FakeChannel(self, c) for c in channel_ids}
|
||||||
|
|
||||||
@@ -149,6 +160,7 @@ async def test_apply_connects_and_reports(env):
|
|||||||
assert env.mgr.is_connected
|
assert env.mgr.is_connected
|
||||||
vc = env.guilds[1].voice_client
|
vc = env.guilds[1].voice_client
|
||||||
assert vc.plays == 1 and vc.channel.id == 11
|
assert vc.plays == 1 and vc.channel.id == 11
|
||||||
|
assert FakeClient.instances[0].presence.name == "County"
|
||||||
|
|
||||||
|
|
||||||
async def test_one_session_serves_two_guilds(env):
|
async def test_one_session_serves_two_guilds(env):
|
||||||
@@ -258,3 +270,53 @@ async def test_no_message_content_intent_on_real_client():
|
|||||||
assert client.intents.voice_states and client.intents.guilds
|
assert client.intents.voice_states and client.intents.guilds
|
||||||
finally:
|
finally:
|
||||||
await client.close()
|
await client.close()
|
||||||
|
|
||||||
|
|
||||||
|
def _presence(client):
|
||||||
|
activity = getattr(client, "presence", None)
|
||||||
|
return activity.name if activity else None
|
||||||
|
|
||||||
|
|
||||||
|
async def test_missing_connect_permission_is_named_not_a_timeout(env):
|
||||||
|
"""Discord ignores a join the bot may not make; say which permission is missing."""
|
||||||
|
env.guilds[1].channels[11].perms = discord.Permissions(view_channel=True, speak=True)
|
||||||
|
await env.mgr.apply_desired(_desired(1, (1, 11, "t1")))
|
||||||
|
st = env.published[-1]["streams"]["1:11"]
|
||||||
|
assert st["state"] == "error" and st["code"] == "missing_permissions"
|
||||||
|
assert "Connect" in st["error"] and "View Channel" not in st["error"]
|
||||||
|
assert env.guilds[1].voice_client is None
|
||||||
|
assert _presence(FakeClient.instances[0]) is None # not "Listening to …" while out of voice
|
||||||
|
|
||||||
|
|
||||||
|
async def test_full_channel_is_reported(env):
|
||||||
|
ch = env.guilds[1].channels[11]
|
||||||
|
ch.user_limit, ch.members = 2, [object(), object()]
|
||||||
|
await env.mgr.apply_desired(_desired(1, (1, 11, "t1")))
|
||||||
|
st = env.published[-1]["streams"]["1:11"]
|
||||||
|
assert st["code"] == "channel_full" and "2/2" in st["error"]
|
||||||
|
|
||||||
|
|
||||||
|
async def test_connect_timeout_has_a_readable_error(env):
|
||||||
|
env.guilds[1].channels[11].connect_error = asyncio.TimeoutError()
|
||||||
|
await env.mgr.apply_desired(_desired(1, (1, 11, "t1")))
|
||||||
|
st = env.published[-1]["streams"]["1:11"]
|
||||||
|
assert st["state"] == "error" and st["code"] == "connect_timeout"
|
||||||
|
assert "timed out" in st["error"] and "TimeoutError: )" not in st["error"]
|
||||||
|
|
||||||
|
|
||||||
|
async def test_presence_is_cleared_when_voice_is_lost_and_rejoin_fails(env):
|
||||||
|
"""The owner saw "Listening to <system>" on a bot that was not in voice:
|
||||||
|
presence was set once on join and never cleared."""
|
||||||
|
await env.mgr.apply_desired(_desired(1, (1, 11, "t1")))
|
||||||
|
client = FakeClient.instances[0]
|
||||||
|
assert _presence(client) == "County"
|
||||||
|
env.guilds[1].voice_client.connected = False
|
||||||
|
env.guilds[1].voice_client = None
|
||||||
|
env.guilds[1].channels[11].connect_error = RuntimeError("voice handshake failed")
|
||||||
|
await env.mgr.tick()
|
||||||
|
st = env.mgr.snapshot()["streams"]["1:11"]
|
||||||
|
assert st["state"] == "error" and st["code"] == "connect_failed"
|
||||||
|
assert _presence(client) is None
|
||||||
|
env.guilds[1].channels[11].connect_error = None
|
||||||
|
await env.mgr.tick()
|
||||||
|
assert _presence(client) == "County"
|
||||||
|
|||||||
Reference in New Issue
Block a user