84 lines
3.9 KiB
Markdown
84 lines
3.9 KiB
Markdown
# M090 — KWP-API Connection-Health
|
|
|
|
**Block:** Block 4 · Modul 19
|
|
**Pflichtenheft-Quelle:** block4.md Modul 19 + Bauprinzip A.18 · **Re-Cut 2026-06-04 (KWP-API)**
|
|
|
|
## Ziel
|
|
Verbindungs-Gesundheit der KWP-API über den generischen M33a-Health-Probe (`validateConnection`-Call im Intervall) statt eines Client-Heartbeats. Status nach `AdapterStatus` (aktiv/eingeschränkt/defekt). Bei `defekt`: Alarm an Plattform-Admin + Mandanten-Admin (Geerkens).
|
|
|
|
## Was sich durch die KWP-API ändert (Re-Cut)
|
|
- **Stark vereinfacht:** Client-Heartbeat (5 Min), 15-Min-Watchdog und Auto-Restart entfallen (kein lokaler Client mehr). Ersetzt durch periodischen Health-Call der Cloud an die KWP-API.
|
|
|
|
## Pflichtenheft-Bezug
|
|
- A.18.1-A.18.3 (sinngemäß auf API-Health übertragen)
|
|
|
|
## Abhängigkeiten
|
|
- **Vorbedingung:** M089, M011 (Notifications)
|
|
- **Wird benötigt von:** M091
|
|
|
|
## Erfolgskriterium
|
|
Health-Status pro KWP-Connection sichtbar im Plattform-Admin; simulierter API-Ausfall setzt Status auf `defekt` und löst Push + Email aus; Erholung sendet Klartext-Bestätigung.
|
|
|
|
## Hinweise für Slice-Planung
|
|
- Nutzt `foundation/adapters` (`AdapterStatus`) + `notify()`; Probe-Intervalle aktiv 5min / eingeschränkt 1min / defekt 15min (M33a)
|
|
- Health-Cron nach Muster `apps/worker/.../dsgvo-grace-cron.ts`
|
|
|
|
|
|
---
|
|
|
|
## 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.
|
|
|