Files
python-tdd/src/apps/voice/consumers.py
Disco DeDisco 41217d5438 my-sea voice Phase C: WebRTC mesh signaling app + TURN endpoint + voice-btn wiring + coturn infra — TDD
Phase C (final) of the my-sea invite → spectator → voice blueprint. Self-
hosted WebRTC mesh voice, built room-general but wired for my-sea only; epic
6-seat rooms reuse the same consumer later (key on Room.id). Media never
touches the server — only signaling is relayed. Built from the blueprint's
distilled spec (disco-voice-mesh.pdf unreadable in-env: no poppler/pypdf).

- C1: new apps/voice/ — RoomVoiceConsumer (AsyncJsonWebsocketConsumer):
  signaling-only relay (room group voice.<room_id> + per-peer peer.<uuid>;
  hello→present handshake, offer/answer/ice routed by target/source, left on
  disconnect). room_id is a STRING kwarg (mysea-<owner_id> now). _can_join
  gates: mysea → owner OR present invitee (token deposited, not left); epic
  UUID → seated gamer (later). routing.py ws/voice/<str:room_id>/; asgi.py
  aggregates epic + voice urlpatterns under AuthMiddlewareStack.
  voice-mesh.js: VoiceRoom client (getUserMedia AEC/NS/AGC, mesh
  RTCPeerConnection, newcomer-offers handshake, tuneOpus SDP munge =
  inbandfec+dtx+40kbps cap, mute via getAudioTracks().enabled), lazy-loaded.
- C2: apps/api VoiceTURNCredentialsAPI at /api/voice/turn-credentials/ —
  coturn use-auth-secret REST scheme: username=<expiry>:<user_id>,
  credential=base64(HMAC-SHA1(username, COTURN_SHARED_SECRET)) + stun/turn
  iceServers + ttl. Authenticated-only. 4 ITs (HMAC shape, auth gate).
- C3: settings COTURN_SHARED_SECRET / COTURN_TURN_HOST / COTURN_REALM /
  COTURN_TTL env block.
- C4: #id_voice_btn wiring — _burger.html renders .active + data-room-id when
  voice_active; burger-btn.js bindVoiceBtn (active click → lazy-load
  voice-mesh.js → join / toggle-mute; inactive → existing 2-pulse flash).
  my_sea (owner) + my_sea_visit (spectator) views compute voice_active
  (open 24h window) + voice_room_id=mysea-<owner_id>; spectator page now
  includes the burger. 4 voice-context ITs.
- C5: infra/coturn.conf.j2 (use-auth-secret, the external-ip footgun, relay
  port range, TLS 5349, peer-IP lockdown) + infra/coturn-playbook.yaml
  (dedicated droplet, PySwiss-style split: install coturn, template conf, ufw
  3478/5349/49152-65535, systemd enable) + [coturn] inventory placeholder.
  *** Manual ops step: provision the droplet + fill inventory before voice
  works on staging/prod; CI/local need none of it. ***
- C6: 8 channels ITs (@tag channels) — connect/auth/_can_join gate (owner,
  present invitee, stranger, not-present, anon) + hello/present handshake +
  offer routing + left-on-disconnect. Scope-injected; TransactionTestCase.
- JS: VoiceMeshSpec.js (tuneOpus) + voice-mesh.js registered in SpecRunner.

1440 IT/UT green; voice channels IT + full Jasmine + voice-btn FT green.
Voice infra is code-complete — provision the coturn droplet to go live.

Code architected by Disco DeDisco <discodedisco@outlook.com>
Git commit message Co-Authored-By:
Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-27 13:57:09 -04:00

130 lines
5.6 KiB
Python

"""Signaling-only relay for a self-hosted WebRTC mesh — Phase C of
[[my-sea-invite-voice-blueprint]] (per disco-voice-mesh.pdf).
Media (the actual audio) never touches the server — only SDP offers/answers
and ICE candidates are relayed. The server is room-agnostic: `room_id` is a
STRING url kwarg — `mysea-<owner_id>` for my-sea today, an epic room UUID
later (the `_can_join` gate is the only room-type-aware piece, so epic rooms
reuse this consumer unchanged).
Mesh handshake (newcomer offers to each existing peer):
client → hello (after `welcome`)
server → peer.hello broadcast → each existing peer replies `present`
newcomer ← present (per existing peer) → newcomer sends `offer` to each
offer / answer / ice are relayed point-to-point by `target` peer id,
tagged with the `source` peer id.
On disconnect the server broadcasts `left` so peers tear down their
RTCPeerConnection.
"""
import uuid as uuidlib
from channels.db import database_sync_to_async
from channels.generic.websocket import AsyncJsonWebsocketConsumer
class RoomVoiceConsumer(AsyncJsonWebsocketConsumer):
async def connect(self):
self.room_id = self.scope["url_route"]["kwargs"]["room_id"]
self.user = self.scope.get("user")
self.room_group = None
self.peer_group = None
self.peer_id = None
if not (self.user and getattr(self.user, "is_authenticated", False)):
await self.close()
return
if not await self._can_join(self.user, self.room_id):
await self.close()
return
self.peer_id = uuidlib.uuid4().hex
self.room_group = f"voice.{self.room_id}"
self.peer_group = f"peer.{self.peer_id}"
await self.channel_layer.group_add(self.room_group, self.channel_name)
await self.channel_layer.group_add(self.peer_group, self.channel_name)
await self.accept()
# Hand the client its own peer id; it sends `hello` next.
await self.send_json({"type": "welcome", "peer_id": self.peer_id})
async def disconnect(self, code):
if self.room_group:
await self.channel_layer.group_send(
self.room_group, {"type": "peer.left", "source": self.peer_id},
)
await self.channel_layer.group_discard(self.room_group, self.channel_name)
if self.peer_group:
await self.channel_layer.group_discard(self.peer_group, self.channel_name)
async def receive_json(self, content):
mtype = content.get("type")
if mtype == "hello":
await self.channel_layer.group_send(
self.room_group, {"type": "peer.hello", "source": self.peer_id},
)
elif mtype in ("offer", "answer", "ice"):
target = content.get("target")
if target:
await self.channel_layer.group_send(
f"peer.{target}",
{
"type": f"relay.{mtype}",
"kind": mtype,
"source": self.peer_id,
"payload": content.get("payload"),
},
)
# ── room-group fan-out handlers ─────────────────────────────────────
async def peer_hello(self, event):
src = event.get("source")
if src == self.peer_id:
return # don't echo our own hello
# Tell the newcomer we're already present (they'll offer to us)…
await self.channel_layer.group_send(
f"peer.{src}", {"type": "peer.present", "source": self.peer_id},
)
# …and note the newcomer locally so we're ready to answer their offer.
await self.send_json({"type": "hello", "source": src})
async def peer_present(self, event):
await self.send_json({"type": "present", "source": event["source"]})
async def peer_left(self, event):
if event.get("source") == self.peer_id:
return
await self.send_json({"type": "left", "source": event["source"]})
# ── point-to-point signaling relay ──────────────────────────────────
async def relay_offer(self, event):
await self._relay(event)
async def relay_answer(self, event):
await self._relay(event)
async def relay_ice(self, event):
await self._relay(event)
async def _relay(self, event):
await self.send_json({
"type": event["kind"],
"source": event["source"],
"payload": event["payload"],
})
# ── membership gate ─────────────────────────────────────────────────
@database_sync_to_async
def _can_join(self, user, room_id):
"""`mysea-<owner_id>` → the owner OR a present invitee (token
deposited, not left). An epic room UUID → a seated gamer (wired in a
later sprint; the consumer itself needs no change)."""
if room_id.startswith("mysea-"):
owner_id = room_id[len("mysea-"):]
if str(user.id) == owner_id:
return True
from apps.gameboard.models import SeaInvite
return SeaInvite.objects.filter(
owner_id=owner_id, invitee=user, status=SeaInvite.ACCEPTED,
token_deposited_at__isnull=False, left_at__isnull=True,
).exists()
from apps.epic.models import TableSeat
return TableSeat.objects.filter(room_id=room_id, gamer=user).exists()