mirror of
https://github.com/J3vb/OwnCord.git
synced 2026-09-03 03:50:00 +03:00
`Server/go.mod` declared `github.com/owncord/server` while the public repository is `github.com/J3vb/OwnCord`. Nothing resolves that path — there is no `owncord` GitHub org and no vanity-import host serving go-import metadata for it — so every import line in the tree named a location that does not exist. It compiles because a main module's own path is never fetched, which is exactly why it went unnoticed. The obvious fix — an AST-aware import rewriter (`gomvpkg`, `go mod edit`) — is wrong here, and provably so. Six of the 722 occurrences are not imports at all: `api/main_test.go:20` (a goleak `IgnoreTopFunction` pattern), `telemetry/metrics.go:17-19` (three OTel instrumentation-scope names), `invariants/syncutil_locks.go:73` (a diagnostic message), and `invariants/syncutil_locks_test.go:56` (an import line inside a raw-string Go fixture). An import rewriter touches none of them, and the compiler cannot see any of them either. Done as one scripted substitution over `git ls-files`, anchored on the full `github.com/owncord/server` string. The anchor matters: `owncord-server` is a different identifier — the OTel `service.name` (`config/config.go`, `telemetry/telemetry_otel.go`) and the GHCR image name (`.github/workflows/release.yml`, `docker-compose.yml`) — and a looser pattern would have moved it. It is untouched: 10 occurrences across 9 files, before and after. 350 files, 728 insertions, 728 deletions. 722 occurrences in 344 Go files, plus `go.mod:1`, the `sed` at `Makefile:67`, `Server/CLAUDE.md:3`, `docs/architecture/server.md:5`, and the ledger pair (`findings-ledger.json:3758` plus a `render-ledger.mjs` re-render of `FINDINGS.md`). Zero in any workflow, zero in the Dockerfile, zero in `Server/.golangci.yml` (no `local-prefixes`, `gci`, `importas` or `depguard` rule keys on the module path, so import grouping is not configured anywhere). The plan's blast-radius estimate missed one thing, and it is the one that would have gone red: **gofmt**. `J` (0x4A) sorts before every lowercase letter, so in the 36 files where a module-local import shares a contiguous group with a third-party one, the module's imports must move above `github.com/go-chi/...`. `gofmt -l` was clean before the substitution and listed exactly 36 files after it; `gofmt -w` on those 36 restores it to clean. `gofmt` is an enforced gate — the `formatters` block in `Server/.golangci.yml`, which is S-05 — so a substitution-only commit fails Lint. Verified: both directions, and the line accounting is exact. Every added line in this diff contains the new module path (728) and every removed line contains the old one (728); the count of changed lines containing neither is **zero**, so the gofmt re-sort moved module-path lines only and touched no third-party import. The residual check (`git ls-files -z | xargs -0 grep -n 'github\.com/owncord/server'`) returns exactly two hits, both deliberately out of scope: the RL-13 row in `docs/audit-2026-08-23-repository-layout.md` and the measurement row in this phase's own plan. The compiler-invisible half was proven by reverting *only* `api/main_test.go:20` to the old path on the otherwise-renamed tree: `go build ./...` and `go vet ./api/` both still pass — they see nothing wrong — while `go test ./api/` FAILS, because the runtime function name now carries the new path and goleak stops ignoring `ws.(*Hub).Run.func1`. Restoring the line makes it pass. `go.sum` is byte-identical (no `go mod tidy` was run and none was needed). All four build-tag variants compile; `go vet ./...`, `go vet -tags otel,wazero ./...` and `go vet -tags deadlock ./...` pass; `go test -race ./...` is 16/16 packages green; `go test -tags deadlock ./...` passes; the tag-gated `./plugin/...` (wazero) and `./telemetry/...` (otel) runs pass. `golangci-lint` v2.11.3 — the pinned CI version, rebuilt locally against Go 1.26 because the packaged binary cannot load a 1.26 config — reports **0 issues**. `go run ./cmd/genprotocol` leaves `git diff --exit-code ws/message_types.go ../Client/src/lib/protocolTypes.ts` clean, so the rename does not reach the generated protocol constants. `npx prettier --check .` and `node .superpowers/render-ledger.mjs --check` pass. Not included: `docs/audit-2026-08-23-repository-layout.md` and `docs/plans/b1-repository-foundation-2026-08-25.md` keep the old path — they are the audit row and the measurement that motivated this change, and rewriting them would erase the record of what was measured. They are why the residual check needs a two-path allowance rather than being empty; that allowance is stated above rather than hidden in a pathspec. `telemetry/metrics.go:19` declares `scopeVoice` for a `Server/voice` package that does not exist; the substitution carried the dead path forward verbatim as `github.com/J3vb/OwnCord/Server/voice` rather than fixing it, because correcting a real observability bug inside a mechanical rename would hide it in a 350-file diff. It needs its own item. No `go.work`, no second module, and no vanity-import host was set up — the new path resolves against the real repository, but nothing imports this module as a library, so `go get` reachability was not exercised either way. Refs RL-13, L-12
318 lines
10 KiB
Go
318 lines
10 KiB
Go
package api_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/coder/websocket"
|
|
"github.com/livekit/protocol/livekit"
|
|
"google.golang.org/protobuf/proto"
|
|
|
|
"github.com/J3vb/OwnCord/Server/api"
|
|
"github.com/J3vb/OwnCord/Server/config"
|
|
"github.com/J3vb/OwnCord/Server/ws"
|
|
)
|
|
|
|
// proxyWebSocket and copyWS carry every LiveKit signaling frame between the
|
|
// client and the media server, and neither had any coverage — the existing
|
|
// livekit_proxy_test.go stops at the path allowlist and Origin check, before
|
|
// the upgrade. handleLiveKitHealth was in the same position: its only "test"
|
|
// hook re-implemented the handler rather than calling it.
|
|
|
|
// echoWSBackend starts a WebSocket server that echoes every message it
|
|
// receives, and returns its ws:// URL.
|
|
func echoWSBackend(t *testing.T) string {
|
|
t.Helper()
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
conn, err := websocket.Accept(w, r, &websocket.AcceptOptions{
|
|
InsecureSkipVerify: true,
|
|
})
|
|
if err != nil {
|
|
return
|
|
}
|
|
defer conn.Close(websocket.StatusNormalClosure, "") //nolint:errcheck // best-effort
|
|
|
|
for {
|
|
typ, data, err := conn.Read(r.Context())
|
|
if err != nil {
|
|
return
|
|
}
|
|
if err := conn.Write(r.Context(), typ, data); err != nil {
|
|
return
|
|
}
|
|
}
|
|
}))
|
|
t.Cleanup(srv.Close)
|
|
return "ws://" + srv.Listener.Addr().String()
|
|
}
|
|
|
|
func TestLiveKitProxy_WebSocket_RoundTrip(t *testing.T) {
|
|
backend := echoWSBackend(t)
|
|
|
|
proxy := httptest.NewServer(api.NewLiveKitProxy(backend, []string{"*"}))
|
|
t.Cleanup(proxy.Close)
|
|
|
|
ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
|
|
defer cancel()
|
|
|
|
conn, dialResp, err := websocket.Dial(ctx, "ws://"+proxy.Listener.Addr().String()+"/rtc", nil)
|
|
if dialResp != nil && dialResp.Body != nil {
|
|
defer dialResp.Body.Close() //nolint:errcheck // best-effort close in test
|
|
}
|
|
if err != nil {
|
|
t.Fatalf("dial through proxy: %v", err)
|
|
}
|
|
defer conn.Close(websocket.StatusNormalClosure, "") //nolint:errcheck // best-effort
|
|
|
|
// Frontend → backend → frontend, through both copyWS goroutines.
|
|
if err := conn.Write(ctx, websocket.MessageText, []byte("signal")); err != nil {
|
|
t.Fatalf("write: %v", err)
|
|
}
|
|
typ, got, err := conn.Read(ctx)
|
|
if err != nil {
|
|
t.Fatalf("read: %v", err)
|
|
}
|
|
if typ != websocket.MessageText || string(got) != "signal" {
|
|
t.Errorf("echo = (%v, %q), want (text, \"signal\")", typ, got)
|
|
}
|
|
}
|
|
|
|
func TestLiveKitProxy_WebSocket_ForwardsBinary(t *testing.T) {
|
|
backend := echoWSBackend(t)
|
|
proxy := httptest.NewServer(api.NewLiveKitProxy(backend, []string{"*"}))
|
|
t.Cleanup(proxy.Close)
|
|
|
|
ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
|
|
defer cancel()
|
|
|
|
conn, dialResp, err := websocket.Dial(ctx, "ws://"+proxy.Listener.Addr().String()+"/rtc", nil)
|
|
if dialResp != nil && dialResp.Body != nil {
|
|
defer dialResp.Body.Close() //nolint:errcheck // best-effort close in test
|
|
}
|
|
if err != nil {
|
|
t.Fatalf("dial through proxy: %v", err)
|
|
}
|
|
defer conn.Close(websocket.StatusNormalClosure, "") //nolint:errcheck // best-effort
|
|
|
|
// LiveKit signaling is protobuf, so the binary opcode must survive the hop.
|
|
payload := []byte{0x00, 0x01, 0x02, 0xff}
|
|
if err := conn.Write(ctx, websocket.MessageBinary, payload); err != nil {
|
|
t.Fatalf("write: %v", err)
|
|
}
|
|
typ, got, err := conn.Read(ctx)
|
|
if err != nil {
|
|
t.Fatalf("read: %v", err)
|
|
}
|
|
if typ != websocket.MessageBinary || !bytes.Equal(got, payload) {
|
|
t.Errorf("echo = (%v, %v), want (binary, %v)", typ, got, payload)
|
|
}
|
|
}
|
|
|
|
func TestLiveKitProxy_WebSocket_PreservesQueryString(t *testing.T) {
|
|
var gotQuery string
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
gotQuery = r.URL.RawQuery
|
|
conn, err := websocket.Accept(w, r, &websocket.AcceptOptions{InsecureSkipVerify: true})
|
|
if err != nil {
|
|
return
|
|
}
|
|
_ = conn.Write(r.Context(), websocket.MessageText, []byte("ok"))
|
|
conn.Close(websocket.StatusNormalClosure, "") //nolint:errcheck // best-effort
|
|
}))
|
|
t.Cleanup(srv.Close)
|
|
|
|
proxy := httptest.NewServer(api.NewLiveKitProxy("ws://"+srv.Listener.Addr().String(), []string{"*"}))
|
|
t.Cleanup(proxy.Close)
|
|
|
|
ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
|
|
defer cancel()
|
|
|
|
conn, dialResp, err := websocket.Dial(ctx, "ws://"+proxy.Listener.Addr().String()+"/rtc?access_token=abc", nil)
|
|
if dialResp != nil && dialResp.Body != nil {
|
|
defer dialResp.Body.Close() //nolint:errcheck // best-effort close in test
|
|
}
|
|
if err != nil {
|
|
t.Fatalf("dial through proxy: %v", err)
|
|
}
|
|
defer conn.Close(websocket.StatusNormalClosure, "") //nolint:errcheck // best-effort
|
|
|
|
if _, _, err := conn.Read(ctx); err != nil {
|
|
t.Fatalf("read: %v", err)
|
|
}
|
|
// LiveKit carries the join token in the query string; dropping it would
|
|
// turn every voice join into an auth failure.
|
|
if gotQuery != "access_token=abc" {
|
|
t.Errorf("backend saw query %q, want %q", gotQuery, "access_token=abc")
|
|
}
|
|
}
|
|
|
|
func TestLiveKitProxy_WebSocket_BackendUnavailable(t *testing.T) {
|
|
// Nothing is listening on this port, so the backend dial must fail.
|
|
proxy := httptest.NewServer(api.NewLiveKitProxy("ws://127.0.0.1:1", []string{"*"}))
|
|
t.Cleanup(proxy.Close)
|
|
|
|
ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
|
|
defer cancel()
|
|
|
|
_, resp, err := websocket.Dial(ctx, "ws://"+proxy.Listener.Addr().String()+"/rtc", nil)
|
|
if err == nil {
|
|
t.Fatal("dial succeeded despite an unreachable backend")
|
|
}
|
|
if resp == nil {
|
|
t.Fatal("no HTTP response returned for the failed upgrade")
|
|
}
|
|
defer resp.Body.Close() //nolint:errcheck // best-effort
|
|
if resp.StatusCode != http.StatusBadGateway {
|
|
t.Errorf("status = %d, want 502", resp.StatusCode)
|
|
}
|
|
}
|
|
|
|
func TestLiveKitProxy_WebSocket_BlockedPathNotUpgraded(t *testing.T) {
|
|
backend := echoWSBackend(t)
|
|
proxy := httptest.NewServer(api.NewLiveKitProxy(backend, []string{"*"}))
|
|
t.Cleanup(proxy.Close)
|
|
|
|
ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
|
|
defer cancel()
|
|
|
|
// The allowlist runs before the upgrade branch, so an Upgrade header must
|
|
// not be a way around it.
|
|
_, resp, err := websocket.Dial(ctx, "ws://"+proxy.Listener.Addr().String()+"/twirp/whatever", nil)
|
|
if err == nil {
|
|
t.Fatal("upgrade to a blocked path succeeded")
|
|
}
|
|
if resp == nil {
|
|
t.Fatal("no HTTP response returned")
|
|
}
|
|
defer resp.Body.Close() //nolint:errcheck // best-effort
|
|
if resp.StatusCode != http.StatusForbidden {
|
|
t.Errorf("status = %d, want 403", resp.StatusCode)
|
|
}
|
|
}
|
|
|
|
func TestLiveKitProxy_WebSocket_CrossOriginRejected(t *testing.T) {
|
|
backend := echoWSBackend(t)
|
|
proxy := httptest.NewServer(api.NewLiveKitProxy(backend, []string{"https://allowed.example"}))
|
|
t.Cleanup(proxy.Close)
|
|
|
|
ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
|
|
defer cancel()
|
|
|
|
_, resp, err := websocket.Dial(ctx, "ws://"+proxy.Listener.Addr().String()+"/rtc", &websocket.DialOptions{
|
|
HTTPHeader: http.Header{"Origin": []string{"https://evil.example"}},
|
|
})
|
|
if err == nil {
|
|
t.Fatal("upgrade from a disallowed origin succeeded")
|
|
}
|
|
if resp == nil {
|
|
t.Fatal("no HTTP response returned")
|
|
}
|
|
defer resp.Body.Close() //nolint:errcheck // best-effort
|
|
if resp.StatusCode != http.StatusForbidden {
|
|
t.Errorf("status = %d, want 403", resp.StatusCode)
|
|
}
|
|
}
|
|
|
|
// ─── handleLiveKitHealth (the real handler) ─────────────────────────────────
|
|
|
|
// hubWithLiveKit returns a Hub whose LiveKit client points at a stub room
|
|
// service replying with the supplied status.
|
|
func hubWithLiveKit(t *testing.T, status int) *ws.Hub {
|
|
t.Helper()
|
|
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
if status != http.StatusOK {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
w.WriteHeader(status)
|
|
_, _ = w.Write([]byte(`{"code":"internal","msg":"boom"}`))
|
|
return
|
|
}
|
|
body, _ := proto.Marshal(&livekit.ListRoomsResponse{})
|
|
w.Header().Set("Content-Type", "application/protobuf")
|
|
_, _ = w.Write(body)
|
|
}))
|
|
t.Cleanup(srv.Close)
|
|
|
|
hub := ws.NewHub(nil, nil, nil)
|
|
lk, err := ws.NewLiveKitClient(&config.VoiceConfig{
|
|
LiveKitAPIKey: "testkeytestkeytest",
|
|
LiveKitAPISecret: "testsecrettestsecrettestsecret",
|
|
LiveKitURL: "ws://" + srv.Listener.Addr().String(),
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("NewLiveKitClient: %v", err)
|
|
}
|
|
hub.SetLiveKit(lk)
|
|
return hub
|
|
}
|
|
|
|
func TestHandleLiveKitHealth_Healthy(t *testing.T) {
|
|
handler := api.LiveKitHealthHandlerForTest(hubWithLiveKit(t, http.StatusOK))
|
|
|
|
rr := httptest.NewRecorder()
|
|
handler(rr, httptest.NewRequest(http.MethodGet, "/api/v1/livekit/health", nil))
|
|
|
|
if rr.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200 (body %q)", rr.Code, rr.Body.String())
|
|
}
|
|
var body struct {
|
|
Status string `json:"status"`
|
|
LiveKitReachable bool `json:"livekit_reachable"`
|
|
Error string `json:"error"`
|
|
}
|
|
if err := json.Unmarshal(rr.Body.Bytes(), &body); err != nil {
|
|
t.Fatalf("decode: %v", err)
|
|
}
|
|
if body.Status != "ok" || !body.LiveKitReachable {
|
|
t.Errorf("body = %+v, want status ok and reachable", body)
|
|
}
|
|
if body.Error != "" {
|
|
t.Errorf("error = %q on the healthy path, want it omitted", body.Error)
|
|
}
|
|
}
|
|
|
|
func TestHandleLiveKitHealth_Degraded(t *testing.T) {
|
|
handler := api.LiveKitHealthHandlerForTest(hubWithLiveKit(t, http.StatusInternalServerError))
|
|
|
|
rr := httptest.NewRecorder()
|
|
handler(rr, httptest.NewRequest(http.MethodGet, "/api/v1/livekit/health", nil))
|
|
|
|
if rr.Code != http.StatusServiceUnavailable {
|
|
t.Fatalf("status = %d, want 503 (body %q)", rr.Code, rr.Body.String())
|
|
}
|
|
var body struct {
|
|
Status string `json:"status"`
|
|
LiveKitReachable bool `json:"livekit_reachable"`
|
|
Error string `json:"error"`
|
|
}
|
|
if err := json.Unmarshal(rr.Body.Bytes(), &body); err != nil {
|
|
t.Fatalf("decode: %v", err)
|
|
}
|
|
if body.Status != "degraded" || body.LiveKitReachable {
|
|
t.Errorf("body = %+v, want status degraded and unreachable", body)
|
|
}
|
|
if body.Error == "" {
|
|
t.Error("error is empty on the degraded path; the reason should be surfaced")
|
|
}
|
|
}
|
|
|
|
func TestHandleLiveKitHealth_NotConfigured(t *testing.T) {
|
|
// A hub with no LiveKit client at all — the common case when voice is off.
|
|
handler := api.LiveKitHealthHandlerForTest(ws.NewHub(nil, nil, nil))
|
|
|
|
rr := httptest.NewRecorder()
|
|
handler(rr, httptest.NewRequest(http.MethodGet, "/api/v1/livekit/health", nil))
|
|
|
|
if rr.Code != http.StatusServiceUnavailable {
|
|
t.Fatalf("status = %d, want 503", rr.Code)
|
|
}
|
|
if !strings.Contains(rr.Body.String(), "not configured") {
|
|
t.Errorf("body = %q, want it to name the missing configuration", rr.Body.String())
|
|
}
|
|
}
|