4.0 KiB
M008 — Apps-Engine: Adapter-Interface + State-Machine
Block: Querschnitt-Hülle Teil 1 (Bauprinzipien)
Bauprinzip: A.2 Teil 1 — Adapter-Schicht für jede Integration
Pflichtenheft-Quelle: _bmad-output/pflichtenheft/03-architektur.md A.2 + Modul 33a (Block 4)
Ziel
Abstrakte Adapter-Klasse + 5-Status-State-Machine (wartet/aktiv/eingeschränkt/defekt/getrennt). Eine Dummy-App zum Beweis.
Pflichtenheft-Bezug
- A.2.1 — Externe Systeme nur über Apps-Engine
- A.2.2 — Adapter-Interface so gebaut, dass weitere Implementierungen ohne Engine-Umbau dazu kommen
- 33a.3 — 5-Status mit Klartext-Hinweis pro Status
Abhängigkeiten
- Vorbedingung: M002, M001
- Wird benötigt von: M009, M010 (Apps-Engine), alle Module mit externer Integration (M19, M9, M12, M25, M125, M131, M153)
Out of Scope
- Konkrete Adapter (KWP, Gmail, AirCall, Legacy-Provider, PandaDoc, Calendar) — eigene Module
- Setup-Wizard → M009
- Probe-Scheduler → M010
- Drittanbieter-Marketplace (Phase 2)
Erfolgskriterium
Dummy-App durchläuft Lifecycle (wartet → aktiv → eingeschränkt → defekt → getrennt), Klartext-Hinweis pro Übergang sichtbar im Test-UI.
Hinweise für Slice-Planung
- Adapter-Interface als TypeScript-Interface mit klaren Hooks (connect, probe, sync, disconnect)
- State-Machine als XState oder einfache Enum-Transitions mit Audit-Eintrag pro Wechsel
- Dummy-App als Referenz-Implementation
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
logActivitybei 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-mockaus 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:
- Login als geeigneter User-Typ (siehe Erfolgskriterium oben)
- Sidebar-Gruppe + Eintrag öffnen (gemäß INTEGRATION-CONTRACTS.md §1)
- Hauptaktion ausführen
- Erwartetes Ergebnis sichtbar (siehe Erfolgskriterium)
Falls etwas nicht erreichbar ist: Milestone ist trotz „grüner Tests" nicht fertig — siehe Erreichbarkeits-Checkliste oben.