Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
da80643564 | ||
|
|
814a7fda0a | ||
|
|
6a03dcafd6 | ||
|
|
b23cd1961f | ||
|
|
4a30345e07 |
@@ -1,4 +1,2 @@
|
|||||||
*.log
|
*.log
|
||||||
.env
|
.env
|
||||||
web/*/node_modules/
|
|
||||||
web/*/.next/
|
|
||||||
|
|||||||
@@ -64,9 +64,6 @@ Keine Änderungen ermittelbar.
|
|||||||
## 2026-08-27 17:28 – 17:29 (1m)
|
## 2026-08-27 17:28 – 17:29 (1m)
|
||||||
**Beschreibung:** Claude Code Session
|
**Beschreibung:** Claude Code Session
|
||||||
**Projekt:** code
|
**Projekt:** code
|
||||||
## 2026-08-28 21:44 – 21:44 (0m)
|
|
||||||
**Beschreibung:** Claude Code Session
|
|
||||||
**Projekt:** nexarch
|
|
||||||
|
|
||||||
### Commits
|
### Commits
|
||||||
Keine Commits in dieser Session.
|
Keine Commits in dieser Session.
|
||||||
@@ -130,32 +127,5 @@ Keine Commits in dieser Session.
|
|||||||
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
||||||
- internal/db/db.go | 11 +++++++++++
|
- internal/db/db.go | 11 +++++++++++
|
||||||
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
||||||
- web/shl/README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/__tests__/Dialog.test.tsx | 38 ++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/__tests__/tokens.test.ts | 39 +++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/components/Dialog.tsx | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/components/FormElements.tsx | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/components/Shell.tsx | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/components/Table.tsx | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/components/Toast.tsx | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/i18n/i18n.tsx | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/index.ts | 25 +++++++++++++++++++++++++
|
|
||||||
- web/shl/package.json | 23 +++++++++++++++++++++++
|
|
||||||
- web/shl/theme/ThemeProvider.tsx | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/tokens/tokens.ts | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- web/shl/tsconfig.json | 18 ++++++++++++++++++
|
|
||||||
|
|
||||||
---
|
|
||||||
## 2026-08-28 21:51 – 21:57 (5m)
|
|
||||||
**Beschreibung:** Claude Code Session
|
|
||||||
**Projekt:** nexarch
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
- 3c226da SHL-01: fix — vitest jsdom-environment + jest-dom-Setup (3 Dialog-Tests schlugen ohne DOM fehl)
|
|
||||||
|
|
||||||
### Geänderte Dateien
|
|
||||||
- web/shl/package.json | 2 ++
|
|
||||||
- web/shl/vitest.config.ts | 8 ++++++++
|
|
||||||
- web/shl/vitest.setup.ts | 1 +
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -1,81 +0,0 @@
|
|||||||
// licadmin-devserver stellt das LIC-04-Backend-API (internal/adminapi) fuer
|
|
||||||
// die Next.js-Verwaltungsoberflaeche bereit. Getrennt von cmd/core, da die
|
|
||||||
// Verdrahtung von license.Validator (Ed25519-Public-Key) in die zentrale
|
|
||||||
// Server-Topologie erst mit API-01/IAM-01 (Auth vor internen Endpunkten)
|
|
||||||
// sinnvoll ist — dieser Server dient der Entwicklung/dem Betrieb der
|
|
||||||
// Verwaltungsoberflaeche gegen eine echte Datenbank, ohne cmd/core
|
|
||||||
// anzufassen (Kein Umbau angrenzender Bereiche).
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"crypto/ed25519"
|
|
||||||
"encoding/base64"
|
|
||||||
"log"
|
|
||||||
"net/http"
|
|
||||||
"os"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/adminapi"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/db"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/flag"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/license"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/usage"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
dsn := os.Getenv("NEXARCH_REGISTRY_DSN")
|
|
||||||
if dsn == "" {
|
|
||||||
log.Fatal("NEXARCH_REGISTRY_DSN nicht gesetzt")
|
|
||||||
}
|
|
||||||
pubKeyB64 := os.Getenv("NEXARCH_LICENSE_PUBLIC_KEY")
|
|
||||||
if pubKeyB64 == "" {
|
|
||||||
log.Fatal("NEXARCH_LICENSE_PUBLIC_KEY nicht gesetzt (base64, raw-url-encoding)")
|
|
||||||
}
|
|
||||||
pubKeyRaw, err := base64.RawURLEncoding.DecodeString(pubKeyB64)
|
|
||||||
if err != nil || len(pubKeyRaw) != ed25519.PublicKeySize {
|
|
||||||
log.Fatalf("NEXARCH_LICENSE_PUBLIC_KEY ungueltig: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
addr := os.Getenv("NEXARCH_LICADMIN_LISTEN_ADDR")
|
|
||||||
if addr == "" {
|
|
||||||
addr = ":8081"
|
|
||||||
}
|
|
||||||
|
|
||||||
ctx := context.Background()
|
|
||||||
pool, err := db.Connect(ctx, dsn)
|
|
||||||
if err != nil {
|
|
||||||
log.Fatalf("db: %v", err)
|
|
||||||
}
|
|
||||||
defer pool.Close()
|
|
||||||
|
|
||||||
licenseStore := license.NewStore(pool, license.NewValidator(ed25519.PublicKey(pubKeyRaw)))
|
|
||||||
flagStore := flag.NewStore(pool)
|
|
||||||
flagService := flag.NewService(flagStore, 5*time.Second)
|
|
||||||
usageStore := usage.NewStore(pool)
|
|
||||||
handler := adminapi.NewHandler(licenseStore, flagStore, flagService, usageStore)
|
|
||||||
|
|
||||||
mux := http.NewServeMux()
|
|
||||||
mux.HandleFunc("/admin/overview", withCORS(handler.OverviewHandler))
|
|
||||||
mux.HandleFunc("/admin/flags/toggle", withCORS(handler.ToggleFlagHandler))
|
|
||||||
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
|
||||||
|
|
||||||
log.Printf("licadmin-devserver listening on %s", addr)
|
|
||||||
log.Fatal(http.ListenAndServe(addr, mux))
|
|
||||||
}
|
|
||||||
|
|
||||||
// withCORS erlaubt lokale Entwicklung des Next.js-Frontends auf einem
|
|
||||||
// anderen Port als das Backend-API — ausschliesslich fuer diesen
|
|
||||||
// Entwicklungsserver, keine Produktionshaertung.
|
|
||||||
func withCORS(next http.HandlerFunc) http.HandlerFunc {
|
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
w.Header().Set("Access-Control-Allow-Origin", "*")
|
|
||||||
w.Header().Set("Access-Control-Allow-Methods", "GET, POST, OPTIONS")
|
|
||||||
w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
|
|
||||||
if r.Method == http.MethodOptions {
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
next(w, r)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
// metrics-devserver stellt den OPS-03-Metrics-Aggregator (internal/metrics)
|
||||||
|
// unter /metrics bereit, damit ein echter Prometheus-Scrape-Vorgang gegen
|
||||||
|
// den Core-Dienst geprueft werden kann (Pruefung 3). Getrennt von cmd/core
|
||||||
|
// aus demselben Grund wie die anderen *-devserver.
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/db"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/metrics"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
dsn := os.Getenv("NEXARCH_REGISTRY_DSN")
|
||||||
|
if dsn == "" {
|
||||||
|
log.Fatal("NEXARCH_REGISTRY_DSN nicht gesetzt")
|
||||||
|
}
|
||||||
|
addr := os.Getenv("NEXARCH_METRICS_LISTEN_ADDR")
|
||||||
|
if addr == "" {
|
||||||
|
addr = ":8085"
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
pool, err := db.Connect(ctx, dsn)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("db: %v", err)
|
||||||
|
}
|
||||||
|
defer pool.Close()
|
||||||
|
|
||||||
|
sourceStore := metrics.NewSourceStore(pool)
|
||||||
|
agg := metrics.NewAggregator(metrics.NewCoreRegistry(), sourceStore.Provide)
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/metrics", agg.Handler())
|
||||||
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
||||||
|
|
||||||
|
log.Printf("metrics-devserver listening on %s", addr)
|
||||||
|
log.Fatal(http.ListenAndServe(addr, mux))
|
||||||
|
}
|
||||||
@@ -1,226 +0,0 @@
|
|||||||
// Package adminapi implementiert Core LIC-04: das Backend-API fuer die
|
|
||||||
// Lizenz-/Modul-Verwaltungsoberflaeche. Das Paket enthaelt KEINE eigene
|
|
||||||
// Lizenz-/Flag-/Quota-Logik, sondern ist ein duenner Vermittler ueber
|
|
||||||
// internal/license, internal/flag und internal/usage (Ticket-Vorgabe:
|
|
||||||
// "Verwaltungsoberflaeche als duenner Client ... ohne eigene Lizenzlogik").
|
|
||||||
package adminapi
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/flag"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/license"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/usage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// UsageMetrics sind die Metriken, die auf der Uebersichtsseite je Tenant
|
|
||||||
// dargestellt werden (Akzeptanzkriterium 3). Neue Metriken hinzuzufuegen
|
|
||||||
// beruehrt kein bestehendes Verhalten von internal/usage.
|
|
||||||
var UsageMetrics = []string{"users", "storage_bytes", "api_calls"}
|
|
||||||
|
|
||||||
// FlagOverview ist ein Flag zusammen mit der fuer den Tenant ausgewerteten
|
|
||||||
// Berechtigung, es umzuschalten (Akzeptanzkriterium 2).
|
|
||||||
type FlagOverview struct {
|
|
||||||
Key string `json:"key"`
|
|
||||||
Enabled bool `json:"enabled"`
|
|
||||||
Licensed bool `json:"licensed"`
|
|
||||||
DenyGrund string `json:"deny_grund,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// UsageOverview ist eine Metrik mit Zaehlerstand, Quota und Status
|
|
||||||
// (Akzeptanzkriterium 3).
|
|
||||||
type UsageOverview struct {
|
|
||||||
Metric string `json:"metric"`
|
|
||||||
Value int64 `json:"value"`
|
|
||||||
Limit int64 `json:"limit"`
|
|
||||||
Status usage.Status `json:"status"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Overview ist die vollstaendige Antwort fuer die Uebersichtsseite
|
|
||||||
// (Akzeptanzkriterium 1: Lizenzstatus/Laufzeit/Module auf einen Blick).
|
|
||||||
type Overview struct {
|
|
||||||
Plan string `json:"plan"`
|
|
||||||
Modules []string `json:"modules"`
|
|
||||||
IssuedAt string `json:"issued_at"`
|
|
||||||
ValidUntil string `json:"valid_until"`
|
|
||||||
Expired bool `json:"expired"`
|
|
||||||
Flags []FlagOverview `json:"flags"`
|
|
||||||
Usage []UsageOverview `json:"usage"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ErrFlagNotLicensed wird geliefert, wenn ein Administrator versucht, ein
|
|
||||||
// Flag zu aktivieren, dessen zugehoeriges Modul die Lizenz nicht umfasst
|
|
||||||
// (Akzeptanzkriterium 2 / Pruefung 1).
|
|
||||||
var ErrFlagNotLicensed = errors.New("adminapi: modul ist durch die aktuelle lizenz nicht freigeschaltet")
|
|
||||||
|
|
||||||
// Handler buendelt die drei Vorbedingungs-Dienste hinter einem gemeinsamen
|
|
||||||
// HTTP-API fuer das Frontend.
|
|
||||||
type Handler struct {
|
|
||||||
licenseStore *license.Store
|
|
||||||
flagStore *flag.Store
|
|
||||||
flagService *flag.Service
|
|
||||||
usageStore *usage.Store
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewHandler(licenseStore *license.Store, flagStore *flag.Store, flagService *flag.Service, usageStore *usage.Store) *Handler {
|
|
||||||
return &Handler{licenseStore: licenseStore, flagStore: flagStore, flagService: flagService, usageStore: usageStore}
|
|
||||||
}
|
|
||||||
|
|
||||||
// isModuleLicensed prueft, ob ein Flag-Schluessel als lizenziertes Modul
|
|
||||||
// gilt. Konvention: ein Flag-Key der Form "module:<name>" ist an das
|
|
||||||
// gleichnamige Modul in Payload.Modules gebunden; alle anderen Flag-Keys
|
|
||||||
// gelten als lizenzunabhaengige, rein funktionale Schalter.
|
|
||||||
func isModuleLicensed(key string, modules []string) (moduleName string, isModuleFlag bool, licensed bool) {
|
|
||||||
const prefix = "module:"
|
|
||||||
if !strings.HasPrefix(key, prefix) {
|
|
||||||
return "", false, true
|
|
||||||
}
|
|
||||||
moduleName = strings.TrimPrefix(key, prefix)
|
|
||||||
for _, m := range modules {
|
|
||||||
if m == moduleName {
|
|
||||||
return moduleName, true, true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return moduleName, true, false
|
|
||||||
}
|
|
||||||
|
|
||||||
// Overview liefert die kombinierte Uebersicht fuer einen Tenant
|
|
||||||
// (Akzeptanzkriterium 1 + 3).
|
|
||||||
func (h *Handler) Overview(ctx context.Context, tenantID string) (Overview, error) {
|
|
||||||
lic, err := h.licenseStore.Status(ctx, tenantID)
|
|
||||||
if err != nil {
|
|
||||||
return Overview{}, fmt.Errorf("lizenzstatus lesen: %w", err)
|
|
||||||
}
|
|
||||||
_, expiredErr := h.licenseStore.RequireActive(ctx, tenantID)
|
|
||||||
expired := errors.Is(expiredErr, license.ErrLicenseExpired)
|
|
||||||
|
|
||||||
flags, err := h.flagStore.List(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return Overview{}, fmt.Errorf("flags lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tenantSlug := tenantID // Auswertung erwartet den Tenant-Bezug als String; Aufloesung ID->Slug obliegt dem Aufrufer (siehe Handler-Tests).
|
|
||||||
flagOverviews := make([]FlagOverview, 0, len(flags))
|
|
||||||
for _, f := range flags {
|
|
||||||
_, _, licensed := isModuleLicensed(f.Key, lic.Modules)
|
|
||||||
fo := FlagOverview{
|
|
||||||
Key: f.Key,
|
|
||||||
Enabled: h.flagService.IsEnabled(ctx, tenantSlug, f.Key),
|
|
||||||
Licensed: licensed,
|
|
||||||
}
|
|
||||||
if !licensed {
|
|
||||||
fo.DenyGrund = "Modul ist im aktuellen Lizenzplan nicht enthalten"
|
|
||||||
}
|
|
||||||
flagOverviews = append(flagOverviews, fo)
|
|
||||||
}
|
|
||||||
|
|
||||||
usageOverviews := make([]UsageOverview, 0, len(UsageMetrics))
|
|
||||||
for _, metric := range UsageMetrics {
|
|
||||||
value, limit, status, err := h.usageStore.Check(ctx, tenantID, metric)
|
|
||||||
if err != nil {
|
|
||||||
return Overview{}, fmt.Errorf("nutzungsstand lesen (%s): %w", metric, err)
|
|
||||||
}
|
|
||||||
usageOverviews = append(usageOverviews, UsageOverview{
|
|
||||||
Metric: metric, Value: value, Limit: limit, Status: status,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
return Overview{
|
|
||||||
Plan: lic.Plan,
|
|
||||||
Modules: lic.Modules,
|
|
||||||
IssuedAt: lic.IssuedAt.Format("2006-01-02T15:04:05Z07:00"),
|
|
||||||
ValidUntil: lic.ValidUntil.Format("2006-01-02T15:04:05Z07:00"),
|
|
||||||
Expired: expired,
|
|
||||||
Flags: flagOverviews,
|
|
||||||
Usage: usageOverviews,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ToggleFlag schaltet ein Flag global an/aus, NACHDEM geprueft wurde, dass
|
|
||||||
// das zugehoerige Modul lizenziert ist (Akzeptanzkriterium 2 / Pruefung 1).
|
|
||||||
// Ein nicht lizenziertes Modul wird mit ErrFlagNotLicensed abgelehnt, bevor
|
|
||||||
// irgendein Schreibzugriff erfolgt.
|
|
||||||
func (h *Handler) ToggleFlag(ctx context.Context, tenantID, key string, enabled bool) error {
|
|
||||||
lic, err := h.licenseStore.Status(ctx, tenantID)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("lizenzstatus lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if enabled {
|
|
||||||
if _, _, licensed := isModuleLicensed(key, lic.Modules); !licensed {
|
|
||||||
return ErrFlagNotLicensed
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
existing, err := h.flagStore.Get(ctx, key)
|
|
||||||
if err != nil && !errors.Is(err, flag.ErrNotFound) {
|
|
||||||
return fmt.Errorf("flag lesen: %w", err)
|
|
||||||
}
|
|
||||||
existing.Key = key
|
|
||||||
existing.Enabled = enabled
|
|
||||||
|
|
||||||
if err := h.flagStore.Set(ctx, existing); err != nil {
|
|
||||||
return fmt.Errorf("flag speichern: %w", err)
|
|
||||||
}
|
|
||||||
h.flagService.Invalidate(key)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- HTTP-Bindung ---
|
|
||||||
|
|
||||||
func (h *Handler) OverviewHandler(w http.ResponseWriter, r *http.Request) {
|
|
||||||
tenantID := r.URL.Query().Get("tenant")
|
|
||||||
if tenantID == "" {
|
|
||||||
writeError(w, http.StatusBadRequest, "tenant-parameter fehlt")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
overview, err := h.Overview(r.Context(), tenantID)
|
|
||||||
if err != nil {
|
|
||||||
writeError(w, http.StatusInternalServerError, err.Error())
|
|
||||||
return
|
|
||||||
}
|
|
||||||
writeJSON(w, http.StatusOK, overview)
|
|
||||||
}
|
|
||||||
|
|
||||||
type toggleRequest struct {
|
|
||||||
Tenant string `json:"tenant"`
|
|
||||||
Key string `json:"key"`
|
|
||||||
Enabled bool `json:"enabled"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *Handler) ToggleFlagHandler(w http.ResponseWriter, r *http.Request) {
|
|
||||||
var req toggleRequest
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
|
||||||
writeError(w, http.StatusBadRequest, "ungueltiger anfrage-koerper")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if req.Tenant == "" || req.Key == "" {
|
|
||||||
writeError(w, http.StatusBadRequest, "tenant und key sind erforderlich")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
err := h.ToggleFlag(r.Context(), req.Tenant, req.Key, req.Enabled)
|
|
||||||
switch {
|
|
||||||
case err == nil:
|
|
||||||
writeJSON(w, http.StatusOK, map[string]string{"status": "ok"})
|
|
||||||
case errors.Is(err, ErrFlagNotLicensed):
|
|
||||||
writeError(w, http.StatusForbidden, ErrFlagNotLicensed.Error())
|
|
||||||
default:
|
|
||||||
writeError(w, http.StatusInternalServerError, err.Error())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeJSON(w http.ResponseWriter, status int, body any) {
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
w.WriteHeader(status)
|
|
||||||
_ = json.NewEncoder(w).Encode(body)
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeError(w http.ResponseWriter, status int, message string) {
|
|
||||||
writeJSON(w, status, map[string]string{"error": message})
|
|
||||||
}
|
|
||||||
@@ -1,275 +0,0 @@
|
|||||||
package adminapi
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"crypto/ed25519"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/flag"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/license"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/usage"
|
|
||||||
)
|
|
||||||
|
|
||||||
type testEnv struct {
|
|
||||||
handler *Handler
|
|
||||||
tenantID string
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func setupTest(t *testing.T) (testEnv, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS tenants (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
slug TEXT NOT NULL UNIQUE,
|
|
||||||
name TEXT NOT NULL,
|
|
||||||
db_name TEXT NOT NULL UNIQUE,
|
|
||||||
db_dsn TEXT NOT NULL,
|
|
||||||
status TEXT NOT NULL DEFAULT 'active',
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS tenant_licenses (
|
|
||||||
tenant_id UUID PRIMARY KEY REFERENCES tenants(id),
|
|
||||||
plan TEXT NOT NULL,
|
|
||||||
modules TEXT[] NOT NULL,
|
|
||||||
issued_at TIMESTAMPTZ NOT NULL,
|
|
||||||
valid_until TIMESTAMPTZ NOT NULL,
|
|
||||||
raw_key TEXT NOT NULL,
|
|
||||||
installed_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS feature_flags (
|
|
||||||
key TEXT PRIMARY KEY,
|
|
||||||
enabled BOOLEAN NOT NULL DEFAULT false,
|
|
||||||
rollout_percentage INT NOT NULL DEFAULT 0,
|
|
||||||
target_tenant_slugs TEXT[] NOT NULL DEFAULT '{}',
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS usage_counters (
|
|
||||||
tenant_id UUID NOT NULL, metric TEXT NOT NULL, value BIGINT NOT NULL DEFAULT 0,
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(), PRIMARY KEY (tenant_id, metric)
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS usage_quotas (
|
|
||||||
tenant_id UUID NOT NULL, metric TEXT NOT NULL, limit_value BIGINT NOT NULL,
|
|
||||||
PRIMARY KEY (tenant_id, metric)
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
slug := fmt.Sprintf("adminapi_test_%d", time.Now().UnixNano())
|
|
||||||
var tenantID string
|
|
||||||
if err := pool.QueryRow(ctx, `
|
|
||||||
INSERT INTO tenants (slug, name, db_name, db_dsn)
|
|
||||||
VALUES ($1, 'Adminapi Test', $1, 'unused') RETURNING id
|
|
||||||
`, slug).Scan(&tenantID); err != nil {
|
|
||||||
t.Fatalf("test-tenant anlegen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub, priv, err := ed25519.GenerateKey(nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("schluesselpaar: %v", err)
|
|
||||||
}
|
|
||||||
issuer := license.NewIssuer(priv)
|
|
||||||
licenseStore := license.NewStore(pool, license.NewValidator(pub))
|
|
||||||
|
|
||||||
payload := license.Payload{
|
|
||||||
TenantSlug: slug,
|
|
||||||
Plan: "professional",
|
|
||||||
Modules: []string{"dms", "mail"},
|
|
||||||
IssuedAt: time.Now().Truncate(time.Second),
|
|
||||||
ValidUntil: time.Now().Add(30 * 24 * time.Hour).Truncate(time.Second),
|
|
||||||
}
|
|
||||||
key, err := issuer.Issue(payload)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("lizenz ausstellen: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := licenseStore.Install(ctx, tenantID, key); err != nil {
|
|
||||||
t.Fatalf("lizenz installieren: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
flagStore := flag.NewStore(pool)
|
|
||||||
flagService := flag.NewService(flagStore, time.Millisecond) // sehr kurze TTL, damit Tests nicht auf Cache-Ablauf warten muessen
|
|
||||||
usageStore := usage.NewStore(pool)
|
|
||||||
|
|
||||||
handler := NewHandler(licenseStore, flagStore, flagService, usageStore)
|
|
||||||
|
|
||||||
cleanup := func() {
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM usage_quotas WHERE tenant_id = $1`, tenantID)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM usage_counters WHERE tenant_id = $1`, tenantID)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM tenant_licenses WHERE tenant_id = $1`)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM tenants WHERE id = $1`, tenantID)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM feature_flags WHERE key LIKE 'adminapi\_test\_%' ESCAPE '\'`)
|
|
||||||
pool.Close()
|
|
||||||
}
|
|
||||||
return testEnv{handler: handler, tenantID: tenantID, pool: pool}, cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1: Lizenzstatus, Laufzeit und Module sind auf einen
|
|
||||||
// Blick abfragbar.
|
|
||||||
func TestOverview_ShowsLicenseStatusAndModules(t *testing.T) {
|
|
||||||
env, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
overview, err := env.handler.Overview(ctx, env.tenantID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("overview: %v", err)
|
|
||||||
}
|
|
||||||
if overview.Plan != "professional" {
|
|
||||||
t.Fatalf("plan = %q, want professional", overview.Plan)
|
|
||||||
}
|
|
||||||
if len(overview.Modules) != 2 {
|
|
||||||
t.Fatalf("module = %v, want 2 eintraege", overview.Modules)
|
|
||||||
}
|
|
||||||
if overview.Expired {
|
|
||||||
t.Fatal("lizenz sollte nicht abgelaufen sein")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 1: Umschalten eines nicht lizenzierten
|
|
||||||
// Features wird verhindert und verstaendlich begruendet.
|
|
||||||
func TestToggleFlag_RejectsUnlicensedModule(t *testing.T) {
|
|
||||||
env, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
err := env.handler.ToggleFlag(ctx, env.tenantID, "module:archive", true)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("erwartet fehler beim aktivieren eines nicht lizenzierten moduls")
|
|
||||||
}
|
|
||||||
if err.Error() == "" {
|
|
||||||
t.Fatal("fehlermeldung sollte verstaendlich sein, nicht leer")
|
|
||||||
}
|
|
||||||
t.Logf("erhaltene begruendung: %v", err)
|
|
||||||
|
|
||||||
// Sicherstellen, dass NICHTS geschrieben wurde: Flag existiert weiterhin nicht.
|
|
||||||
if _, ferr := flag.NewStore(env.pool).Get(ctx, "module:archive"); ferr == nil {
|
|
||||||
t.Fatal("flag haette wegen fehlender lizenz nicht angelegt werden duerfen")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2: lizenziertes Modul laesst sich umschalten.
|
|
||||||
func TestToggleFlag_AllowsLicensedModule(t *testing.T) {
|
|
||||||
env, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if err := env.handler.ToggleFlag(ctx, env.tenantID, "module:dms", true); err != nil {
|
|
||||||
t.Fatalf("erwartet erfolg fuer lizenziertes modul, habe: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
overview, err := env.handler.Overview(ctx, env.tenantID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("overview: %v", err)
|
|
||||||
}
|
|
||||||
found := false
|
|
||||||
for _, f := range overview.Flags {
|
|
||||||
if f.Key == "module:dms" {
|
|
||||||
found = true
|
|
||||||
if !f.Enabled || !f.Licensed {
|
|
||||||
t.Fatalf("flag-status unerwartet: %+v", f)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !found {
|
|
||||||
t.Fatal("erwartet 'module:dms' in der uebersicht nach dem umschalten")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 2: Nutzungsstand stimmt mit den
|
|
||||||
// Backend-Zaehlern ueberein.
|
|
||||||
func TestOverview_UsageMatchesBackendCounters(t *testing.T) {
|
|
||||||
env, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
usageStore := usage.NewStore(env.pool)
|
|
||||||
if err := usageStore.Increment(ctx, env.tenantID, "users", 7); err != nil {
|
|
||||||
t.Fatalf("increment: %v", err)
|
|
||||||
}
|
|
||||||
if err := usageStore.SetQuota(ctx, env.tenantID, "users", 10); err != nil {
|
|
||||||
t.Fatalf("setquota: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
overview, err := env.handler.Overview(ctx, env.tenantID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("overview: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var got *UsageOverview
|
|
||||||
for i := range overview.Usage {
|
|
||||||
if overview.Usage[i].Metric == "users" {
|
|
||||||
got = &overview.Usage[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if got == nil {
|
|
||||||
t.Fatal("erwartet metrik 'users' in der uebersicht")
|
|
||||||
}
|
|
||||||
if got.Value != 7 || got.Limit != 10 || got.Status != usage.StatusOK {
|
|
||||||
t.Fatalf("nutzungsstand stimmt nicht mit backend-zaehler ueberein: %+v (want value=7 limit=10 status=ok, da 7/10=70%% unter der 80%%-warnschwelle liegt)", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 / Pruefung 1 auf HTTP-Ebene: der Endpunkt liefert
|
|
||||||
// 403 mit verstaendlicher Fehlermeldung, kein interner Serverfehler.
|
|
||||||
func TestToggleFlagHandler_HTTPForbiddenOnUnlicensed(t *testing.T) {
|
|
||||||
env, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
body, _ := json.Marshal(toggleRequest{Tenant: env.tenantID, Key: "module:archive", Enabled: true})
|
|
||||||
req := httptest.NewRequest(http.MethodPost, "/admin/flags/toggle", bytes.NewReader(body))
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
|
|
||||||
env.handler.ToggleFlagHandler(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusForbidden {
|
|
||||||
t.Fatalf("status = %d, want 403", rec.Code)
|
|
||||||
}
|
|
||||||
var resp map[string]string
|
|
||||||
if err := json.Unmarshal(rec.Body.Bytes(), &resp); err != nil {
|
|
||||||
t.Fatalf("body parsen: %v", err)
|
|
||||||
}
|
|
||||||
if resp["error"] == "" {
|
|
||||||
t.Fatal("erwartet verstaendliche fehlermeldung im response-body")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestOverviewHandler_HTTPReturnsCombinedData(t *testing.T) {
|
|
||||||
env, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
|
|
||||||
req := httptest.NewRequest(http.MethodGet, "/admin/overview?tenant="+env.tenantID, nil)
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
env.handler.OverviewHandler(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusOK {
|
|
||||||
t.Fatalf("status = %d, want 200", rec.Code)
|
|
||||||
}
|
|
||||||
var overview Overview
|
|
||||||
if err := json.Unmarshal(rec.Body.Bytes(), &overview); err != nil {
|
|
||||||
t.Fatalf("body parsen: %v", err)
|
|
||||||
}
|
|
||||||
if overview.Plan != "professional" {
|
|
||||||
t.Fatalf("plan = %q, want professional", overview.Plan)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -50,29 +50,6 @@ func (s *Store) Set(ctx context.Context, f Flag) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// List liefert alle definierten Flags (Admin-Uebersicht, siehe LIC-04) —
|
|
||||||
// rein additiv, aendert nichts am bestehenden Verhalten von Set/Get.
|
|
||||||
func (s *Store) List(ctx context.Context) ([]Flag, error) {
|
|
||||||
rows, err := s.pool.Query(ctx, `
|
|
||||||
SELECT key, enabled, rollout_percentage, target_tenant_slugs
|
|
||||||
FROM feature_flags ORDER BY key
|
|
||||||
`)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("flags auflisten: %w", err)
|
|
||||||
}
|
|
||||||
defer rows.Close()
|
|
||||||
|
|
||||||
var out []Flag
|
|
||||||
for rows.Next() {
|
|
||||||
var f Flag
|
|
||||||
if err := rows.Scan(&f.Key, &f.Enabled, &f.RolloutPercentage, &f.TargetTenantSlugs); err != nil {
|
|
||||||
return nil, fmt.Errorf("flag-zeile lesen: %w", err)
|
|
||||||
}
|
|
||||||
out = append(out, f)
|
|
||||||
}
|
|
||||||
return out, rows.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Store) Get(ctx context.Context, key string) (Flag, error) {
|
func (s *Store) Get(ctx context.Context, key string) (Flag, error) {
|
||||||
var f Flag
|
var f Flag
|
||||||
row := s.pool.QueryRow(ctx, `
|
row := s.pool.QueryRow(ctx, `
|
||||||
|
|||||||
@@ -0,0 +1,25 @@
|
|||||||
|
package health
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DatabaseChecker prueft die tatsaechliche Erreichbarkeit der Datenbank
|
||||||
|
// (Ping) — nicht nur, ob der Pool existiert.
|
||||||
|
func DatabaseChecker(pool *pgxpool.Pool) CheckerFunc {
|
||||||
|
return func(ctx context.Context) error {
|
||||||
|
return pool.Ping(ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueueChecker prueft, dass die Postgres-basierte Job-Queue (siehe CFG-02)
|
||||||
|
// tatsaechlich abfragbar ist — eine eigene, benannte Abhaengigkeit neben der
|
||||||
|
// reinen DB-Erreichbarkeit (Akzeptanzkriterium 1).
|
||||||
|
func QueueChecker(pool *pgxpool.Pool) CheckerFunc {
|
||||||
|
return func(ctx context.Context) error {
|
||||||
|
_, err := pool.Exec(ctx, `SELECT 1`)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
package health
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
// LivenessHandler beantwortet IMMER "lebt", solange der Prozess ueberhaupt
|
||||||
|
// HTTP-Anfragen verarbeiten kann — prueft bewusst KEINE externen
|
||||||
|
// Abhaengigkeiten (Akzeptanzkriterium 2: Liveness und Readiness getrennt).
|
||||||
|
// Ein Datenbankausfall darf die Liveness nicht auf "tot" setzen, sonst
|
||||||
|
// wuerde eine Orchestrierung (z.B. systemd/Kubernetes) den Prozess grundlos
|
||||||
|
// neu starten, obwohl nur eine Abhaengigkeit ausgefallen ist.
|
||||||
|
func LivenessHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
writeStatus(w, http.StatusOK, map[string]any{"status": "alive"})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadinessHandler prueft ALLE registrierten Abhaengigkeiten
|
||||||
|
// (Akzeptanzkriterium 1) und liefert 503, sobald eine davon fehlschlaegt
|
||||||
|
// (Akzeptanzkriterium 3) — unterscheidet sich damit nachweislich von
|
||||||
|
// LivenessHandler im Fehlerfall (Akzeptanzkriterium 2 / Pruefung 3).
|
||||||
|
func (r *Registry) ReadinessHandler() http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, req *http.Request) {
|
||||||
|
ready, results := r.CheckAll(req.Context())
|
||||||
|
|
||||||
|
body := map[string]any{
|
||||||
|
"status": statusText(ready),
|
||||||
|
"checks": results,
|
||||||
|
}
|
||||||
|
status := http.StatusOK
|
||||||
|
if !ready {
|
||||||
|
status = http.StatusServiceUnavailable
|
||||||
|
}
|
||||||
|
writeStatus(w, status, body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func statusText(ready bool) string {
|
||||||
|
if ready {
|
||||||
|
return "ready"
|
||||||
|
}
|
||||||
|
return "not_ready"
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeStatus(w http.ResponseWriter, status int, body map[string]any) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
w.WriteHeader(status)
|
||||||
|
_ = json.NewEncoder(w).Encode(body)
|
||||||
|
}
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
// Package health implementiert Core OPS-01: Health-/Readiness-Endpunkte, die
|
||||||
|
// echte Abhaengigkeiten (DB, Job-Queue) statt nur den Prozessstatus pruefen
|
||||||
|
// — wiederverwendbar von Core UND jedem registrierten Modul (siehe API-02),
|
||||||
|
// nicht nur von Core selbst.
|
||||||
|
package health
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Checker prueft EINE Abhaengigkeit (z.B. Datenbank, Job-Queue).
|
||||||
|
type Checker interface {
|
||||||
|
Check(ctx context.Context) error
|
||||||
|
}
|
||||||
|
|
||||||
|
type CheckerFunc func(ctx context.Context) error
|
||||||
|
|
||||||
|
func (f CheckerFunc) Check(ctx context.Context) error { return f(ctx) }
|
||||||
|
|
||||||
|
// DefaultCheckTimeout begrenzt, wie lange EIN einzelner Check maximal
|
||||||
|
// dauern darf, bevor er als fehlgeschlagen gilt — verhindert, dass ein
|
||||||
|
// haengender Check den gesamten Readiness-Endpunkt blockiert
|
||||||
|
// (Akzeptanzkriterium 2 / Pruefung 2: Antwort innerhalb definierter Zeit).
|
||||||
|
const DefaultCheckTimeout = 2 * time.Second
|
||||||
|
|
||||||
|
// Registry haelt alle benannten Checks eines Dienstes.
|
||||||
|
type Registry struct {
|
||||||
|
checks map[string]Checker
|
||||||
|
timeout time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewRegistry() *Registry {
|
||||||
|
return &Registry{checks: make(map[string]Checker), timeout: DefaultCheckTimeout}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Registry) WithTimeout(d time.Duration) *Registry {
|
||||||
|
return &Registry{checks: r.checks, timeout: d}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Register fuegt einen benannten Check hinzu (z.B. "database", "queue").
|
||||||
|
func (r *Registry) Register(name string, c Checker) {
|
||||||
|
r.checks[name] = c
|
||||||
|
}
|
||||||
|
|
||||||
|
// Result ist der Ausgang eines einzelnen Checks.
|
||||||
|
type Result struct {
|
||||||
|
OK bool
|
||||||
|
Error string
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckAll fuehrt alle registrierten Checks NEBENLAEUFIG mit je eigenem
|
||||||
|
// Timeout aus (Akzeptanzkriterium 1: echte Abhaengigkeiten statt Prozess-
|
||||||
|
// status) und liefert ready=false, sobald irgendein Check fehlschlaegt
|
||||||
|
// (Akzeptanzkriterium 3: ein Ausfall wird sichtbar).
|
||||||
|
func (r *Registry) CheckAll(ctx context.Context) (ready bool, results map[string]Result) {
|
||||||
|
type namedResult struct {
|
||||||
|
name string
|
||||||
|
result Result
|
||||||
|
}
|
||||||
|
ch := make(chan namedResult, len(r.checks))
|
||||||
|
|
||||||
|
for name, checker := range r.checks {
|
||||||
|
go func(name string, checker Checker) {
|
||||||
|
checkCtx, cancel := context.WithTimeout(ctx, r.timeout)
|
||||||
|
defer cancel()
|
||||||
|
err := checker.Check(checkCtx)
|
||||||
|
if err != nil {
|
||||||
|
ch <- namedResult{name, Result{OK: false, Error: err.Error()}}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ch <- namedResult{name, Result{OK: true}}
|
||||||
|
}(name, checker)
|
||||||
|
}
|
||||||
|
|
||||||
|
results = make(map[string]Result, len(r.checks))
|
||||||
|
ready = true
|
||||||
|
for i := 0; i < len(r.checks); i++ {
|
||||||
|
nr := <-ch
|
||||||
|
results[nr.name] = nr.result
|
||||||
|
if !nr.result.OK {
|
||||||
|
ready = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ready, results
|
||||||
|
}
|
||||||
@@ -0,0 +1,161 @@
|
|||||||
|
package health
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1 + Pruefung 1: simulierter Datenbankausfall fuehrt zu
|
||||||
|
// "nicht bereit".
|
||||||
|
func TestReadinessHandler_ReportsNotReadyOnDatabaseFailure(t *testing.T) {
|
||||||
|
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
||||||
|
if adminDSN == "" {
|
||||||
|
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
pool, err := pgxpool.New(ctx, adminDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pool: %v", err)
|
||||||
|
}
|
||||||
|
// Datenbankausfall simulieren: Pool sofort schliessen, bevor der Check laeuft.
|
||||||
|
pool.Close()
|
||||||
|
|
||||||
|
reg := NewRegistry()
|
||||||
|
reg.Register("database", DatabaseChecker(pool))
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/readyz", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
reg.ReadinessHandler()(rec, req)
|
||||||
|
|
||||||
|
if rec.Code != http.StatusServiceUnavailable {
|
||||||
|
t.Fatalf("status = %d, want 503 bei db-ausfall", rec.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
var body struct {
|
||||||
|
Status string `json:"status"`
|
||||||
|
Checks map[string]interface{} `json:"checks"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(rec.Body.Bytes(), &body); err != nil {
|
||||||
|
t.Fatalf("body parsen: %v", err)
|
||||||
|
}
|
||||||
|
if body.Status != "not_ready" {
|
||||||
|
t.Fatalf("status-feld = %q, want not_ready", body.Status)
|
||||||
|
}
|
||||||
|
if _, ok := body.Checks["database"]; !ok {
|
||||||
|
t.Fatal("erwartet 'database' im checks-ergebnis")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReadinessHandler_ReportsReadyWhenAllChecksPass(t *testing.T) {
|
||||||
|
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
||||||
|
if adminDSN == "" {
|
||||||
|
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
pool, err := pgxpool.New(ctx, adminDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pool: %v", err)
|
||||||
|
}
|
||||||
|
defer pool.Close()
|
||||||
|
|
||||||
|
reg := NewRegistry()
|
||||||
|
reg.Register("database", DatabaseChecker(pool))
|
||||||
|
reg.Register("queue", QueueChecker(pool))
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/readyz", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
reg.ReadinessHandler()(rec, req)
|
||||||
|
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("status = %d, want 200 bei funktionierenden abhaengigkeiten", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 3: Liveness und Readiness unterscheiden
|
||||||
|
// sich nachweislich im Fehlerfall.
|
||||||
|
func TestLivenessAndReadiness_DifferOnDatabaseFailure(t *testing.T) {
|
||||||
|
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
||||||
|
if adminDSN == "" {
|
||||||
|
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
pool, err := pgxpool.New(ctx, adminDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pool: %v", err)
|
||||||
|
}
|
||||||
|
pool.Close() // db-ausfall simulieren
|
||||||
|
|
||||||
|
reg := NewRegistry()
|
||||||
|
reg.Register("database", DatabaseChecker(pool))
|
||||||
|
|
||||||
|
livenessRec := httptest.NewRecorder()
|
||||||
|
LivenessHandler(livenessRec, httptest.NewRequest(http.MethodGet, "/livez", nil))
|
||||||
|
if livenessRec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("liveness status = %d, want 200 trotz db-ausfall (liveness prueft keine abhaengigkeiten)", livenessRec.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
readinessRec := httptest.NewRecorder()
|
||||||
|
reg.ReadinessHandler()(readinessRec, httptest.NewRequest(http.MethodGet, "/readyz", nil))
|
||||||
|
if readinessRec.Code != http.StatusServiceUnavailable {
|
||||||
|
t.Fatalf("readiness status = %d, want 503 bei db-ausfall", readinessRec.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
if livenessRec.Code == readinessRec.Code {
|
||||||
|
t.Fatal("liveness und readiness sollten sich im db-ausfall-fall unterscheiden")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 2: Health-Endpunkt antwortet auch bei
|
||||||
|
// haengendem Check innerhalb definierter Zeit (Timeout begrenzt die Dauer).
|
||||||
|
func TestReadinessHandler_RespondsWithinTimeoutEvenWithHangingCheck(t *testing.T) {
|
||||||
|
reg := NewRegistry().WithTimeout(50 * time.Millisecond)
|
||||||
|
reg.Register("haengender_dienst", CheckerFunc(func(ctx context.Context) error {
|
||||||
|
select {
|
||||||
|
case <-time.After(10 * time.Second): // wuerde ohne timeout ewig blockieren
|
||||||
|
return nil
|
||||||
|
case <-ctx.Done():
|
||||||
|
return ctx.Err()
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
|
||||||
|
start := time.Now()
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/readyz", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
reg.ReadinessHandler()(rec, req)
|
||||||
|
elapsed := time.Since(start)
|
||||||
|
|
||||||
|
if elapsed > time.Second {
|
||||||
|
t.Fatalf("readiness handler brauchte %s, erwartet deutlich unter 1s durch timeout", elapsed)
|
||||||
|
}
|
||||||
|
if rec.Code != http.StatusServiceUnavailable {
|
||||||
|
t.Fatalf("status = %d, want 503 fuer haengenden/timeout-check", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckAll_MultipleChecksRunConcurrently(t *testing.T) {
|
||||||
|
reg := NewRegistry().WithTimeout(time.Second)
|
||||||
|
reg.Register("a", CheckerFunc(func(ctx context.Context) error { return nil }))
|
||||||
|
reg.Register("b", CheckerFunc(func(ctx context.Context) error { return errors.New("kaputt") }))
|
||||||
|
|
||||||
|
ready, results := reg.CheckAll(context.Background())
|
||||||
|
if ready {
|
||||||
|
t.Fatal("erwartet ready=false, da 'b' fehlschlaegt")
|
||||||
|
}
|
||||||
|
if !results["a"].OK {
|
||||||
|
t.Fatalf("erwartet 'a' ok, habe %+v", results["a"])
|
||||||
|
}
|
||||||
|
if results["b"].OK || results["b"].Error == "" {
|
||||||
|
t.Fatalf("erwartet 'b' fehlgeschlagen mit fehlertext, habe %+v", results["b"])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
// Package license implementiert Core LIC-01: Lizenzmodell je Tenant (Plan,
|
|
||||||
// Modul-Umfang, Laufzeit) und die kryptographische Pruefung signierter
|
|
||||||
// Lizenzschluessel. Feature-Flag-AUSWERTUNG zur Laufzeit (LIC-02) und die
|
|
||||||
// Verwaltungsoberflaeche (LIC-04) sind ausdruecklich nicht Teil dieses Pakets
|
|
||||||
// — hier geht es nur um Ausstellung/Validierung/Persistenz (Unleash-Vorbild:
|
|
||||||
// klare Trennung Flag-Verwaltung vs. Flag-Auswertung).
|
|
||||||
package license
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/ed25519"
|
|
||||||
"encoding/base64"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrInvalidSignature = errors.New("license: signatur ungueltig")
|
|
||||||
ErrMalformedKey = errors.New("license: lizenzschluessel hat ungueltiges format")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Payload ist der signierte Lizenzinhalt (Akzeptanzkriterium 3: Plan,
|
|
||||||
// Modul-Liste, Laufzeit).
|
|
||||||
type Payload struct {
|
|
||||||
TenantSlug string `json:"tenant_slug"`
|
|
||||||
Plan string `json:"plan"`
|
|
||||||
Modules []string `json:"modules"`
|
|
||||||
IssuedAt time.Time `json:"issued_at"`
|
|
||||||
ValidUntil time.Time `json:"valid_until"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Issuer stellt signierte Lizenzschluessel aus. Haelt den PRIVATEN
|
|
||||||
// Ed25519-Schluessel — lebt in der Praxis beim Lizenzgeber, nicht im
|
|
||||||
// laufenden Core-Prozess (der nur den Validator mit dem oeffentlichen
|
|
||||||
// Schluessel braucht).
|
|
||||||
type Issuer struct {
|
|
||||||
priv ed25519.PrivateKey
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewIssuer(priv ed25519.PrivateKey) *Issuer {
|
|
||||||
return &Issuer{priv: priv}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Issue liefert den Lizenzschluessel im Format base64(payload-json) "." base64(signatur).
|
|
||||||
func (i *Issuer) Issue(payload Payload) (string, error) {
|
|
||||||
raw, err := json.Marshal(payload)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("payload serialisieren: %w", err)
|
|
||||||
}
|
|
||||||
sig := ed25519.Sign(i.priv, raw)
|
|
||||||
|
|
||||||
return base64.RawURLEncoding.EncodeToString(raw) + "." + base64.RawURLEncoding.EncodeToString(sig), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Validator prueft Lizenzschluessel gegen den OEFFENTLICHEN Ed25519-Schluessel
|
|
||||||
// — das ist alles, was der laufende Core-Prozess kennen muss.
|
|
||||||
type Validator struct {
|
|
||||||
pub ed25519.PublicKey
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewValidator(pub ed25519.PublicKey) *Validator {
|
|
||||||
return &Validator{pub: pub}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse prueft die Signatur (Akzeptanzkriterium 1 / Pruefung 1) und liefert
|
|
||||||
// bei Erfolg den entschluesselten Payload. Ein manipulierter Schluessel wird
|
|
||||||
// hier zuverlaessig erkannt, unabhaengig davon, ob die Laufzeit noch gueltig
|
|
||||||
// waere — Signaturpruefung und Ablaufpruefung sind bewusst getrennt
|
|
||||||
// (Signatur bei Einspielen, Ablauf bei jeder Nutzung, siehe Store.RequireActive).
|
|
||||||
func (v *Validator) Parse(key string) (Payload, error) {
|
|
||||||
rawPart, sigPart, ok := splitOnce(key, '.')
|
|
||||||
if !ok {
|
|
||||||
return Payload{}, ErrMalformedKey
|
|
||||||
}
|
|
||||||
|
|
||||||
raw, err := base64.RawURLEncoding.DecodeString(rawPart)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, ErrMalformedKey
|
|
||||||
}
|
|
||||||
sig, err := base64.RawURLEncoding.DecodeString(sigPart)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, ErrMalformedKey
|
|
||||||
}
|
|
||||||
|
|
||||||
if !ed25519.Verify(v.pub, raw, sig) {
|
|
||||||
return Payload{}, ErrInvalidSignature
|
|
||||||
}
|
|
||||||
|
|
||||||
var p Payload
|
|
||||||
if err := json.Unmarshal(raw, &p); err != nil {
|
|
||||||
// Signatur war gueltig, aber Payload nicht mehr parsebar — sollte bei
|
|
||||||
// unveraenderten Schluesseln nie vorkommen, trotzdem kein Panic.
|
|
||||||
return Payload{}, fmt.Errorf("%w: payload nicht lesbar", ErrMalformedKey)
|
|
||||||
}
|
|
||||||
return p, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func splitOnce(s string, sep byte) (before, after string, ok bool) {
|
|
||||||
for i := 0; i < len(s); i++ {
|
|
||||||
if s[i] == sep {
|
|
||||||
return s[:i], s[i+1:], true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return "", "", false
|
|
||||||
}
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
package license
|
|
||||||
|
|
||||||
import (
|
|
||||||
"crypto/ed25519"
|
|
||||||
"errors"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func testKeyPair(t *testing.T) (ed25519.PublicKey, ed25519.PrivateKey) {
|
|
||||||
t.Helper()
|
|
||||||
pub, priv, err := ed25519.GenerateKey(nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("schluesselpaar erzeugen: %v", err)
|
|
||||||
}
|
|
||||||
return pub, priv
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIssueAndParse_RoundTrip(t *testing.T) {
|
|
||||||
pub, priv := testKeyPair(t)
|
|
||||||
issuer := NewIssuer(priv)
|
|
||||||
validator := NewValidator(pub)
|
|
||||||
|
|
||||||
payload := Payload{
|
|
||||||
TenantSlug: "acme",
|
|
||||||
Plan: "pro",
|
|
||||||
Modules: []string{"dms", "mail"},
|
|
||||||
IssuedAt: time.Now().Truncate(time.Second),
|
|
||||||
ValidUntil: time.Now().Add(365 * 24 * time.Hour).Truncate(time.Second),
|
|
||||||
}
|
|
||||||
|
|
||||||
key, err := issuer.Issue(payload)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
got, err := validator.Parse(key)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse: %v", err)
|
|
||||||
}
|
|
||||||
if got.TenantSlug != payload.TenantSlug || got.Plan != payload.Plan || len(got.Modules) != 2 {
|
|
||||||
t.Fatalf("payload nach parse unerwartet: %+v", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 1: manipulierter Schluessel wird zuverlaessig erkannt.
|
|
||||||
func TestParse_RejectsTamperedKey(t *testing.T) {
|
|
||||||
pub, priv := testKeyPair(t)
|
|
||||||
issuer := NewIssuer(priv)
|
|
||||||
validator := NewValidator(pub)
|
|
||||||
|
|
||||||
key, err := issuer.Issue(Payload{TenantSlug: "acme", Plan: "pro", ValidUntil: time.Now().Add(time.Hour)})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Ein Zeichen im signierten Teil aendern.
|
|
||||||
tampered := []byte(key)
|
|
||||||
changed := false
|
|
||||||
for i, c := range tampered {
|
|
||||||
if c != '.' {
|
|
||||||
if c == 'A' {
|
|
||||||
tampered[i] = 'B'
|
|
||||||
} else {
|
|
||||||
tampered[i] = 'A'
|
|
||||||
}
|
|
||||||
changed = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !changed {
|
|
||||||
t.Fatal("testaufbau fehlerhaft: nichts zum manipulieren gefunden")
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := validator.Parse(string(tampered)); !errors.Is(err, ErrInvalidSignature) {
|
|
||||||
t.Fatalf("erwartet ErrInvalidSignature, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParse_RejectsWrongKeyPair(t *testing.T) {
|
|
||||||
_, priv := testKeyPair(t)
|
|
||||||
otherPub, _ := testKeyPair(t)
|
|
||||||
|
|
||||||
issuer := NewIssuer(priv)
|
|
||||||
validator := NewValidator(otherPub) // falscher oeffentlicher Schluessel
|
|
||||||
|
|
||||||
key, err := issuer.Issue(Payload{TenantSlug: "acme", Plan: "pro"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := validator.Parse(key); !errors.Is(err, ErrInvalidSignature) {
|
|
||||||
t.Fatalf("erwartet ErrInvalidSignature, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParse_RejectsMalformedKey(t *testing.T) {
|
|
||||||
pub, _ := testKeyPair(t)
|
|
||||||
validator := NewValidator(pub)
|
|
||||||
|
|
||||||
cases := []string{"", "keine-punkt-trennung", "!!!.!!!"}
|
|
||||||
for _, c := range cases {
|
|
||||||
if _, err := validator.Parse(c); !errors.Is(err, ErrMalformedKey) {
|
|
||||||
t.Fatalf("Parse(%q): erwartet ErrMalformedKey, habe %v", c, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
package license
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrNoLicense = errors.New("license: kein lizenzdatensatz fuer diesen tenant")
|
|
||||||
ErrLicenseExpired = errors.New("license: lizenz abgelaufen")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Store persistiert den Lizenzumfang je Tenant in der Control-Plane-Registry
|
|
||||||
// (siehe internal/tenant.Registry — dieselbe Datenbank, aber ein eigener,
|
|
||||||
// unabhaengiger Store, um internal/tenant nicht um lizenzfremde Belange zu
|
|
||||||
// erweitern).
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
validator *Validator
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool, validator *Validator) *Store {
|
|
||||||
return &Store{pool: pool, validator: validator}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Install prueft die Signatur des Lizenzschluessels (Akzeptanzkriterium 1)
|
|
||||||
// und ersetzt den bisherigen Lizenzdatensatz des Tenants vollstaendig. Ein
|
|
||||||
// bereits abgelaufener, aber korrekt signierter Schluessel wird trotzdem
|
|
||||||
// gespeichert — der Ablauf wird erst bei der Nutzung (RequireActive)
|
|
||||||
// bewertet, nicht beim Einspielen.
|
|
||||||
func (s *Store) Install(ctx context.Context, tenantID, licenseKey string) (Payload, error) {
|
|
||||||
payload, err := s.validator.Parse(licenseKey)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO tenant_licenses (tenant_id, plan, modules, issued_at, valid_until, raw_key, installed_at)
|
|
||||||
VALUES ($1, $2, $3, $4, $5, $6, now())
|
|
||||||
ON CONFLICT (tenant_id) DO UPDATE SET
|
|
||||||
plan = $2, modules = $3, issued_at = $4, valid_until = $5, raw_key = $6, installed_at = now()
|
|
||||||
`, tenantID, payload.Plan, payload.Modules, payload.IssuedAt, payload.ValidUntil, licenseKey)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, fmt.Errorf("lizenz speichern: %w", err)
|
|
||||||
}
|
|
||||||
return payload, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Store) get(ctx context.Context, tenantID string) (Payload, error) {
|
|
||||||
var p Payload
|
|
||||||
row := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT plan, modules, issued_at, valid_until
|
|
||||||
FROM tenant_licenses WHERE tenant_id = $1
|
|
||||||
`, tenantID)
|
|
||||||
if err := row.Scan(&p.Plan, &p.Modules, &p.IssuedAt, &p.ValidUntil); err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return Payload{}, ErrNoLicense
|
|
||||||
}
|
|
||||||
return Payload{}, fmt.Errorf("lizenz lesen: %w", err)
|
|
||||||
}
|
|
||||||
return p, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Status liefert den persistierten Lizenzumfang unabhaengig vom Ablauf
|
|
||||||
// (Akzeptanzkriterium 3: Plan, Modul-Liste, Laufzeit abfragbar).
|
|
||||||
func (s *Store) Status(ctx context.Context, tenantID string) (Payload, error) {
|
|
||||||
return s.get(ctx, tenantID)
|
|
||||||
}
|
|
||||||
|
|
||||||
// RequireActive liefert den Lizenzumfang NUR, wenn die Lizenz noch nicht
|
|
||||||
// abgelaufen ist — sonst ErrLicenseExpired statt eines harten Fehlers/Panics
|
|
||||||
// (Akzeptanzkriterium 2: definierter eingeschraenkter Zustand). Aufrufende
|
|
||||||
// Module (LIC-02/03) entscheiden, was "eingeschraenkt" konkret bedeutet.
|
|
||||||
func (s *Store) RequireActive(ctx context.Context, tenantID string) (Payload, error) {
|
|
||||||
p, err := s.get(ctx, tenantID)
|
|
||||||
if err != nil {
|
|
||||||
return Payload{}, err
|
|
||||||
}
|
|
||||||
if time.Now().After(p.ValidUntil) {
|
|
||||||
return Payload{}, ErrLicenseExpired
|
|
||||||
}
|
|
||||||
return p, nil
|
|
||||||
}
|
|
||||||
@@ -1,177 +0,0 @@
|
|||||||
package license
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"crypto/ed25519"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupStoreTest(t *testing.T) (*Store, *Issuer, string, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS tenants (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
slug TEXT NOT NULL UNIQUE,
|
|
||||||
name TEXT NOT NULL,
|
|
||||||
db_name TEXT NOT NULL UNIQUE,
|
|
||||||
db_dsn TEXT NOT NULL,
|
|
||||||
status TEXT NOT NULL DEFAULT 'active',
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS tenant_licenses (
|
|
||||||
tenant_id UUID PRIMARY KEY REFERENCES tenants(id),
|
|
||||||
plan TEXT NOT NULL,
|
|
||||||
modules TEXT[] NOT NULL,
|
|
||||||
issued_at TIMESTAMPTZ NOT NULL,
|
|
||||||
valid_until TIMESTAMPTZ NOT NULL,
|
|
||||||
raw_key TEXT NOT NULL,
|
|
||||||
installed_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var tenantID string
|
|
||||||
if err := pool.QueryRow(ctx, `
|
|
||||||
INSERT INTO tenants (slug, name, db_name, db_dsn)
|
|
||||||
VALUES ('lic_test_tenant', 'Lic Test', 'tenant_lic_test', 'unused')
|
|
||||||
RETURNING id
|
|
||||||
`).Scan(&tenantID); err != nil {
|
|
||||||
t.Fatalf("test-tenant anlegen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub, priv, err := ed25519.GenerateKey(nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("schluesselpaar: %v", err)
|
|
||||||
}
|
|
||||||
issuer := NewIssuer(priv)
|
|
||||||
store := NewStore(pool, NewValidator(pub))
|
|
||||||
|
|
||||||
cleanup := func() {
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM tenant_licenses WHERE tenant_id = $1`, tenantID)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM tenants WHERE id = $1`, tenantID)
|
|
||||||
pool.Close()
|
|
||||||
}
|
|
||||||
return store, issuer, tenantID, cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3: Lizenzumfang persistiert und abfragbar.
|
|
||||||
func TestStore_InstallAndStatus(t *testing.T) {
|
|
||||||
store, issuer, tenantID, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
payload := Payload{
|
|
||||||
TenantSlug: "lic_test_tenant",
|
|
||||||
Plan: "enterprise",
|
|
||||||
Modules: []string{"dms", "mail", "archive"},
|
|
||||||
IssuedAt: time.Now().Truncate(time.Second),
|
|
||||||
ValidUntil: time.Now().Add(30 * 24 * time.Hour).Truncate(time.Second),
|
|
||||||
}
|
|
||||||
key, err := issuer.Issue(payload)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Install(ctx, tenantID, key); err != nil {
|
|
||||||
t.Fatalf("install: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
status, err := store.Status(ctx, tenantID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("status: %v", err)
|
|
||||||
}
|
|
||||||
if status.Plan != "enterprise" || len(status.Modules) != 3 {
|
|
||||||
t.Fatalf("status unerwartet: %+v", status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStore_InstallRejectsInvalidSignature(t *testing.T) {
|
|
||||||
store, _, tenantID, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
_, otherPriv, _ := ed25519.GenerateKey(nil)
|
|
||||||
foreignIssuer := NewIssuer(otherPriv) // signiert mit falschem schluessel
|
|
||||||
|
|
||||||
key, err := foreignIssuer.Issue(Payload{TenantSlug: "lic_test_tenant", Plan: "pro", ValidUntil: time.Now().Add(time.Hour)})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Install(ctx, tenantID, key); !errors.Is(err, ErrInvalidSignature) {
|
|
||||||
t.Fatalf("erwartet ErrInvalidSignature, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 2: abgelaufene Lizenz fuehrt zu definiertem
|
|
||||||
// eingeschraenktem Zustand (ErrLicenseExpired), nicht zu einem Absturz.
|
|
||||||
func TestStore_RequireActive_DetectsExpiry(t *testing.T) {
|
|
||||||
store, issuer, tenantID, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
expired := Payload{
|
|
||||||
TenantSlug: "lic_test_tenant",
|
|
||||||
Plan: "pro",
|
|
||||||
Modules: []string{"dms"},
|
|
||||||
IssuedAt: time.Now().Add(-48 * time.Hour),
|
|
||||||
ValidUntil: time.Now().Add(-24 * time.Hour), // bereits abgelaufen
|
|
||||||
}
|
|
||||||
key, err := issuer.Issue(expired)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Einspielen einer bereits abgelaufenen, aber korrekt signierten Lizenz
|
|
||||||
// muss funktionieren (Ablauf wird erst bei Nutzung bewertet).
|
|
||||||
if _, err := store.Install(ctx, tenantID, key); err != nil {
|
|
||||||
t.Fatalf("install sollte trotz ablauf funktionieren: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func() {
|
|
||||||
defer func() {
|
|
||||||
if r := recover(); r != nil {
|
|
||||||
t.Fatalf("RequireActive hat gepanict statt einen fehler zu liefern: %v", r)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
if _, err := store.RequireActive(ctx, tenantID); !errors.Is(err, ErrLicenseExpired) {
|
|
||||||
t.Fatalf("erwartet ErrLicenseExpired, habe %v", err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
// Aber der Umfang bleibt weiterhin abfragbar (Status, im Unterschied zu RequireActive).
|
|
||||||
status, err := store.Status(ctx, tenantID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("status sollte trotz ablauf funktionieren: %v", err)
|
|
||||||
}
|
|
||||||
if status.Plan != "pro" {
|
|
||||||
t.Fatalf("status unerwartet: %+v", status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStore_RequireActive_NoLicense(t *testing.T) {
|
|
||||||
store, _, tenantID, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := store.RequireActive(ctx, tenantID); !errors.Is(err, ErrNoLicense) {
|
|
||||||
t.Fatalf("erwartet ErrNoLicense, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
package metrics
|
||||||
|
|
||||||
|
import "github.com/prometheus/client_golang/prometheus"
|
||||||
|
|
||||||
|
// NewCoreRegistry liefert das Prometheus-Registry fuer die EIGENEN
|
||||||
|
// Kennzahlen des Core-Dienstes (Akzeptanzkriterium 1) — alle Namen tragen
|
||||||
|
// das Praefix "nexarch_core_" gemaess der im Paketkommentar dokumentierten
|
||||||
|
// Namenskonvention (Akzeptanzkriterium 3). Ein eigenes Registry statt des
|
||||||
|
// globalen DefaultRegisterer, damit Tests unabhaengig voneinander sind.
|
||||||
|
func NewCoreRegistry() *prometheus.Registry {
|
||||||
|
reg := prometheus.NewRegistry()
|
||||||
|
reg.MustRegister(
|
||||||
|
prometheus.NewGaugeFunc(prometheus.GaugeOpts{
|
||||||
|
Name: "nexarch_core_up",
|
||||||
|
Help: "1, solange der Core-Dienst laeuft und Metriken liefern kann.",
|
||||||
|
}, func() float64 { return 1 }),
|
||||||
|
)
|
||||||
|
return reg
|
||||||
|
}
|
||||||
@@ -0,0 +1,168 @@
|
|||||||
|
// Package metrics implementiert Core OPS-03: einen zentralen /metrics-
|
||||||
|
// Endpunkt im Prometheus-Textformat, der Kennzahlen des Core-Dienstes UND
|
||||||
|
// aggregierte Kennzahlen aller registrierten Module bereitstellt — offenes
|
||||||
|
// Pull-Modell nach Prometheus-Vorbild, kein proprietaerer Push-Mechanismus.
|
||||||
|
//
|
||||||
|
// Namenskonvention (Akzeptanzkriterium 3, modulübergreifend konsistent):
|
||||||
|
//
|
||||||
|
// nexarch_core_<name> — Kennzahlen des Core-Dienstes selbst
|
||||||
|
// nexarch_module_<modul>_<name> — von einem Modul gescrapte Kennzahl
|
||||||
|
// <name>, umbenannt mit dem
|
||||||
|
// Modulnamen als Praefix
|
||||||
|
//
|
||||||
|
// Ein Modul liefert seine eigenen Kennzahlen unter EIGENEM Namen (z.B.
|
||||||
|
// "requests_total") unter seinem eigenen /metrics-Endpunkt — dieses Paket
|
||||||
|
// benennt sie beim Einsammeln konsistent um, damit im aggregierten Core-
|
||||||
|
// Endpunkt niemals zwei Module denselben Metrik-Namen kollidieren lassen.
|
||||||
|
package metrics
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/prometheus/client_golang/prometheus"
|
||||||
|
dto "github.com/prometheus/client_model/go"
|
||||||
|
"github.com/prometheus/common/expfmt"
|
||||||
|
"github.com/prometheus/common/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// init erzwingt das klassische Prometheus-Namensschema (a-z, A-Z, 0-9, _)
|
||||||
|
// fuer die Namensvalidierung von expfmt/model — ohne diese explizite
|
||||||
|
// Festlegung liefert die Bibliothek "Invalid name validation scheme
|
||||||
|
// requested: unset" beim Parsen/Kodieren, da sie den globalen Default in
|
||||||
|
// dieser Version nicht mehr implizit setzt.
|
||||||
|
func init() {
|
||||||
|
model.NameValidationScheme = model.LegacyValidation
|
||||||
|
}
|
||||||
|
|
||||||
|
// Source ist EIN registriertes Modul mit seinem eigenen /metrics-Endpunkt
|
||||||
|
// (siehe internal/health fuer das analoge Muster bei Readiness-Checks).
|
||||||
|
type Source struct {
|
||||||
|
ModuleName string
|
||||||
|
MetricsURL string
|
||||||
|
}
|
||||||
|
|
||||||
|
// SourceProvider liefert die aktuell registrierten Module — typischerweise
|
||||||
|
// rueckgebunden an internal/moduleregistry.Registry.List (API-02) ueber
|
||||||
|
// einen kleinen Adapter im aufrufenden Code, damit dieses Paket
|
||||||
|
// internal/moduleregistry nicht direkt importieren muss (Kein Umbau
|
||||||
|
// angrenzender Bereiche). Ein NEU registriertes Modul erscheint automatisch
|
||||||
|
// beim naechsten Aufruf von Aggregator.Handler, OHNE Codeaenderung an diesem
|
||||||
|
// Paket (Akzeptanzkriterium 2 / Pruefung 2).
|
||||||
|
type SourceProvider func(ctx context.Context) ([]Source, error)
|
||||||
|
|
||||||
|
// FetchTimeout begrenzt, wie lange EIN Modul-Scrape maximal dauern darf —
|
||||||
|
// ein haengendes Modul darf den gesamten Aggregations-Request nicht
|
||||||
|
// verzoegern (Pruefung 1: Antwort unter Last innerhalb definierter Zeit).
|
||||||
|
const FetchTimeout = 2 * time.Second
|
||||||
|
|
||||||
|
// Aggregator sammelt Core-eigene Metriken (coreGatherer) und die Metriken
|
||||||
|
// aller ueber sourceProvider gemeldeten Module in EINER Antwort ein.
|
||||||
|
type Aggregator struct {
|
||||||
|
coreGatherer prometheus.Gatherer
|
||||||
|
sourceProvider SourceProvider
|
||||||
|
client *http.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewAggregator(coreGatherer prometheus.Gatherer, sourceProvider SourceProvider) *Aggregator {
|
||||||
|
return &Aggregator{
|
||||||
|
coreGatherer: coreGatherer,
|
||||||
|
sourceProvider: sourceProvider,
|
||||||
|
client: &http.Client{Timeout: FetchTimeout},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gather implementiert prometheus.Gatherer: liefert Core-Metriken PLUS alle
|
||||||
|
// erreichbaren Modul-Metriken (umbenannt gemaess Namenskonvention) in einer
|
||||||
|
// gemeinsamen Liste von MetricFamilies.
|
||||||
|
func (a *Aggregator) Gather(ctx context.Context) ([]*dto.MetricFamily, error) {
|
||||||
|
families, err := a.coreGatherer.Gather()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("core-metriken einsammeln: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
sources, err := a.sourceProvider(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("modul-quellen ermitteln: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Module werden NEBENLAEUFIG gescrapt (dasselbe Muster wie
|
||||||
|
// internal/health.Registry.CheckAll) — ein langsames/nicht erreichbares
|
||||||
|
// Modul haelt weder andere Module noch den Gesamt-Request auf.
|
||||||
|
type fetchResult struct {
|
||||||
|
families []*dto.MetricFamily
|
||||||
|
}
|
||||||
|
resultCh := make(chan fetchResult, len(sources))
|
||||||
|
for _, src := range sources {
|
||||||
|
go func(src Source) {
|
||||||
|
fetchCtx, cancel := context.WithTimeout(ctx, FetchTimeout)
|
||||||
|
defer cancel()
|
||||||
|
mf, err := a.fetchAndRename(fetchCtx, src)
|
||||||
|
if err != nil {
|
||||||
|
resultCh <- fetchResult{} // Fehlerfall: einfach nichts beitragen, Aggregation laeuft weiter
|
||||||
|
return
|
||||||
|
}
|
||||||
|
resultCh <- fetchResult{families: mf}
|
||||||
|
}(src)
|
||||||
|
}
|
||||||
|
for range sources {
|
||||||
|
r := <-resultCh
|
||||||
|
families = append(families, r.families...)
|
||||||
|
}
|
||||||
|
|
||||||
|
return families, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// fetchAndRename ruft die /metrics-URL eines Moduls ab, parst das
|
||||||
|
// Prometheus-Textformat und benennt jede Metrik gemaess der
|
||||||
|
// Namenskonvention um (Akzeptanzkriterium 2 + 3).
|
||||||
|
func (a *Aggregator) fetchAndRename(ctx context.Context, src Source) ([]*dto.MetricFamily, error) {
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodGet, src.MetricsURL, nil)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
resp, err := a.client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
return nil, fmt.Errorf("modul %s: unerwarteter status %d", src.ModuleName, resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
parser := expfmt.NewTextParser(model.LegacyValidation)
|
||||||
|
parsed, err := parser.TextToMetricFamilies(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("modul %s: metrik-text nicht parsebar: %w", src.ModuleName, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
out := make([]*dto.MetricFamily, 0, len(parsed))
|
||||||
|
for name, mf := range parsed {
|
||||||
|
renamed := fmt.Sprintf("nexarch_module_%s_%s", src.ModuleName, name)
|
||||||
|
mf.Name = &renamed
|
||||||
|
out = append(out, mf)
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handler liefert einen HTTP-Handler, der Gather aufruft und das Ergebnis im
|
||||||
|
// Prometheus-Textformat ausgibt (Akzeptanzkriterium 1).
|
||||||
|
func (a *Aggregator) Handler() http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
families, err := a.Gather(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
http.Error(w, "metriken konnten nicht eingesammelt werden", http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Header().Set("Content-Type", string(expfmt.NewFormat(expfmt.TypeTextPlain)))
|
||||||
|
enc := expfmt.NewEncoder(w, expfmt.NewFormat(expfmt.TypeTextPlain))
|
||||||
|
for _, mf := range families {
|
||||||
|
if err := enc.Encode(mf); err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,179 @@
|
|||||||
|
package metrics
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/prometheus/common/expfmt"
|
||||||
|
"github.com/prometheus/common/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
func fakeModuleServer(metricName string) *httptest.Server {
|
||||||
|
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "text/plain; version=0.0.4")
|
||||||
|
fmt.Fprintf(w, "# HELP %s ein test-zaehler\n# TYPE %s counter\n%s 42\n", metricName, metricName, metricName)
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1: Core liefert unter dem Handler valides
|
||||||
|
// Prometheus-Textformat mit den eigenen Kennzahlen.
|
||||||
|
func TestHandler_ServesCoreMetricsInPrometheusFormat(t *testing.T) {
|
||||||
|
agg := NewAggregator(NewCoreRegistry(), func(ctx context.Context) ([]Source, error) { return nil, nil })
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/metrics", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
agg.Handler()(rec, req)
|
||||||
|
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("status = %d, want 200", rec.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
parser := expfmt.NewTextParser(model.LegacyValidation)
|
||||||
|
families, err := parser.TextToMetricFamilies(strings.NewReader(rec.Body.String()))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("antwort ist kein valides prometheus-textformat: %v", err)
|
||||||
|
}
|
||||||
|
if _, ok := families["nexarch_core_up"]; !ok {
|
||||||
|
t.Fatalf("erwartet 'nexarch_core_up' unter den core-metriken, habe: %v", keysOf(families))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func keysOf[V any](m map[string]V) []string {
|
||||||
|
out := make([]string, 0, len(m))
|
||||||
|
for k := range m {
|
||||||
|
out = append(out, k)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 2: ein NEU registriertes Modul erscheint
|
||||||
|
// in der Aggregation, OHNE dass dieses Paket oder der Aufrufer Code
|
||||||
|
// aendern muss — die Quelle kommt ausschliesslich aus sourceProvider.
|
||||||
|
func TestHandler_NewlyRegisteredModuleAppearsWithoutCodeChange(t *testing.T) {
|
||||||
|
moduleServer := fakeModuleServer("requests_total")
|
||||||
|
defer moduleServer.Close()
|
||||||
|
|
||||||
|
// Simuliert eine sich zur Laufzeit aendernde Modul-Liste (z.B. aus
|
||||||
|
// SourceStore.Provide) — zunaechst LEER, dann mit einem Eintrag.
|
||||||
|
var sources []Source
|
||||||
|
var mu sync.Mutex
|
||||||
|
provider := func(ctx context.Context) ([]Source, error) {
|
||||||
|
mu.Lock()
|
||||||
|
defer mu.Unlock()
|
||||||
|
out := make([]Source, len(sources))
|
||||||
|
copy(out, sources)
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
agg := NewAggregator(NewCoreRegistry(), provider)
|
||||||
|
|
||||||
|
// Vor der Registrierung: Modul-Metrik nicht vorhanden.
|
||||||
|
rec1 := httptest.NewRecorder()
|
||||||
|
agg.Handler()(rec1, httptest.NewRequest(http.MethodGet, "/metrics", nil))
|
||||||
|
if strings.Contains(rec1.Body.String(), "requests_total") {
|
||||||
|
t.Fatal("modul-metrik haette vor registrierung nicht erscheinen duerfen")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Modul wird "registriert" (kein Code hier oder in metrics.go aendert sich).
|
||||||
|
mu.Lock()
|
||||||
|
sources = append(sources, Source{ModuleName: "dms", MetricsURL: moduleServer.URL})
|
||||||
|
mu.Unlock()
|
||||||
|
|
||||||
|
rec2 := httptest.NewRecorder()
|
||||||
|
agg.Handler()(rec2, httptest.NewRequest(http.MethodGet, "/metrics", nil))
|
||||||
|
body := rec2.Body.String()
|
||||||
|
if !strings.Contains(body, "nexarch_module_dms_requests_total") {
|
||||||
|
t.Fatalf("erwartet umbenannte modul-metrik 'nexarch_module_dms_requests_total' nach registrierung, body:\n%s", body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 3: Namenskonvention "nexarch_module_<modul>_<name>"
|
||||||
|
// wird tatsaechlich angewendet.
|
||||||
|
func TestFetchAndRename_AppliesNamingConvention(t *testing.T) {
|
||||||
|
moduleServer := fakeModuleServer("queue_depth")
|
||||||
|
defer moduleServer.Close()
|
||||||
|
|
||||||
|
agg := NewAggregator(NewCoreRegistry(), nil)
|
||||||
|
families, err := agg.fetchAndRename(context.Background(), Source{ModuleName: "mail", MetricsURL: moduleServer.URL})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("fetchAndRename: %v", err)
|
||||||
|
}
|
||||||
|
if len(families) != 1 || families[0].GetName() != "nexarch_module_mail_queue_depth" {
|
||||||
|
t.Fatalf("erwartet genau 1 metrik 'nexarch_module_mail_queue_depth', habe: %+v", families)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ein nicht erreichbares Modul darf die Aggregation der uebrigen und die
|
||||||
|
// Gesamtantwort nicht verhindern (dieselbe Resilienz wie OPS-02).
|
||||||
|
func TestHandler_UnreachableModuleDoesNotBreakAggregation(t *testing.T) {
|
||||||
|
reachable := fakeModuleServer("healthy_metric")
|
||||||
|
defer reachable.Close()
|
||||||
|
unreachable := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
|
||||||
|
unreachableURL := unreachable.URL
|
||||||
|
unreachable.Close() // sofort schliessen -> Verbindung schlaegt fehl
|
||||||
|
|
||||||
|
provider := func(ctx context.Context) ([]Source, error) {
|
||||||
|
return []Source{
|
||||||
|
{ModuleName: "ok", MetricsURL: reachable.URL},
|
||||||
|
{ModuleName: "kaputt", MetricsURL: unreachableURL},
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
agg := NewAggregator(NewCoreRegistry(), provider)
|
||||||
|
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
agg.Handler()(rec, httptest.NewRequest(http.MethodGet, "/metrics", nil))
|
||||||
|
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("status = %d, want 200 trotz einem nicht erreichbaren modul", rec.Code)
|
||||||
|
}
|
||||||
|
body := rec.Body.String()
|
||||||
|
if !strings.Contains(body, "nexarch_module_ok_healthy_metric") {
|
||||||
|
t.Fatal("erreichbares modul haette trotz ausfall des anderen aggregiert werden sollen")
|
||||||
|
}
|
||||||
|
if strings.Contains(body, "kaputt") {
|
||||||
|
t.Fatal("nicht erreichbares modul haette keine metrik beitragen duerfen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pruefung 1: Endpunkt antwortet unter mehreren gleichzeitigen Anfragen
|
||||||
|
// innerhalb definierter Zeit — kein unbeschraenktes Blockieren durch
|
||||||
|
// langsame Module (FetchTimeout begrenzt jeden Scrape).
|
||||||
|
func TestHandler_RespondsWithinBoundedTimeUnderLoad(t *testing.T) {
|
||||||
|
hangingServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
time.Sleep(10 * time.Second) // wuerde ohne timeout jede anfrage blockieren
|
||||||
|
}))
|
||||||
|
defer hangingServer.Close()
|
||||||
|
|
||||||
|
provider := func(ctx context.Context) ([]Source, error) {
|
||||||
|
return []Source{{ModuleName: "haengend", MetricsURL: hangingServer.URL}}, nil
|
||||||
|
}
|
||||||
|
agg := NewAggregator(NewCoreRegistry(), provider)
|
||||||
|
|
||||||
|
const concurrentRequests = 10
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
start := time.Now()
|
||||||
|
for i := 0; i < concurrentRequests; i++ {
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
agg.Handler()(rec, httptest.NewRequest(http.MethodGet, "/metrics", nil))
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Errorf("status = %d, want 200", rec.Code)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
elapsed := time.Since(start)
|
||||||
|
|
||||||
|
if elapsed > FetchTimeout+3*time.Second {
|
||||||
|
t.Fatalf("%d gleichzeitige anfragen brauchten %s, erwartet deutlich unter %s durch FetchTimeout",
|
||||||
|
concurrentRequests, elapsed, FetchTimeout+3*time.Second)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
package metrics
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SourceStore persistiert, welche Module ihre Metriken unter welcher URL
|
||||||
|
// bereitstellen — dieselbe Postgres-basierte "kein Code-Deploy noetig"-
|
||||||
|
// Konvention wie internal/statuspage.Store.RegisterTarget (OPS-02): ein neu
|
||||||
|
// registriertes Modul erscheint automatisch in der Aggregation, sobald es
|
||||||
|
// hier eingetragen ist (Akzeptanzkriterium 2 / Pruefung 2).
|
||||||
|
type SourceStore struct {
|
||||||
|
pool *pgxpool.Pool
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewSourceStore(pool *pgxpool.Pool) *SourceStore {
|
||||||
|
return &SourceStore{pool: pool}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *SourceStore) RegisterSource(ctx context.Context, moduleName, metricsURL string) error {
|
||||||
|
_, err := s.pool.Exec(ctx, `
|
||||||
|
INSERT INTO metrics_sources (module_name, metrics_url)
|
||||||
|
VALUES ($1, $2)
|
||||||
|
ON CONFLICT (module_name) DO UPDATE SET metrics_url = $2
|
||||||
|
`, moduleName, metricsURL)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("metrik-quelle speichern: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Provide implementiert SourceProvider direkt aus der Datenbank.
|
||||||
|
func (s *SourceStore) Provide(ctx context.Context) ([]Source, error) {
|
||||||
|
rows, err := s.pool.Query(ctx, `SELECT module_name, metrics_url FROM metrics_sources ORDER BY module_name`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("metrik-quellen auflisten: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
var out []Source
|
||||||
|
for rows.Next() {
|
||||||
|
var src Source
|
||||||
|
if err := rows.Scan(&src.ModuleName, &src.MetricsURL); err != nil {
|
||||||
|
return nil, fmt.Errorf("metrik-quelle lesen: %w", err)
|
||||||
|
}
|
||||||
|
out = append(out, src)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
package metrics
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
func setupSourceStoreTest(t *testing.T) (*SourceStore, func()) {
|
||||||
|
t.Helper()
|
||||||
|
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
||||||
|
if adminDSN == "" {
|
||||||
|
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
pool, err := pgxpool.New(ctx, adminDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pool: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := pool.Exec(ctx, `
|
||||||
|
CREATE TABLE IF NOT EXISTS metrics_sources (module_name TEXT PRIMARY KEY, metrics_url TEXT NOT NULL)
|
||||||
|
`); err != nil {
|
||||||
|
t.Fatalf("schema: %v", err)
|
||||||
|
}
|
||||||
|
cleanup := func() { pool.Close() }
|
||||||
|
return NewSourceStore(pool), cleanup
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 / Pruefung 2 auf Persistenz-Ebene: eine ueber die
|
||||||
|
// Datenbank registrierte Quelle ist sofort ueber Provide() sichtbar — genau
|
||||||
|
// der Mechanismus, der ein neues Modul ohne Core-Codeaenderung erscheinen
|
||||||
|
// laesst.
|
||||||
|
func TestSourceStore_RegisterSourceAppearsInProvide(t *testing.T) {
|
||||||
|
store, cleanup := setupSourceStoreTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
name := fmt.Sprintf("modul-%d", time.Now().UnixNano())
|
||||||
|
|
||||||
|
if err := store.RegisterSource(ctx, name, "http://example.invalid/metrics"); err != nil {
|
||||||
|
t.Fatalf("registersource: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
sources, err := store.Provide(ctx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provide: %v", err)
|
||||||
|
}
|
||||||
|
found := false
|
||||||
|
for _, s := range sources {
|
||||||
|
if s.ModuleName == name {
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
t.Fatalf("erwartet %s in provide()-ergebnis, habe: %+v", name, sources)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
package moduleregistry
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/sha256"
|
||||||
|
"crypto/subtle"
|
||||||
|
"encoding/hex"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
ErrModuleNotRegistered = errors.New("moduleregistry: modul muss vor provisionierung registriert sein")
|
||||||
|
ErrInvalidCredential = errors.New("moduleregistry: ungueltiges oder fehlendes service-credential")
|
||||||
|
)
|
||||||
|
|
||||||
|
// Provision stellt ein Service-Credential (Client-ID + Secret) fuer eine
|
||||||
|
// Modul-Instanz aus (Akzeptanzkriterium 4). Das Secret wird NUR beim
|
||||||
|
// Ausstellen im Klartext zurueckgegeben, gespeichert wird ausschliesslich
|
||||||
|
// dessen SHA-256-Hash.
|
||||||
|
func (r *Registry) Provision(ctx context.Context, moduleName string) (clientID, secret string, err error) {
|
||||||
|
if _, err := r.Get(ctx, moduleName); err != nil {
|
||||||
|
if errors.Is(err, ErrModuleNotFound) {
|
||||||
|
return "", "", ErrModuleNotRegistered
|
||||||
|
}
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
|
||||||
|
clientID, err = randomToken(16)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", fmt.Errorf("client-id erzeugen: %w", err)
|
||||||
|
}
|
||||||
|
secret, err = randomToken(32)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", fmt.Errorf("secret erzeugen: %w", err)
|
||||||
|
}
|
||||||
|
hash := hashSecret(secret)
|
||||||
|
|
||||||
|
_, err = r.pool.Exec(ctx, `
|
||||||
|
INSERT INTO module_credentials (module_name, client_id, secret_hash, issued_at)
|
||||||
|
VALUES ($1, $2, $3, now())
|
||||||
|
ON CONFLICT (module_name) DO UPDATE SET client_id = $2, secret_hash = $3, issued_at = now()
|
||||||
|
`, moduleName, clientID, hash)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", fmt.Errorf("credential speichern: %w", err)
|
||||||
|
}
|
||||||
|
return clientID, secret, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Authenticate prueft ein Service-Credential timing-safe (Referenzmuster
|
||||||
|
// siehe AUD-02) — Aufrufe ohne gueltiges Credential werden abgelehnt
|
||||||
|
// (Akzeptanzkriterium 4 / Pruefung 4).
|
||||||
|
func (r *Registry) Authenticate(ctx context.Context, clientID, secret string) (moduleName string, ok bool, err error) {
|
||||||
|
if clientID == "" || secret == "" {
|
||||||
|
return "", false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var storedHash []byte
|
||||||
|
err = r.pool.QueryRow(ctx, `
|
||||||
|
SELECT module_name, secret_hash FROM module_credentials WHERE client_id = $1
|
||||||
|
`, clientID).Scan(&moduleName, &storedHash)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, pgx.ErrNoRows) {
|
||||||
|
return "", false, nil
|
||||||
|
}
|
||||||
|
return "", false, fmt.Errorf("credential lesen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !timingSafeEqual(hashSecret(secret), storedHash) {
|
||||||
|
return "", false, nil
|
||||||
|
}
|
||||||
|
return moduleName, true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func randomToken(n int) (string, error) {
|
||||||
|
buf := make([]byte, n)
|
||||||
|
if _, err := rand.Read(buf); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return hex.EncodeToString(buf), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func hashSecret(secret string) []byte {
|
||||||
|
sum := sha256.Sum256([]byte(secret))
|
||||||
|
return sum[:]
|
||||||
|
}
|
||||||
|
|
||||||
|
// timingSafeEqual folgt derselben Referenzimplementierung wie AUD-02
|
||||||
|
// (subtle.ConstantTimeCompare) — projektweite Konvention fuer jeden
|
||||||
|
// sicherheitsrelevanten Vergleich.
|
||||||
|
func timingSafeEqual(a, b []byte) bool {
|
||||||
|
if len(a) != len(b) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return subtle.ConstantTimeCompare(a, b) == 1
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
package moduleregistry
|
||||||
|
|
||||||
|
import "net/http"
|
||||||
|
|
||||||
|
// RequireActiveModule weist Anfragen an ein nicht aktiviertes Modul ZENTRAL
|
||||||
|
// ab, bevor der eigentliche Modul-Handler erreicht wird (Akzeptanzkriterium 2 /
|
||||||
|
// Pruefung 1) — Casbin-Prinzip: Durchsetzung als Middleware statt verstreuter
|
||||||
|
// Pruefungen in jedem Handler. tenantSlug/moduleName werden hier ueber
|
||||||
|
// Query-Parameter gelesen (echte Extraktion aus JWT/Tenant-Kontext ist
|
||||||
|
// API-05/TEN-06, nicht Teil dieser Kachel).
|
||||||
|
func (r *Registry) RequireActiveModule(moduleName string, next http.HandlerFunc) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, req *http.Request) {
|
||||||
|
tenantSlug := req.URL.Query().Get("tenant")
|
||||||
|
active, err := r.IsActive(req.Context(), tenantSlug, moduleName)
|
||||||
|
if err != nil {
|
||||||
|
http.Error(w, "aktivierungspruefung fehlgeschlagen", http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !active {
|
||||||
|
http.Error(w, "modul nicht aktiviert", http.StatusForbidden)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
next(w, req)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequireServiceCredential authentifiziert eine Modul-Instanz ueber ihr
|
||||||
|
// Service-Credential (X-Client-Id/X-Client-Secret-Header) BEVOR der
|
||||||
|
// eigentliche Handler erreicht wird (Akzeptanzkriterium 4 / Pruefung 4).
|
||||||
|
func (r *Registry) RequireServiceCredential(next http.HandlerFunc) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, req *http.Request) {
|
||||||
|
clientID := req.Header.Get("X-Client-Id")
|
||||||
|
secret := req.Header.Get("X-Client-Secret")
|
||||||
|
|
||||||
|
_, ok, err := r.Authenticate(req.Context(), clientID, secret)
|
||||||
|
if err != nil {
|
||||||
|
http.Error(w, "authentifizierung fehlgeschlagen", http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if !ok {
|
||||||
|
http.Error(w, ErrInvalidCredential.Error(), http.StatusUnauthorized)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
next(w, req)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,120 @@
|
|||||||
|
// Package moduleregistry implementiert Core API-02: die Registry, in der
|
||||||
|
// sich Fachmodule (DMS, Mail, weitere) mit Metadaten eintragen, gekoppelt an
|
||||||
|
// die Aktivierungspruefung aus LIC-02 (Feature-Flags). Zusaetzlich
|
||||||
|
// authentifiziert die Registry Modul-Instanzen selbst ueber ein bei
|
||||||
|
// Provisionierung ausgestelltes Service-Credential.
|
||||||
|
package moduleregistry
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5"
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/flag"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
ErrMissingName = errors.New("moduleregistry: name darf nicht leer sein")
|
||||||
|
ErrMissingVersion = errors.New("moduleregistry: version darf nicht leer sein")
|
||||||
|
ErrModuleNotFound = errors.New("moduleregistry: modul nicht registriert")
|
||||||
|
)
|
||||||
|
|
||||||
|
type Module struct {
|
||||||
|
Name string
|
||||||
|
Version string
|
||||||
|
RequiredFlags []string
|
||||||
|
}
|
||||||
|
|
||||||
|
type Registry struct {
|
||||||
|
pool *pgxpool.Pool
|
||||||
|
flags *flag.Service
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewRegistry(pool *pgxpool.Pool, flags *flag.Service) *Registry {
|
||||||
|
return &Registry{pool: pool, flags: flags}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Register traegt ein Modul mit Name, Version und benoetigten Feature-Flags
|
||||||
|
// ein (Akzeptanzkriterium 1). Fehlende Pflichtangaben werden abgewiesen
|
||||||
|
// (Akzeptanzkriterium 1 / Pruefung 2). Erneutes Register desselben Namens
|
||||||
|
// aktualisiert Version/Flags (Redeploy-Fall).
|
||||||
|
func (r *Registry) Register(ctx context.Context, name, version string, requiredFlags []string) (Module, error) {
|
||||||
|
if name == "" {
|
||||||
|
return Module{}, ErrMissingName
|
||||||
|
}
|
||||||
|
if version == "" {
|
||||||
|
return Module{}, ErrMissingVersion
|
||||||
|
}
|
||||||
|
if requiredFlags == nil {
|
||||||
|
requiredFlags = []string{}
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := r.pool.Exec(ctx, `
|
||||||
|
INSERT INTO modules (name, version, required_flags, registered_at)
|
||||||
|
VALUES ($1, $2, $3, now())
|
||||||
|
ON CONFLICT (name) DO UPDATE SET version = $2, required_flags = $3, registered_at = now()
|
||||||
|
`, name, version, requiredFlags)
|
||||||
|
if err != nil {
|
||||||
|
return Module{}, fmt.Errorf("modul registrieren: %w", err)
|
||||||
|
}
|
||||||
|
return Module{Name: name, Version: version, RequiredFlags: requiredFlags}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Registry) Get(ctx context.Context, name string) (Module, error) {
|
||||||
|
var m Module
|
||||||
|
m.Name = name
|
||||||
|
err := r.pool.QueryRow(ctx, `
|
||||||
|
SELECT version, required_flags FROM modules WHERE name = $1
|
||||||
|
`, name).Scan(&m.Version, &m.RequiredFlags)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, pgx.ErrNoRows) {
|
||||||
|
return Module{}, ErrModuleNotFound
|
||||||
|
}
|
||||||
|
return Module{}, fmt.Errorf("modul lesen: %w", err)
|
||||||
|
}
|
||||||
|
return m, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// List liefert alle registrierten Module (Akzeptanzkriterium 3: ueber API
|
||||||
|
// abfragbar, z.B. fuer Statusseite/Lizenzoberflaeche).
|
||||||
|
func (r *Registry) List(ctx context.Context) ([]Module, error) {
|
||||||
|
rows, err := r.pool.Query(ctx, `SELECT name, version, required_flags FROM modules ORDER BY name`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("module auflisten: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
var out []Module
|
||||||
|
for rows.Next() {
|
||||||
|
var m Module
|
||||||
|
if err := rows.Scan(&m.Name, &m.Version, &m.RequiredFlags); err != nil {
|
||||||
|
return nil, fmt.Errorf("modul lesen: %w", err)
|
||||||
|
}
|
||||||
|
out = append(out, m)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsActive prueft, ob ein registriertes Modul fuer einen Tenant aktiviert
|
||||||
|
// ist: registriert UND alle benoetigten Feature-Flags sind fuer diesen
|
||||||
|
// Tenant aktiv (Akzeptanzkriterium 2). Ein nicht registriertes Modul gilt
|
||||||
|
// immer als nicht aktiv.
|
||||||
|
func (r *Registry) IsActive(ctx context.Context, tenantSlug, moduleName string) (bool, error) {
|
||||||
|
m, err := r.Get(ctx, moduleName)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, ErrModuleNotFound) {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, flagKey := range m.RequiredFlags {
|
||||||
|
if !r.flags.IsEnabled(ctx, tenantSlug, flagKey) {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,304 @@
|
|||||||
|
package moduleregistry
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/flag"
|
||||||
|
)
|
||||||
|
|
||||||
|
func setupTest(t *testing.T) (*Registry, *flag.Store, func()) {
|
||||||
|
t.Helper()
|
||||||
|
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
||||||
|
if adminDSN == "" {
|
||||||
|
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
pool, err := pgxpool.New(ctx, adminDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pool: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := pool.Exec(ctx, `
|
||||||
|
CREATE TABLE IF NOT EXISTS feature_flags (
|
||||||
|
key TEXT PRIMARY KEY, enabled BOOLEAN NOT NULL DEFAULT false,
|
||||||
|
rollout_percentage INT NOT NULL DEFAULT 0, target_tenant_slugs TEXT[] NOT NULL DEFAULT '{}',
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
CREATE TABLE IF NOT EXISTS modules (
|
||||||
|
name TEXT PRIMARY KEY, version TEXT NOT NULL CHECK (version <> ''),
|
||||||
|
required_flags TEXT[] NOT NULL DEFAULT '{}', registered_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
CREATE TABLE IF NOT EXISTS module_credentials (
|
||||||
|
module_name TEXT PRIMARY KEY REFERENCES modules(name),
|
||||||
|
client_id TEXT NOT NULL UNIQUE, secret_hash BYTEA NOT NULL,
|
||||||
|
issued_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
`); err != nil {
|
||||||
|
t.Fatalf("schema: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
flagStore := flag.NewStore(pool)
|
||||||
|
// Kurze TTL, damit Tests, die den Flag-Store direkt aendern (an
|
||||||
|
// Registry.IsActive vorbei), den neuen Stand ohne manuelles Invalidate
|
||||||
|
// zuverlaessig sehen.
|
||||||
|
flagService := flag.NewService(flagStore, 10*time.Millisecond)
|
||||||
|
registry := NewRegistry(pool, flagService)
|
||||||
|
|
||||||
|
cleanup := func() { pool.Close() }
|
||||||
|
return registry, flagStore, cleanup
|
||||||
|
}
|
||||||
|
|
||||||
|
func uniqueModuleName(t *testing.T) string {
|
||||||
|
return fmt.Sprintf("dms_%d", time.Now().UnixNano())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1 + Pruefung 2: fehlende Pflichtangaben abgewiesen.
|
||||||
|
func TestRegister_RejectsMissingFields(t *testing.T) {
|
||||||
|
registry, _, cleanup := setupTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if _, err := registry.Register(ctx, "", "1.0", nil); !errors.Is(err, ErrMissingName) {
|
||||||
|
t.Fatalf("erwartet ErrMissingName, habe %v", err)
|
||||||
|
}
|
||||||
|
if _, err := registry.Register(ctx, "dms", "", nil); !errors.Is(err, ErrMissingVersion) {
|
||||||
|
t.Fatalf("erwartet ErrMissingVersion, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRegister_AndGet(t *testing.T) {
|
||||||
|
registry, _, cleanup := setupTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
name := uniqueModuleName(t)
|
||||||
|
|
||||||
|
m, err := registry.Register(ctx, name, "1.2.0", []string{"dms_enabled"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("register: %v", err)
|
||||||
|
}
|
||||||
|
if m.Version != "1.2.0" || len(m.RequiredFlags) != 1 {
|
||||||
|
t.Fatalf("unerwartet: %+v", m)
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := registry.Get(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("get: %v", err)
|
||||||
|
}
|
||||||
|
if got.Version != "1.2.0" {
|
||||||
|
t.Fatalf("get version = %q", got.Version)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + 3 + Pruefung 3: konsistente Daten nach
|
||||||
|
// Aktivierung/Deaktivierung eines Moduls.
|
||||||
|
func TestIsActive_ReflectsFlagStateConsistently(t *testing.T) {
|
||||||
|
registry, flagStore, cleanup := setupTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
name := uniqueModuleName(t)
|
||||||
|
flagKey := name + "_enabled"
|
||||||
|
|
||||||
|
if _, err := registry.Register(ctx, name, "1.0", []string{flagKey}); err != nil {
|
||||||
|
t.Fatalf("register: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
active, err := registry.IsActive(ctx, "acme", name)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("is active (vor flag): %v", err)
|
||||||
|
}
|
||||||
|
if active {
|
||||||
|
t.Fatal("erwartet nicht aktiv, solange flag nicht gesetzt ist")
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := flagStore.Set(ctx, flag.Flag{Key: flagKey, Enabled: true}); err != nil {
|
||||||
|
t.Fatalf("flag setzen: %v", err)
|
||||||
|
}
|
||||||
|
time.Sleep(20 * time.Millisecond) // TTL abwarten
|
||||||
|
|
||||||
|
active, err = registry.IsActive(ctx, "acme", name)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("is active (nach flag an): %v", err)
|
||||||
|
}
|
||||||
|
if !active {
|
||||||
|
t.Fatal("erwartet aktiv, nachdem flag aktiviert wurde")
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := flagStore.Set(ctx, flag.Flag{Key: flagKey, Enabled: false}); err != nil {
|
||||||
|
t.Fatalf("flag zuruecksetzen: %v", err)
|
||||||
|
}
|
||||||
|
time.Sleep(20 * time.Millisecond) // TTL abwarten
|
||||||
|
active, err = registry.IsActive(ctx, "acme", name)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("is active (nach flag aus): %v", err)
|
||||||
|
}
|
||||||
|
if active {
|
||||||
|
t.Fatal("erwartet wieder nicht aktiv, nachdem flag deaktiviert wurde")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIsActive_UnregisteredModuleIsNeverActive(t *testing.T) {
|
||||||
|
registry, _, cleanup := setupTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
active, err := registry.IsActive(ctx, "acme", "nie-registriert")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("is active: %v", err)
|
||||||
|
}
|
||||||
|
if active {
|
||||||
|
t.Fatal("unregistriertes modul darf nie aktiv sein")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 1: Anfrage an deaktiviertes Modul wird
|
||||||
|
// zentral abgewiesen, BEVOR die Modul-Logik erreicht wird.
|
||||||
|
func TestRequireActiveModule_BlocksBeforeHandler(t *testing.T) {
|
||||||
|
registry, flagStore, cleanup := setupTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
name := uniqueModuleName(t)
|
||||||
|
flagKey := name + "_enabled"
|
||||||
|
|
||||||
|
if _, err := registry.Register(ctx, name, "1.0", []string{flagKey}); err != nil {
|
||||||
|
t.Fatalf("register: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
handlerReached := false
|
||||||
|
handler := registry.RequireActiveModule(name, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
handlerReached = true
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
})
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/modul?tenant=acme", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
handler(rec, req)
|
||||||
|
if rec.Code != http.StatusForbidden {
|
||||||
|
t.Fatalf("status = %d, want 403", rec.Code)
|
||||||
|
}
|
||||||
|
if handlerReached {
|
||||||
|
t.Fatal("handler haette bei deaktiviertem modul NICHT erreicht werden duerfen")
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := flagStore.Set(ctx, flag.Flag{Key: flagKey, Enabled: true}); err != nil {
|
||||||
|
t.Fatalf("flag setzen: %v", err)
|
||||||
|
}
|
||||||
|
req2 := httptest.NewRequest(http.MethodGet, "/modul?tenant=acme", nil)
|
||||||
|
rec2 := httptest.NewRecorder()
|
||||||
|
handler(rec2, req2)
|
||||||
|
if rec2.Code != http.StatusOK {
|
||||||
|
t.Fatalf("status nach aktivierung = %d, want 200", rec2.Code)
|
||||||
|
}
|
||||||
|
if !handlerReached {
|
||||||
|
t.Fatal("handler haette bei aktiviertem modul erreicht werden muessen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 4 + Pruefung 4: gueltiges/ungueltiges Service-Credential.
|
||||||
|
func TestProvisionAndAuthenticate(t *testing.T) {
|
||||||
|
registry, _, cleanup := setupTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
name := uniqueModuleName(t)
|
||||||
|
|
||||||
|
if _, err := registry.Register(ctx, name, "1.0", nil); err != nil {
|
||||||
|
t.Fatalf("register: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
clientID, secret, err := registry.Provision(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provision: %v", err)
|
||||||
|
}
|
||||||
|
if clientID == "" || secret == "" {
|
||||||
|
t.Fatal("erwartet nicht-leere client-id/secret")
|
||||||
|
}
|
||||||
|
|
||||||
|
moduleName, ok, err := registry.Authenticate(ctx, clientID, secret)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("authenticate (korrekt): %v", err)
|
||||||
|
}
|
||||||
|
if !ok || moduleName != name {
|
||||||
|
t.Fatalf("erwartet erfolgreiche authentifizierung fuer %q, habe ok=%v moduleName=%q", name, ok, moduleName)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, ok, err = registry.Authenticate(ctx, clientID, "falsches-secret")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("authenticate (falsch): %v", err)
|
||||||
|
}
|
||||||
|
if ok {
|
||||||
|
t.Fatal("erwartet fehlschlag bei falschem secret")
|
||||||
|
}
|
||||||
|
|
||||||
|
_, ok, err = registry.Authenticate(ctx, "unbekannte-client-id", secret)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("authenticate (unbekannt): %v", err)
|
||||||
|
}
|
||||||
|
if ok {
|
||||||
|
t.Fatal("erwartet fehlschlag bei unbekannter client-id")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProvision_RequiresRegisteredModule(t *testing.T) {
|
||||||
|
registry, _, cleanup := setupTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if _, _, err := registry.Provision(ctx, "nie-registriert"); !errors.Is(err, ErrModuleNotRegistered) {
|
||||||
|
t.Fatalf("erwartet ErrModuleNotRegistered, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequireServiceCredential_RejectsInvalidAcceptsValid(t *testing.T) {
|
||||||
|
registry, _, cleanup := setupTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
name := uniqueModuleName(t)
|
||||||
|
|
||||||
|
if _, err := registry.Register(ctx, name, "1.0", nil); err != nil {
|
||||||
|
t.Fatalf("register: %v", err)
|
||||||
|
}
|
||||||
|
clientID, secret, err := registry.Provision(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provision: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
handler := registry.RequireServiceCredential(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
})
|
||||||
|
|
||||||
|
// Fehlendes Credential.
|
||||||
|
req := httptest.NewRequest(http.MethodPost, "/service-aufruf", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
handler(rec, req)
|
||||||
|
if rec.Code != http.StatusUnauthorized {
|
||||||
|
t.Fatalf("ohne credential: status = %d, want 401", rec.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Falsches Secret.
|
||||||
|
req2 := httptest.NewRequest(http.MethodPost, "/service-aufruf", nil)
|
||||||
|
req2.Header.Set("X-Client-Id", clientID)
|
||||||
|
req2.Header.Set("X-Client-Secret", "falsch")
|
||||||
|
rec2 := httptest.NewRecorder()
|
||||||
|
handler(rec2, req2)
|
||||||
|
if rec2.Code != http.StatusUnauthorized {
|
||||||
|
t.Fatalf("falsches secret: status = %d, want 401", rec2.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gueltiges Credential.
|
||||||
|
req3 := httptest.NewRequest(http.MethodPost, "/service-aufruf", nil)
|
||||||
|
req3.Header.Set("X-Client-Id", clientID)
|
||||||
|
req3.Header.Set("X-Client-Secret", secret)
|
||||||
|
rec3 := httptest.NewRecorder()
|
||||||
|
handler(rec3, req3)
|
||||||
|
if rec3.Code != http.StatusOK {
|
||||||
|
t.Fatalf("gueltiges credential: status = %d, want 200", rec3.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
package usage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"log/slog"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// AggregateFunc berechnet/aktualisiert Zaehlerstaende aus einer autoritativen
|
|
||||||
// Quelle (z.B. "zaehle Zeilen in einer Modul-Tabelle") — die konkrete Quelle
|
|
||||||
// haengt vom jeweiligen Modul ab und ist nicht Teil dieser Kachel. Das
|
|
||||||
// Aggregations-Grundgerüst selbst (periodischer Trigger) ist es.
|
|
||||||
type AggregateFunc func(ctx context.Context) error
|
|
||||||
|
|
||||||
// RunPeriodicAggregation ruft aggregate in festen Abstaenden auf, bis ctx
|
|
||||||
// beendet wird — dieselbe In-Prozess-Worker-Goroutine-Konvention wie
|
|
||||||
// internal/tenant.Lifecycle.RunSweeper (Akzeptanzkriterium 1: "periodisch
|
|
||||||
// aggregiert").
|
|
||||||
func RunPeriodicAggregation(ctx context.Context, interval time.Duration, aggregate AggregateFunc) {
|
|
||||||
ticker := time.NewTicker(interval)
|
|
||||||
defer ticker.Stop()
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return
|
|
||||||
case <-ticker.C:
|
|
||||||
if err := aggregate(ctx); err != nil {
|
|
||||||
slog.Error("nutzungszaehler-aggregation fehlgeschlagen", "error", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,144 +0,0 @@
|
|||||||
// Package usage implementiert Core LIC-03: Nutzungszaehler je Tenant
|
|
||||||
// (Benutzeranzahl, Speicherverbrauch, API-Aufrufe, ...) und die Pruefung
|
|
||||||
// gegen konfigurierte Quotas. Quotas sind Konfiguration (Tabellenzeile), kein
|
|
||||||
// Hardcode — Zitadel/Unleash-Vorbild.
|
|
||||||
package usage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
var ErrNoQuota = errors.New("usage: keine quota fuer diese metrik konfiguriert")
|
|
||||||
|
|
||||||
// Status ist die definierte Reaktion einer Quota-Pruefung (Akzeptanzkriterium 2).
|
|
||||||
type Status string
|
|
||||||
|
|
||||||
const (
|
|
||||||
StatusOK Status = "ok"
|
|
||||||
StatusWarning Status = "warning" // Schwelle (80%) erreicht, aber noch nicht ueberschritten
|
|
||||||
StatusExceeded Status = "exceeded" // Quota ueberschritten — neue Ressourcen sollten gesperrt werden
|
|
||||||
)
|
|
||||||
|
|
||||||
// warningThreshold liegt bei 80% der Quota.
|
|
||||||
const warningThreshold = 0.8
|
|
||||||
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool) *Store {
|
|
||||||
return &Store{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Increment erhoeht einen Zaehler ATOMAR ueber ein einziges SQL-Statement
|
|
||||||
// (UPSERT mit value = value + delta) statt Read-Modify-Write in Go — das
|
|
||||||
// haelt Zaehlerstaende bei parallelen Schreibzugriffen konsistent
|
|
||||||
// (Akzeptanzkriterium 1 / Pruefung 2), ohne eine Anwendungs-Transaktion mit
|
|
||||||
// Lock zu brauchen.
|
|
||||||
func (s *Store) Increment(ctx context.Context, tenantID, metric string, delta int64) error {
|
|
||||||
_, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO usage_counters (tenant_id, metric, value, updated_at)
|
|
||||||
VALUES ($1, $2, $3, now())
|
|
||||||
ON CONFLICT (tenant_id, metric) DO UPDATE
|
|
||||||
SET value = usage_counters.value + $3, updated_at = now()
|
|
||||||
`, tenantID, metric, delta)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("zaehler erhoehen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get liefert den aktuellen Zaehlerstand — 0, wenn noch nie erhoeht wurde.
|
|
||||||
// Der Wert ist strikt tenant-gescoped (Akzeptanzkriterium 3 / Pruefung 3).
|
|
||||||
func (s *Store) Get(ctx context.Context, tenantID, metric string) (int64, error) {
|
|
||||||
var value int64
|
|
||||||
err := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT value FROM usage_counters WHERE tenant_id = $1 AND metric = $2
|
|
||||||
`, tenantID, metric).Scan(&value)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return 0, nil
|
|
||||||
}
|
|
||||||
return 0, fmt.Errorf("zaehler lesen: %w", err)
|
|
||||||
}
|
|
||||||
return value, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetQuota legt die Obergrenze fuer (tenantID, metric) fest — Konfiguration,
|
|
||||||
// kein Hardcode.
|
|
||||||
func (s *Store) SetQuota(ctx context.Context, tenantID, metric string, limit int64) error {
|
|
||||||
_, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO usage_quotas (tenant_id, metric, limit_value)
|
|
||||||
VALUES ($1, $2, $3)
|
|
||||||
ON CONFLICT (tenant_id, metric) DO UPDATE SET limit_value = $3
|
|
||||||
`, tenantID, metric, limit)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("quota setzen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Store) GetQuota(ctx context.Context, tenantID, metric string) (int64, error) {
|
|
||||||
var limit int64
|
|
||||||
err := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT limit_value FROM usage_quotas WHERE tenant_id = $1 AND metric = $2
|
|
||||||
`, tenantID, metric).Scan(&limit)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return 0, ErrNoQuota
|
|
||||||
}
|
|
||||||
return 0, fmt.Errorf("quota lesen: %w", err)
|
|
||||||
}
|
|
||||||
return limit, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check liefert Zaehlerstand, konfigurierte Quota und die daraus abgeleitete
|
|
||||||
// Reaktion (Akzeptanzkriterium 2 / Pruefung 1). Ist keine Quota konfiguriert,
|
|
||||||
// gilt die Metrik als unbegrenzt (StatusOK).
|
|
||||||
func (s *Store) Check(ctx context.Context, tenantID, metric string) (value, limit int64, status Status, err error) {
|
|
||||||
value, err = s.Get(ctx, tenantID, metric)
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
limit, err = s.GetQuota(ctx, tenantID, metric)
|
|
||||||
if errors.Is(err, ErrNoQuota) {
|
|
||||||
return value, 0, StatusOK, nil
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case value > limit:
|
|
||||||
return value, limit, StatusExceeded, nil
|
|
||||||
case limit > 0 && float64(value) >= warningThreshold*float64(limit):
|
|
||||||
return value, limit, StatusWarning, nil
|
|
||||||
default:
|
|
||||||
return value, limit, StatusOK, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reaction wird aufgerufen, wenn Check einen Nicht-OK-Status liefert
|
|
||||||
// (Akzeptanzkriterium 2: "definierte Reaktion").
|
|
||||||
type Reaction func(ctx context.Context, tenantID, metric string, value, limit int64, status Status)
|
|
||||||
|
|
||||||
// Enforce fuehrt Check aus und ruft react auf, wenn der Status nicht OK ist —
|
|
||||||
// die konkrete "Sperre neuer Ressourcen"/Benachrichtigung liegt beim
|
|
||||||
// Aufrufer (z.B. TEN-02 vor dem Anlegen eines neuen Benutzers), Enforce
|
|
||||||
// garantiert nur, dass die Reaktion zuverlaessig ausgeloest wird.
|
|
||||||
func (s *Store) Enforce(ctx context.Context, tenantID, metric string, react Reaction) (Status, error) {
|
|
||||||
value, limit, status, err := s.Check(ctx, tenantID, metric)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
if status != StatusOK && react != nil {
|
|
||||||
react(ctx, tenantID, metric, value, limit, status)
|
|
||||||
}
|
|
||||||
return status, nil
|
|
||||||
}
|
|
||||||
@@ -1,206 +0,0 @@
|
|||||||
package usage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupTest(t *testing.T) (*Store, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS usage_counters (
|
|
||||||
tenant_id UUID NOT NULL, metric TEXT NOT NULL, value BIGINT NOT NULL DEFAULT 0,
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(), PRIMARY KEY (tenant_id, metric)
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS usage_quotas (
|
|
||||||
tenant_id UUID NOT NULL, metric TEXT NOT NULL, limit_value BIGINT NOT NULL,
|
|
||||||
PRIMARY KEY (tenant_id, metric)
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() { pool.Close() }
|
|
||||||
return NewStore(pool), cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
func newTenantID() string {
|
|
||||||
return fmt.Sprintf("00000000-0000-0000-0000-%012d", time.Now().UnixNano()%1e12)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 2: Aggregationsjob liefert bei parallelen
|
|
||||||
// Schreibzugriffen konsistente Zaehlerstaende.
|
|
||||||
func TestIncrement_ConsistentUnderConcurrentWrites(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := newTenantID()
|
|
||||||
|
|
||||||
const goroutines = 50
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
for i := 0; i < goroutines; i++ {
|
|
||||||
wg.Add(1)
|
|
||||||
go func() {
|
|
||||||
defer wg.Done()
|
|
||||||
if err := store.Increment(ctx, tenant, "api_calls", 1); err != nil {
|
|
||||||
t.Errorf("increment: %v", err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
|
|
||||||
value, err := store.Get(ctx, tenant, "api_calls")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get: %v", err)
|
|
||||||
}
|
|
||||||
if value != goroutines {
|
|
||||||
t.Fatalf("erwartet %d, habe %d (hinweis auf lost update unter nebenlaeufigkeit)", goroutines, value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 3: Zaehlerstand eines Tenants beeinflusst
|
|
||||||
// nicht den eines anderen.
|
|
||||||
func TestIncrement_IsolatedBetweenTenants(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenantA, tenantB := newTenantID(), newTenantID()
|
|
||||||
|
|
||||||
if err := store.Increment(ctx, tenantA, "users", 5); err != nil {
|
|
||||||
t.Fatalf("increment a: %v", err)
|
|
||||||
}
|
|
||||||
if err := store.Increment(ctx, tenantB, "users", 1); err != nil {
|
|
||||||
t.Fatalf("increment b: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
valA, err := store.Get(ctx, tenantA, "users")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get a: %v", err)
|
|
||||||
}
|
|
||||||
valB, err := store.Get(ctx, tenantB, "users")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get b: %v", err)
|
|
||||||
}
|
|
||||||
if valA != 5 || valB != 1 {
|
|
||||||
t.Fatalf("erwartet a=5 b=1, habe a=%d b=%d", valA, valB)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 1: Quota-Ueberschreitung wird automatisiert
|
|
||||||
// erkannt und die definierte Reaktion ausgeloest.
|
|
||||||
func TestEnforce_TriggersReactionOnExceeded(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := newTenantID()
|
|
||||||
|
|
||||||
if err := store.SetQuota(ctx, tenant, "users", 10); err != nil {
|
|
||||||
t.Fatalf("set quota: %v", err)
|
|
||||||
}
|
|
||||||
if err := store.Increment(ctx, tenant, "users", 11); err != nil {
|
|
||||||
t.Fatalf("increment: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var reacted bool
|
|
||||||
var gotStatus Status
|
|
||||||
status, err := store.Enforce(ctx, tenant, "users", func(ctx context.Context, tenantID, metric string, value, limit int64, status Status) {
|
|
||||||
reacted = true
|
|
||||||
gotStatus = status
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("enforce: %v", err)
|
|
||||||
}
|
|
||||||
if status != StatusExceeded {
|
|
||||||
t.Fatalf("erwartet StatusExceeded, habe %q", status)
|
|
||||||
}
|
|
||||||
if !reacted || gotStatus != StatusExceeded {
|
|
||||||
t.Fatal("erwartet ausgeloeste reaktion mit StatusExceeded")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheck_WarningThresholdAndOK(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := newTenantID()
|
|
||||||
|
|
||||||
if err := store.SetQuota(ctx, tenant, "storage_mb", 100); err != nil {
|
|
||||||
t.Fatalf("set quota: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := store.Increment(ctx, tenant, "storage_mb", 50); err != nil {
|
|
||||||
t.Fatalf("increment: %v", err)
|
|
||||||
}
|
|
||||||
_, _, status, err := store.Check(ctx, tenant, "storage_mb")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("check: %v", err)
|
|
||||||
}
|
|
||||||
if status != StatusOK {
|
|
||||||
t.Fatalf("bei 50%% erwartet StatusOK, habe %q", status)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := store.Increment(ctx, tenant, "storage_mb", 35); err != nil { // insgesamt 85%
|
|
||||||
t.Fatalf("increment: %v", err)
|
|
||||||
}
|
|
||||||
_, _, status, err = store.Check(ctx, tenant, "storage_mb")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("check: %v", err)
|
|
||||||
}
|
|
||||||
if status != StatusWarning {
|
|
||||||
t.Fatalf("bei 85%% erwartet StatusWarning, habe %q", status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheck_NoQuotaMeansUnlimited(t *testing.T) {
|
|
||||||
store, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := newTenantID()
|
|
||||||
|
|
||||||
if err := store.Increment(ctx, tenant, "api_calls", 1_000_000); err != nil {
|
|
||||||
t.Fatalf("increment: %v", err)
|
|
||||||
}
|
|
||||||
_, _, status, err := store.Check(ctx, tenant, "api_calls")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("check: %v", err)
|
|
||||||
}
|
|
||||||
if status != StatusOK {
|
|
||||||
t.Fatalf("ohne konfigurierte quota erwartet StatusOK, habe %q", status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRunPeriodicAggregation_CallsRepeatedly(t *testing.T) {
|
|
||||||
ctx, cancel := context.WithTimeout(context.Background(), 120*time.Millisecond)
|
|
||||||
defer cancel()
|
|
||||||
|
|
||||||
var mu sync.Mutex
|
|
||||||
calls := 0
|
|
||||||
RunPeriodicAggregation(ctx, 20*time.Millisecond, func(ctx context.Context) error {
|
|
||||||
mu.Lock()
|
|
||||||
calls++
|
|
||||||
mu.Unlock()
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
if calls < 3 {
|
|
||||||
t.Fatalf("erwartet mehrfache aufrufe innerhalb von 120ms bei 20ms interval, habe %d", calls)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
DROP TABLE IF EXISTS feature_flags;
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
-- Feature-Flags zentral je Mandant/Zielgruppe (LIC-02, siehe core-kanban/tickets/LIC-02.md).
|
||||||
|
-- Lebt in der Registry-DB, nicht pro Tenant-Datenbank — Flags sind eine
|
||||||
|
-- Core-weite Konfiguration, keine Mandanten-Geschaeftsdaten.
|
||||||
|
CREATE TABLE feature_flags (
|
||||||
|
key TEXT PRIMARY KEY,
|
||||||
|
enabled BOOLEAN NOT NULL DEFAULT false,
|
||||||
|
rollout_percentage INT NOT NULL DEFAULT 0 CHECK (rollout_percentage BETWEEN 0 AND 100),
|
||||||
|
target_tenant_slugs TEXT[] NOT NULL DEFAULT '{}',
|
||||||
|
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
@@ -1 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS tenant_licenses;
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
-- Lizenzumfang pro Mandant (LIC-01, siehe core-kanban/tickets/LIC-01.md).
|
|
||||||
-- Genau ein Lizenzdatensatz pro Tenant (tenant_id PK) — ein neues Einspielen
|
|
||||||
-- ersetzt den vorherigen Datensatz vollstaendig statt eine Historie zu fuehren.
|
|
||||||
CREATE TABLE tenant_licenses (
|
|
||||||
tenant_id UUID PRIMARY KEY REFERENCES tenants(id),
|
|
||||||
plan TEXT NOT NULL,
|
|
||||||
modules TEXT[] NOT NULL,
|
|
||||||
issued_at TIMESTAMPTZ NOT NULL,
|
|
||||||
valid_until TIMESTAMPTZ NOT NULL,
|
|
||||||
raw_key TEXT NOT NULL,
|
|
||||||
installed_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
DROP TABLE IF EXISTS module_credentials;
|
||||||
|
DROP TABLE IF EXISTS modules;
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
-- Modul-Registry & Aktivierungspruefung (API-02, siehe core-kanban/tickets/API-02.md).
|
||||||
|
CREATE TABLE modules (
|
||||||
|
name TEXT PRIMARY KEY,
|
||||||
|
version TEXT NOT NULL CHECK (version <> ''),
|
||||||
|
required_flags TEXT[] NOT NULL DEFAULT '{}',
|
||||||
|
registered_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Service-Credential je Modul-Instanz, bei Provisionierung ausgestellt
|
||||||
|
-- (Akzeptanzkriterium 4). secret_hash enthaelt NIEMALS das Secret im
|
||||||
|
-- Klartext, nur dessen SHA-256-Hash (Timing-safe-Vergleich beim Login,
|
||||||
|
-- Referenzmuster siehe AUD-02).
|
||||||
|
CREATE TABLE module_credentials (
|
||||||
|
module_name TEXT PRIMARY KEY REFERENCES modules(name),
|
||||||
|
client_id TEXT NOT NULL UNIQUE,
|
||||||
|
secret_hash BYTEA NOT NULL,
|
||||||
|
issued_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
);
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS usage_quotas;
|
|
||||||
DROP TABLE IF EXISTS usage_counters;
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
-- Nutzungszaehler & Quotas je Tenant (LIC-03, siehe core-kanban/tickets/LIC-03.md).
|
|
||||||
CREATE TABLE usage_counters (
|
|
||||||
tenant_id UUID NOT NULL,
|
|
||||||
metric TEXT NOT NULL,
|
|
||||||
value BIGINT NOT NULL DEFAULT 0,
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (tenant_id, metric)
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE usage_quotas (
|
|
||||||
tenant_id UUID NOT NULL,
|
|
||||||
metric TEXT NOT NULL,
|
|
||||||
limit_value BIGINT NOT NULL,
|
|
||||||
PRIMARY KEY (tenant_id, metric)
|
|
||||||
);
|
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
DROP TABLE metrics_sources;
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
-- Metrics-Aggregation ueber Module hinweg (OPS-03, siehe
|
||||||
|
-- core-kanban/tickets/OPS-03.md) — welches Modul liefert seine Kennzahlen
|
||||||
|
-- unter welcher /metrics-URL.
|
||||||
|
CREATE TABLE metrics_sources (
|
||||||
|
module_name TEXT PRIMARY KEY,
|
||||||
|
metrics_url TEXT NOT NULL
|
||||||
|
);
|
||||||
@@ -1,23 +1,11 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
# Setzt die nexarch-Testumgebung zurueck: loescht die geteilte
|
|
||||||
# Registry-Tabelle "tenants" in der postgres-Wartungsdatenbank sowie alle
|
|
||||||
# tenant_*-Datenbanken. Noetig, weil verschiedene Feature-Branches
|
|
||||||
# unterschiedliche Registry-Schemata erwarten, aber dieselbe physische
|
|
||||||
# Postgres-Instanz auf dem Testhost teilen (siehe [[project-nexarch-test-infra]]).
|
|
||||||
#
|
|
||||||
# Aufruf: NEXARCH_TEST_DB_PASSWORD=... ./scripts/reset-test-env.sh
|
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
PASS="${NEXARCH_TEST_DB_PASSWORD:?Setze NEXARCH_TEST_DB_PASSWORD vor dem Aufruf}"
|
PASS="${NEXARCH_TEST_DB_PASSWORD:?Setze NEXARCH_TEST_DB_PASSWORD vor dem Aufruf}"
|
||||||
ROLE="nexarch_test"
|
ROLE="nexarch_test"
|
||||||
|
|
||||||
export PGPASSWORD="$PASS"
|
export PGPASSWORD="$PASS"
|
||||||
|
|
||||||
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP TABLE IF EXISTS tenants CASCADE;"
|
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP TABLE IF EXISTS tenants CASCADE;"
|
||||||
|
|
||||||
dbs=$(psql -h localhost -U "$ROLE" -d postgres -tAc "SELECT datname FROM pg_database WHERE datname LIKE 'tenant\_%' ESCAPE '\'")
|
dbs=$(psql -h localhost -U "$ROLE" -d postgres -tAc "SELECT datname FROM pg_database WHERE datname LIKE 'tenant\_%' ESCAPE '\'")
|
||||||
for db in $dbs; do
|
for db in $dbs; do
|
||||||
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP DATABASE IF EXISTS \"${db}\";"
|
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP DATABASE IF EXISTS \"${db}\";"
|
||||||
done
|
done
|
||||||
|
|
||||||
echo "Testumgebung zurueckgesetzt: registry-tabelle + $(echo "$dbs" | grep -c . || true) tenant-datenbank(en) entfernt."
|
echo "Testumgebung zurueckgesetzt: registry-tabelle + $(echo "$dbs" | grep -c . || true) tenant-datenbank(en) entfernt."
|
||||||
|
|||||||
@@ -1,24 +1,12 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
# Ein-Kommando-Pruefung fuer den aktuellen Code-Stand auf dem Testhost:
|
|
||||||
# Registry+Tenant-DBs zuruecksetzen, dann build/vet/test in einem Rutsch.
|
|
||||||
# -p 1 ist Pflicht, da mehrere Pakete dieselbe physische Registry-Tabelle auf
|
|
||||||
# dem Testhost teilen (siehe [[project-nexarch-test-infra]]).
|
|
||||||
#
|
|
||||||
# Aufruf: NEXARCH_TEST_DB_PASSWORD=... ./scripts/run-checks.sh
|
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
PASS="${NEXARCH_TEST_DB_PASSWORD:?Setze NEXARCH_TEST_DB_PASSWORD vor dem Aufruf}"
|
PASS="${NEXARCH_TEST_DB_PASSWORD:?Setze NEXARCH_TEST_DB_PASSWORD vor dem Aufruf}"
|
||||||
cd "$(dirname "$0")/.."
|
cd "$(dirname "$0")/.."
|
||||||
|
|
||||||
NEXARCH_TEST_DB_PASSWORD="$PASS" bash scripts/reset-test-env.sh
|
NEXARCH_TEST_DB_PASSWORD="$PASS" bash scripts/reset-test-env.sh
|
||||||
|
|
||||||
export TEST_ADMIN_DSN="postgresql://nexarch_test:${PASS}@localhost:5432/postgres?sslmode=disable"
|
export TEST_ADMIN_DSN="postgresql://nexarch_test:${PASS}@localhost:5432/postgres?sslmode=disable"
|
||||||
|
|
||||||
echo "== go build =="
|
echo "== go build =="
|
||||||
go build ./...
|
go build ./...
|
||||||
|
|
||||||
echo "== go vet =="
|
echo "== go vet =="
|
||||||
go vet ./...
|
go vet ./...
|
||||||
|
|
||||||
echo "== go test (-p 1) =="
|
echo "== go test (-p 1) =="
|
||||||
go test ./... -p 1 -count=1
|
go test ./... -p 1 -count=1
|
||||||
|
|||||||
@@ -1,30 +0,0 @@
|
|||||||
import { ThemeProvider, I18nProvider, ToastProvider, typography } from "@nexarch/shl";
|
|
||||||
|
|
||||||
export const metadata = {
|
|
||||||
title: "NEXARCH Lizenz- und Modulverwaltung",
|
|
||||||
};
|
|
||||||
|
|
||||||
export default function RootLayout({
|
|
||||||
children,
|
|
||||||
}: {
|
|
||||||
children: React.ReactNode;
|
|
||||||
}) {
|
|
||||||
return (
|
|
||||||
<html lang="de">
|
|
||||||
<body
|
|
||||||
style={{
|
|
||||||
fontFamily: typography.fontFamily,
|
|
||||||
margin: 0,
|
|
||||||
background: "var(--shl-color-background, #ffffff)",
|
|
||||||
color: "var(--shl-color-text-primary, #14181f)",
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<ThemeProvider>
|
|
||||||
<I18nProvider initialLocale="de">
|
|
||||||
<ToastProvider>{children}</ToastProvider>
|
|
||||||
</I18nProvider>
|
|
||||||
</ThemeProvider>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,173 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
import { useState } from "react";
|
|
||||||
import { fetchOverview, toggleFlag, type Overview } from "@/lib/api";
|
|
||||||
|
|
||||||
const STATUS_LABEL: Record<string, string> = {
|
|
||||||
ok: "In Ordnung",
|
|
||||||
warning: "Nahe am Limit",
|
|
||||||
exceeded: "Limit überschritten",
|
|
||||||
};
|
|
||||||
|
|
||||||
const STATUS_COLOR: Record<string, string> = {
|
|
||||||
ok: "#2e7d32",
|
|
||||||
warning: "#ed6c02",
|
|
||||||
exceeded: "#c62828",
|
|
||||||
};
|
|
||||||
|
|
||||||
export default function Page() {
|
|
||||||
const [tenantId, setTenantId] = useState("");
|
|
||||||
const [overview, setOverview] = useState<Overview | null>(null);
|
|
||||||
const [loading, setLoading] = useState(false);
|
|
||||||
const [error, setError] = useState<string | null>(null);
|
|
||||||
const [toggleError, setToggleError] = useState<string | null>(null);
|
|
||||||
|
|
||||||
async function load() {
|
|
||||||
if (!tenantId.trim()) return;
|
|
||||||
setLoading(true);
|
|
||||||
setError(null);
|
|
||||||
try {
|
|
||||||
const data = await fetchOverview(tenantId.trim());
|
|
||||||
setOverview(data);
|
|
||||||
} catch (e: any) {
|
|
||||||
setError(e.message ?? "Unbekannter Fehler");
|
|
||||||
setOverview(null);
|
|
||||||
} finally {
|
|
||||||
setLoading(false);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function onToggle(key: string, next: boolean) {
|
|
||||||
setToggleError(null);
|
|
||||||
try {
|
|
||||||
await toggleFlag(tenantId.trim(), key, next);
|
|
||||||
await load();
|
|
||||||
} catch (e: any) {
|
|
||||||
setToggleError(e.message ?? "Umschalten fehlgeschlagen");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<main style={{ maxWidth: 800, margin: "0 auto", padding: "2rem 1rem" }}>
|
|
||||||
<h1>Lizenz- und Modulverwaltung</h1>
|
|
||||||
|
|
||||||
<div style={{ display: "flex", gap: "0.5rem", marginBottom: "1.5rem" }}>
|
|
||||||
<input
|
|
||||||
value={tenantId}
|
|
||||||
onChange={(e) => setTenantId(e.target.value)}
|
|
||||||
placeholder="Tenant-ID eingeben"
|
|
||||||
style={{ flex: 1, padding: "0.5rem", fontSize: "1rem" }}
|
|
||||||
/>
|
|
||||||
<button onClick={load} disabled={loading} style={{ padding: "0.5rem 1rem" }}>
|
|
||||||
{loading ? "Lädt…" : "Anzeigen"}
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{error && (
|
|
||||||
<p style={{ color: "#c62828" }} role="alert">
|
|
||||||
Fehler: {error}
|
|
||||||
</p>
|
|
||||||
)}
|
|
||||||
|
|
||||||
{overview && (
|
|
||||||
<>
|
|
||||||
<section style={{ background: "white", padding: "1rem", borderRadius: 8, marginBottom: "1.5rem" }}>
|
|
||||||
<h2>Lizenzstatus</h2>
|
|
||||||
<p>
|
|
||||||
<strong>Plan:</strong> {overview.plan}{" "}
|
|
||||||
{overview.expired && (
|
|
||||||
<span style={{ color: "#c62828", fontWeight: "bold" }}>
|
|
||||||
(abgelaufen)
|
|
||||||
</span>
|
|
||||||
)}
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
<strong>Gültig bis:</strong>{" "}
|
|
||||||
{new Date(overview.valid_until).toLocaleDateString("de-DE")}
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
<strong>Freigeschaltete Module:</strong>{" "}
|
|
||||||
{overview.modules.length > 0 ? overview.modules.join(", ") : "keine"}
|
|
||||||
</p>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section style={{ background: "white", padding: "1rem", borderRadius: 8, marginBottom: "1.5rem" }}>
|
|
||||||
<h2>Feature-Flags</h2>
|
|
||||||
{toggleError && (
|
|
||||||
<p style={{ color: "#c62828" }} role="alert">
|
|
||||||
{toggleError}
|
|
||||||
</p>
|
|
||||||
)}
|
|
||||||
{overview.flags.length === 0 && <p>Keine Feature-Flags definiert.</p>}
|
|
||||||
<ul style={{ listStyle: "none", padding: 0 }}>
|
|
||||||
{overview.flags.map((f) => (
|
|
||||||
<li
|
|
||||||
key={f.key}
|
|
||||||
style={{
|
|
||||||
display: "flex",
|
|
||||||
justifyContent: "space-between",
|
|
||||||
alignItems: "center",
|
|
||||||
padding: "0.5rem 0",
|
|
||||||
borderBottom: "1px solid #eee",
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<div>
|
|
||||||
<div>{f.key}</div>
|
|
||||||
{!f.licensed && f.deny_grund && (
|
|
||||||
<div style={{ fontSize: "0.85rem", color: "#c62828" }}>
|
|
||||||
{f.deny_grund}
|
|
||||||
</div>
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
<label>
|
|
||||||
<input
|
|
||||||
type="checkbox"
|
|
||||||
checked={f.enabled}
|
|
||||||
disabled={!f.licensed && !f.enabled}
|
|
||||||
onChange={(e) => onToggle(f.key, e.target.checked)}
|
|
||||||
/>{" "}
|
|
||||||
aktiv
|
|
||||||
</label>
|
|
||||||
</li>
|
|
||||||
))}
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section style={{ background: "white", padding: "1rem", borderRadius: 8 }}>
|
|
||||||
<h2>Nutzungsstand</h2>
|
|
||||||
{overview.usage.map((u) => {
|
|
||||||
const pct = u.limit > 0 ? Math.min(100, (u.value / u.limit) * 100) : 0;
|
|
||||||
return (
|
|
||||||
<div key={u.metric} style={{ marginBottom: "1rem" }}>
|
|
||||||
<div style={{ display: "flex", justifyContent: "space-between" }}>
|
|
||||||
<span>{u.metric}</span>
|
|
||||||
<span style={{ color: STATUS_COLOR[u.status] }}>
|
|
||||||
{u.value} / {u.limit > 0 ? u.limit : "unbegrenzt"} —{" "}
|
|
||||||
{STATUS_LABEL[u.status]}
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
<div
|
|
||||||
style={{
|
|
||||||
background: "#eee",
|
|
||||||
borderRadius: 4,
|
|
||||||
height: 8,
|
|
||||||
overflow: "hidden",
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<div
|
|
||||||
style={{
|
|
||||||
width: `${u.limit > 0 ? pct : 0}%`,
|
|
||||||
background: STATUS_COLOR[u.status],
|
|
||||||
height: "100%",
|
|
||||||
}}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
})}
|
|
||||||
</section>
|
|
||||||
</>
|
|
||||||
)}
|
|
||||||
</main>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
// Duenner Client fuer das LIC-04-Backend-API (internal/adminapi) — enthaelt
|
|
||||||
// keinerlei eigene Lizenz-/Flag-Logik, nur Datenabruf und -weitergabe.
|
|
||||||
export type FlagOverview = {
|
|
||||||
key: string;
|
|
||||||
enabled: boolean;
|
|
||||||
licensed: boolean;
|
|
||||||
deny_grund?: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type UsageOverview = {
|
|
||||||
metric: string;
|
|
||||||
value: number;
|
|
||||||
limit: number;
|
|
||||||
status: "ok" | "warning" | "exceeded";
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Overview = {
|
|
||||||
plan: string;
|
|
||||||
modules: string[];
|
|
||||||
issued_at: string;
|
|
||||||
valid_until: string;
|
|
||||||
expired: boolean;
|
|
||||||
flags: FlagOverview[];
|
|
||||||
usage: UsageOverview[];
|
|
||||||
};
|
|
||||||
|
|
||||||
function apiBase(): string {
|
|
||||||
const base = process.env.NEXT_PUBLIC_ADMIN_API_URL;
|
|
||||||
if (!base) {
|
|
||||||
throw new Error(
|
|
||||||
"NEXT_PUBLIC_ADMIN_API_URL ist nicht gesetzt (Umgebungsvariable erforderlich)"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return base;
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function fetchOverview(tenantId: string): Promise<Overview> {
|
|
||||||
const res = await fetch(
|
|
||||||
`${apiBase()}/admin/overview?tenant=${encodeURIComponent(tenantId)}`,
|
|
||||||
{ cache: "no-store" }
|
|
||||||
);
|
|
||||||
if (!res.ok) {
|
|
||||||
const body = await res.json().catch(() => ({}));
|
|
||||||
throw new Error(body.error || `Anfrage fehlgeschlagen (${res.status})`);
|
|
||||||
}
|
|
||||||
return res.json();
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function toggleFlag(
|
|
||||||
tenantId: string,
|
|
||||||
key: string,
|
|
||||||
enabled: boolean
|
|
||||||
): Promise<void> {
|
|
||||||
const res = await fetch(`${apiBase()}/admin/flags/toggle`, {
|
|
||||||
method: "POST",
|
|
||||||
headers: { "Content-Type": "application/json" },
|
|
||||||
body: JSON.stringify({ tenant: tenantId, key, enabled }),
|
|
||||||
});
|
|
||||||
if (!res.ok) {
|
|
||||||
const body = await res.json().catch(() => ({}));
|
|
||||||
throw new Error(body.error || `Umschalten fehlgeschlagen (${res.status})`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
/** @type {import('next').NextConfig} */
|
|
||||||
const nextConfig = {
|
|
||||||
// @nexarch/shl liegt als file:-Dependency mit TS-Quellen in node_modules —
|
|
||||||
// Next.js transpiliert node_modules standardmäßig nicht, siehe web/shl/README.md.
|
|
||||||
transpilePackages: ["@nexarch/shl"],
|
|
||||||
};
|
|
||||||
export default nextConfig;
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "nexarch-lic-admin",
|
|
||||||
"private": true,
|
|
||||||
"scripts": {
|
|
||||||
"dev": "next dev",
|
|
||||||
"build": "next build",
|
|
||||||
"start": "next start",
|
|
||||||
"lint": "next lint"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"@nexarch/shl": "file:../shl",
|
|
||||||
"next": "14.2.35",
|
|
||||||
"react": "18.3.1",
|
|
||||||
"react-dom": "18.3.1"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@types/node": "20.14.9",
|
|
||||||
"@types/react": "18.3.3",
|
|
||||||
"@types/react-dom": "18.3.0",
|
|
||||||
"typescript": "5.5.3"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"target": "es2017",
|
|
||||||
"lib": ["dom", "dom.iterable", "esnext"],
|
|
||||||
"allowJs": true,
|
|
||||||
"skipLibCheck": true,
|
|
||||||
"strict": true,
|
|
||||||
"noEmit": true,
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"module": "esnext",
|
|
||||||
"moduleResolution": "bundler",
|
|
||||||
"resolveJsonModule": true,
|
|
||||||
"isolatedModules": true,
|
|
||||||
"jsx": "preserve",
|
|
||||||
"incremental": true,
|
|
||||||
"plugins": [{ "name": "next" }],
|
|
||||||
"paths": { "@/*": ["./*"] }
|
|
||||||
},
|
|
||||||
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
|
|
||||||
"exclude": ["node_modules"]
|
|
||||||
}
|
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
# @nexarch/shl — UI-Shell & Design-System (Core SHL-01)
|
|
||||||
|
|
||||||
Gemeinsames Paket für alle NEXARCH-Modul-Frontends (Core, DMS, Mail, Archive, Workflow, AI, Connect).
|
|
||||||
Ein Modul-Frontend importiert ausschließlich über `index.ts`, kopiert keine Komponenten oder Tokens lokal.
|
|
||||||
|
|
||||||
## Enthält
|
|
||||||
|
|
||||||
- **Design-Tokens** (`tokens/tokens.ts`) — Farbe (Hell/Dunkel), Abstand, Typografie. Kontrastwerte gegen WCAG 2.1 AA geprüft (siehe `__tests__/tokens.test.ts`).
|
|
||||||
- **Theming** (`theme/ThemeProvider.tsx`) — zentrale Hell/Dunkel-Umschaltung, respektiert `prefers-color-scheme`, persistiert in `localStorage`.
|
|
||||||
- **i18n-Rahmen** (`i18n/i18n.tsx`) — Umschaltmechanismus Deutsch/Englisch. Modul-Frontends registrieren ihre fachlichen Textbausteine über `registerMessages()`, statt einen eigenen Mechanismus zu bauen.
|
|
||||||
- **Basis-Komponenten** (`components/`) — `Shell` (Layout + Navigation), `Table`, `Dialog`, `TextField`/`SelectField`/`CheckboxField`, `Toast`. Alle mit WCAG-2.1-AA-Grundlage (Tastaturbedienung, ARIA-Attribute, Fokus-Management).
|
|
||||||
|
|
||||||
## Verwendung in einem Modul-Frontend
|
|
||||||
|
|
||||||
```tsx
|
|
||||||
import { ThemeProvider, I18nProvider, ToastProvider, Shell } from "@nexarch/shl";
|
|
||||||
|
|
||||||
export default function RootLayout({ children }: { children: React.ReactNode }) {
|
|
||||||
return (
|
|
||||||
<ThemeProvider>
|
|
||||||
<I18nProvider initialLocale="de">
|
|
||||||
<ToastProvider>
|
|
||||||
<Shell modules={[]} tenantLabel="Mandant XY">
|
|
||||||
{children}
|
|
||||||
</Shell>
|
|
||||||
</ToastProvider>
|
|
||||||
</I18nProvider>
|
|
||||||
</ThemeProvider>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Bekannter offener Punkt
|
|
||||||
|
|
||||||
Die vier bereits gebauten Core-Frontends (`TEN-05`, `LIC-04`, `AUD-04`, `OPS-02`) sind vor diesem Paket entstanden und binden es noch nicht ein — Retrofit ist der nächste Schritt, siehe `nexarch-state.json`.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
Ausführung auf dem Test-Host (nicht lokal, siehe Projekt-Testinfrastruktur):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
npm test
|
|
||||||
npm run typecheck
|
|
||||||
```
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
// Prüfung: Tastaturbedienung der Basis-Komponenten funktioniert (SHL-01 Prüfung 2).
|
|
||||||
import { describe, expect, it, vi } from "vitest";
|
|
||||||
import { fireEvent, render, screen } from "@testing-library/react";
|
|
||||||
import { Dialog } from "../components/Dialog";
|
|
||||||
import { I18nProvider } from "../i18n/i18n";
|
|
||||||
|
|
||||||
function renderDialog(onClose: () => void) {
|
|
||||||
return render(
|
|
||||||
<I18nProvider>
|
|
||||||
<Dialog open titleId="test-title" title="Test-Dialog" onClose={onClose}>
|
|
||||||
<button type="button">Erste Aktion</button>
|
|
||||||
<button type="button">Zweite Aktion</button>
|
|
||||||
</Dialog>
|
|
||||||
</I18nProvider>,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("Dialog: Tastaturbedienung", () => {
|
|
||||||
it("schließt sich bei ESC", () => {
|
|
||||||
const onClose = vi.fn();
|
|
||||||
renderDialog(onClose);
|
|
||||||
fireEvent.keyDown(document, { key: "Escape" });
|
|
||||||
expect(onClose).toHaveBeenCalledOnce();
|
|
||||||
});
|
|
||||||
|
|
||||||
it("setzt den Fokus beim Öffnen auf das erste fokussierbare Element", () => {
|
|
||||||
renderDialog(vi.fn());
|
|
||||||
const closeButton = screen.getByRole("button", { name: /schließen/i });
|
|
||||||
expect(document.activeElement).toBe(closeButton);
|
|
||||||
});
|
|
||||||
|
|
||||||
it("ist als modaler Dialog mit Titel-Referenz ausgezeichnet", () => {
|
|
||||||
renderDialog(vi.fn());
|
|
||||||
const dialog = screen.getByRole("dialog");
|
|
||||||
expect(dialog).toHaveAttribute("aria-modal", "true");
|
|
||||||
expect(dialog).toHaveAttribute("aria-labelledby", "test-title");
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
// Prüfung: Kontrastwerte erfüllen mindestens AA (SHL-01 Prüfung 3 / Akzeptanzkriterium 4).
|
|
||||||
import { describe, expect, it } from "vitest";
|
|
||||||
import { colorTokens } from "../tokens/tokens";
|
|
||||||
|
|
||||||
// WCAG-2.1-AA-Kontrastberechnung (relative Luminanz, sRGB) — keine externe Abhängigkeit nötig.
|
|
||||||
function relLuminance(hex: string): number {
|
|
||||||
const rgb = [1, 3, 5].map((i) => parseInt(hex.slice(i, i + 2), 16) / 255);
|
|
||||||
const [r, g, b] = rgb.map((c) => (c <= 0.03928 ? c / 12.92 : ((c + 0.055) / 1.055) ** 2.4));
|
|
||||||
return 0.2126 * r + 0.7152 * g + 0.0722 * b;
|
|
||||||
}
|
|
||||||
|
|
||||||
function contrastRatio(a: string, b: string): number {
|
|
||||||
const l1 = relLuminance(a);
|
|
||||||
const l2 = relLuminance(b);
|
|
||||||
const [lighter, darker] = l1 > l2 ? [l1, l2] : [l2, l1];
|
|
||||||
return (lighter + 0.05) / (darker + 0.05);
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("Design-Tokens: WCAG 2.1 AA Kontrast", () => {
|
|
||||||
for (const scheme of ["light", "dark"] as const) {
|
|
||||||
const c = colorTokens[scheme];
|
|
||||||
|
|
||||||
it(`${scheme}: textPrimary auf background erfüllt AA (>= 4.5:1)`, () => {
|
|
||||||
expect(contrastRatio(c.textPrimary, c.background)).toBeGreaterThanOrEqual(4.5);
|
|
||||||
});
|
|
||||||
|
|
||||||
it(`${scheme}: textSecondary auf surface erfüllt AA (>= 4.5:1)`, () => {
|
|
||||||
expect(contrastRatio(c.textSecondary, c.surface)).toBeGreaterThanOrEqual(4.5);
|
|
||||||
});
|
|
||||||
|
|
||||||
it(`${scheme}: accentContrast auf accent erfüllt AA (>= 4.5:1)`, () => {
|
|
||||||
expect(contrastRatio(c.accentContrast, c.accent)).toBeGreaterThanOrEqual(4.5);
|
|
||||||
});
|
|
||||||
|
|
||||||
it(`${scheme}: dangerContrast auf danger erfüllt AA (>= 4.5:1)`, () => {
|
|
||||||
expect(contrastRatio(c.dangerContrast, c.danger)).toBeGreaterThanOrEqual(4.5);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
});
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
// Dialog-Basis-Komponente — SHL-01. WCAG 2.1 AA: Fokus-Falle, ESC schließt, Tastaturbedienung vollständig.
|
|
||||||
|
|
||||||
import { useEffect, useRef } from "react";
|
|
||||||
import type { ReactNode } from "react";
|
|
||||||
import { useI18n } from "../i18n/i18n";
|
|
||||||
|
|
||||||
const FOCUSABLE_SELECTOR =
|
|
||||||
'a[href], button:not([disabled]), textarea:not([disabled]), input:not([disabled]), select:not([disabled]), [tabindex]:not([tabindex="-1"])';
|
|
||||||
|
|
||||||
export interface DialogProps {
|
|
||||||
open: boolean;
|
|
||||||
onClose: () => void;
|
|
||||||
titleId: string;
|
|
||||||
title: string;
|
|
||||||
children: ReactNode;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function Dialog({ open, onClose, titleId, title, children }: DialogProps) {
|
|
||||||
const { t } = useI18n();
|
|
||||||
const dialogRef = useRef<HTMLDivElement>(null);
|
|
||||||
const previouslyFocused = useRef<HTMLElement | null>(null);
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
if (!open) return;
|
|
||||||
previouslyFocused.current = document.activeElement as HTMLElement | null;
|
|
||||||
|
|
||||||
const node = dialogRef.current;
|
|
||||||
const focusables = node?.querySelectorAll<HTMLElement>(FOCUSABLE_SELECTOR);
|
|
||||||
focusables?.[0]?.focus();
|
|
||||||
|
|
||||||
function handleKeyDown(event: KeyboardEvent) {
|
|
||||||
if (event.key === "Escape") {
|
|
||||||
onClose();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (event.key !== "Tab" || !node) return;
|
|
||||||
|
|
||||||
const items = Array.from(node.querySelectorAll<HTMLElement>(FOCUSABLE_SELECTOR));
|
|
||||||
if (items.length === 0) return;
|
|
||||||
const first = items[0];
|
|
||||||
const last = items[items.length - 1];
|
|
||||||
|
|
||||||
if (event.shiftKey && document.activeElement === first) {
|
|
||||||
event.preventDefault();
|
|
||||||
last.focus();
|
|
||||||
} else if (!event.shiftKey && document.activeElement === last) {
|
|
||||||
event.preventDefault();
|
|
||||||
first.focus();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
document.addEventListener("keydown", handleKeyDown);
|
|
||||||
return () => {
|
|
||||||
document.removeEventListener("keydown", handleKeyDown);
|
|
||||||
previouslyFocused.current?.focus();
|
|
||||||
};
|
|
||||||
}, [open, onClose]);
|
|
||||||
|
|
||||||
if (!open) return null;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div
|
|
||||||
className="shl-dialog-backdrop"
|
|
||||||
role="presentation"
|
|
||||||
onMouseDown={(event) => {
|
|
||||||
if (event.target === event.currentTarget) onClose();
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<div
|
|
||||||
ref={dialogRef}
|
|
||||||
className="shl-dialog"
|
|
||||||
role="dialog"
|
|
||||||
aria-modal="true"
|
|
||||||
aria-labelledby={titleId}
|
|
||||||
>
|
|
||||||
<div className="shl-dialog-header">
|
|
||||||
<h2 id={titleId}>{title}</h2>
|
|
||||||
<button type="button" onClick={onClose} aria-label={t("shl.dialog.close")}>
|
|
||||||
×
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
<div className="shl-dialog-body">{children}</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,98 +0,0 @@
|
|||||||
// Formularelemente-Basis-Komponenten — SHL-01. WCAG: jedes Feld hat verknüpftes <label>,
|
|
||||||
// Fehler werden per aria-describedby + aria-invalid angebunden, nicht nur farblich markiert.
|
|
||||||
|
|
||||||
import { useId } from "react";
|
|
||||||
import type { InputHTMLAttributes, ReactNode, SelectHTMLAttributes } from "react";
|
|
||||||
|
|
||||||
interface FieldWrapperProps {
|
|
||||||
label: string;
|
|
||||||
error?: string;
|
|
||||||
hint?: string;
|
|
||||||
children: (ids: { inputId: string; describedBy: string | undefined }) => ReactNode;
|
|
||||||
}
|
|
||||||
|
|
||||||
function FieldWrapper({ label, error, hint, children }: FieldWrapperProps) {
|
|
||||||
const inputId = useId();
|
|
||||||
const hintId = hint ? `${inputId}-hint` : undefined;
|
|
||||||
const errorId = error ? `${inputId}-error` : undefined;
|
|
||||||
const describedBy = [hintId, errorId].filter(Boolean).join(" ") || undefined;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className="shl-field">
|
|
||||||
<label htmlFor={inputId}>{label}</label>
|
|
||||||
{children({ inputId, describedBy })}
|
|
||||||
{hint && (
|
|
||||||
<p id={hintId} className="shl-field-hint">
|
|
||||||
{hint}
|
|
||||||
</p>
|
|
||||||
)}
|
|
||||||
{error && (
|
|
||||||
<p id={errorId} className="shl-field-error" role="alert">
|
|
||||||
{error}
|
|
||||||
</p>
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface TextFieldProps
|
|
||||||
extends Omit<InputHTMLAttributes<HTMLInputElement>, "id" | "aria-describedby"> {
|
|
||||||
label: string;
|
|
||||||
error?: string;
|
|
||||||
hint?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function TextField({ label, error, hint, ...inputProps }: TextFieldProps) {
|
|
||||||
return (
|
|
||||||
<FieldWrapper label={label} error={error} hint={hint}>
|
|
||||||
{({ inputId, describedBy }) => (
|
|
||||||
<input
|
|
||||||
id={inputId}
|
|
||||||
aria-describedby={describedBy}
|
|
||||||
aria-invalid={error ? true : undefined}
|
|
||||||
{...inputProps}
|
|
||||||
/>
|
|
||||||
)}
|
|
||||||
</FieldWrapper>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface SelectFieldProps
|
|
||||||
extends Omit<SelectHTMLAttributes<HTMLSelectElement>, "id" | "aria-describedby"> {
|
|
||||||
label: string;
|
|
||||||
error?: string;
|
|
||||||
hint?: string;
|
|
||||||
children: ReactNode;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function SelectField({ label, error, hint, children, ...selectProps }: SelectFieldProps) {
|
|
||||||
return (
|
|
||||||
<FieldWrapper label={label} error={error} hint={hint}>
|
|
||||||
{({ inputId, describedBy }) => (
|
|
||||||
<select
|
|
||||||
id={inputId}
|
|
||||||
aria-describedby={describedBy}
|
|
||||||
aria-invalid={error ? true : undefined}
|
|
||||||
{...selectProps}
|
|
||||||
>
|
|
||||||
{children}
|
|
||||||
</select>
|
|
||||||
)}
|
|
||||||
</FieldWrapper>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface CheckboxFieldProps
|
|
||||||
extends Omit<InputHTMLAttributes<HTMLInputElement>, "id" | "type"> {
|
|
||||||
label: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function CheckboxField({ label, ...inputProps }: CheckboxFieldProps) {
|
|
||||||
const inputId = useId();
|
|
||||||
return (
|
|
||||||
<div className="shl-field shl-field-checkbox">
|
|
||||||
<input id={inputId} type="checkbox" {...inputProps} />
|
|
||||||
<label htmlFor={inputId}>{label}</label>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,62 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
// Layout-Shell mit Navigation — SHL-01 Akzeptanzkriterium 1.
|
|
||||||
// Globale Navigation zeigt nur Module, die Core für Tenant/Benutzer freigibt (Backend entscheidet, UI blendet nur aus).
|
|
||||||
|
|
||||||
import type { ReactNode } from "react";
|
|
||||||
import { useI18n } from "../i18n/i18n";
|
|
||||||
import { useTheme } from "../theme/ThemeProvider";
|
|
||||||
|
|
||||||
export interface ModuleLink {
|
|
||||||
key: string;
|
|
||||||
label: string;
|
|
||||||
href: string;
|
|
||||||
active?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ShellProps {
|
|
||||||
modules: ModuleLink[];
|
|
||||||
tenantLabel: string;
|
|
||||||
children: ReactNode;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function Shell({ modules, tenantLabel, children }: ShellProps) {
|
|
||||||
const { scheme, toggle } = useTheme();
|
|
||||||
const { t } = useI18n();
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className="shl-shell">
|
|
||||||
<a className="shl-skip-link" href="#shl-main-content">
|
|
||||||
{t("shl.shell.skipToContent", "Zum Inhalt springen")}
|
|
||||||
</a>
|
|
||||||
<header className="shl-shell-header">
|
|
||||||
<nav aria-label={t("shl.shell.moduleNav", "Modul-Navigation")}>
|
|
||||||
<ul>
|
|
||||||
{modules.map((mod) => (
|
|
||||||
<li key={mod.key}>
|
|
||||||
<a href={mod.href} aria-current={mod.active ? "page" : undefined}>
|
|
||||||
{mod.label}
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
))}
|
|
||||||
</ul>
|
|
||||||
</nav>
|
|
||||||
<div className="shl-shell-context">
|
|
||||||
<span className="shl-tenant-context">{tenantLabel}</span>
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
onClick={toggle}
|
|
||||||
aria-label={
|
|
||||||
scheme === "light" ? t("shl.theme.toggleToDark") : t("shl.theme.toggleToLight")
|
|
||||||
}
|
|
||||||
>
|
|
||||||
{scheme === "light" ? "🌙" : "☀️"}
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</header>
|
|
||||||
<main id="shl-main-content" className="shl-shell-content" tabIndex={-1}>
|
|
||||||
{children}
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
// Table-Basis-Komponente — SHL-01. WCAG: semantische <table>, scope auf Kopfzellen, sortierbare Spalten per Tastatur.
|
|
||||||
|
|
||||||
import type { ReactNode } from "react";
|
|
||||||
import { useI18n } from "../i18n/i18n";
|
|
||||||
|
|
||||||
export interface TableColumn<Row> {
|
|
||||||
key: string;
|
|
||||||
header: string;
|
|
||||||
render: (row: Row) => ReactNode;
|
|
||||||
sortable?: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface TableProps<Row> {
|
|
||||||
columns: TableColumn<Row>[];
|
|
||||||
rows: Row[];
|
|
||||||
rowKey: (row: Row) => string;
|
|
||||||
sortKey?: string;
|
|
||||||
sortDirection?: "asc" | "desc";
|
|
||||||
onSort?: (key: string) => void;
|
|
||||||
caption?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function Table<Row>({
|
|
||||||
columns,
|
|
||||||
rows,
|
|
||||||
rowKey,
|
|
||||||
sortKey,
|
|
||||||
sortDirection,
|
|
||||||
onSort,
|
|
||||||
caption,
|
|
||||||
}: TableProps<Row>) {
|
|
||||||
const { t } = useI18n();
|
|
||||||
|
|
||||||
return (
|
|
||||||
<table className="shl-table">
|
|
||||||
{caption && <caption>{caption}</caption>}
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
{columns.map((column) => {
|
|
||||||
const isSorted = column.key === sortKey;
|
|
||||||
const ariaSort = column.sortable
|
|
||||||
? isSorted
|
|
||||||
? sortDirection === "asc"
|
|
||||||
? "ascending"
|
|
||||||
: "descending"
|
|
||||||
: "none"
|
|
||||||
: undefined;
|
|
||||||
return (
|
|
||||||
<th key={column.key} scope="col" aria-sort={ariaSort}>
|
|
||||||
{column.sortable ? (
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
onClick={() => onSort?.(column.key)}
|
|
||||||
className="shl-table-sort-button"
|
|
||||||
>
|
|
||||||
{column.header}
|
|
||||||
</button>
|
|
||||||
) : (
|
|
||||||
column.header
|
|
||||||
)}
|
|
||||||
</th>
|
|
||||||
);
|
|
||||||
})}
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
{rows.length === 0 ? (
|
|
||||||
<tr>
|
|
||||||
<td colSpan={columns.length}>{t("shl.table.noRows")}</td>
|
|
||||||
</tr>
|
|
||||||
) : (
|
|
||||||
rows.map((row) => (
|
|
||||||
<tr key={rowKey(row)}>
|
|
||||||
{columns.map((column) => (
|
|
||||||
<td key={column.key}>{column.render(row)}</td>
|
|
||||||
))}
|
|
||||||
</tr>
|
|
||||||
))
|
|
||||||
)}
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
// Toast-Basis-Komponente — SHL-01. WCAG: aria-live sorgt dafür, dass Screenreader Meldungen ansagen.
|
|
||||||
|
|
||||||
import { createContext, useCallback, useContext, useMemo, useState } from "react";
|
|
||||||
import type { ReactNode } from "react";
|
|
||||||
import { useI18n } from "../i18n/i18n";
|
|
||||||
|
|
||||||
export type ToastVariant = "info" | "success" | "danger" | "warning";
|
|
||||||
|
|
||||||
export interface ToastMessage {
|
|
||||||
id: string;
|
|
||||||
text: string;
|
|
||||||
variant: ToastVariant;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface ToastContextValue {
|
|
||||||
toasts: ToastMessage[];
|
|
||||||
push: (text: string, variant?: ToastVariant) => void;
|
|
||||||
dismiss: (id: string) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
const ToastContext = createContext<ToastContextValue | null>(null);
|
|
||||||
|
|
||||||
export function ToastProvider({ children }: { children: ReactNode }) {
|
|
||||||
const [toasts, setToasts] = useState<ToastMessage[]>([]);
|
|
||||||
const { t } = useI18n();
|
|
||||||
|
|
||||||
const dismiss = useCallback((id: string) => {
|
|
||||||
setToasts((current) => current.filter((toast) => toast.id !== id));
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
const push = useCallback((text: string, variant: ToastVariant = "info") => {
|
|
||||||
const id = `${Date.now()}-${Math.random().toString(36).slice(2, 8)}`;
|
|
||||||
setToasts((current) => [...current, { id, text, variant }]);
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
const value = useMemo(() => ({ toasts, push, dismiss }), [toasts, push, dismiss]);
|
|
||||||
|
|
||||||
return (
|
|
||||||
<ToastContext.Provider value={value}>
|
|
||||||
{children}
|
|
||||||
<div className="shl-toast-region" role="status" aria-live="polite" aria-atomic="false">
|
|
||||||
{toasts.map((toast) => (
|
|
||||||
<div key={toast.id} className={`shl-toast shl-toast-${toast.variant}`}>
|
|
||||||
<span>{toast.text}</span>
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
onClick={() => dismiss(toast.id)}
|
|
||||||
aria-label={t("shl.toast.dismiss")}
|
|
||||||
>
|
|
||||||
×
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
))}
|
|
||||||
</div>
|
|
||||||
</ToastContext.Provider>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function useToast(): ToastContextValue {
|
|
||||||
const ctx = useContext(ToastContext);
|
|
||||||
if (!ctx) {
|
|
||||||
throw new Error("useToast muss innerhalb von <ToastProvider> aufgerufen werden");
|
|
||||||
}
|
|
||||||
return ctx;
|
|
||||||
}
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
// i18n-Rahmen (mind. Deutsch/Englisch) — SHL-01 Akzeptanzkriterium 5.
|
|
||||||
// Liefert nur den Umschaltmechanismus + Basis-Komponenten-Texte.
|
|
||||||
// Modul-Frontends liefern ihre eigenen fachlichen Textbausteine über registerMessages(),
|
|
||||||
// statt einen eigenen i18n-Mechanismus zu bauen (siehe UI-UX-KONZEPT.md Abschnitt 4).
|
|
||||||
|
|
||||||
import { createContext, useContext, useMemo, useState } from "react";
|
|
||||||
import type { ReactNode } from "react";
|
|
||||||
|
|
||||||
export type Locale = "de" | "en";
|
|
||||||
|
|
||||||
type MessageDict = Record<string, string>;
|
|
||||||
type MessageBundle = Record<Locale, MessageDict>;
|
|
||||||
|
|
||||||
const baseMessages: MessageBundle = {
|
|
||||||
de: {
|
|
||||||
"shl.dialog.close": "Schließen",
|
|
||||||
"shl.toast.dismiss": "Meldung schließen",
|
|
||||||
"shl.table.noRows": "Keine Einträge vorhanden",
|
|
||||||
"shl.theme.toggleToLight": "Helles Erscheinungsbild",
|
|
||||||
"shl.theme.toggleToDark": "Dunkles Erscheinungsbild",
|
|
||||||
},
|
|
||||||
en: {
|
|
||||||
"shl.dialog.close": "Close",
|
|
||||||
"shl.toast.dismiss": "Dismiss message",
|
|
||||||
"shl.table.noRows": "No entries",
|
|
||||||
"shl.theme.toggleToLight": "Switch to light theme",
|
|
||||||
"shl.theme.toggleToDark": "Switch to dark theme",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
// Registry, in die Modul-Frontends ihre eigenen Textbausteine einhängen.
|
|
||||||
const registry: MessageBundle = { de: { ...baseMessages.de }, en: { ...baseMessages.en } };
|
|
||||||
|
|
||||||
export function registerMessages(locale: Locale, messages: MessageDict): void {
|
|
||||||
registry[locale] = { ...registry[locale], ...messages };
|
|
||||||
}
|
|
||||||
|
|
||||||
interface I18nContextValue {
|
|
||||||
locale: Locale;
|
|
||||||
setLocale: (locale: Locale) => void;
|
|
||||||
t: (key: string, fallback?: string) => string;
|
|
||||||
}
|
|
||||||
|
|
||||||
const I18nContext = createContext<I18nContextValue | null>(null);
|
|
||||||
|
|
||||||
export function I18nProvider({
|
|
||||||
initialLocale = "de",
|
|
||||||
children,
|
|
||||||
}: {
|
|
||||||
initialLocale?: Locale;
|
|
||||||
children: ReactNode;
|
|
||||||
}) {
|
|
||||||
const [locale, setLocale] = useState<Locale>(initialLocale);
|
|
||||||
|
|
||||||
const value = useMemo<I18nContextValue>(
|
|
||||||
() => ({
|
|
||||||
locale,
|
|
||||||
setLocale,
|
|
||||||
t: (key: string, fallback?: string) => registry[locale][key] ?? fallback ?? key,
|
|
||||||
}),
|
|
||||||
[locale],
|
|
||||||
);
|
|
||||||
|
|
||||||
return <I18nContext.Provider value={value}>{children}</I18nContext.Provider>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function useI18n(): I18nContextValue {
|
|
||||||
const ctx = useContext(I18nContext);
|
|
||||||
if (!ctx) {
|
|
||||||
throw new Error("useI18n muss innerhalb von <I18nProvider> aufgerufen werden");
|
|
||||||
}
|
|
||||||
return ctx;
|
|
||||||
}
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
// Öffentliche Schnittstelle des Pakets @nexarch/shl — Modul-Frontends importieren ausschließlich hierüber,
|
|
||||||
// nicht aus internen Unterpfaden (SHL-01 Akzeptanzkriterium 2: dokumentiert, versioniert, importierbar statt kopiert).
|
|
||||||
|
|
||||||
export { colorTokens, spacing, breakpoints, typography, cssVariables } from "./tokens/tokens";
|
|
||||||
export type { ColorScheme, ColorTokens } from "./tokens/tokens";
|
|
||||||
|
|
||||||
export { ThemeProvider, useTheme, currentColors } from "./theme/ThemeProvider";
|
|
||||||
|
|
||||||
export { I18nProvider, useI18n, registerMessages } from "./i18n/i18n";
|
|
||||||
export type { Locale } from "./i18n/i18n";
|
|
||||||
|
|
||||||
export { Shell } from "./components/Shell";
|
|
||||||
export type { ShellProps, ModuleLink } from "./components/Shell";
|
|
||||||
|
|
||||||
export { Dialog } from "./components/Dialog";
|
|
||||||
export type { DialogProps } from "./components/Dialog";
|
|
||||||
|
|
||||||
export { Table } from "./components/Table";
|
|
||||||
export type { TableProps, TableColumn } from "./components/Table";
|
|
||||||
|
|
||||||
export { TextField, SelectField, CheckboxField } from "./components/FormElements";
|
|
||||||
export type { TextFieldProps, SelectFieldProps, CheckboxFieldProps } from "./components/FormElements";
|
|
||||||
|
|
||||||
export { ToastProvider, useToast } from "./components/Toast";
|
|
||||||
export type { ToastMessage, ToastVariant } from "./components/Toast";
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@nexarch/shl",
|
|
||||||
"version": "0.1.0",
|
|
||||||
"private": true,
|
|
||||||
"description": "NEXARCH UI-Shell & Design-System (Core SHL-01) — gemeinsames Paket für alle Modul-Frontends.",
|
|
||||||
"main": "index.ts",
|
|
||||||
"types": "index.ts",
|
|
||||||
"scripts": {
|
|
||||||
"test": "vitest run",
|
|
||||||
"typecheck": "tsc --noEmit"
|
|
||||||
},
|
|
||||||
"peerDependencies": {
|
|
||||||
"react": "^18.3.1",
|
|
||||||
"react-dom": "^18.3.1"
|
|
||||||
},
|
|
||||||
"devDependencies": {
|
|
||||||
"@testing-library/jest-dom": "^6.4.8",
|
|
||||||
"@testing-library/react": "^16.0.0",
|
|
||||||
"@types/react": "18.3.3",
|
|
||||||
"@types/react-dom": "18.3.0",
|
|
||||||
"jsdom": "^24.1.1",
|
|
||||||
"typescript": "5.5.3",
|
|
||||||
"vitest": "^2.0.0"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
"use client";
|
|
||||||
|
|
||||||
// Zentrales Theming (Hell/Dunkel) — SHL-01 Akzeptanzkriterium 6.
|
|
||||||
// Einzige Quelle für Hell/Dunkel-Werte; Modul-Frontends schalten nur um, bauen kein eigenes Theming.
|
|
||||||
|
|
||||||
import { createContext, useCallback, useContext, useEffect, useMemo, useState } from "react";
|
|
||||||
import type { ReactNode } from "react";
|
|
||||||
import { colorTokens, cssVariables, type ColorScheme } from "../tokens/tokens";
|
|
||||||
|
|
||||||
const STORAGE_KEY = "nexarch-shl-theme";
|
|
||||||
|
|
||||||
interface ThemeContextValue {
|
|
||||||
scheme: ColorScheme;
|
|
||||||
setScheme: (scheme: ColorScheme) => void;
|
|
||||||
toggle: () => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
const ThemeContext = createContext<ThemeContextValue | null>(null);
|
|
||||||
|
|
||||||
function readStoredScheme(): ColorScheme | null {
|
|
||||||
if (typeof window === "undefined") return null;
|
|
||||||
try {
|
|
||||||
const stored = window.localStorage.getItem(STORAGE_KEY);
|
|
||||||
return stored === "light" || stored === "dark" ? stored : null;
|
|
||||||
} catch {
|
|
||||||
// localStorage kann in privaten Fenstern/eingeschränkten Kontexten fehlschlagen — kein Absturz, nur kein persistierter Zustand.
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function systemPrefersDark(): boolean {
|
|
||||||
if (typeof window === "undefined" || !window.matchMedia) return false;
|
|
||||||
return window.matchMedia("(prefers-color-scheme: dark)").matches;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function ThemeProvider({ children }: { children: ReactNode }) {
|
|
||||||
const [scheme, setSchemeState] = useState<ColorScheme>("light");
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
const stored = readStoredScheme();
|
|
||||||
setSchemeState(stored ?? (systemPrefersDark() ? "dark" : "light"));
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
const setScheme = useCallback((next: ColorScheme) => {
|
|
||||||
setSchemeState(next);
|
|
||||||
try {
|
|
||||||
window.localStorage.setItem(STORAGE_KEY, next);
|
|
||||||
} catch {
|
|
||||||
// Speichern optional — Umschaltung funktioniert auch ohne Persistenz.
|
|
||||||
}
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
const toggle = useCallback(() => {
|
|
||||||
setScheme(scheme === "light" ? "dark" : "light");
|
|
||||||
}, [scheme, setScheme]);
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
const vars = cssVariables(scheme);
|
|
||||||
const root = document.documentElement;
|
|
||||||
for (const [key, value] of Object.entries(vars)) {
|
|
||||||
root.style.setProperty(key, value);
|
|
||||||
}
|
|
||||||
root.dataset.shlTheme = scheme;
|
|
||||||
}, [scheme]);
|
|
||||||
|
|
||||||
const value = useMemo(() => ({ scheme, setScheme, toggle }), [scheme, setScheme, toggle]);
|
|
||||||
|
|
||||||
return <ThemeContext.Provider value={value}>{children}</ThemeContext.Provider>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function useTheme(): ThemeContextValue {
|
|
||||||
const ctx = useContext(ThemeContext);
|
|
||||||
if (!ctx) {
|
|
||||||
throw new Error("useTheme muss innerhalb von <ThemeProvider> aufgerufen werden");
|
|
||||||
}
|
|
||||||
return ctx;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function currentColors(scheme: ColorScheme) {
|
|
||||||
return colorTokens[scheme];
|
|
||||||
}
|
|
||||||
@@ -1,96 +0,0 @@
|
|||||||
// Design-Tokens: einzige Quelle für Farbe, Abstand, Typografie im gesamten Frontend-Verbund.
|
|
||||||
// Modul-Frontends importieren diese Tokens, überschreiben sie nicht lokal (SHL-01 Akzeptanzkriterium 3).
|
|
||||||
// Kontrastwerte sind gegen WCAG 2.1 AA geprüft (Akzeptanzkriterium 1/4): mindestens 4.5:1 für Fließtext.
|
|
||||||
|
|
||||||
export type ColorScheme = "light" | "dark";
|
|
||||||
|
|
||||||
export interface ColorTokens {
|
|
||||||
background: string;
|
|
||||||
surface: string;
|
|
||||||
surfaceRaised: string;
|
|
||||||
border: string;
|
|
||||||
textPrimary: string;
|
|
||||||
textSecondary: string;
|
|
||||||
accent: string;
|
|
||||||
accentContrast: string;
|
|
||||||
danger: string;
|
|
||||||
dangerContrast: string;
|
|
||||||
success: string;
|
|
||||||
warning: string;
|
|
||||||
focusRing: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Kontrastwerte geprüft: textPrimary auf background/surface >= 7:1, textSecondary >= 4.5:1,
|
|
||||||
// accentContrast auf accent >= 4.5:1 (WCAG AA, siehe SHL-01 Prüfung 3).
|
|
||||||
export const colorTokens: Record<ColorScheme, ColorTokens> = {
|
|
||||||
light: {
|
|
||||||
background: "#FFFFFF",
|
|
||||||
surface: "#F5F6F8",
|
|
||||||
surfaceRaised: "#FFFFFF",
|
|
||||||
border: "#D7DBE0",
|
|
||||||
textPrimary: "#14181F",
|
|
||||||
textSecondary: "#4B5563",
|
|
||||||
accent: "#1D4ED8",
|
|
||||||
accentContrast: "#FFFFFF",
|
|
||||||
danger: "#B91C1C",
|
|
||||||
dangerContrast: "#FFFFFF",
|
|
||||||
success: "#15803D",
|
|
||||||
warning: "#B45309",
|
|
||||||
focusRing: "#1D4ED8",
|
|
||||||
},
|
|
||||||
dark: {
|
|
||||||
background: "#0F1115",
|
|
||||||
surface: "#181B21",
|
|
||||||
surfaceRaised: "#20242C",
|
|
||||||
border: "#333944",
|
|
||||||
textPrimary: "#F2F4F7",
|
|
||||||
textSecondary: "#B4BAC4",
|
|
||||||
accent: "#5B8DEF",
|
|
||||||
accentContrast: "#0F1115",
|
|
||||||
danger: "#F87171",
|
|
||||||
dangerContrast: "#0F1115",
|
|
||||||
success: "#4ADE80",
|
|
||||||
warning: "#FBBF24",
|
|
||||||
focusRing: "#5B8DEF",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
export const spacing = {
|
|
||||||
xs: "4px",
|
|
||||||
sm: "8px",
|
|
||||||
md: "16px",
|
|
||||||
lg: "24px",
|
|
||||||
xl: "32px",
|
|
||||||
xxl: "48px",
|
|
||||||
} as const;
|
|
||||||
|
|
||||||
export const breakpoints = {
|
|
||||||
mobile: "0px",
|
|
||||||
tablet: "768px",
|
|
||||||
desktop: "1200px",
|
|
||||||
} as const;
|
|
||||||
|
|
||||||
export const typography = {
|
|
||||||
fontFamily: "'Inter', 'Segoe UI', system-ui, sans-serif",
|
|
||||||
fontFamilyMono: "'JetBrains Mono', ui-monospace, monospace",
|
|
||||||
sizeSm: "13px",
|
|
||||||
sizeMd: "15px",
|
|
||||||
sizeLg: "18px",
|
|
||||||
sizeXl: "24px",
|
|
||||||
lineHeight: 1.5,
|
|
||||||
weightRegular: 400,
|
|
||||||
weightMedium: 500,
|
|
||||||
weightBold: 600,
|
|
||||||
} as const;
|
|
||||||
|
|
||||||
export function cssVariables(scheme: ColorScheme): Record<string, string> {
|
|
||||||
const c = colorTokens[scheme];
|
|
||||||
const vars: Record<string, string> = {};
|
|
||||||
for (const [key, value] of Object.entries(c)) {
|
|
||||||
vars[`--shl-color-${key.replace(/([A-Z])/g, "-$1").toLowerCase()}`] = value;
|
|
||||||
}
|
|
||||||
for (const [key, value] of Object.entries(spacing)) {
|
|
||||||
vars[`--shl-spacing-${key}`] = value;
|
|
||||||
}
|
|
||||||
return vars;
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"target": "ES2020",
|
|
||||||
"lib": ["dom", "dom.iterable", "esnext"],
|
|
||||||
"jsx": "react-jsx",
|
|
||||||
"module": "ESNext",
|
|
||||||
"moduleResolution": "bundler",
|
|
||||||
"strict": true,
|
|
||||||
"declaration": true,
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"skipLibCheck": true,
|
|
||||||
"forceConsistentCasingInFileNames": true,
|
|
||||||
"noUnusedLocals": true,
|
|
||||||
"noUnusedParameters": true
|
|
||||||
},
|
|
||||||
"include": ["**/*.ts", "**/*.tsx"],
|
|
||||||
"exclude": ["node_modules"]
|
|
||||||
}
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
import { defineConfig } from "vitest/config";
|
|
||||||
|
|
||||||
export default defineConfig({
|
|
||||||
test: {
|
|
||||||
environment: "jsdom",
|
|
||||||
setupFiles: ["./vitest.setup.ts"],
|
|
||||||
},
|
|
||||||
});
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
import "@testing-library/jest-dom/vitest";
|
|
||||||
import { afterEach } from "vitest";
|
|
||||||
import { cleanup } from "@testing-library/react";
|
|
||||||
|
|
||||||
// Ohne explizites Cleanup bleiben zwischen den it()-Blöcken gerenderte Dialoge im DOM stehen
|
|
||||||
// (mehrere <html>/<body>-Bäume stapeln sich), wodurch getByRole() mehrere Treffer statt einen findet.
|
|
||||||
afterEach(() => {
|
|
||||||
cleanup();
|
|
||||||
});
|
|
||||||
Reference in New Issue
Block a user