mirror of
https://github.com/got-feedBack/feedBack.git
synced 2026-07-25 22:31:48 +00:00
* v3 library: multi-chart work grouping engine + work-charts API — P5a/P5b
Charts of the same song (same normalized artist+title) now GROUP under a
computed work_key, with a materialized representative filter so the grid
can collapse them without breaking keyset paging:
- work_key = normalize(artist+title) (diacritics/punct/case folded,
leading "The" folded on artist); resolves the effective artist via the
artist_alias table when present (feature-detected, no hard dep).
- Sparse, never-purged-on-rescan tables: chart_group_pref(work_key,
preferred_filename) + chart_group_split(filename, split_key); purged
only by the explicit per-song delete.
- Materialized work_display(filename, work_key, effective_work_key,
is_group_representative, group_size) read-model: lazy rebuild via a
dirty flag set on put/delete; set_chart_preferred does an incremental
re-flip (no full rebuild). Auto-pick representative = most
arrangements -> most plays -> newest -> filename; a user pref wins and
degrades to auto-pick if its file disappears.
- group=1 on query_page/query_stats = one extra representative
predicate applied identically to page + total + sort_letters, so the
keyset cursor (sort_value, filename) stays a valid total order and
counts works, not charts. Grouped rows carry chart_count + work_key.
- Charts API: GET /api/work/{work_key}/charts (members + which is the
keeper, your pick vs auto), PUT/DELETE .../preferred, and
POST /api/chart/{filename}/split + /unsplit (under /api/chart so the
DELETE /api/song catch-all can't shadow them).
Tests: 15 grouping-engine + 7 charts-API tests, including grouped
keyset pagination (no skip/dupe across pages).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Nm7tHs1Yvjjtnnu4nzJgdN
* v3 library: grouped grid card + persistent "N charts" chip — P5c
Flip the v3 grid to the grouped library (group=1 on /api/library and the
rail's /api/library/stats fetch): one card per song, showing the
representative (preferred/auto-pick) chart. group rides page, total and
sort_letters identically so the A-Z rail's cumulative-seek math and the
virtualized sizer stay consistent, counting works not charts; the keyset
cursor chains with group on every page.
- New groupingActive() helper, default ON per the design; the persisted
per-view toggle (P5e) lands there. Only the local provider implements
group=; smart collections and remote providers ignore it and stay
flat, so it is safe to send unconditionally.
- chartsChipHtml(): a "flag N charts" chip rendered ONLY when
chart_count >= 2 - single-chart cards emit byte-identical markup.
First in the fixed-height chip row + shrink-0 so it never clips and
card height is unchanged.
- Chip click = feature-detected window.__fbOpenChartsDrawer (the Charts
drawer arrives in P5d); until then a no-op. Plain-click / play / the
arrangement chips are untouched and play the representative.
- The library-home repertoire meter's stats fetch deliberately stays
ungrouped: its mastered numerator counts chart filenames, so a works
denominator could exceed 100% - reconciling that is P5e's
mastery-anchor work. The tree view stays flat (query_artists has no
grouping; its opener is wired in P5d).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Nm7tHs1Yvjjtnnu4nzJgdN
* v3 library: Charts drawer + openers — P5d
The single deep-management surface for a work's charts (design UX-2/3):
a body-appended slide-in drawer (filter-drawer idiom) listing every
chart of the work as a radiogroup — the checked row is the keeper the
grid card plays.
- Rows show format / tuning / arrangements / year / your accuracy (or
"not played") plus the pack filename, usually the only human-readable
distinguisher between duplicate charts. Keeper is labeled
"Preferred (auto)" vs "Preferred - your pick".
- Row click (or Enter/Space) = one-tap Set-preferred; "Reset to auto
pick" appears when the keeper is an explicit pick. Writes go through
the work-charts API and the drawer re-renders from the response; the
grid re-fetches in place since the representative may have flipped.
- Per-row Play (plays that exact chart) and Add-to-playlist (the picker
is z-[200], layering over the z-50 drawer).
- a11y: Tab focus-trap, Escape closes, ArrowUp/Down move focus between
rows (focus only - arrow-select would fire a preferred write per
keystroke), focus restored to the opener on close.
- Openers: the "N charts" chip opens the drawer directly; the card's
overflow menu gains "Charts (N)..." and "Play version >" (expands
inline; picking one plays it as a one-off - the keeper/headline does
not move). Tree rows ride the ungrouped artists endpoint, so the menu
resolves their work lazily via the new GET /api/chart/{fn}/work
({work_key, chart_count}) and slots a "Charts (N)..." entry in when
versions exist. A window.__fbOpenChartsDrawer global lets other views
open the drawer. Right-click is deferred: the open native card
context-menu PR should host that entry once both merge.
- tailwind.min.css rebuilt: carries the new utility classes from this
and the previous commit (the grouped-card chip tint was missing).
Split keys contain '#', so clients MUST URL-encode work_key in paths
(the v3 client does; a test documents the round-trip). 4 new endpoint
tests; 26/26 grouping+charts tests green.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Nm7tHs1Yvjjtnnu4nzJgdN
* v3 library: group toggle, split UI, the filter law + mastery-anchor rules — P5e
Completes the multi-chart grouping slice (design 7.1):
- Filter law under group=1: work-identity (artist/album/search) and
practice-state (favorites/mastery/tags/difficulty) predicates stay on
the representative row, while CHART-INTRINSIC predicates (format/
arrangements/stems/lyrics/tuning) now match if ANY member of the work
does - a song you own in Drop D is no longer hidden because your
preferred chart is E Standard. Intrinsic clauses moved to an
alias-aware builder and re-applied as a member EXISTS; identical in
query_page and query_stats so counts and the A-Z rail stay in
lockstep. A pure predicate - keyset paging is untouched (tested).
- Display-chart switch: when the representative itself doesn't match,
the row carries a display_chart override (the matching member). The
row stays the representative's - swapping rows wholesale would break
the (sort_value, filename) cursor - and the card renders/plays the
member while the accuracy badge and heart stay anchored on the
preferred chart.
- Mastery sort aggregates MAX across the group ("a song surfaces on any
chart you've touched"); OFFSET-paged, so cursor-safe. The
Recently-Added aggregate is deliberately deferred: mtime IS a keyset
sort, so its aggregate would need materializing into work_display.
- History-sticky auto-pick: most-played -> most-complete -> newest.
A newer/"more complete" import can't silently take the pick from the
chart your reps accrued on, and a one-off try of an alternate can't
out-rank a practiced incumbent; all-unplayed groups still pick by
completeness.
- Persisted "One card per song" toggle in the filter drawer (default
ON; OFF = one card per chart). A view mode: never counted in the
filter badge, never saved into collection rules, local provider only.
- Split escape hatch: "Split out" per drawer row gives a chart its own
card; the split card's overflow menu offers "Rejoin other versions"
(rows and the chart-work lookup now carry is_split).
- Mastery-anchor heads-up: after set-preferred the drawer shows a
one-line ambient note that practice history stays with each chart
(no toast - hearing-safe).
10 new filter-law tests; 38/38 grouping tests green. tailwind.min.css
rebuilt for the new utility classes.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Nm7tHs1Yvjjtnnu4nzJgdN
* fix(v3): work-grouping — escape Charts-drawer meta (XSS), keep non-Latin titles distinct, guard mid-rebuild reads (PR #702 review)
- XSS: esc() the composed `meta` string in _chartRowHtml (arrangement/tuning
names come from untrusted feedpak metadata) before innerHTML; acc stays HTML.
- Non-Latin titles: _norm_token falls back to raw lowercased whitespace-collapsed
text when the NFKD+strip fold yields "" (CJK/Cyrillic/Greek/Arabic), so distinct
non-Latin titles keep distinct _work_key values instead of collapsing into one
bogus work. Latin names still hit the folded branch — behavior unchanged.
- Mid-rebuild reads: wrap the grouped representative SELECT in query_page and
query_stats under self._lock (nullcontext when ungrouped, so lazy reads stay
lock-free) so a reader can't observe work_display between rebuild_work_display's
DELETE and INSERT/commit. _ensure_work_display stays OUTSIDE the lock — it
self-locks the rebuild and self._lock is non-reentrant — so only the SELECT is
guarded (rebuild fully completes before the guarded SELECT runs).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: byrongamatos <xasiklas@gmail.com>
165 lines
7.3 KiB
Python
165 lines
7.3 KiB
Python
"""Tests for the multi-chart work API (P5b): GET /api/work/{work_key}/charts +
|
|
PUT/DELETE …/preferred + POST /api/chart/{filename}/split|unsplit. HTTP surface
|
|
over the P5a grouping engine (what the P5d Charts drawer consumes)."""
|
|
|
|
import importlib
|
|
import sys
|
|
|
|
import pytest
|
|
from fastapi.testclient import TestClient
|
|
|
|
|
|
@pytest.fixture()
|
|
def server(tmp_path, monkeypatch, isolate_logging):
|
|
monkeypatch.setenv("CONFIG_DIR", str(tmp_path))
|
|
monkeypatch.setenv("FEEDBACK_SKIP_STARTUP_TASKS", "1")
|
|
sys.modules.pop("server", None)
|
|
srv = importlib.import_module("server")
|
|
try:
|
|
yield srv
|
|
finally:
|
|
conn = getattr(getattr(srv, "meta_db", None), "conn", None)
|
|
if conn is not None:
|
|
conn.close()
|
|
sys.modules.pop("server", None)
|
|
|
|
|
|
@pytest.fixture()
|
|
def client(server):
|
|
return TestClient(server.app)
|
|
|
|
|
|
def _put(server, fn, title, artist, arrangements=1):
|
|
arr = [{"name": "Lead", "index": i} for i in range(arrangements)]
|
|
server.meta_db.put(fn, 0, 0, {"title": title, "artist": artist, "arrangements": arr})
|
|
|
|
|
|
def _wk(server, fn):
|
|
return server.meta_db.work_key_for(fn)
|
|
|
|
|
|
def _rep(body):
|
|
return next(c for c in body["charts"] if c["is_representative"])
|
|
|
|
|
|
# ── grouped grid row carries work_key (so the drawer can address it) ─────────
|
|
|
|
def test_grouped_row_exposes_work_key(client, server):
|
|
_put(server, "a.archive", "Song", "Artist")
|
|
_put(server, "b.archive", "Song", "Artist")
|
|
row = client.get("/api/library", params={"group": 1}).json()["songs"][0]
|
|
assert row["work_key"] == _wk(server, "a.archive")
|
|
assert row["chart_count"] == 2
|
|
|
|
|
|
# ── GET charts ───────────────────────────────────────────────────────────────
|
|
|
|
def test_get_work_charts(client, server):
|
|
_put(server, "a.archive", "Song", "Artist", arrangements=2)
|
|
_put(server, "b.archive", "Song", "Artist", arrangements=1)
|
|
body = client.get(f"/api/work/{_wk(server, 'a.archive')}/charts").json()
|
|
assert body["count"] == 2
|
|
assert {c["filename"] for c in body["charts"]} == {"a.archive", "b.archive"}
|
|
assert _rep(body)["filename"] == "a.archive" # auto-pick = most arrangements
|
|
assert body["preferred_source"] == "auto"
|
|
assert body["preferred_filename"] is None
|
|
|
|
|
|
def test_charts_include_best_accuracy(client, server):
|
|
_put(server, "a.archive", "Song", "Artist")
|
|
_put(server, "b.archive", "Song", "Artist")
|
|
server.meta_db.record_session("a.archive", 0, score=900, accuracy=0.9)
|
|
charts = {c["filename"]: c for c in
|
|
client.get(f"/api/work/{_wk(server, 'a.archive')}/charts").json()["charts"]}
|
|
assert charts["a.archive"]["best_accuracy"] == 0.9
|
|
assert charts["b.archive"]["best_accuracy"] is None
|
|
|
|
|
|
# ── PUT / DELETE preferred ───────────────────────────────────────────────────
|
|
|
|
def test_set_preferred(client, server):
|
|
_put(server, "a.archive", "Song", "Artist", arrangements=2)
|
|
_put(server, "b.archive", "Song", "Artist", arrangements=1)
|
|
wk = _wk(server, "a.archive")
|
|
body = client.put(f"/api/work/{wk}/preferred", json={"filename": "b.archive"}).json()
|
|
assert body["preferred_filename"] == "b.archive" and body["preferred_source"] == "user"
|
|
assert _rep(body)["filename"] == "b.archive" and _rep(body)["is_preferred"]
|
|
# the grouped grid now shows b as the work's card
|
|
assert client.get("/api/library", params={"group": 1}).json()["songs"][0]["filename"] == "b.archive"
|
|
|
|
|
|
def test_set_preferred_nonmember_is_400(client, server):
|
|
_put(server, "a.archive", "Song", "Artist")
|
|
_put(server, "x.archive", "Other", "Artist")
|
|
wk = _wk(server, "a.archive")
|
|
assert client.put(f"/api/work/{wk}/preferred", json={"filename": "x.archive"}).status_code == 400
|
|
assert client.put(f"/api/work/{wk}/preferred", json={}).status_code == 400
|
|
|
|
|
|
def test_reset_preferred_returns_to_auto(client, server):
|
|
_put(server, "a.archive", "Song", "Artist", arrangements=2)
|
|
_put(server, "b.archive", "Song", "Artist", arrangements=1)
|
|
wk = _wk(server, "a.archive")
|
|
client.put(f"/api/work/{wk}/preferred", json={"filename": "b.archive"})
|
|
body = client.delete(f"/api/work/{wk}/preferred").json()
|
|
assert body["preferred_source"] == "auto"
|
|
assert _rep(body)["filename"] == "a.archive" # auto-pick again
|
|
|
|
|
|
# ── split / unsplit ──────────────────────────────────────────────────────────
|
|
|
|
def test_split_and_unsplit_endpoints(client, server):
|
|
_put(server, "a.archive", "Song", "Artist")
|
|
_put(server, "b.archive", "Song", "Artist")
|
|
wk = _wk(server, "a.archive")
|
|
assert client.get(f"/api/work/{wk}/charts").json()["count"] == 2
|
|
assert client.post("/api/chart/b.archive/split").json()["ok"] is True
|
|
assert {c["filename"] for c in client.get(f"/api/work/{wk}/charts").json()["charts"]} == {"a.archive"}
|
|
assert client.get("/api/library", params={"group": 1}).json()["total"] == 2 # two works now
|
|
assert client.post("/api/chart/b.archive/unsplit").json()["ok"] is True
|
|
assert client.get(f"/api/work/{wk}/charts").json()["count"] == 2 # rejoined
|
|
|
|
|
|
# ── GET chart work membership (P5d — tree/ungrouped opener resolve) ──────────
|
|
|
|
def test_chart_work_grouped_pair(client, server):
|
|
_put(server, "a.archive", "Song", "Artist")
|
|
_put(server, "b.archive", "Song", "Artist")
|
|
wk = _wk(server, "a.archive")
|
|
for fn in ("a.archive", "b.archive"):
|
|
body = client.get(f"/api/chart/{fn}/work").json()
|
|
assert body == {"filename": fn, "work_key": wk, "chart_count": 2,
|
|
"is_split": False}
|
|
|
|
|
|
def test_chart_work_singleton(client, server):
|
|
_put(server, "a.archive", "Song", "Artist")
|
|
body = client.get("/api/chart/a.archive/work").json()
|
|
assert body["work_key"] == _wk(server, "a.archive")
|
|
assert body["chart_count"] == 1
|
|
|
|
|
|
def test_chart_work_split_resolves_to_singleton_key(client, server):
|
|
_put(server, "a.archive", "Song", "Artist")
|
|
_put(server, "b.archive", "Song", "Artist")
|
|
wk = _wk(server, "a.archive")
|
|
client.post("/api/chart/b.archive/split")
|
|
body = client.get("/api/chart/b.archive/work").json()
|
|
# the split chart stands alone under its EFFECTIVE (split) key…
|
|
assert body["work_key"] != wk and body["chart_count"] == 1
|
|
# …and its key round-trips into the charts endpoint as its own work.
|
|
# Split keys contain '#' — clients MUST URL-encode the work_key in the
|
|
# path (the v3 client encodeURIComponent's it) or the '#' truncates the
|
|
# URL as a fragment.
|
|
from urllib.parse import quote
|
|
charts = client.get(f"/api/work/{quote(body['work_key'], safe='')}/charts").json()
|
|
assert [c["filename"] for c in charts["charts"]] == ["b.archive"]
|
|
# the chart left behind is a singleton too
|
|
assert client.get("/api/chart/a.archive/work").json()["chart_count"] == 1
|
|
|
|
|
|
def test_chart_work_unknown_file(client, server):
|
|
_put(server, "a.archive", "Song", "Artist")
|
|
body = client.get("/api/chart/nope.archive/work").json()
|
|
assert body["work_key"] is None and body["chart_count"] == 0
|