Files
minstrel/internal/api/library_sync_test.go
T
bvandeusenandClaude Opus 5.5 29042e4eb2
release / govulncheck (push) Successful in 29s
release / web (push) Failing after 1m21s
release / go (push) Successful in 1m39s
release / integration (push) Successful in 5m26s
release / android (push) Successful in 5m27s
release / Build signed APK (push) Successful in 5m44s
release / Attach APK to the Release (tag releases only) (push) Skipped
release / Build + push container image (push) Skipped
release / Verify release artifacts (tag releases only) (push) Skipped
feat: a new Minstrel restores a backup, from the web app or the command line, then rescans (#6775)
A new server (no accounts, no library) offers "Restore a backup" beside
"Create account". The file goes up as the request body to
POST /api/auth/restore with the setup token from the log in X-Setup-Token,
since the backup's admins become this server's. It loads in one transaction,
then a library scan starts and finds each file at its path. The same load runs
offline as `minstrel restore FILE`, which migrates the schema first.

That path alone gets a 1 GiB, 15-minute body allowance instead of 4 MiB and
30s, and skips the JSON-only check for cookie writes: a stale cookie from the
old server would otherwise refuse the upload, and the custom header already
rules out a cross-site form.

The library sync answers 410 cursor_ahead to a cursor past the last one the
server has handed out, read from the change sequence, so an app synced with
the old server after the backup was made starts over instead of skipping the
ids the restored server reuses. Restore now leaves each sequence as having
issued the restored maximum, so that reading holds; a compacted log still
counts its handed-out cursors.

backup.Read keeps the underlying error in its chain, so an oversized upload
answers 413 rather than "not a backup". The hosting docs say how to put the
music back first and what is entered again afterwards.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 16:10:06 -05:00

253 lines
7.7 KiB
Go

package api
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"strconv"
"strings"
"testing"
"git.fabledsword.com/bvandeusen/minstrel/internal/auth"
"git.fabledsword.com/bvandeusen/minstrel/internal/db/dbq"
"git.fabledsword.com/bvandeusen/minstrel/internal/sync"
)
func callLibrarySync(h *handlers, user dbq.User, since string) *httptest.ResponseRecorder {
url := "/api/library/sync"
if since != "" {
url += "?since=" + since
}
req := httptest.NewRequest(http.MethodGet, url, nil)
req = req.WithContext(context.WithValue(req.Context(), auth.UserCtxKeyForTest(), user))
w := httptest.NewRecorder()
h.handleLibrarySync(w, req)
return w
}
func TestLibrarySync_NoChanges_Returns204(t *testing.T) {
h, pool := testHandlers(t)
truncateLibrary(t, pool)
u := seedUser(t, pool, "alice", "x", false)
w := callLibrarySync(h, u, "0")
if w.Code != http.StatusNoContent {
t.Fatalf("status = %d body = %s", w.Code, w.Body.String())
}
}
func TestLibrarySync_AfterArtistUpsert_ReturnsHydratedPayload(t *testing.T) {
h, pool := testHandlers(t)
truncateLibrary(t, pool)
u := seedUser(t, pool, "alice", "x", false)
// Seed an artist + write a change row in the same tx — the invariant
// library writes keep, and the handler relies on.
ctx := context.Background()
tx, err := pool.Begin(ctx)
if err != nil {
t.Fatalf("begin: %v", err)
}
defer func() { _ = tx.Rollback(ctx) }()
var artistID string
if err := tx.QueryRow(ctx,
`INSERT INTO artists (name, sort_name) VALUES ($1, $2) RETURNING id::text`,
"Boards of Canada", "Boards of Canada",
).Scan(&artistID); err != nil {
t.Fatalf("insert artist: %v", err)
}
if err := sync.LogChange(ctx, tx, sync.EntityArtist, artistID, sync.OpUpsert); err != nil {
t.Fatalf("LogChange: %v", err)
}
if err := tx.Commit(ctx); err != nil {
t.Fatalf("commit: %v", err)
}
w := callLibrarySync(h, u, "0")
if w.Code != http.StatusOK {
t.Fatalf("status = %d body = %s", w.Code, w.Body.String())
}
var body struct {
Cursor int64 `json:"cursor"`
Upserts map[string][]json.RawMessage `json:"upserts"`
Deletes map[string][]string `json:"deletes"`
}
if err := json.NewDecoder(w.Body).Decode(&body); err != nil {
t.Fatalf("decode: %v", err)
}
if body.Cursor <= 0 {
t.Fatalf("expected positive cursor, got %d", body.Cursor)
}
if len(body.Upserts["artist"]) != 1 {
t.Fatalf("expected 1 artist upsert, got %d", len(body.Upserts["artist"]))
}
}
func TestLibrarySync_CursorMonotonic(t *testing.T) {
h, pool := testHandlers(t)
truncateLibrary(t, pool)
u := seedUser(t, pool, "alice", "x", false)
ctx := context.Background()
tx, _ := pool.Begin(ctx)
var artistID string
_ = tx.QueryRow(ctx,
`INSERT INTO artists (name, sort_name) VALUES ($1, $2) RETURNING id::text`,
"A", "A",
).Scan(&artistID)
_ = sync.LogChange(ctx, tx, sync.EntityArtist, artistID, sync.OpUpsert)
_ = tx.Commit(ctx)
w1 := callLibrarySync(h, u, "0")
if w1.Code != http.StatusOK {
t.Fatalf("first call status = %d", w1.Code)
}
var body1 struct {
Cursor int64 `json:"cursor"`
}
if err := json.NewDecoder(w1.Body).Decode(&body1); err != nil {
t.Fatalf("decode: %v", err)
}
w2 := callLibrarySync(h, u, strconv.FormatInt(body1.Cursor, 10))
if w2.Code != http.StatusNoContent {
t.Fatalf("second call status = %d body = %s", w2.Code, w2.Body.String())
}
}
func TestLibrarySync_DeleteIsReflected(t *testing.T) {
h, pool := testHandlers(t)
truncateLibrary(t, pool)
u := seedUser(t, pool, "alice", "x", false)
// Just write a delete change row directly (no underlying mutation).
// Library writes couple real deletes to LogChange; here we test the
// handler reflects what's in the log.
ctx := context.Background()
tx, _ := pool.Begin(ctx)
_ = sync.LogChange(ctx, tx, sync.EntityArtist, "deadbeef-dead-beef-dead-beefdeadbeef", sync.OpDelete)
_ = tx.Commit(ctx)
w := callLibrarySync(h, u, "0")
if w.Code != http.StatusOK {
t.Fatalf("status = %d body = %s", w.Code, w.Body.String())
}
var body struct {
Cursor int64 `json:"cursor"`
Upserts map[string][]json.RawMessage `json:"upserts"`
Deletes map[string][]string `json:"deletes"`
}
if err := json.NewDecoder(w.Body).Decode(&body); err != nil {
t.Fatalf("decode: %v", err)
}
if got := body.Deletes["artist"]; len(got) != 1 || got[0] != "deadbeef-dead-beef-dead-beefdeadbeef" {
t.Fatalf("expected one artist delete; got %#v", body.Deletes)
}
}
func TestLibrarySync_LikeRowScopedToUser(t *testing.T) {
h, pool := testHandlers(t)
truncateLibrary(t, pool)
u := seedUser(t, pool, "alice", "x", false)
other := seedUser(t, pool, "bob", "x", false)
// Two like_track rows: one for u, one for other. u's call should
// see only their own row.
ctx := context.Background()
tx, _ := pool.Begin(ctx)
_ = sync.LogChange(ctx, tx, sync.EntityLikeTrack,
sync.EncodeLikeID(sync.FormatUUID(u.ID), "11111111-1111-1111-1111-111111111111"),
sync.OpUpsert)
_ = sync.LogChange(ctx, tx, sync.EntityLikeTrack,
sync.EncodeLikeID(sync.FormatUUID(other.ID), "22222222-2222-2222-2222-222222222222"),
sync.OpUpsert)
_ = tx.Commit(ctx)
w := callLibrarySync(h, u, "0")
if w.Code != http.StatusOK {
t.Fatalf("status = %d body = %s", w.Code, w.Body.String())
}
var body struct {
Upserts map[string][]json.RawMessage `json:"upserts"`
}
if err := json.NewDecoder(w.Body).Decode(&body); err != nil {
t.Fatalf("decode: %v", err)
}
got := body.Upserts["like_track"]
if len(got) != 1 {
t.Fatalf("expected 1 like row scoped to alice, got %d", len(got))
}
}
// Pure unit tests below — run even with -short.
func TestSplitOnce(t *testing.T) {
cases := []struct {
in, sep string
want []string
}{
{"a:b", ":", []string{"a", "b"}},
{"a:b:c", ":", []string{"a", "b:c"}},
{"abc", ":", []string{"abc"}},
{":x", ":", []string{"", "x"}},
}
for _, c := range cases {
got := splitOnce(c.in, c.sep)
if len(got) != len(c.want) {
t.Errorf("splitOnce(%q,%q): len got=%d want=%d", c.in, c.sep, len(got), len(c.want))
continue
}
for i := range got {
if got[i] != c.want[i] {
t.Errorf("splitOnce(%q,%q)[%d] = %q want %q", c.in, c.sep, i, got[i], c.want[i])
}
}
}
}
// A server restored from an older backup has handed out fewer cursors than an
// app remembers; the app is told to reset rather than wait for ids it would
// then skip. A compacted log is not that: the cursor the server handed out
// still counts.
func TestLibrarySync_ACursorPastTheServersLastChangeIsReset(t *testing.T) {
h, pool := testHandlers(t)
truncateLibrary(t, pool)
u := seedUser(t, pool, "alice", "x", false)
ctx := context.Background()
var artistID string
if err := pool.QueryRow(ctx,
`INSERT INTO artists (name, sort_name) VALUES ('A', 'A') RETURNING id::text`).Scan(&artistID); err != nil {
t.Fatal(err)
}
tx, err := pool.Begin(ctx)
if err != nil {
t.Fatal(err)
}
if err := sync.LogChange(ctx, tx, sync.EntityArtist, artistID, sync.OpUpsert); err != nil {
t.Fatal(err)
}
if err := tx.Commit(ctx); err != nil {
t.Fatal(err)
}
var last int64
if err := pool.QueryRow(ctx, `SELECT max(id) FROM library_changes`).Scan(&last); err != nil {
t.Fatal(err)
}
w := callLibrarySync(h, u, strconv.FormatInt(last+50, 10))
if w.Code != http.StatusGone || !strings.Contains(w.Body.String(), "cursor_ahead") {
t.Errorf("a cursor past the last change: status = %d body = %s, want 410 cursor_ahead", w.Code, w.Body.String())
}
// The compactor trims every row; the app's cursor is still one this
// server handed out.
if _, err := pool.Exec(ctx, `DELETE FROM library_changes`); err != nil {
t.Fatal(err)
}
if w := callLibrarySync(h, u, strconv.FormatInt(last, 10)); w.Code != http.StatusNoContent {
t.Errorf("the last cursor after compaction: status = %d body = %s, want 204", w.Code, w.Body.String())
}
}