Plugins dedup + planung: Prüf-API, Verzahnung mit Benachrichtigung und Audit-Log
Plugin dedup: - Öffentliche Prüf-API check_titel(titel, verlag, bgg_id, user) mit strukturiertem PruefErgebnis (Konflikte, Verlagsauswahl, Titel-Empfehlung) - Vier Prüfungen: Verlags-Konflikt, Titel-Varianten (deutsche Version bevorzugt: Umlaut-/Wort-Heuristik + BGG Alternate-Names), Spiel oder Vorgänger bereits besprochen (BGG boardgameexpansion-Relation + rapidfuzz-Fuzzy-Match), Titel in fremder Planungsliste - BGG-Hilfsclient mit Rate-Limit, netzwerkfrei testbar, degradiert defensiv - Eigene Migration (Prüfprotokoll dedup_pruefungen) + Prüfseite /dedup - Fremde Plugin-Tabellen werden nur lesend über die gemeinsame Metadata gelesen — keine Import-Abhängigkeiten zwischen Plugins Plugin planung: - Migration planungsliste: Titel, Verlag, Ausgabe, Rezensent, Status (offen/in_bearbeitung/abgeschlossen), Quelle, Prüf-Befund (JSON) - Beide Eintragswege durch die dedup-Prüfung: Verschiebung aus den Neuheiten (Button „→ Zur Planung“, Neuheit wechselt auf Status planung) und händisches Nachtragen im Formular - Bei Treffern: send_notification an den eintragenden Rezensenten (benachrichtigung-Plugin) + Audit-Log-Eintrag (audit-log-Plugin) - Verlags-Konflikt → Auswahl-Dialog „Welcher Verlag wird geführt?“, Entscheidung wird auditiert - Planungsliste mit Zuordnung, Statuswechsel, Bearbeiten/Löschen; Rezensenten nur eigene Einträge, Admin/Redakteur alle Tests: 45 neue Tests (Heuristik, alle vier Prüfungen mit Fake-BGG-Client, Protokoll, beide Eintragswege mit Stub-gemockten Abhängigkeiten, Rollen, Integration mit echten Plugins) — 141 Tests grün.
This commit is contained in:
106
README.md
106
README.md
@@ -3,7 +3,8 @@
|
||||
**KI-Assistenz für Spielemagazin-Redaktionen** — Multi-User-Webanwendung mit
|
||||
modularer Plugin-Architektur. Lauffähiger Kern mit Plugin-System,
|
||||
Authentifizierung/Rollen und Migrationen; vollständig implementiert sind
|
||||
bisher **Audit-Log**, **Benachrichtigung** und **Neuheiten (BGG-Sync)**.
|
||||
bisher **Audit-Log**, **Benachrichtigung**, **Neuheiten (BGG-Sync)**,
|
||||
**Dedup-Prüfung** und **Planungsliste**.
|
||||
|
||||
## Stack
|
||||
|
||||
@@ -52,6 +53,7 @@ Beim ersten Start wird automatisch ein Admin-Konto angelegt:
|
||||
| `SPIELE_BGG_SYNC_INTERVALL_STUNDEN` | `24` | Intervall des BGG-Syncs in Stunden (min. 1) |
|
||||
| `SPIELE_BGG_SUCHBEGRIFFE` | `brettspiel` | Komma-getrennte Suchbegriffe für den regelmäßigen Sync |
|
||||
| `SPIELE_BGG_MAX_TREFFER_PRO_SUCHE` | `25` | Obergrenze Treffer je Suchbegriff (schont das BGG-Rate-Limit) |
|
||||
| `SPIELE_DEDUP_BGG_AKTIV` | `1` | BGG-Zusatzdaten für die Dedup-Prüfung an (`1`) oder aus (`0`): Alternate-Names und Erweiterungs-Relationen |
|
||||
|
||||
|
||||
## Tests
|
||||
@@ -67,7 +69,12 @@ Audit-Log-Plugin (Logging-Funktion, Migration, Filter, Paginierung,
|
||||
Nur-Admin-Zugriff) sowie das Neuheiten-Plugin: BGG-Parsing, Erweiterungs-/
|
||||
Prototyp-Filter, Rate-Limit & Retry-Backoff (gemockte HTTP-Antworten, keine
|
||||
echten API-Calls), Update-statt-Duplikat-Logik, UI-Suche/Filter/Sortierung,
|
||||
Rollen am Sync-Endpunkt und Scheduler-Lifecycle.
|
||||
Rollen am Sync-Endpunkt und Scheduler-Lifecycle. Dazu die beiden neuen
|
||||
Plugins: **dedup** (Titel-Heuristik, Fuzzy-Match, alle vier Prüfungen mit
|
||||
Fake-BGG-Client, Prüfprotokoll, Prüfseite) und **planung** (beide Eintragswege
|
||||
mit Stub-gemockter dedup-/Benachrichtigungs-/Audit-API, Verlags-Auswahl-
|
||||
Dialog, Statuswechsel, Bearbeiten/Löschen, Rechte pro Rolle) plus ein
|
||||
Integrationstest mit den echten Plugins (In-App-Nachricht + Audit-Eintrag).
|
||||
|
||||
## Architektur
|
||||
|
||||
@@ -85,7 +92,9 @@ plugins/ ein Ordner pro Funktion, ladbar über den Plugin-Load
|
||||
├── audit-log/ VOLL IMPLEMENTIERT: Model, Migration, API, Admin-Ansicht
|
||||
├── neuheiten/ VOLL IMPLEMENTIERT: BGG-Client, Sync-Job, Migration, UI
|
||||
├── benachrichtigung/ VOLL IMPLEMENTIERT: E-Mail/Telegram/In-App
|
||||
├── dedup/ planung/ archiv/ erinnerung/ export/ (Stubs, ladbar)
|
||||
├── dedup/ VOLL IMPLEMENTIERT: check_titel-API, Heuristik, Protokoll
|
||||
├── planung/ VOLL IMPLEMENTIERT: Planungsliste, Verschiebung, Dialoge
|
||||
├── archiv/ erinnerung/ export/ (Stubs, ladbar)
|
||||
└── … je __init__.py + templates/<name>/
|
||||
```
|
||||
|
||||
@@ -269,6 +278,91 @@ Autor, Erscheinungsjahr, Status, aktualisiert am):
|
||||
- Jeder Titel verlinkt direkt auf den BGG-Eintrag.
|
||||
- Sync-Steuerung nur für Rolle Admin/Redakteur.
|
||||
|
||||
## Plugin „dedup“ (implementiert)
|
||||
|
||||
Dedup-Prüfungen bei Import und händigem Eintrag. Die Prüf-Logik liegt
|
||||
komplett im Plugin; der Kern bleibt unberührt.
|
||||
|
||||
### Öffentliche Prüf-API für andere Plugins
|
||||
|
||||
```python
|
||||
dedup = request.app.state.registry.get("dedup")
|
||||
ergebnis = await dedup.check_titel(titel, verlag, bgg_id, user=user)
|
||||
# ergebnis.hat_konflikte -> bool
|
||||
# ergebnis.konflikte -> Liste TitelKonflikt (art, beschreibung, details)
|
||||
# ergebnis.verlags_optionen -> Verlage zur Auswahl bei Verlags-Konflikt
|
||||
# ergebnis.titel_empfehlung -> deutschester bekannter Titel
|
||||
# ergebnis.als_text() -> lesbare Zusammenfassung (deutsch)
|
||||
```
|
||||
|
||||
### Die vier Prüfungen
|
||||
|
||||
| # | Prüfung | Mechanik |
|
||||
|---|---------|----------|
|
||||
| a | **Verlags-Konflikt** | Gleiches Spiel (BGG-ID oder Fuzzy-Match) bereits unter anderem Verlag/Vertrieb → Konflikt mit Verlagsauswahl |
|
||||
| b | **Titel-Varianten** | Deutsche Version wird bevorzugt — Heuristik über deutsche Titel-Indikatoren (Umlaute/ß, Funktionswörter, typische Spielbegriffe) plus BGG Alternate-Names, falls verfügbar |
|
||||
| c | **Bereits besprochen** | Abgeschlossene Planungseinträge bilden das Korpus; Vorgänger werden über die BGG `boardgameexpansion`-Relation erkannt und zusätzlich fuzzy auf Titel gematcht (rapidfuzz, Schwelle 85, `token_set_ratio`) |
|
||||
| d | **Schon in Planung** | Titel steht bereits in der Planungsliste eines anderen Rezensenten (eigene Einträge zählen nicht) |
|
||||
|
||||
Fehlt eine Partner-Tabelle (Plugin nicht geladen), entfällt die jeweilige
|
||||
Teilprüfung. BGG-Störungen blockieren nie: der Hilfsclient degradiert auf
|
||||
die reine Heuristik und protokolliert nur. Abschaltbar über
|
||||
`SPIELE_DEDUP_BGG_AKTIV=0` (Standard: an, Rate-Limit 1 s).
|
||||
|
||||
### Prüfprotokoll & Prüfseite
|
||||
|
||||
Jede `check_titel`-Prüfung landet in der eigenen Migration
|
||||
`0001_pruefprotokoll` (Tabelle `dedup_pruefungen`: Titel, Verlag, BGG-ID,
|
||||
Befund als JSON, geprüft von, Zeitpunkt). Unter **Dedup-Prüfung** (`/dedup`)
|
||||
kann jeder angemeldete Benutzer einen Titel von Hand prüfen und sieht die
|
||||
letzten 20 Prüfungen.
|
||||
|
||||
## Plugin „planung“ (implementiert)
|
||||
|
||||
Planungsliste mit Zuordnung an Rezensenten und Ausgaben. Beide Eintragswege
|
||||
laufen automatisch durch die dedup-Prüfung.
|
||||
|
||||
### Datentabelle
|
||||
|
||||
Eigene Migration `0001_planungsliste`, Tabelle `planungsliste`:
|
||||
|
||||
| Spalte | Inhalt |
|
||||
|--------|--------|
|
||||
| `titel` / `verlag` / `autor` | Spieldaten |
|
||||
| `bgg_id` | BoardGameGeek-ID (Match-Kriterium der dedup-Prüfung) |
|
||||
| `ausgabe` | Magazin-Ausgabe, z. B. „3/2025“ (mehrere parallel möglich) |
|
||||
| `rezensent_id` | Zuordnung (FK auf die Benutzer-Tabelle des Kerns) |
|
||||
| `status` | `offen` → `in_bearbeitung` → `abgeschlossen` |
|
||||
| `notizen` | Freitext |
|
||||
| `quelle` | `neuheiten` (verschoben) oder `manuell` (nachgetragen) |
|
||||
| `pruefung` | Befund der dedup-Prüfung beim Anlegen (JSON) |
|
||||
| `erstellt_am` / `aktualisiert_am` | Zeitstempel |
|
||||
|
||||
### Die beiden Eintragswege
|
||||
|
||||
1. **Verschiebung aus der Neuheitenliste** — Button „→ Zur Planung“ in der
|
||||
Neuheitenliste ruft `POST /planung/uebernehmen/<id>` auf; der Neuheiten-
|
||||
Eintrag wechselt in den Status `planung`, der Planungseintrag wird als
|
||||
Quelle `neuheiten` angelegt.
|
||||
2. **Händisches Nachtragen** — Formular auf der Planungsseite
|
||||
(`POST /planung/neu`, Quelle `manuell`).
|
||||
|
||||
Bei einem Prüftreffer erhält der eintragende Rezensent eine
|
||||
**Benachrichtigung** (`send_notification` des benachrichtigung-Plugins,
|
||||
Kategorie `dedup`), und es wird ein **Audit-Log-Eintrag** geschrieben
|
||||
(`log` des audit-log-Plugins, Befund in `details.dedup_konflikte`). Bei
|
||||
einem **Verlags-Konflikt** erscheint zuerst der Auswahl-Dialog „Welcher
|
||||
Verlag soll geführt werden?“ — erst die bestätigte Wahl legt den Eintrag an;
|
||||
die Entscheidung ist auditiert.
|
||||
|
||||
### UI & Rechte
|
||||
|
||||
Unter **Planung** (`/planung`) sieht jeder angemeldete Benutzer die komplette
|
||||
Liste mit Zuordnung (Rezensent, Ausgabe, Status, Prüfhinweis-Badge).
|
||||
Rezensenten können **nur ihre eigenen Einträge** bearbeiten (Statuswechsel,
|
||||
Bearbeiten, Löschen); Admins und Redakteure alle. Jede Änderung wird im
|
||||
Audit-Log protokolliert (`erstellt`/`verschoben`/`geaendert`/`geloescht`).
|
||||
|
||||
## Deployment (später)
|
||||
|
||||
Docker/Podman Compose ist vorgesehen (Henry-Lab, danach Kundenhardware).
|
||||
@@ -282,11 +376,11 @@ geschrieben.
|
||||
| # | Baustein | Status |
|
||||
|---|----------|--------|
|
||||
| 1 | Kern: FastAPI, Plugin-System, DB/Migrationen, Auth/Rollen, HTMX-Layout | ✅ fertig (28 Tests grün) |
|
||||
| 2 | Plugin `benachrichtigung` (E-Mail/Telegram/In-App, User-Präferenzen) | 🔄 in Arbeit |
|
||||
| 2 | Plugin `benachrichtigung` (E-Mail/Telegram/In-App, User-Präferenzen) | ✅ fertig |
|
||||
| 3 | Plugin `audit-log` (Wer/Was/Wann, Admin-Ansicht, öffentliche API) | ✅ fertig |
|
||||
| 4 | Plugin `neuheiten` (BGG-Sync, APScheduler, Filter) | ✅ fertig |
|
||||
| 5 | Plugin `dedup` (Verlags-Konflikt, deutsche Version, Vorgänger-/Planungs-Check) | ⏳ offen |
|
||||
| 6 | Plugin `planung` (Verschiebung, händischer Eintrag + Prüfungen + Benachrichtigung) | ⏳ offen |
|
||||
| 5 | Plugin `dedup` (Verlags-Konflikt, deutsche Version, Vorgänger-/Planungs-Check) | ✅ fertig (141 Tests grün) |
|
||||
| 6 | Plugin `planung` (Verschiebung, händischer Eintrag + Prüfungen + Benachrichtigung) | ✅ fertig (141 Tests grün) |
|
||||
| 7 | Plugin `archiv` (12-Monats-Autopilot) | ⏳ offen |
|
||||
| 8 | Plugin `erinnerung` (Redaktionsschluss pro Ausgabe, 4-Wochen-Erinnerung) | ⏳ offen |
|
||||
| 9 | Plugin `export` (CSV + PDF via WeasyPrint) | ⏳ offen |
|
||||
|
||||
Reference in New Issue
Block a user