Files
yellowjacket/backend/library/staleness_test.go
T
yonluandClaude Opus 5 e7748f1fd5
CI / check (push) Successful in 3m7s
CI / e2e (push) Canceled after 1m45s
feat(database): shape the library like files, and shrink the catalog
Plans 013 and 014, the album page that prompted them, and the smaller
fixes they turned up. Changelog, largest first.

## The local library is shaped like files, not like MusicBrainz

`audio_files` carries its own tags and points at `albums` and
`artists`; `file_genres` is the one real many-to-many. `recordings`,
`release_group_recordings`, `artist_credit`, `artist_credit_artist`,
`recording_genres`, `release_groups` and `release_to_rg` are gone from
the local side, and with them a six-way join in every read, a
`MIN(release_group_id)` subquery in eleven queries and a
first-credited-artist subquery in nine. Measured on a real 25,966-file
library, every many-to-many that model expressed was 1:1 in the data.

- Ownership is a file. `GetFilePathsByRecordingMBIDs`,
  `LibraryMBIDIndex.CheckMBIDs`, `collectLibraryEntities` and
  `pruneStaleLocalCrossReferences` all join `audio_files`, so the 812
  orphaned recordings, 216 release groups and 260 artists that library
  carried are now structurally impossible.
- One projection: every track query selects from the `track_metadata`
  view, one row type, one mapper. Nine hand-rolled copies had drifted
  far enough to report different years on different screens.
- `library_id = 0` means every library, so each list query exists once
  instead of scoped and unscoped with a branch at every call site.
- No migration chain. `sql/schemas/` is the one description of the
  shape; `sql/migrations/`, `applyMigrations` and `schema_migrations`
  are squashed away, along with the drift between them that had sqlc
  generating against a stale schema.
- `database.InsertTestTrack` is the one test seeder; twenty test files
  had been assembling the old FK chain each in its own order.

## The catalog stores its ids as bytes

`explore_index`'s three 36-char MBID columns and its entity-type text
are 16 raw bytes and a small integer. The table and its six indexes go
780 MB to 405 MB on a real 2,052,200-row catalog, which is why a fresh
install is ~0.6 GB rather than ~1.0 GB.

- `backend/explore/mbid.go` is the only place the encoding is known;
  everything above it speaks dashed strings.
- `CHECK(length(mbid) = 16)` makes a stringly write fail at the insert
  rather than silently returning no rows, since SQLite does not coerce
  between TEXT and BLOB.
- The importer asks the artifact what encoding it carries and converts
  on the way in, so the artifact already published keeps working and no
  format bump is needed.
- `indexRowColumns`/`scanIndexRow` replace four copies of a 22-column
  list, and `TestStoredEncodingRoundTrips` sweeps every read path.

## An album page that says how much of the album is yours

- One question, asked once: is there a file. `filePaths` is filled by a
  single batched lookup when the tracklist settles, and the badge, the
  Play count, the dimmed rows and every menu item read it — replacing
  four claims of decreasing confidence that could show a green tick on
  an album whose every action did nothing.
- Play, Play 7 of 12, or no play button at all.
- `total_tracks` on `explore_index` (~2 bytes over 400,677 release
  groups) and on `audio_files` from tags that have always carried it:
  a complete MBID-matched album now makes no catalog call at all, where
  it used to spend the most expensive request the app makes.
- A merged cluster shows the running order the most releases agree on,
  and the version list marks the release you own rather than standing a
  synthetic entry in for it.
- `AlbumReleasesFailed`: a slow fetch is no longer reported as a failed
  one by a 12-second timer.
- Rows not in the library are dimmed in place (with `aria-disabled`)
  instead of the owned ones wearing a green tick and a legend.

## Caches and cover art get ceilings

- Only the three tiers of a cover are stored; the full-resolution copy
  nothing rendered was 1,134 MB of a 1.4 GB covers directory.
- One artist portrait is downloaded and the rest are remembered as
  URLs — 4.1 GB of a 5.3 GB cache was candidates no code path reads.
- `browsedArtBudget` and `httpCacheBudget` bound what an age cannot:
  the same install held art for 5,770 artists in a 1,301-artist
  library.
- `OrphanedArtistImagesJob` joined a bare MBID onto a sharded
  directory, so it deleted the rows that were the only record of the
  files it left behind. `explore.ArtistImageDir` is that layout's one
  definition now.

## The autotag queue asks whether there is work

`tagging_items` was a row per album folder, not a queue, and no query
read the `tag_status` column that held the answer. The four queue
queries ask the files, which matters most where it is least visible:
`startPrefetch` was scoring every album in a tagged library against
MusicBrainz.

## Phantom playlist tracks resolve in place

An M3U8 imported before its files leaves phantom rows; they now match
by path and fall back to position, keep their place in the playlist
when resolved, and pair best-first so two phantoms cannot claim the
same file.

## Playing a track plays the list it is in

Double-click, and Play on a single row's menu, queue the list as
displayed with `startIndex` on that row — the album page and the track
list used to queue one track and discard the album around it. A
multi-row selection still plays exactly itself.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AfVYUVExXsx1nSWrXN8mAh
2026-08-16 13:58:15 -04:00

275 lines
6.7 KiB
Go

package library
import (
"os"
"path/filepath"
"testing"
"time"
"yellowjacket/backend/database"
"yellowjacket/backend/database/sql/sqlcgen"
)
// ---------------------------------------------------------------------------
// fileContentChanged — the staleness predicate
// ---------------------------------------------------------------------------
func TestFileContentChanged(t *testing.T) {
t.Parallel()
const (
baseMod int64 = 1700000000
baseSize int64 = 5_000_000
)
tests := []struct {
name string
recordedMod int64
recordedSz int64
diskMod int64
diskSz int64
want bool
}{
{
name: "unchanged file",
recordedMod: baseMod,
recordedSz: baseSize,
diskMod: baseMod,
diskSz: baseSize,
want: false,
},
{
name: "retagged in place, mtime bumped and size grew",
recordedMod: baseMod,
recordedSz: baseSize,
diskMod: baseMod + 60,
diskSz: baseSize + 2048,
want: true,
},
{
name: "mtime bumped, size absorbed by tag padding",
recordedMod: baseMod,
recordedSz: baseSize,
diskMod: baseMod + 60,
diskSz: baseSize,
want: true,
},
{
name: "size changed but mtime preserved by the writer",
recordedMod: baseMod,
recordedSz: baseSize,
diskMod: baseMod,
diskSz: baseSize + 2048,
want: true,
},
{
name: "no recorded baseline is never stale",
recordedMod: 0,
recordedSz: baseSize,
diskMod: baseMod,
diskSz: baseSize + 4096,
want: false,
},
{
name: "failed stat is never stale",
recordedMod: baseMod,
recordedSz: baseSize,
diskMod: 0,
diskSz: 0,
want: false,
},
{
name: "file replaced with an older copy",
recordedMod: baseMod,
recordedSz: baseSize,
diskMod: baseMod - 3600,
diskSz: baseSize,
want: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
af := sqlcgen.AudioFile{
ModifiedAt: tt.recordedMod,
FileSize: tt.recordedSz,
}
got := fileContentChanged(af, tt.diskMod, tt.diskSz)
if got != tt.want {
t.Errorf(
"fileContentChanged() = %v, want %v",
got, tt.want,
)
}
})
}
}
// ---------------------------------------------------------------------------
// surveyAudioFiles — soft scan change signal
// ---------------------------------------------------------------------------
func TestSurveyAudioFiles(t *testing.T) {
t.Parallel()
dir := t.TempDir()
// Two audio files plus one unsupported file that must be ignored.
writeFile(t, filepath.Join(dir, "a.mp3"), 1024)
writeFile(t, filepath.Join(dir, "nested", "b.flac"), 2048)
writeFile(t, filepath.Join(dir, "cover.jpg"), 512)
older := time.Now().Add(-48 * time.Hour)
newer := time.Now().Add(-1 * time.Hour)
setModTime(t, filepath.Join(dir, "a.mp3"), older)
setModTime(t, filepath.Join(dir, "nested", "b.flac"), newer)
// The ignored file is the newest on disk — it must not influence
// the result, or every artwork change would trigger a rescan.
setModTime(t, filepath.Join(dir, "cover.jpg"), time.Now())
count, maxMod := surveyAudioFiles(dir, nil)
if count != 2 {
t.Errorf("count = %d, want 2", count)
}
if maxMod != newer.Unix() {
t.Errorf("maxModTime = %d, want %d", maxMod, newer.Unix())
}
// Retagging the older file in place makes it the newest, which is
// what the soft scan compares against the database.
touched := time.Now()
setModTime(t, filepath.Join(dir, "a.mp3"), touched)
_, afterMod := surveyAudioFiles(dir, nil)
if afterMod != touched.Unix() {
t.Errorf(
"maxModTime after touch = %d, want %d",
afterMod, touched.Unix(),
)
}
}
func TestSurveyAudioFiles_EmptyDir(t *testing.T) {
t.Parallel()
count, maxMod := surveyAudioFiles(t.TempDir(), nil)
if count != 0 || maxMod != 0 {
t.Errorf(
"surveyAudioFiles(empty) = (%d, %d), want (0, 0)",
count, maxMod,
)
}
}
// ---------------------------------------------------------------------------
// flushStatBackfill — baseline backfill for pre-migration rows
// ---------------------------------------------------------------------------
func TestFlushStatBackfill(t *testing.T) {
t.Parallel()
lib, db := setupTestLibrary(t)
ctx := lib.ctx
q := db.Queries
// Seed two rows with no staleness baseline, as an older install
// leaves them.
first := database.InsertTestTrack(t, db, database.TestTrack{
FilePath: "/music/first.mp3",
Title: "Test Song",
Artist: "Test Artist",
LengthMs: 180000,
})
second := database.InsertTestTrack(t, db, database.TestTrack{
FilePath: "/music/second.mp3",
Title: "Test Song",
Artist: "Test Artist",
LengthMs: 200000,
})
seeded, err := q.GetAudioFile(ctx, first)
if err != nil {
t.Fatalf("get seeded file: %v", err)
}
if seeded.ModifiedAt != 0 {
t.Fatalf("seeded ModifiedAt = %d, want 0", seeded.ModifiedAt)
}
lib.flushStatBackfill([]sqlcgen.UpdateAudioFileStatParams{
{ModifiedAt: 1700000000, FileSize: 4096, ID: first},
{ModifiedAt: 1700000500, FileSize: 8192, ID: second},
})
got, err := q.GetAudioFile(ctx, first)
if err != nil {
t.Fatalf("get first audio file: %v", err)
}
if got.ModifiedAt != 1700000000 || got.FileSize != 4096 {
t.Errorf(
"first row = (mtime %d, size %d), want (1700000000, 4096)",
got.ModifiedAt, got.FileSize,
)
}
// A backfilled row now has a baseline, so the same file on disk is
// no longer treated as stale.
if fileContentChanged(got, 1700000000, 4096) {
t.Error("backfilled row reported stale against identical stat")
}
// The backfill must not disturb unrelated columns.
if got.LengthMilliseconds != 180000 {
t.Errorf(
"LengthMilliseconds = %d, want 180000 (backfill overwrote it)",
got.LengthMilliseconds,
)
}
if got.FilePath != "/music/first.mp3" {
t.Errorf("FilePath = %q, want /music/first.mp3", got.FilePath)
}
}
func TestFlushStatBackfill_Empty(t *testing.T) {
t.Parallel()
lib, _ := setupTestLibrary(t)
// Must be a no-op rather than opening an empty transaction.
lib.flushStatBackfill(nil)
}
// ---------------------------------------------------------------------------
// helpers
// ---------------------------------------------------------------------------
func writeFile(t *testing.T, path string, size int) {
t.Helper()
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
t.Fatalf("mkdir %s: %v", filepath.Dir(path), err)
}
if err := os.WriteFile(path, make([]byte, size), 0o600); err != nil {
t.Fatalf("write %s: %v", path, err)
}
}
func setModTime(t *testing.T, path string, mt time.Time) {
t.Helper()
if err := os.Chtimes(path, mt, mt); err != nil {
t.Fatalf("chtimes %s: %v", path, err)
}
}