Files
HiveGrid-Wireframes/hivegrid-cloud/docs/milestones/M001-audit-log-default/PLAN.md
T

89 lines
4.0 KiB
Markdown

# M001 — Audit-Log default
**Block:** Querschnitt-Hülle Teil 1 (Bauprinzipien)
**Bauprinzip:** A.6 — Audit-Log als Default
**Pflichtenheft-Quelle:** `_bmad-output/pflichtenheft/03-architektur.md` Sektion A.6
## Ziel
Eine Schreib-Aktion durch ein beliebiges Modul erzeugt automatisch einen Audit-Eintrag — ohne dass das Modul den Audit-Service aktiv aufrufen muss.
## Pflichtenheft-Bezug
- A.6.1 — Jede schreibende Aktion (Anlegen, Ändern, Löschen, Status-Wechsel) wird mit Wer/Wann/Was/Vor-Nach-Wert protokolliert
- A.6.2 — Auch Aktionen durch Automatisierungen oder externe Sync-Vorgänge; Auslöser wird mit-protokolliert
## Abhängigkeiten
- **Vorbedingung:** EU-Sterilisation + RR7-Migration der Boilerplate abgeschlossen
- **Wird benötigt von:** M004, M005, M006, M075-M082 (Automation), M151-M152 (Audit-UI/Export), alle schreibenden Module
## Out of Scope
- Audit-Anzeige-UI → M151
- Audit-Export für Compliance → M152
## Erfolgskriterium
Test-Modul ruft `kontakt.create({...})` → ohne expliziten Audit-Code-Aufruf erscheint ein Eintrag in `audit_events` mit korrektem actor, tenant, before/after, timestamp.
## Hinweise für Slice-Planung
- Schema-Design separat von Hook-Implementierung
- Akteur-Resolution unterscheidet User / Auto / Sync / System
- Performance: Bulk-Update von 1000 Datensätzen darf nicht > 2x normale Latenz erzeugen
- Audit-Writes sind unveränderlich (keine UPDATE/DELETE-Pfade)
---
## Definition of Done — verbindlich (siehe `AGENTS.md` + `docs/INTEGRATION-CONTRACTS.md`)
Dieses Milestone gilt **nur dann als erledigt**, wenn alle Punkte wahr sind. Bei Verstoß: PR-Block.
### Erreichbarkeit
- [ ] **Sidebar-Eintrag** in `packages/ui-hivegrid/src/app-shell/sidebar.config.ts` mit Permission-Gate (oder explizit dokumentiert, warum nur Inline-Verlinkung) — Gruppe gemäß `docs/INTEGRATION-CONTRACTS.md` §1
- [ ] **Route** unter korrektem URL-Pattern (INTEGRATION-CONTRACTS §3)
- [ ] **Breadcrumb** für Detail-Routes (§4)
- [ ] **Mobile-Tab-Bar-Eintrag** falls mobile-relevant (§13)
- [ ] **Customer-Portal-Sichtbarkeit** explizit konfiguriert (§14)
### Querschnitt-Wiring
- [ ] **Audit** läuft (auto via M001 oder manuell)
- [ ] **Activity-Stream** via `logActivity` bei relevanter Aktion (M045)
- [ ] **Notifications** via `notify()` (M011), nicht direkt
- [ ] **Search-Index** registriert in `indexed-entities.ts`, falls suchbar
- [ ] **Permission-Filter** via `withTenantScope()` + `withPermission()` (M004)
- [ ] **Feature-Flag-fähig** (M006) — Modul ohne Deploy abschaltbar
### Code-Layer-Disziplin (PR-Block)
- [ ] Loader baut View-Model; UI-Component empfängt nur VM + Actions
- [ ] Keine Prisma-/Server-Imports in `packages/ui-hivegrid/**`
- [ ] Subframe-Output via Adapter, nicht direkt importiert
- [ ] Alle UI-Texte als i18n-Keys (M003-Build-Lint blockt sonst)
### Tests
- [ ] **Unit-Test** für VM-Builder mit Zod-Schema-Validierung
- [ ] **Smoke-Test** `e2e/smoke/<modul>.spec.ts` (Login → Route → Hauptaktion → erwartetes UI)
- [ ] **Hot-Swap-Drill** grün (Smoke-Test gegen `packages/ui-mock` aus M017)
- [ ] **Visual-Regression-Snapshot** der Hauptansicht (M016)
### Klartext (User-facing)
- [ ] Fehler-Texte aus M002-Catalog (kein HTTP-Code im UI)
- [ ] Empty-State mit Klartext + nächster Aktion
- [ ] Loading-State mit Klartext (kein leerer Spinner)
- [ ] Permission-Denied → 404, nicht 403 (Bauprinzip A.5.3)
### Rollback-Pfad
- [ ] **Forward-Only-DB-Migration** mit Inverse-SQL als Kommentar
- [ ] **Atomic-Slice-Commits** (TC-Default)
- [ ] **Feature-Flag** vorhanden, um das Modul ohne Deploy auszuschalten
---
## Klick-Pfad zum Prüfen (für User)
Wenn dieses Milestone fertig ist, prüft der User die Funktion über folgenden Pfad:
1. Login als geeigneter User-Typ (siehe Erfolgskriterium oben)
2. Sidebar-Gruppe + Eintrag öffnen (gemäß INTEGRATION-CONTRACTS.md §1)
3. Hauptaktion ausführen
4. Erwartetes Ergebnis sichtbar (siehe Erfolgskriterium)
**Falls etwas nicht erreichbar ist:** Milestone ist trotz „grüner Tests" nicht fertig — siehe Erreichbarkeits-Checkliste oben.