Files
feedBack/plugins/achievements/routes.py
T
05dd3d227a feat(achievements): local engine + tabbed Profile shell (epic PR1) (#587)
Adds the Achievements & Feats of Power local engine, fully offline.

Core (static/v3/profile.js): the Profile screen becomes tabbed exactly
like v3 Settings (.fb-tabbar/.fb-tab/.fb-tabpanel, active tab persisted in
localStorage 'v3-profile-tab'). A Profile (main) tab carries the existing
cards + a Feats trophy-shelf mount (#v3-profile-feats-slot, earned-only),
and an Achievements tab carries a plugin mount
(#v3-profile-achievements-mount) + empty-state note. A new
`v3:profile-rendered` event fires after every render so the plugin
re-injects (mirrors v3:settings-rendered).

New bundled plugin (plugins/achievements/): SQLite engine
(unlocks/counters/comp_ledger/sync_queue) with pure threshold/criterion
math in the testable sibling engine.py (P-V); routes activity/
report-unlock/report-criterion/catalog/earned/feats/remove-me. Feats read
activity counters only (batched song:ended POST; notes only when notedetect
present — graceful degradation); competency Achievements evaluate from
progression events only — the integration law, never crossed. Catalogue is
always shown (locked=greyed), grouped by the real progression paths
(Global/Guitar/Bass/Drums/Keys, auto-extending) with per-category earned
badges. Versioned window.feedBack.achievements registration API with the
__feedBackAchievementsPending load-order queue + achievements:ready event.

Verified natively (uvicorn) end-to-end + Playwright (tabbar, earned-only
Feats shelf, greyed catalogue, registration API, zero console errors);
24 plugin tests pass incl. the integration-law assertion.

Opt-in/privacy/data-min gate (PR2) and the hosted wall (PR3) follow.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-24 16:57:37 +02:00

409 lines
16 KiB
Python

"""Achievements & Feats of Power — local engine (offline).
State lives under ``<config_dir>/achievements/``:
- ``achievements.db`` SQLite — unlocks, activity counters, derived ledger,
and the (PR3) wall sync queue.
Two surfaces, one engine, kept structurally apart (the **integration law**):
* **Feats of Power** — activity/volume. The engine OWNS raw activity counters
(`counters`), evaluates Feat thresholds, and records Feat unlocks. Feats are
the only thing that ever syncs to the public wall.
* **Achievements** — demonstrated competency. The engine RECORDS unlocks the
source reports (`report-unlock`); it never re-derives them from activity.
A baseline catalogue ships here and is driven by the built-in progression
system; richer items are contributed by source plugins at runtime.
Endpoints (all under /api/plugins/achievements/):
POST /activity bump activity counters, eval Feats, return newly-unlocked
POST /report-unlock idempotent upsert of a competency/feat unlock
POST /report-criterion record a (criterion_id, token) pair → distinct count
GET /catalog baseline competency defs + earned state
GET /earned all earned items (id, cls, category, tier, at)
GET /feats earned Feats (for the profile trophy shelf)
POST /remove-me wipe synced state (full wall-removal lands in PR2/PR3)
Pure threshold/criterion math lives in the sibling ``engine.py`` (P-V testable);
this module is the SQLite + HTTP shell.
"""
import json
import logging
import sqlite3
import threading
import time
from pathlib import Path
from fastapi import HTTPException
from pydantic import BaseModel, Field
_lock = threading.Lock()
_state = {
"db_path": None,
"dir": None, # plugin directory (for catalog JSON)
"log": logging.getLogger("feedBack.plugin.achievements"),
"engine": None, # sibling engine.py module (pure helpers)
"feat_defs": [], # parsed feats.json -> list of feat defs
"baseline": {}, # parsed achievements.json
}
# ── SQLite ──────────────────────────────────────────────────────────────────
def _conn():
conn = sqlite3.connect(_state["db_path"], timeout=5)
conn.row_factory = sqlite3.Row
conn.execute("PRAGMA journal_mode=WAL")
return conn
def _init_db():
conn = _conn()
try:
conn.execute(
"""
CREATE TABLE IF NOT EXISTS unlocks (
achievement_id TEXT PRIMARY KEY,
cls TEXT NOT NULL, -- 'competency' | 'feat'
disp_category TEXT, -- global/guitar/bass/...
source_id TEXT,
tier INTEGER NOT NULL DEFAULT 0,
unlocked_at TEXT,
synced INTEGER NOT NULL DEFAULT 0
)
"""
)
conn.execute(
"""
CREATE TABLE IF NOT EXISTS counters (
key TEXT PRIMARY KEY,
value INTEGER NOT NULL DEFAULT 0
)
"""
)
conn.execute(
"""
CREATE TABLE IF NOT EXISTS comp_ledger (
criterion_id TEXT NOT NULL,
token TEXT NOT NULL,
PRIMARY KEY (criterion_id, token)
)
"""
)
conn.execute(
"""
CREATE TABLE IF NOT EXISTS sync_queue (
id INTEGER PRIMARY KEY AUTOINCREMENT,
kind TEXT NOT NULL, -- 'unlock' | 'remove'
payload TEXT NOT NULL,
state TEXT NOT NULL DEFAULT 'pending' -- 'pending' | 'dead_letter'
)
"""
)
conn.commit()
finally:
conn.close()
def _now_iso():
return time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime())
def _read_counters(conn):
return {row["key"]: int(row["value"]) for row in conn.execute("SELECT key, value FROM counters")}
def _write_counters(conn, counters):
for key, value in counters.items():
conn.execute(
"INSERT INTO counters(key, value) VALUES (?, ?) "
"ON CONFLICT(key) DO UPDATE SET value=excluded.value",
(key, int(value)),
)
def _bump_counter(conn, key, delta):
"""Increment a counter and return the new value (used for per-chart plays)."""
conn.execute(
"INSERT INTO counters(key, value) VALUES (?, ?) "
"ON CONFLICT(key) DO UPDATE SET value=value+excluded.value",
(key, int(delta)),
)
row = conn.execute("SELECT value FROM counters WHERE key=?", (key,)).fetchone()
return int(row["value"]) if row else int(delta)
def _earned_feat_tiers(conn):
return {
row["achievement_id"]: int(row["tier"])
for row in conn.execute("SELECT achievement_id, tier FROM unlocks WHERE cls='feat'")
}
def _record_unlock(conn, ach_id, cls, disp_category, source_id, tier, at):
"""Idempotent upsert; only advances the tier upward. Returns True if changed."""
row = conn.execute("SELECT tier FROM unlocks WHERE achievement_id=?", (ach_id,)).fetchone()
if row is not None and int(row["tier"]) >= int(tier):
return False
conn.execute(
"""
INSERT INTO unlocks(achievement_id, cls, disp_category, source_id, tier, unlocked_at, synced)
VALUES (?, ?, ?, ?, ?, ?, 0)
ON CONFLICT(achievement_id) DO UPDATE SET
tier=excluded.tier,
cls=excluded.cls,
disp_category=COALESCE(excluded.disp_category, unlocks.disp_category),
source_id=COALESCE(excluded.source_id, unlocks.source_id)
""",
(ach_id, cls, disp_category, source_id, int(tier), at or _now_iso()),
)
return True
# ── Catalog loading ─────────────────────────────────────────────────────────
def _feat_by_id(fid):
for f in _state["feat_defs"]:
if f.get("id") == fid:
return f
return None
def _load_catalogs():
base = Path(_state["dir"])
try:
feats = json.loads((base / "feats.json").read_text(encoding="utf-8"))
_state["feat_defs"] = feats.get("feats", []) if isinstance(feats, dict) else []
except (OSError, ValueError) as e:
_state["log"].warning("achievements: could not load feats.json: %s", e)
_state["feat_defs"] = []
try:
_state["baseline"] = json.loads((base / "achievements.json").read_text(encoding="utf-8"))
except (OSError, ValueError) as e:
_state["log"].warning("achievements: could not load achievements.json: %s", e)
_state["baseline"] = {}
# ── Request models ──────────────────────────────────────────────────────────
class ActivityIn(BaseModel):
notes: int = Field(ge=0, default=0)
session_notes: int = Field(ge=0, default=0)
in_song_streak: int = Field(ge=0, default=0)
song_done: int = Field(ge=0, default=0)
seconds: int = Field(ge=0, default=0)
chart: str | None = None
night_session: bool = False
night_date: str | None = None # 'YYYY-MM-DD', frontend supplies (no server clock)
class UnlockIn(BaseModel):
id: str
kind: str = "achievement" # 'achievement' | 'feat'
category: str | None = None # display category (global/guitar/...)
sourceId: str | None = None
tier: int = Field(ge=0, default=0)
at: str | None = None
class CriterionIn(BaseModel):
criterion_id: str
token: str
# ── FastAPI wiring ──────────────────────────────────────────────────────────
def setup(app, context):
config_dir = context["config_dir"]
base = Path(config_dir) / "achievements"
base.mkdir(parents=True, exist_ok=True)
_state["db_path"] = str(base / "achievements.db")
_state["dir"] = str(Path(__file__).resolve().parent)
_state["log"] = context.get("log") or _state["log"]
# Pure helpers via the per-plugin sibling loader (constitution P-III), with a
# plain-import fallback for pytest / standalone use.
load_sibling = context.get("load_sibling")
try:
_state["engine"] = load_sibling("engine") if load_sibling else __import__("engine")
except Exception: # noqa: BLE001 — last-ditch, keep the plugin alive
import importlib.util
spec = importlib.util.spec_from_file_location(
"achievements_engine", str(Path(__file__).resolve().parent / "engine.py"))
mod = importlib.util.module_from_spec(spec)
spec.loader.exec_module(mod)
_state["engine"] = mod
_init_db()
_load_catalogs()
log = _state["log"]
@app.post("/api/plugins/achievements/activity")
def post_activity(body: ActivityIn):
engine = _state["engine"]
with _lock:
conn = _conn()
try:
# Per-chart play count is the only stateful bit; bump it first so
# apply_activity() stays pure (it just takes the new max).
chart_play_count = None
if body.song_done and body.chart:
chart_key = "chart_plays:" + str(abs(hash(body.chart)))
chart_play_count = _bump_counter(conn, chart_key, 1)
# Night-window ledger → consecutive-night run feeds witching feat.
if body.night_session and body.night_date:
conn.execute(
"INSERT OR IGNORE INTO comp_ledger(criterion_id, token) VALUES ('witching', ?)",
(body.night_date,),
)
nights = [r["token"] for r in conn.execute(
"SELECT token FROM comp_ledger WHERE criterion_id='witching'")]
run = engine.consecutive_run_length(nights)
conn.execute(
"INSERT INTO counters(key, value) VALUES ('witching_nights_run', ?) "
"ON CONFLICT(key) DO UPDATE SET value=excluded.value", (run,))
counters = _read_counters(conn)
prev_tiers = _state["engine"].evaluate_feats(_state["feat_defs"], counters)
new_counters = engine.apply_activity(counters, {
"notes": body.notes,
"session_notes": body.session_notes,
"in_song_streak": body.in_song_streak,
"song_done": body.song_done,
"seconds": body.seconds,
"chart_play_count": chart_play_count,
})
_write_counters(conn, new_counters)
new_tiers = engine.evaluate_feats(_state["feat_defs"], new_counters)
fresh = engine.diff_unlocks(prev_tiers, new_tiers)
unlocked = []
for fid in fresh:
f = _feat_by_id(fid) or {}
tier = new_tiers[fid]
if _record_unlock(conn, fid, "feat", f.get("category"), f.get("sourceId"), tier, _now_iso()):
unlocked.append(_feat_payload(fid, f, tier))
conn.commit()
return {"ok": True, "unlocked": unlocked, "counters": new_counters}
finally:
conn.close()
@app.post("/api/plugins/achievements/report-unlock")
def post_report_unlock(body: UnlockIn):
cls = "feat" if body.kind == "feat" else "competency"
with _lock:
conn = _conn()
try:
changed = _record_unlock(
conn, body.id, cls, body.category, body.sourceId, body.tier, body.at)
conn.commit()
return {"ok": True, "changed": changed, "id": body.id, "tier": body.tier}
finally:
conn.close()
@app.post("/api/plugins/achievements/report-criterion")
def post_report_criterion(body: CriterionIn):
"""Record a distinct (criterion_id, token); return the distinct count.
Lets a baseline subscriber aggregate multi-event criteria (e.g. the set
of distinct days with a real advance → `steady_hands`) without us
re-deriving competency from activity. Bookkeeping over events only.
"""
with _lock:
conn = _conn()
try:
conn.execute(
"INSERT OR IGNORE INTO comp_ledger(criterion_id, token) VALUES (?, ?)",
(body.criterion_id, body.token),
)
row = conn.execute(
"SELECT COUNT(*) AS n FROM comp_ledger WHERE criterion_id=?",
(body.criterion_id,),
).fetchone()
conn.commit()
return {"ok": True, "count": int(row["n"]) if row else 0}
finally:
conn.close()
@app.get("/api/plugins/achievements/catalog")
def get_catalog():
with _lock:
conn = _conn()
try:
earned = _earned_map(conn)
finally:
conn.close()
return {"baseline": _state["baseline"], "earned": earned}
@app.get("/api/plugins/achievements/earned")
def get_earned():
with _lock:
conn = _conn()
try:
return {"earned": list(_earned_map(conn).values())}
finally:
conn.close()
@app.get("/api/plugins/achievements/feats")
def get_feats():
with _lock:
conn = _conn()
try:
rows = conn.execute(
"SELECT achievement_id, tier, unlocked_at FROM unlocks WHERE cls='feat'"
).fetchall()
finally:
conn.close()
out = []
for row in rows:
fid = row["achievement_id"]
f = _feat_by_id(fid) or {}
payload = _feat_payload(fid, f, int(row["tier"]))
payload["unlocked_at"] = row["unlocked_at"]
out.append(payload)
return {"feats": out}
@app.post("/api/plugins/achievements/remove-me")
def post_remove_me():
# Local removal works offline: drop the synced flag so nothing re-syncs,
# and enqueue a wall removal (drained in PR3). The wall identity
# (player_hash) is resolved server-side at drain time, not stored here.
with _lock:
conn = _conn()
try:
conn.execute("UPDATE unlocks SET synced=0 WHERE cls='feat'")
conn.execute(
"INSERT INTO sync_queue(kind, payload, state) VALUES ('remove', '{}', 'pending')")
conn.commit()
return {"ok": True}
finally:
conn.close()
log.info("achievements engine ready (%d feats, baseline v%s)",
len(_state["feat_defs"]), str(_state["baseline"].get("version", "?")))
def _feat_payload(fid, feat, tier):
titles = feat.get("tier_titles") or []
title = titles[tier] if 0 <= tier < len(titles) else feat.get("title", fid)
return {
"id": fid,
"cls": "feat",
"tier": tier,
"title": title,
"description": feat.get("description", ""),
"category": feat.get("category", "global"),
"secret": bool(feat.get("secret", False)),
}
def _earned_map(conn):
out = {}
for row in conn.execute(
"SELECT achievement_id, cls, disp_category, tier, unlocked_at FROM unlocks"
):
out[row["achievement_id"]] = {
"id": row["achievement_id"],
"cls": row["cls"],
"category": row["disp_category"],
"tier": int(row["tier"]),
"unlocked_at": row["unlocked_at"],
}
return out