Files
2026-07-08 16:15:37 +02:00

4.2 KiB

M092 — KWP-API-Contract-Sentinel

Block: Block 4 · Modul 19 Pflichtenheft-Quelle: block4.md Modul 19 + Bauprinzip A.11 · Re-Cut 2026-06-04 (KWP-API)

Ziel

Statt MSSQL-Schema-Drift jetzt API-Vertrags-/Versions-Überwachung: jede KWP-API-Response wird gegen ein erwartetes zod-Schema validiert; bei Vertragsbruch (unerwartete Felder/Typen, API-Version-Bump) → Sync automatisch pausiert + Alarm an Plattform-Admin zuerst (vor Geerkens).

Was sich durch die KWP-API ändert (Re-Cut)

  • Vereinfacht bis ggf. integrierbar: Bei stabiler, versionierter API ändert KWP das Schema nicht mehr „still". Der tägliche MSSQL-Snapshot+Hash-Diff entfällt; übrig bleibt eine laufende zod-Response-Validierung + Versions-Check. Ob eigenständiges Milestone oder Teil des M089-Connectors hängt vom KWP-API-Versionierungs-Modell ab (offen).

Pflichtenheft-Bezug

  • A.11.1-A.11.2
  • 33a.6 — Schema-/Contract-Drift generell

Abhängigkeiten

  • Vorbedingung: M089-M091, M011 (Notifications)
  • Offen: KWP-API-Versionierungs-/Changelog-Modell (klären) — entscheidet den Umfang
  • Wird benötigt von: stabiler Geerkens-Betrieb

Erfolgskriterium

Eine bewusst veränderte/unerwartete API-Response (Feld umbenannt) wird von der zod-Validierung erkannt; Sync pausiert; Plattform-Admin erhält Push vor Geerkens es bemerkt; Mandant sieht Klartext „Wir wurden informiert".

Hinweise für Slice-Planung

  • zod-Schemas pro KWP-Endpoint; KwpApiContractSnapshot (API-Version + Schema-Fingerprint) statt MSSQL-Snapshot
  • Auto-Pause über M33a-Status (degraded) + notify() an Plattform-Admin zuerst, dann Mandant

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 apps/web/app/application/sidebar/ 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-app/**
  • 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.