Files
OwnCord/Server/api/router_livekit_process_test.go
T
J3vbandClaude b8b7a2a1f9 fix: correctness fixes across LiveKit voice, client session and transport paths (#1374)
* fix: enhance bugfix workflow documentation with detailed clustering and staging instructions

* fix(voice): 6 defect(s) (OC-0001, OC-0006, OC-0009, OC-0010, OC-0015, OC-0029)

* fix(voice): 1 defect(s) (OC-0005)

* fix(client): 1 defect(s) (OC-0007)

* fix(client): 1 defect(s) (OC-0011)

* fix(client): 1 defect(s) (OC-0012)

* fix(admin): 1 defect(s) (OC-0013)

* fix(client): 3 defect(s) (OC-0014, OC-0024, OC-0031)

* fix(voice): 1 defect(s) (OC-0018)

* fix(voice): 1 defect(s) (OC-0019)

* fix(client): 1 defect(s) (OC-0021)

* fix(client): 1 defect(s) (OC-0025)

* fix(ws): 1 defect(s) (OC-0026)

* fix(client): 1 defect(s) (OC-0027)

* fix(client): 1 defect(s) (OC-0028)

* fix(identity): 1 defect(s) (OC-0030)

* fix(voice): 1 defect(s) (OC-0016)

* fix(client): 2 defect(s) (OC-0002, OC-0020)

OC-0002: chain offer handling behind the announce chain so an offer that
arrives immediately behind its sender's announce is not dropped as an
unknown peer.

OC-0020: retire a departing peer's ECDH key on participant-left so a
replayed pre-leave announce cannot overwrite the fresh key they rejoined
with.

* fix(voice): 1 defect(s) (OC-0008)

handleVoiceJoin handed the client its LiveKit token before checking whether
the join had been superseded by a concurrent eviction (moderator kick/move,
the CONNECT_VOICE revocation sweep, CleanupVoiceForChannel). Those evictors
delete the voice_states row, clear the client's in-memory state, and call
RemoveParticipant — which no-ops because the join has not reached the SFU
yet. The client was left holding a live 5-minute RoomJoin credential for a
membership the server had just torn down.

Re-check the client's voice state immediately after GenerateToken and
withhold the credential if the join was superseded, with a best-effort
RemoveParticipant to match every other eviction path.

* fix(ws): 2 defect(s) (OC-0017, OC-0022)

OC-0017: sweepStaleVoiceStates re-checks the live client immediately before
deleting a snapshotted-stale voice_states row. voice_join commits the row
before calling c.setVoiceState, so a join that lands inside that window was
snapshotted as a ghost and had its just-committed row deleted, leaving the
client in voice in memory with no DB row.

OC-0022: CleanupVoiceForChannel resolves its voice_leave audience with a
variant of channelReadAudience that skips the archived short-circuit. Both
production callers archive the channel before evicting, so the plain
resolver always returned an empty audience and only the evicted
participants learned the call ended.

* fix(voice): 1 defect(s) (OC-0023)

Camera and screenshare now draw from the same per-channel voice_max_video
budget. handleVoiceScreenshareV2 performed no cap check at all, and the
camera gate's slot-count subquery counted only `camera = 1` rows, so a
screensharing occupant was invisible to it. Both gates now count
`camera = 1 OR screenshare = 1` via a shared enableVideoSlot helper.

* fix(client): 2 defect(s) (OC-0032, OC-0033)

OC-0033: voice_disconnected staleness guard swallowed the kick toast when
the sibling voice_leave had already cleared currentChannelId. Treat a
cleared store as not-stale.

OC-0032: VIDEO_LIMIT rollback assumed the camera, tearing down a working
camera and leaving refused screen tracks published. Correlate by envelope
id and roll back the kind that was actually refused.

* fix(voice): 1 defect(s) (OC-0034)

* fix(client): 1 defect(s) (OC-0035)

A superseded video-enable id makes rollbackPendingVideo return undefined.
The dispatcher's ternary treated undefined as "not screen" and called
disableCamera(), tearing down a working camera the user never touched.
Return early instead: undefined means there is nothing to roll back.

* fix(voice): 1 defect(s) (OC-0036)

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-08-15 12:57:51 +02:00

151 lines
5.2 KiB
Go

package api_test
// router_livekit_process_test.go pins the production wiring for OC-0019:
// when OwnCord is configured to manage its own companion LiveKit process
// (voice.auto_download_livekit or voice.livekit_binary set) and
// LiveKitProcess.Start() fails synchronously (e.g. generateConfig rejects an
// operator-chosen credential containing a YAML-unsafe character), NewRouter
// must still register the process with the hub so the voice_join guard in
// ws/voice_join.go — `if h.lkProcess != nil && !h.lkProcess.IsRunning()` —
// fails CLOSED. Before the fix, router.go skipped hub.SetLiveKitProcess on
// the Start() error path, leaving h.lkProcess nil, which reads as "LiveKit
// is externally managed" and lets voice_join proceed with no SFU running at
// all: a voice_states row gets persisted, a LiveKit JWT gets minted, and
// voice_state fans out to every client for a room nothing is serving.
//
// This test drives the real api.NewRouter wiring end to end over a live
// WebSocket connection, so it fails if the router ever again drops the
// process on a failed Start().
import (
"context"
"encoding/json"
"net/http/httptest"
"testing"
"time"
"github.com/coder/websocket"
"github.com/owncord/server/api"
"github.com/owncord/server/auth"
"github.com/owncord/server/config"
"github.com/owncord/server/db"
)
// voiceJoinWSMsg builds a raw voice_join WebSocket frame for the given channel.
func voiceJoinWSMsg(channelID int64) []byte {
raw, _ := json.Marshal(map[string]any{
"type": "voice_join",
"payload": map[string]any{"channel_id": channelID},
})
return raw
}
func TestNewRouter_LiveKitProcessStartFailure_VoiceJoinFailsClosed(t *testing.T) {
database, err := db.Open(":memory:")
if err != nil {
t.Fatalf("db.Open: %v", err)
}
t.Cleanup(func() { _ = database.Close() })
if err := db.Migrate(database); err != nil {
t.Fatalf("db.Migrate: %v", err)
}
cfg := &config.Config{
Server: config.ServerConfig{
Name: "Test Server",
Port: 8443,
DataDir: t.TempDir(),
AllowedOrigins: []string{"*"},
},
Voice: config.VoiceConfig{
// Non-default, non-empty credentials so NewLiveKitClient succeeds
// and hub.SetLiveKit runs (router.go:162) — voice looks
// "configured". The colon in the secret is the ordinary
// credential character that trips livekit_process.go's unsafeYAML
// check inside generateConfig, so proc.Start() fails
// synchronously, before any goroutine or network call.
LiveKitAPIKey: "test-livekit-key-oc0019",
LiveKitAPISecret: "prod:livekit:secret-at-least-32-chars-long",
LiveKitURL: "ws://localhost:7880",
AutoDownloadLiveKit: true,
},
}
handler, _, cleanup := api.NewRouter(cfg, database, "test", nil, nil)
t.Cleanup(cleanup)
// role_id=1 -> Owner, so CONNECT_VOICE is granted and the test isolates
// the LiveKit-process guard rather than a permission check.
uid, err := database.CreateUser(context.Background(), "oc0019voiceuser", "hash", 1)
if err != nil {
t.Fatalf("CreateUser: %v", err)
}
token, err := auth.GenerateToken()
if err != nil {
t.Fatalf("GenerateToken: %v", err)
}
if _, err := database.CreateSession(context.Background(), uid, auth.HashToken(token), "test", "127.0.0.1"); err != nil {
t.Fatalf("CreateSession: %v", err)
}
channelID, err := database.CreateChannel(context.Background(), "oc0019-voice", "voice", "", "", 0)
if err != nil {
t.Fatalf("CreateChannel: %v", err)
}
srv := httptest.NewServer(handler)
t.Cleanup(srv.Close)
conn := dialAndAuthWS(t, srv, token)
writeCtx, writeCancel := context.WithTimeout(context.Background(), 5*time.Second)
defer writeCancel()
if err := conn.Write(writeCtx, websocket.MessageText, voiceJoinWSMsg(channelID)); err != nil {
t.Fatalf("write voice_join: %v", err)
}
// Read frames until we see a response to the join attempt (skipping the
// "ready" hydration frame and any other unrelated broadcasts), or time out.
deadline := time.Now().Add(10 * time.Second)
var lastFrame map[string]any
for time.Now().Before(deadline) {
readCtx, readCancel := context.WithTimeout(context.Background(), 2*time.Second)
_, msg, readErr := conn.Read(readCtx)
readCancel()
if readErr != nil {
break
}
var frame map[string]any
if err := json.Unmarshal(msg, &frame); err != nil {
continue
}
switch frame["type"] {
case "ready", "voice_config":
continue
case "error", "voice_token":
lastFrame = frame
}
if lastFrame != nil {
break
}
}
if lastFrame == nil {
t.Fatal("no error or voice_token response observed for voice_join before the deadline")
}
if lastFrame["type"] != "error" {
t.Fatalf("voice_join with a LiveKit process that failed to start must be rejected, got type=%v frame=%v — "+
"router.go must register the LiveKitProcess with the hub even when proc.Start() fails, "+
"so ws/voice_join.go's `h.lkProcess != nil && !h.lkProcess.IsRunning()` guard can fail closed "+
"instead of reading a dropped process as \"externally managed, don't check\"",
lastFrame["type"], lastFrame)
}
payload, _ := lastFrame["payload"].(map[string]any)
if payload["code"] != "VOICE_ERROR" {
t.Fatalf("expected error code VOICE_ERROR, got %v (frame=%v)", payload["code"], lastFrame)
}
}