Files
OwnCord/Server/api/gif_handler_test.go
T
Claude 7a4e5dc357 refactor: rename the Go module to github.com/J3vb/OwnCord/Server (RL-13)
`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
2026-08-26 20:23:49 +00:00

354 lines
12 KiB
Go

package api_test
import (
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"
"github.com/J3vb/OwnCord/Server/api"
"github.com/J3vb/OwnCord/Server/auth"
"github.com/J3vb/OwnCord/Server/config"
"github.com/J3vb/OwnCord/Server/db"
"github.com/go-chi/chi/v5"
)
// ─── Helpers ─────────────────────────────────────────────────────────────────
// buildGIFRouter mounts the GIF proxy with the given upstream API key.
func buildGIFRouter(database *db.DB, apiKey string) http.Handler {
r := chi.NewRouter()
limiter := auth.NewRateLimiter()
cfg := &config.Config{}
cfg.GIF.APIKey = apiKey
api.MountGIFRoutes(r, database, limiter, cfg)
return r
}
// stubKlipy starts a fake upstream and points the GIF proxy at it. The
// returned recorder captures the query of the last upstream request.
func stubKlipy(t *testing.T, body string, status int) *lastRequest {
t.Helper()
rec := &lastRequest{}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
rec.path = r.URL.Path
rec.query = r.URL.Query()
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(status)
_, _ = w.Write([]byte(body))
}))
t.Cleanup(srv.Close)
// The production transport uses the SSRF-guarded dialer, which refuses the
// loopback address httptest binds to — supply a plain client for the stub.
restore := api.SetGIFUpstreamForTest(srv.URL, srv.Client())
t.Cleanup(restore)
return rec
}
type lastRequest struct {
path string
query map[string][]string
}
func (l *lastRequest) get(key string) string {
if v := l.query[key]; len(v) > 0 {
return v[0]
}
return ""
}
// gifGET issues an authenticated GET against the GIF router.
func gifGET(t *testing.T, router http.Handler, path, token string) *httptest.ResponseRecorder {
t.Helper()
req := httptest.NewRequest(http.MethodGet, path, nil)
if token != "" {
req.Header.Set("Authorization", "Bearer "+token)
}
req.RemoteAddr = "127.0.0.1:9999"
rr := httptest.NewRecorder()
router.ServeHTTP(rr, req)
return rr
}
const gifUpstreamBody = `{"results":[
{"id":"a","title":"Cat","media_formats":{"tinygif":{"url":"https://media.klipy.com/a_tiny.gif"},"gif":{"url":"https://media.klipy.com/a.gif"}},"secret_echo":"leak"},
{"id":"b","title":"NoTiny","media_formats":{"gif":{"url":"https://media.klipy.com/b.gif"}}}
]}`
func decodeGIFResults(t *testing.T, rr *httptest.ResponseRecorder) []map[string]any {
t.Helper()
var body struct {
Results []map[string]any `json:"results"`
}
if err := json.Unmarshal(rr.Body.Bytes(), &body); err != nil {
t.Fatalf("decode response: %v (body=%s)", err, rr.Body.String())
}
return body.Results
}
func decodeGIFError(t *testing.T, rr *httptest.ResponseRecorder) string {
t.Helper()
var body struct {
Error string `json:"error"`
}
if err := json.Unmarshal(rr.Body.Bytes(), &body); err != nil {
t.Fatalf("decode error body: %v (body=%s)", err, rr.Body.String())
}
return body.Error
}
// ─── Key configured: proxies upstream ────────────────────────────────────────
func TestGIFSearchProxiesUpstream(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
up := stubKlipy(t, gifUpstreamBody, http.StatusOK)
router := buildGIFRouter(database, "server-side-key")
rr := gifGET(t, router, "/api/v1/gif/search?q=cats&limit=5", token)
if rr.Code != http.StatusOK {
t.Fatalf("status = %d, want 200 (body=%s)", rr.Code, rr.Body.String())
}
if up.path != "/search" {
t.Errorf("upstream path = %q, want /search", up.path)
}
if got := up.get("q"); got != "cats" {
t.Errorf("upstream q = %q, want cats", got)
}
if got := up.get("limit"); got != "5" {
t.Errorf("upstream limit = %q, want 5", got)
}
if got := up.get("key"); got != "server-side-key" {
t.Errorf("upstream key = %q, want the server-held key", got)
}
results := decodeGIFResults(t, rr)
if len(results) != 1 {
t.Fatalf("results = %d, want 1 (entries missing a format are dropped)", len(results))
}
if results[0]["id"] != "a" {
t.Errorf("result id = %v, want a", results[0]["id"])
}
}
func TestGIFTrendingProxiesUpstream(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
up := stubKlipy(t, gifUpstreamBody, http.StatusOK)
router := buildGIFRouter(database, "server-side-key")
rr := gifGET(t, router, "/api/v1/gif/trending", token)
if rr.Code != http.StatusOK {
t.Fatalf("status = %d, want 200 (body=%s)", rr.Code, rr.Body.String())
}
if up.path != "/featured" {
t.Errorf("upstream path = %q, want /featured", up.path)
}
if up.get("q") != "" {
t.Errorf("trending must not send q, got %q", up.get("q"))
}
if got := up.get("limit"); got != "20" {
t.Errorf("default limit = %q, want 20", got)
}
}
// The API key must never reach the client, directly or via an upstream echo.
func TestGIFResponseNeverLeaksAPIKey(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
stubKlipy(t, `{"results":[{"id":"a","title":"t","key":"server-side-key","media_formats":{"tinygif":{"url":"https://media.klipy.com/a_tiny.gif"},"gif":{"url":"https://media.klipy.com/a.gif"}}}],"echoed_key":"server-side-key"}`, http.StatusOK)
router := buildGIFRouter(database, "server-side-key")
rr := gifGET(t, router, "/api/v1/gif/search?q=cats", token)
if rr.Code != http.StatusOK {
t.Fatalf("status = %d, want 200", rr.Code)
}
if strings.Contains(rr.Body.String(), "server-side-key") {
t.Fatalf("response leaked the API key: %s", rr.Body.String())
}
}
// ─── Default-off contract ────────────────────────────────────────────────────
func TestGIFDisabledWhenNoKeyConfigured(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
router := buildGIFRouter(database, "")
for _, path := range []string{"/api/v1/gif/search?q=cats", "/api/v1/gif/trending"} {
rr := gifGET(t, router, path, token)
if rr.Code != http.StatusServiceUnavailable {
t.Errorf("%s status = %d, want 503", path, rr.Code)
}
if code := decodeGIFError(t, rr); code != "GIF_DISABLED" {
t.Errorf("%s error code = %q, want GIF_DISABLED", path, code)
}
}
}
// A disabled server must not make an outbound call at all.
func TestGIFDisabledMakesNoUpstreamCall(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
up := stubKlipy(t, gifUpstreamBody, http.StatusOK)
router := buildGIFRouter(database, "")
gifGET(t, router, "/api/v1/gif/search?q=cats", token)
if up.path != "" {
t.Errorf("upstream was called (%q) despite the feature being disabled", up.path)
}
}
// ─── Auth ────────────────────────────────────────────────────────────────────
func TestGIFRequiresAuth(t *testing.T) {
database := newAuthTestDB(t)
stubKlipy(t, gifUpstreamBody, http.StatusOK)
router := buildGIFRouter(database, "server-side-key")
for _, path := range []string{"/api/v1/gif/search?q=cats", "/api/v1/gif/trending"} {
rr := gifGET(t, router, path, "")
if rr.Code != http.StatusUnauthorized {
t.Errorf("%s without a token: status = %d, want 401", path, rr.Code)
}
}
}
func TestGIFRejectsInvalidToken(t *testing.T) {
database := newAuthTestDB(t)
stubKlipy(t, gifUpstreamBody, http.StatusOK)
router := buildGIFRouter(database, "server-side-key")
rr := gifGET(t, router, "/api/v1/gif/search?q=cats", "not-a-real-token")
if rr.Code != http.StatusUnauthorized {
t.Errorf("status = %d, want 401", rr.Code)
}
}
// Auth is checked before the disabled check, so an anonymous caller cannot
// probe whether the operator configured a GIF key.
func TestGIFAuthCheckedBeforeDisabledCheck(t *testing.T) {
database := newAuthTestDB(t)
router := buildGIFRouter(database, "")
rr := gifGET(t, router, "/api/v1/gif/search?q=cats", "")
if rr.Code != http.StatusUnauthorized {
t.Errorf("status = %d, want 401 (not 503)", rr.Code)
}
}
// ─── Input validation ────────────────────────────────────────────────────────
func TestGIFSearchValidatesInput(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
stubKlipy(t, gifUpstreamBody, http.StatusOK)
router := buildGIFRouter(database, "server-side-key")
tests := []struct {
name string
path string
}{
{"missing q", "/api/v1/gif/search"},
{"blank q", "/api/v1/gif/search?q=%20%20"},
{"q too long", "/api/v1/gif/search?q=" + strings.Repeat("a", 101)},
{"limit not a number", "/api/v1/gif/search?q=cats&limit=abc"},
{"limit zero", "/api/v1/gif/search?q=cats&limit=0"},
{"limit over max", "/api/v1/gif/search?q=cats&limit=51"},
{"limit negative", "/api/v1/gif/search?q=cats&limit=-1"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
rr := gifGET(t, router, tt.path, token)
if rr.Code != http.StatusBadRequest {
t.Errorf("status = %d, want 400 (body=%s)", rr.Code, rr.Body.String())
}
})
}
}
// ─── Upstream failure ────────────────────────────────────────────────────────
func TestGIFUpstreamErrorBecomesBadGateway(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
stubKlipy(t, `{"error":"quota exceeded for key server-side-key"}`, http.StatusPaymentRequired)
router := buildGIFRouter(database, "server-side-key")
rr := gifGET(t, router, "/api/v1/gif/search?q=cats", token)
if rr.Code != http.StatusBadGateway {
t.Fatalf("status = %d, want 502", rr.Code)
}
if strings.Contains(rr.Body.String(), "quota exceeded") {
t.Errorf("upstream error body was passed through to the client: %s", rr.Body.String())
}
if strings.Contains(rr.Body.String(), "server-side-key") {
t.Errorf("response leaked the API key: %s", rr.Body.String())
}
}
func TestGIFMalformedUpstreamBecomesBadGateway(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
stubKlipy(t, `<html>not json</html>`, http.StatusOK)
router := buildGIFRouter(database, "server-side-key")
rr := gifGET(t, router, "/api/v1/gif/search?q=cats", token)
if rr.Code != http.StatusBadGateway {
t.Errorf("status = %d, want 502", rr.Code)
}
}
// ─── Rate limiting ───────────────────────────────────────────────────────────
func TestGIFRateLimited(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
stubKlipy(t, `{"results":[]}`, http.StatusOK)
router := buildGIFRouter(database, "server-side-key")
// The limiter allows 30/minute per IP; the 31st must be refused.
for i := range 30 {
rr := gifGET(t, router, "/api/v1/gif/trending", token)
if rr.Code != http.StatusOK {
t.Fatalf("request %d: status = %d, want 200", i+1, rr.Code)
}
}
rr := gifGET(t, router, "/api/v1/gif/trending", token)
if rr.Code != http.StatusTooManyRequests {
t.Fatalf("request 31: status = %d, want 429", rr.Code)
}
if code := decodeGIFError(t, rr); code != "RATE_LIMITED" {
t.Errorf("error code = %q, want RATE_LIMITED", code)
}
if rr.Header().Get("Retry-After") == "" {
t.Error("429 response is missing the Retry-After header")
}
}
// The GIF bucket must be separate from the shared empty-prefix bucket, so a
// user hammering the picker cannot rate-limit their own password change.
func TestGIFRateLimitBucketIsSeparate(t *testing.T) {
database := newAuthTestDB(t)
token := profileCreateToken(t, database, "gifuser", 4)
stubKlipy(t, `{"results":[]}`, http.StatusOK)
limiter := auth.NewRateLimiter()
r := chi.NewRouter()
cfg := &config.Config{}
cfg.GIF.APIKey = "server-side-key"
api.MountGIFRoutes(r, database, limiter, cfg)
for range 31 {
gifGET(t, r, "/api/v1/gif/trending", token)
}
// The shared (empty-prefix) bucket used by sensitive endpoints must be
// untouched by the GIF traffic above.
if !limiter.Allow("127.0.0.1", 5, time.Minute) {
t.Error("GIF traffic consumed the shared rate-limit bucket")
}
}