Compare commits
12
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6537888da6 | ||
|
|
bfa5c61db5 | ||
|
|
554c9aae66 | ||
|
|
1ba90319a2 | ||
|
|
3c226dab12 | ||
|
|
f344f79326 | ||
|
|
c4bcfa8caf | ||
|
|
584cefa388 | ||
|
|
00665592f6 | ||
|
|
3b96d8ef41 | ||
|
|
c9e8edbbf0 | ||
|
|
b12d53f469 |
@@ -1,2 +1,4 @@
|
|||||||
*.log
|
*.log
|
||||||
.env
|
.env
|
||||||
|
web/*/node_modules/
|
||||||
|
web/*/.next/
|
||||||
|
|||||||
@@ -64,6 +64,9 @@ 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.
|
||||||
@@ -127,36 +130,32 @@ 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 23:55 – 23:59 (3m)
|
## 2026-08-28 21:51 – 21:57 (5m)
|
||||||
**Beschreibung:** Claude Code Session
|
**Beschreibung:** Claude Code Session
|
||||||
**Projekt:** nexarch
|
**Projekt:** nexarch
|
||||||
|
|
||||||
### Commits
|
### Commits
|
||||||
- 369a40a OPS-05: alerting-bei-schwellwert-ueberschreitung (internal/alerting: regel-store, evaluator gegen ops-03-metriken, cfg-02-zustellung, drosselung je regel+zeitreihe)
|
- 3c226da SHL-01: fix — vitest jsdom-environment + jest-dom-Setup (3 Dialog-Tests schlugen ohne DOM fehl)
|
||||||
- 06dbd52 Merge branch 'feature/cfg-02-benachrichtigungs-dispatcher-core-service-fuer-module' into feature/ops-05-alerting-bei-schwellwert-ueberschreitung
|
|
||||||
|
|
||||||
### Geänderte Dateien
|
### Geänderte Dateien
|
||||||
- internal/alerting/evaluator.go | 194 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
- web/shl/package.json | 2 ++
|
||||||
- internal/alerting/evaluator_test.go | 233 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
- web/shl/vitest.config.ts | 8 ++++++++
|
||||||
- internal/alerting/rules.go | 132 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
- web/shl/vitest.setup.ts | 1 +
|
||||||
- migrations/0006_alert_rules.down.sql | 2 ++
|
|
||||||
- migrations/0006_alert_rules.up.sql | 24 ++++++++++++++++++++++
|
|
||||||
|
|
||||||
---
|
|
||||||
## 2026-08-29 00:00 – 00:00 (0m)
|
|
||||||
**Beschreibung:** Claude Code Session
|
|
||||||
**Projekt:** code
|
|
||||||
|
|
||||||
### Commits
|
|
||||||
Keine Commits in dieser Session.
|
|
||||||
|
|
||||||
### Geänderte Dateien
|
|
||||||
- internal/alerting/evaluator.go | 194 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- internal/alerting/evaluator_test.go | 233 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- internal/alerting/rules.go | 132 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
||||||
- migrations/0006_alert_rules.down.sql | 2 ++
|
|
||||||
- migrations/0006_alert_rules.up.sql | 24 ++++++++++++++++++++++
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -0,0 +1,69 @@
|
|||||||
|
// auditlog-devserver stellt AUD-03s ExportHandler (internal/audit) fuer die
|
||||||
|
// Next.js-Audit-Log-Ansicht (AUD-04) bereit. Getrennt von cmd/core aus
|
||||||
|
// demselben Grund wie die anderen *-devserver (siehe LIC-04/TEN-05): echte
|
||||||
|
// Auth/RBAC ist noch nicht in die zentrale Server-Topologie verdrahtet.
|
||||||
|
//
|
||||||
|
// Authorize wird hier mit einem geteilten Admin-Token ueber
|
||||||
|
// crypto/subtle.ConstantTimeCompare umgesetzt — demselben Timing-safe-Muster
|
||||||
|
// wie internal/audit.timingsafe (AUD-02), NICHT ueber eine neue
|
||||||
|
// Rollen-/Rechteschicht, da diese Kachel ausdruecklich nur von AUD-03
|
||||||
|
// abhaengt und keine Rechteverwaltung duplizieren soll.
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/audit"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/auditadmin"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/db"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
dsn := os.Getenv("NEXARCH_REGISTRY_DSN")
|
||||||
|
if dsn == "" {
|
||||||
|
log.Fatal("NEXARCH_REGISTRY_DSN nicht gesetzt")
|
||||||
|
}
|
||||||
|
adminToken := os.Getenv("NEXARCH_AUDIT_ADMIN_TOKEN")
|
||||||
|
if adminToken == "" {
|
||||||
|
log.Fatal("NEXARCH_AUDIT_ADMIN_TOKEN nicht gesetzt")
|
||||||
|
}
|
||||||
|
addr := os.Getenv("NEXARCH_AUDITLOG_LISTEN_ADDR")
|
||||||
|
if addr == "" {
|
||||||
|
addr = ":8083"
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
pool, err := db.Connect(ctx, dsn)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("db: %v", err)
|
||||||
|
}
|
||||||
|
defer pool.Close()
|
||||||
|
|
||||||
|
auditLog := audit.NewLog(pool)
|
||||||
|
tokenAuthorize := auditadmin.NewTokenAuthorizer(adminToken)
|
||||||
|
authorize := func(_ context.Context, caller string) bool { return tokenAuthorize(caller) }
|
||||||
|
handler := audit.NewExportHandler(auditLog, authorize)
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/audit/export", withCORS(handler.Export))
|
||||||
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
||||||
|
|
||||||
|
log.Printf("auditlog-devserver listening on %s", addr)
|
||||||
|
log.Fatal(http.ListenAndServe(addr, mux))
|
||||||
|
}
|
||||||
|
|
||||||
|
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, OPTIONS")
|
||||||
|
w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
|
||||||
|
if r.Method == http.MethodOptions {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
next(w, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
// 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,25 +1,14 @@
|
|||||||
module gitea.perlbach24.de/scripte/nexarch
|
module gitea.perlbach24.de/scripte/nexarch
|
||||||
|
|
||||||
go 1.25.0
|
go 1.22
|
||||||
|
|
||||||
|
require github.com/jackc/pgx/v5 v5.6.0
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/jackc/pgx/v5 v5.6.0
|
|
||||||
github.com/prometheus/client_golang v1.24.1
|
|
||||||
github.com/prometheus/client_model v0.6.2
|
|
||||||
github.com/prometheus/common v0.70.1
|
|
||||||
)
|
|
||||||
|
|
||||||
require (
|
|
||||||
github.com/beorn7/perks v1.0.1 // indirect
|
|
||||||
github.com/cespare/xxhash/v2 v2.3.0 // indirect
|
|
||||||
github.com/jackc/pgpassfile v1.0.0 // indirect
|
github.com/jackc/pgpassfile v1.0.0 // indirect
|
||||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
|
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
|
||||||
github.com/jackc/puddle/v2 v2.2.1 // indirect
|
github.com/jackc/puddle/v2 v2.2.1 // indirect
|
||||||
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
|
|
||||||
github.com/prometheus/procfs v0.21.1 // indirect
|
|
||||||
golang.org/x/crypto v0.17.0 // indirect
|
golang.org/x/crypto v0.17.0 // indirect
|
||||||
golang.org/x/sync v0.22.0 // indirect
|
golang.org/x/sync v0.1.0 // indirect
|
||||||
golang.org/x/sys v0.47.0 // indirect
|
golang.org/x/text v0.14.0 // indirect
|
||||||
golang.org/x/text v0.40.0 // indirect
|
|
||||||
google.golang.org/protobuf v1.36.11 // indirect
|
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,12 +1,6 @@
|
|||||||
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
|
|
||||||
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
|
|
||||||
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
|
|
||||||
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
|
|
||||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
|
|
||||||
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
|
|
||||||
github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
|
github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
|
||||||
github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
|
github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
|
||||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
|
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
|
||||||
@@ -15,37 +9,19 @@ github.com/jackc/pgx/v5 v5.6.0 h1:SWJzexBzPL5jb0GEsrPMLIsi/3jOo7RHlzTjcAeDrPY=
|
|||||||
github.com/jackc/pgx/v5 v5.6.0/go.mod h1:DNZ/vlrUnhWCoFGxHAG8U2ljioxukquj7utPDgtQdTw=
|
github.com/jackc/pgx/v5 v5.6.0/go.mod h1:DNZ/vlrUnhWCoFGxHAG8U2ljioxukquj7utPDgtQdTw=
|
||||||
github.com/jackc/puddle/v2 v2.2.1 h1:RhxXJtFG022u4ibrCSMSiu5aOq1i77R3OHKNJj77OAk=
|
github.com/jackc/puddle/v2 v2.2.1 h1:RhxXJtFG022u4ibrCSMSiu5aOq1i77R3OHKNJj77OAk=
|
||||||
github.com/jackc/puddle/v2 v2.2.1/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
|
github.com/jackc/puddle/v2 v2.2.1/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
|
||||||
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
|
|
||||||
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
|
|
||||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
github.com/prometheus/client_golang v1.24.1 h1:JnJkREXzWxUdCuPFpIWZiPispT9xVV59uiuyR2bPlnU=
|
|
||||||
github.com/prometheus/client_golang v1.24.1/go.mod h1:F+oSRECHg4sse5ucfYpYDeIv/hu68Zo0uoHKetWnzcE=
|
|
||||||
github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk=
|
|
||||||
github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE=
|
|
||||||
github.com/prometheus/common v0.70.1 h1:1HvjP4D5oL3t8RsPlwxA9onvvStjtIHYE5XuuwOi/PY=
|
|
||||||
github.com/prometheus/common v0.70.1/go.mod h1:VdFUQDMZK3VLkurFUVhia6uys/0suUp86TJz5qbJRhc=
|
|
||||||
github.com/prometheus/procfs v0.21.1 h1:GljZCt+zSTS+NZq88cyQ1LjZ+RCHp3uVuabBWA5+OJI=
|
|
||||||
github.com/prometheus/procfs v0.21.1/go.mod h1:aB55Cww9pdSJVHk0hUf0inxWyyjPogFIjmHKYgMKmtY=
|
|
||||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||||
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
|
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
|
||||||
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
|
||||||
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
|
|
||||||
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
|
|
||||||
go.yaml.in/yaml/v2 v2.4.4 h1:tuyd0P+2Ont/d6e2rl3be67goVK4R6deVxCUX5vyPaQ=
|
|
||||||
go.yaml.in/yaml/v2 v2.4.4/go.mod h1:gMZqIpDtDqOfM0uNfy0SkpRhvUryYH0Z6wdMYcacYXQ=
|
|
||||||
golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
|
golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
|
||||||
golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
|
golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
|
||||||
golang.org/x/sync v0.22.0 h1:SZjpbeLmrCk4xhRSZFNZW5gFUeCeFgjekvI/+gfScek=
|
golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
|
||||||
golang.org/x/sync v0.22.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
|
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
|
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||||
golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
golang.org/x/text v0.40.0 h1:Ub2Z6/xjgF1WrYQz2nuITOEegKFtiIy+rieRJ5lHZKs=
|
|
||||||
golang.org/x/text v0.40.0/go.mod h1:hpnzDAfGV753zIKo+wk3u1bVKCGPbrnF7+7LBF/UHVY=
|
|
||||||
google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
|
|
||||||
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
|
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
|
|||||||
@@ -1,194 +0,0 @@
|
|||||||
package alerting
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"sort"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
dto "github.com/prometheus/client_model/go"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/notify"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DefaultDebounceInterval: wiederholte Alarmierung für denselben
|
|
||||||
// anhaltenden Zustand ist gedrosselt (Akzeptanzkriterium 3) — 15 Minuten
|
|
||||||
// ist ein üblicher Kompromiss zwischen "schnell genug informiert" und
|
|
||||||
// "kein Alarm-Spam bei dauerhaft überschrittenem Wert".
|
|
||||||
const DefaultDebounceInterval = 15 * time.Minute
|
|
||||||
|
|
||||||
// AlertChannel ist der CFG-02-Kanal, über den Schwellwert-Alarme zugestellt
|
|
||||||
// werden — ein eigener Kanalname, damit Zustellregeln/-vorlagen (CFG-03)
|
|
||||||
// unabhängig von anderen Benachrichtigungsarten konfiguriert werden können.
|
|
||||||
const AlertChannel = "alert"
|
|
||||||
|
|
||||||
// Evaluator prüft konfigurierte Regeln gegen aktuell gesammelte Metriken
|
|
||||||
// (aus internal/metrics.Aggregator.Gather) und löst bei Überschreitung eine
|
|
||||||
// Benachrichtigung über CFG-02 aus (Akzeptanzkriterium 2), gedrosselt je
|
|
||||||
// Regel+Zeitreihe (Akzeptanzkriterium 3).
|
|
||||||
type Evaluator struct {
|
|
||||||
rules *RuleStore
|
|
||||||
debounce *debounceStore
|
|
||||||
dispatcher *notify.Dispatcher
|
|
||||||
interval time.Duration
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewEvaluator(rules *RuleStore, dispatcher *notify.Dispatcher, debouncePool *pgxpool.Pool, interval time.Duration) *Evaluator {
|
|
||||||
if interval <= 0 {
|
|
||||||
interval = DefaultDebounceInterval
|
|
||||||
}
|
|
||||||
return &Evaluator{
|
|
||||||
rules: rules,
|
|
||||||
debounce: &debounceStore{pool: debouncePool},
|
|
||||||
dispatcher: dispatcher,
|
|
||||||
interval: interval,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// FiredAlert beschreibt einen tatsächlich ausgelösten (nicht gedrosselten)
|
|
||||||
// Alarm — fürs Testen/Logging, nicht Teil des öffentlichen Zustellwegs.
|
|
||||||
type FiredAlert struct {
|
|
||||||
RuleID string
|
|
||||||
MetricName string
|
|
||||||
Value float64
|
|
||||||
Threshold float64
|
|
||||||
Labels map[string]string
|
|
||||||
Skipped bool // true, wenn wegen Drosselung NICHT tatsaechlich zugestellt
|
|
||||||
}
|
|
||||||
|
|
||||||
// Evaluate prüft alle konfigurierten Regeln gegen families (Akzeptanzkriterium 1).
|
|
||||||
// Für jede Zeitreihe, die eine Regel verletzt, wird — sofern nicht gedrosselt
|
|
||||||
// — eine Benachrichtigung mit Metrik/Wert/Schwellwert/Labels (Tenant/Modul,
|
|
||||||
// falls als Label vorhanden) über CFG-02 eingereiht (Akzeptanzkriterium 2).
|
|
||||||
func (e *Evaluator) Evaluate(ctx context.Context, families []*dto.MetricFamily) ([]FiredAlert, error) {
|
|
||||||
rules, err := e.rules.ListRules(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("regeln laden: %w", err)
|
|
||||||
}
|
|
||||||
if len(rules) == 0 {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
byName := make(map[string]*dto.MetricFamily, len(families))
|
|
||||||
for _, f := range families {
|
|
||||||
if f.Name != nil {
|
|
||||||
byName[*f.Name] = f
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var fired []FiredAlert
|
|
||||||
for _, rule := range rules {
|
|
||||||
family, ok := byName[rule.MetricName]
|
|
||||||
if !ok {
|
|
||||||
continue // Metrik (noch) nicht vorhanden -> keine Aussage moeglich, kein Fehler.
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, m := range family.Metric {
|
|
||||||
labels := labelMap(m)
|
|
||||||
if !matchesFilter(labels, rule.LabelFilters) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
value, ok := metricValue(m)
|
|
||||||
if !ok {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if !violates(rule, value) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
ruleKey := ruleKeyFor(rule.ID, labels)
|
|
||||||
allowed, err := e.debounce.shouldFire(ctx, ruleKey, e.interval.Seconds())
|
|
||||||
if err != nil {
|
|
||||||
return fired, fmt.Errorf("drosselung pruefen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
alert := FiredAlert{
|
|
||||||
RuleID: rule.ID, MetricName: rule.MetricName, Value: value,
|
|
||||||
Threshold: rule.Threshold, Labels: labels, Skipped: !allowed,
|
|
||||||
}
|
|
||||||
fired = append(fired, alert)
|
|
||||||
|
|
||||||
if !allowed {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
payload := map[string]any{
|
|
||||||
"metric": rule.MetricName,
|
|
||||||
"value": value,
|
|
||||||
"threshold": rule.Threshold,
|
|
||||||
"comparison": string(rule.Comparison),
|
|
||||||
"description": rule.Description,
|
|
||||||
"labels": labels,
|
|
||||||
}
|
|
||||||
if _, err := e.dispatcher.Enqueue(ctx, AlertChannel, rule.Recipient, payload); err != nil {
|
|
||||||
return fired, fmt.Errorf("alarm einreihen: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return fired, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func violates(rule Rule, value float64) bool {
|
|
||||||
switch rule.Comparison {
|
|
||||||
case ComparisonGreaterThan:
|
|
||||||
return value > rule.Threshold
|
|
||||||
case ComparisonLessThan:
|
|
||||||
return value < rule.Threshold
|
|
||||||
default:
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func labelMap(m *dto.Metric) map[string]string {
|
|
||||||
out := make(map[string]string, len(m.Label))
|
|
||||||
for _, l := range m.Label {
|
|
||||||
if l.Name != nil && l.Value != nil {
|
|
||||||
out[*l.Name] = *l.Value
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func matchesFilter(labels, filter map[string]string) bool {
|
|
||||||
for k, v := range filter {
|
|
||||||
if labels[k] != v {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
func metricValue(m *dto.Metric) (float64, bool) {
|
|
||||||
switch {
|
|
||||||
case m.Gauge != nil && m.Gauge.Value != nil:
|
|
||||||
return *m.Gauge.Value, true
|
|
||||||
case m.Counter != nil && m.Counter.Value != nil:
|
|
||||||
return *m.Counter.Value, true
|
|
||||||
case m.Untyped != nil && m.Untyped.Value != nil:
|
|
||||||
return *m.Untyped.Value, true
|
|
||||||
default:
|
|
||||||
return 0, false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ruleKeyFor macht die Drosselung unabhaengig je Regel UND je konkreter
|
|
||||||
// Zeitreihe (z. B. verschiedene Tenants/Module derselben Metrik loesen
|
|
||||||
// unabhaengig voneinander aus, siehe Migrationskommentar).
|
|
||||||
func ruleKeyFor(ruleID string, labels map[string]string) string {
|
|
||||||
keys := make([]string, 0, len(labels))
|
|
||||||
for k := range labels {
|
|
||||||
keys = append(keys, k)
|
|
||||||
}
|
|
||||||
sort.Strings(keys)
|
|
||||||
var b strings.Builder
|
|
||||||
b.WriteString(ruleID)
|
|
||||||
for _, k := range keys {
|
|
||||||
b.WriteString("|")
|
|
||||||
b.WriteString(k)
|
|
||||||
b.WriteString("=")
|
|
||||||
b.WriteString(labels[k])
|
|
||||||
}
|
|
||||||
return b.String()
|
|
||||||
}
|
|
||||||
@@ -1,233 +0,0 @@
|
|||||||
package alerting
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
dto "github.com/prometheus/client_model/go"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/notify"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupTest(t *testing.T) (*RuleStore, *notify.Dispatcher, *pgxpool.Pool, 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 alert_rules (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), metric_name TEXT NOT NULL,
|
|
||||||
comparison TEXT NOT NULL CHECK (comparison IN ('gt','lt')), threshold DOUBLE PRECISION NOT NULL,
|
|
||||||
label_filters JSONB NOT NULL DEFAULT '{}'::jsonb, recipient TEXT NOT NULL,
|
|
||||||
description TEXT NOT NULL DEFAULT '', created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS alert_debounce_state (
|
|
||||||
rule_key TEXT PRIMARY KEY, last_fired_at TIMESTAMPTZ NOT NULL
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS notification_jobs (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), channel TEXT NOT NULL, recipient TEXT NOT NULL,
|
|
||||||
payload JSONB NOT NULL DEFAULT '{}'::jsonb, status TEXT NOT NULL DEFAULT 'pending', attempts INT NOT NULL DEFAULT 0,
|
|
||||||
max_attempts INT NOT NULL DEFAULT 5, next_attempt_at TIMESTAMPTZ NOT NULL DEFAULT now(), last_error TEXT,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(), updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() {
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM alert_rules`)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM alert_debounce_state`)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM notification_jobs`)
|
|
||||||
pool.Close()
|
|
||||||
}
|
|
||||||
return NewRuleStore(pool), notify.NewDispatcher(pool), pool, cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
func gaugeFamily(name string, labels map[string]string, value float64) *dto.MetricFamily {
|
|
||||||
pairs := make([]*dto.LabelPair, 0, len(labels))
|
|
||||||
for k, v := range labels {
|
|
||||||
k, v := k, v
|
|
||||||
pairs = append(pairs, &dto.LabelPair{Name: &k, Value: &v})
|
|
||||||
}
|
|
||||||
n := name
|
|
||||||
return &dto.MetricFamily{
|
|
||||||
Name: &n,
|
|
||||||
Metric: []*dto.Metric{
|
|
||||||
{Label: pairs, Gauge: &dto.Gauge{Value: &value}},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + 2 / Pruefung 1 + 2: Überschreitung löst eine
|
|
||||||
// Benachrichtigung mit vollständigem Inhalt (Metrik/Tenant/Modul) aus.
|
|
||||||
func TestEvaluate_FiresAlertOnThresholdExceeded(t *testing.T) {
|
|
||||||
rules, dispatcher, pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
rule, err := rules.CreateRule(ctx, Rule{
|
|
||||||
MetricName: "nexarch_core_error_rate", Comparison: ComparisonGreaterThan, Threshold: 0.05,
|
|
||||||
Recipient: "ops@acme.example", Description: "Fehlerrate zu hoch",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create rule: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
eval := NewEvaluator(rules, dispatcher, pool, time.Hour)
|
|
||||||
families := []*dto.MetricFamily{
|
|
||||||
gaugeFamily("nexarch_core_error_rate", map[string]string{"tenant": "acme", "module": "dms"}, 0.12),
|
|
||||||
}
|
|
||||||
|
|
||||||
fired, err := eval.Evaluate(ctx, families)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("evaluate: %v", err)
|
|
||||||
}
|
|
||||||
if len(fired) != 1 || fired[0].Skipped {
|
|
||||||
t.Fatalf("erwartet genau 1 tatsaechlich ausgeloesten alarm, habe %+v", fired)
|
|
||||||
}
|
|
||||||
if fired[0].RuleID != rule.ID {
|
|
||||||
t.Fatalf("rule id = %q, want %q", fired[0].RuleID, rule.ID)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Pruefung 2: Benachrichtigungsinhalt vollstaendig (Metrik/Tenant/Modul).
|
|
||||||
var payloadJSON []byte
|
|
||||||
if err := pool.QueryRow(ctx, `SELECT payload FROM notification_jobs LIMIT 1`).Scan(&payloadJSON); err != nil {
|
|
||||||
t.Fatalf("notification_jobs lesen: %v", err)
|
|
||||||
}
|
|
||||||
payload := string(payloadJSON)
|
|
||||||
for _, want := range []string{`"metric"`, `nexarch_core_error_rate`, `"tenant"`, `"acme"`, `"module"`, `"dms"`} {
|
|
||||||
if !strings.Contains(payload, want) {
|
|
||||||
t.Errorf("payload enthaelt nicht %q: %s", want, payload)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestEvaluate_DoesNotFireBelowThreshold(t *testing.T) {
|
|
||||||
rules, dispatcher, pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := rules.CreateRule(ctx, Rule{
|
|
||||||
MetricName: "nexarch_core_error_rate", Comparison: ComparisonGreaterThan, Threshold: 0.05,
|
|
||||||
Recipient: "ops@acme.example",
|
|
||||||
}); err != nil {
|
|
||||||
t.Fatalf("create rule: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
eval := NewEvaluator(rules, dispatcher, pool, time.Hour)
|
|
||||||
families := []*dto.MetricFamily{
|
|
||||||
gaugeFamily("nexarch_core_error_rate", map[string]string{"tenant": "acme"}, 0.01),
|
|
||||||
}
|
|
||||||
|
|
||||||
fired, err := eval.Evaluate(ctx, families)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("evaluate: %v", err)
|
|
||||||
}
|
|
||||||
if len(fired) != 0 {
|
|
||||||
t.Fatalf("erwartet keinen alarm unterhalb des schwellwerts, habe %+v", fired)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 / Pruefung 3: anhaltende Überschreitung erzeugt NICHT
|
|
||||||
// bei jeder Messung eine neue Benachrichtigung.
|
|
||||||
func TestEvaluate_DebouncesRepeatedFiring(t *testing.T) {
|
|
||||||
rules, dispatcher, pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := rules.CreateRule(ctx, Rule{
|
|
||||||
MetricName: "nexarch_core_error_rate", Comparison: ComparisonGreaterThan, Threshold: 0.05,
|
|
||||||
Recipient: "ops@acme.example",
|
|
||||||
}); err != nil {
|
|
||||||
t.Fatalf("create rule: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Langes Debounce-Intervall: der zweite Evaluate-Lauf (simuliert die
|
|
||||||
// naechste Messung bei anhaltend ueberschrittenem Wert) darf keinen
|
|
||||||
// weiteren Job einreihen.
|
|
||||||
eval := NewEvaluator(rules, dispatcher, pool, time.Hour)
|
|
||||||
families := []*dto.MetricFamily{
|
|
||||||
gaugeFamily("nexarch_core_error_rate", map[string]string{"tenant": "acme"}, 0.5),
|
|
||||||
}
|
|
||||||
|
|
||||||
first, err := eval.Evaluate(ctx, families)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("erster evaluate-lauf: %v", err)
|
|
||||||
}
|
|
||||||
if len(first) != 1 || first[0].Skipped {
|
|
||||||
t.Fatalf("erster lauf haette feuern muessen, habe %+v", first)
|
|
||||||
}
|
|
||||||
|
|
||||||
second, err := eval.Evaluate(ctx, families)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("zweiter evaluate-lauf: %v", err)
|
|
||||||
}
|
|
||||||
if len(second) != 1 || !second[0].Skipped {
|
|
||||||
t.Fatalf("zweiter lauf haette gedrosselt werden muessen, habe %+v", second)
|
|
||||||
}
|
|
||||||
|
|
||||||
var count int
|
|
||||||
if err := pool.QueryRow(ctx, `SELECT count(*) FROM notification_jobs`).Scan(&count); err != nil {
|
|
||||||
t.Fatalf("notification_jobs zaehlen: %v", err)
|
|
||||||
}
|
|
||||||
if count != 1 {
|
|
||||||
t.Fatalf("erwartet genau 1 eingereihten job trotz zwei ueberschreitenden messungen, habe %d", count)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Verschiedene Zeitreihen derselben Regel (unterschiedlicher Tenant) werden
|
|
||||||
// unabhaengig voneinander gedrosselt.
|
|
||||||
func TestEvaluate_DebouncesIndependentlyPerLabelSet(t *testing.T) {
|
|
||||||
rules, dispatcher, pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := rules.CreateRule(ctx, Rule{
|
|
||||||
MetricName: "nexarch_core_error_rate", Comparison: ComparisonGreaterThan, Threshold: 0.05,
|
|
||||||
Recipient: "ops@acme.example",
|
|
||||||
}); err != nil {
|
|
||||||
t.Fatalf("create rule: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
eval := NewEvaluator(rules, dispatcher, pool, time.Hour)
|
|
||||||
families := []*dto.MetricFamily{
|
|
||||||
{
|
|
||||||
Name: strPtr("nexarch_core_error_rate"),
|
|
||||||
Metric: []*dto.Metric{
|
|
||||||
metricWithLabel("tenant", "acme", 0.5),
|
|
||||||
metricWithLabel("tenant", "beta", 0.6),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
fired, err := eval.Evaluate(ctx, families)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("evaluate: %v", err)
|
|
||||||
}
|
|
||||||
if len(fired) != 2 {
|
|
||||||
t.Fatalf("erwartet 2 unabhaengige alarme (verschiedene tenants), habe %d", len(fired))
|
|
||||||
}
|
|
||||||
for _, a := range fired {
|
|
||||||
if a.Skipped {
|
|
||||||
t.Fatalf("beide tenants sollten beim ersten mal feuern, habe %+v", a)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func metricWithLabel(name, value string, gaugeValue float64) *dto.Metric {
|
|
||||||
n, v := name, value
|
|
||||||
return &dto.Metric{Label: []*dto.LabelPair{{Name: &n, Value: &v}}, Gauge: &dto.Gauge{Value: &gaugeValue}}
|
|
||||||
}
|
|
||||||
|
|
||||||
func strPtr(s string) *string { return &s }
|
|
||||||
@@ -1,132 +0,0 @@
|
|||||||
// Package alerting implementiert Core OPS-05: schwellwertbasierte
|
|
||||||
// Alarmierung auf den aus OPS-03 aggregierten Metriken, Zustellung über den
|
|
||||||
// Core-Benachrichtigungs-Dispatcher (CFG-02). Der Alertmanager-Gedanke von
|
|
||||||
// Prometheus/Grafana, aber auf das Nötigste reduziert (Schwellwert, Ziel,
|
|
||||||
// Drosselung) — keine eigene Ausdruckssprache.
|
|
||||||
package alerting
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Comparison legt fest, ob ein Schwellwert nach oben oder unten überwacht
|
|
||||||
// wird — bewusst nur zwei Operatoren, keine eigene Ausdruckssprache
|
|
||||||
// (Ticket-Produkt-DNA).
|
|
||||||
type Comparison string
|
|
||||||
|
|
||||||
const (
|
|
||||||
ComparisonGreaterThan Comparison = "gt"
|
|
||||||
ComparisonLessThan Comparison = "lt"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Rule ist eine Schwellwert-Regel auf einer beliebigen aggregierten Metrik
|
|
||||||
// (Akzeptanzkriterium 1). LabelFilters schränkt optional auf bestimmte
|
|
||||||
// Label-Werte ein (z. B. tenant/module), leer = alle Zeitreihen der Metrik.
|
|
||||||
type Rule struct {
|
|
||||||
ID string
|
|
||||||
MetricName string
|
|
||||||
Comparison Comparison
|
|
||||||
Threshold float64
|
|
||||||
LabelFilters map[string]string
|
|
||||||
Recipient string
|
|
||||||
Description string
|
|
||||||
}
|
|
||||||
|
|
||||||
// RuleStore verwaltet Alert-Regeln in der zentralen Registry-DB.
|
|
||||||
type RuleStore struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewRuleStore(pool *pgxpool.Pool) *RuleStore {
|
|
||||||
return &RuleStore{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// CreateRule legt eine neue Schwellwert-Regel an (Akzeptanzkriterium 1).
|
|
||||||
func (s *RuleStore) CreateRule(ctx context.Context, r Rule) (Rule, error) {
|
|
||||||
if r.MetricName == "" || r.Recipient == "" {
|
|
||||||
return Rule{}, errors.New("alerting: metricName und recipient duerfen nicht leer sein")
|
|
||||||
}
|
|
||||||
if r.Comparison != ComparisonGreaterThan && r.Comparison != ComparisonLessThan {
|
|
||||||
return Rule{}, fmt.Errorf("alerting: unbekannter comparison-operator %q", r.Comparison)
|
|
||||||
}
|
|
||||||
if r.LabelFilters == nil {
|
|
||||||
r.LabelFilters = map[string]string{}
|
|
||||||
}
|
|
||||||
filtersJSON, err := json.Marshal(r.LabelFilters)
|
|
||||||
if err != nil {
|
|
||||||
return Rule{}, fmt.Errorf("label-filter serialisieren: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = s.pool.QueryRow(ctx, `
|
|
||||||
INSERT INTO alert_rules (metric_name, comparison, threshold, label_filters, recipient, description)
|
|
||||||
VALUES ($1, $2, $3, $4, $5, $6)
|
|
||||||
RETURNING id
|
|
||||||
`, r.MetricName, string(r.Comparison), r.Threshold, filtersJSON, r.Recipient, r.Description).Scan(&r.ID)
|
|
||||||
if err != nil {
|
|
||||||
return Rule{}, fmt.Errorf("regel speichern: %w", err)
|
|
||||||
}
|
|
||||||
return r, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ListRules liefert alle konfigurierten Regeln — Grundlage für Evaluate.
|
|
||||||
func (s *RuleStore) ListRules(ctx context.Context) ([]Rule, error) {
|
|
||||||
rows, err := s.pool.Query(ctx, `
|
|
||||||
SELECT id, metric_name, comparison, threshold, label_filters, recipient, description
|
|
||||||
FROM alert_rules ORDER BY created_at
|
|
||||||
`)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("regeln auflisten: %w", err)
|
|
||||||
}
|
|
||||||
defer rows.Close()
|
|
||||||
|
|
||||||
var out []Rule
|
|
||||||
for rows.Next() {
|
|
||||||
var r Rule
|
|
||||||
var comparison string
|
|
||||||
var filtersJSON []byte
|
|
||||||
if err := rows.Scan(&r.ID, &r.MetricName, &comparison, &r.Threshold, &filtersJSON, &r.Recipient, &r.Description); err != nil {
|
|
||||||
return nil, fmt.Errorf("regel lesen: %w", err)
|
|
||||||
}
|
|
||||||
r.Comparison = Comparison(comparison)
|
|
||||||
if err := json.Unmarshal(filtersJSON, &r.LabelFilters); err != nil {
|
|
||||||
return nil, fmt.Errorf("label-filter lesen: %w", err)
|
|
||||||
}
|
|
||||||
out = append(out, r)
|
|
||||||
}
|
|
||||||
return out, rows.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
// DeleteRule entfernt eine Regel.
|
|
||||||
func (s *RuleStore) DeleteRule(ctx context.Context, id string) error {
|
|
||||||
_, err := s.pool.Exec(ctx, `DELETE FROM alert_rules WHERE id = $1`, id)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("regel loeschen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// debounceStore kapselt die Drosselungs-Zustandstabelle (Akzeptanzkriterium 3).
|
|
||||||
type debounceStore struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
// shouldFire prueft, ob seit dem letzten Alarm fuer ruleKey mindestens
|
|
||||||
// interval vergangen ist — atomar ueber eine bedingte UPDATE/INSERT-
|
|
||||||
// Sequenz, damit zwei gleichzeitige Evaluate-Laeufe (z. B. bei mehreren
|
|
||||||
// Core-Instanzen) nicht beide gleichzeitig alarmieren.
|
|
||||||
func (d *debounceStore) shouldFire(ctx context.Context, ruleKey string, intervalSeconds float64) (bool, error) {
|
|
||||||
tag, err := d.pool.Exec(ctx, `
|
|
||||||
INSERT INTO alert_debounce_state (rule_key, last_fired_at) VALUES ($1, now())
|
|
||||||
ON CONFLICT (rule_key) DO UPDATE SET last_fired_at = now()
|
|
||||||
WHERE alert_debounce_state.last_fired_at <= now() - ($2 * interval '1 second')
|
|
||||||
`, ruleKey, intervalSeconds)
|
|
||||||
if err != nil {
|
|
||||||
return false, fmt.Errorf("drosselungszustand pruefen: %w", err)
|
|
||||||
}
|
|
||||||
return tag.RowsAffected() == 1, nil
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
// Package audit implementiert Core AUD-01: das zentrale, vom allgemeinen
|
||||||
|
// Anwendungs-Log getrennte Audit-Datenmodell fuer sicherheits- und
|
||||||
|
// compliancerelevante Ereignisse (wer, was, wann, an welchem Tenant).
|
||||||
|
// Unveraenderlichkeit (Append-only) ist AUD-02, Export/Filter-API ist AUD-03
|
||||||
|
// — dieses Paket liefert nur das Datenmodell und den EINEN zentralen
|
||||||
|
// Schreibpfad (Akzeptanzkriterium 3).
|
||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SystemTenant ist der reservierte Tenant-Bezug fuer mandantenuebergreifende
|
||||||
|
// Ereignisse (z.B. Superadmin-Aktionen) — es gibt bewusst KEINEN Weg, ein
|
||||||
|
// Ereignis ganz ohne Tenant-Bezug zu schreiben (Akzeptanzkriterium 2).
|
||||||
|
const SystemTenant = "system"
|
||||||
|
|
||||||
|
var ErrMissingTenant = errors.New("audit: tenant_slug darf nicht leer sein")
|
||||||
|
var ErrMissingActor = errors.New("audit: actor darf nicht leer sein")
|
||||||
|
var ErrMissingAction = errors.New("audit: action darf nicht leer sein")
|
||||||
|
|
||||||
|
// Event ist ein strukturiertes Audit-Ereignis (Akzeptanzkriterium 1: Akteur,
|
||||||
|
// Aktion, Zielobjekt, Zeitpunkt, Tenant).
|
||||||
|
type Event struct {
|
||||||
|
TenantSlug string
|
||||||
|
Actor string
|
||||||
|
Action string
|
||||||
|
Target string
|
||||||
|
Metadata map[string]any
|
||||||
|
OccurredAt time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// Log ist der EINE zentrale Schreibpfad fuer Audit-Ereignisse — es gibt
|
||||||
|
// bewusst keine zweite Schreibmoeglichkeit, damit kein Handler versehentlich
|
||||||
|
// direkt in audit_events schreibt und dabei die Validierung umgeht
|
||||||
|
// (Akzeptanzkriterium 3).
|
||||||
|
type Log struct {
|
||||||
|
pool *pgxpool.Pool
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewLog(pool *pgxpool.Pool) *Log {
|
||||||
|
return &Log{pool: pool}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Record persistiert genau einen Audit-Eintrag. Fehlender Tenant-Bezug wird
|
||||||
|
// bereits hier abgewiesen (klarer Fehler statt Constraint-Verletzung im
|
||||||
|
// Normalfall) — die Datenbank-CHECK-Constraint aus der Migration ist die
|
||||||
|
// zweite, unumgehbare Verteidigungslinie (Akzeptanzkriterium 2 / Pruefung 2).
|
||||||
|
func (l *Log) Record(ctx context.Context, e Event) error {
|
||||||
|
if e.TenantSlug == "" {
|
||||||
|
return ErrMissingTenant
|
||||||
|
}
|
||||||
|
if e.Actor == "" {
|
||||||
|
return ErrMissingActor
|
||||||
|
}
|
||||||
|
if e.Action == "" {
|
||||||
|
return ErrMissingAction
|
||||||
|
}
|
||||||
|
if e.Metadata == nil {
|
||||||
|
e.Metadata = map[string]any{}
|
||||||
|
}
|
||||||
|
metadataJSON, err := json.Marshal(e.Metadata)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("metadaten serialisieren: %w", err)
|
||||||
|
}
|
||||||
|
if e.OccurredAt.IsZero() {
|
||||||
|
e.OccurredAt = time.Now()
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = l.pool.Exec(ctx, `
|
||||||
|
INSERT INTO audit_events (occurred_at, tenant_slug, actor, action, target, metadata)
|
||||||
|
VALUES ($1, $2, $3, $4, $5, $6)
|
||||||
|
`, e.OccurredAt, e.TenantSlug, e.Actor, e.Action, e.Target, metadataJSON)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("audit-ereignis schreiben: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CountByTenant ist eine schlanke Lesehilfe fuer Tests/Diagnose — die
|
||||||
|
// eigentliche Filter-/Export-API ist AUD-03, hier bewusst nicht vorgezogen.
|
||||||
|
func (l *Log) CountByTenant(ctx context.Context, tenantSlug string) (int, error) {
|
||||||
|
var n int
|
||||||
|
if err := l.pool.QueryRow(ctx, `
|
||||||
|
SELECT count(*) FROM audit_events WHERE tenant_slug = $1
|
||||||
|
`, tenantSlug).Scan(&n); err != nil {
|
||||||
|
return 0, fmt.Errorf("audit-ereignisse zaehlen: %w", err)
|
||||||
|
}
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
func setupAuditTest(t *testing.T) (*Log, *pgxpool.Pool, 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 audit_events (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
occurred_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
tenant_slug TEXT NOT NULL CHECK (tenant_slug <> ''),
|
||||||
|
actor TEXT NOT NULL CHECK (actor <> ''),
|
||||||
|
action TEXT NOT NULL CHECK (action <> ''),
|
||||||
|
target TEXT NOT NULL,
|
||||||
|
metadata JSONB NOT NULL DEFAULT '{}'::jsonb
|
||||||
|
)`); err != nil {
|
||||||
|
t.Fatalf("schema: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
cleanup := func() {
|
||||||
|
_, _ = pool.Exec(ctx, `DELETE FROM audit_events WHERE tenant_slug LIKE 'test\_%' ESCAPE '\' OR tenant_slug = $1`, SystemTenant)
|
||||||
|
pool.Close()
|
||||||
|
}
|
||||||
|
return NewLog(pool), pool, cleanup
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1 + Pruefung 1: ein sicherheitsrelevanter Vorgang
|
||||||
|
// (hier: fehlgeschlagener Login) erzeugt zuverlaessig genau einen Eintrag.
|
||||||
|
func TestRecord_PersistsExactlyOneEventPerSecurityIncident(t *testing.T) {
|
||||||
|
log, pool, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
err := log.Record(ctx, Event{
|
||||||
|
TenantSlug: "test_acme",
|
||||||
|
Actor: "alice@example.com",
|
||||||
|
Action: "iam.login_failed",
|
||||||
|
Target: "user:alice@example.com",
|
||||||
|
Metadata: map[string]any{"reason": "falsches passwort"},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("record: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
count, err := log.CountByTenant(ctx, "test_acme")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("count: %v", err)
|
||||||
|
}
|
||||||
|
if count != 1 {
|
||||||
|
t.Fatalf("erwartet genau 1 audit-eintrag, habe %d", count)
|
||||||
|
}
|
||||||
|
|
||||||
|
var actor, action, target string
|
||||||
|
if err := pool.QueryRow(ctx, `
|
||||||
|
SELECT actor, action, target FROM audit_events WHERE tenant_slug = 'test_acme'
|
||||||
|
`).Scan(&actor, &action, &target); err != nil {
|
||||||
|
t.Fatalf("eintrag lesen: %v", err)
|
||||||
|
}
|
||||||
|
if actor != "alice@example.com" || action != "iam.login_failed" || target != "user:alice@example.com" {
|
||||||
|
t.Fatalf("eintrag unerwartet: actor=%q action=%q target=%q", actor, action, target)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 2 (App-Ebene): fehlender Tenant-Bezug wird
|
||||||
|
// bereits vom zentralen Schreibpfad abgewiesen.
|
||||||
|
func TestRecord_RejectsMissingTenant(t *testing.T) {
|
||||||
|
log, _, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
err := log.Record(ctx, Event{TenantSlug: "", Actor: "alice", Action: "irgendwas"})
|
||||||
|
if !errors.Is(err, ErrMissingTenant) {
|
||||||
|
t.Fatalf("erwartet ErrMissingTenant, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 2 (DB-Ebene): selbst ein direkter INSERT,
|
||||||
|
// der Log.Record umgeht, wird durch die CHECK-Constraint verhindert — der
|
||||||
|
// Schutz haengt nicht allein von der Go-Validierung ab.
|
||||||
|
func TestConstraint_RejectsMissingTenantAtDatabaseLevel(t *testing.T) {
|
||||||
|
_, pool, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO audit_events (tenant_slug, actor, action, target)
|
||||||
|
VALUES ('', 'alice', 'irgendwas', 'ziel')
|
||||||
|
`)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("erwartet fehler durch CHECK-constraint bei leerem tenant_slug, habe nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRecord_RejectsMissingActorAndAction(t *testing.T) {
|
||||||
|
log, _, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: "test_acme", Actor: "", Action: "x"}); !errors.Is(err, ErrMissingActor) {
|
||||||
|
t.Fatalf("erwartet ErrMissingActor, habe %v", err)
|
||||||
|
}
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: "test_acme", Actor: "alice", Action: ""}); !errors.Is(err, ErrMissingAction) {
|
||||||
|
t.Fatalf("erwartet ErrMissingAction, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRecord_SystemTenantForCrossTenantEvents(t *testing.T) {
|
||||||
|
log, _, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: SystemTenant, Actor: "superadmin", Action: "tenant.provisioned", Target: "tenant:acme"}); err != nil {
|
||||||
|
t.Fatalf("record mit SystemTenant: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,122 @@
|
|||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/csv"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Filter grenzt einen Export ein (Akzeptanzkriterium 1). Leere/Nil-Felder
|
||||||
|
// bedeuten "kein Filter auf diesem Feld".
|
||||||
|
type Filter struct {
|
||||||
|
TenantSlug string
|
||||||
|
Actor string
|
||||||
|
Action string
|
||||||
|
From *time.Time
|
||||||
|
To *time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
func buildFilterQuery(f Filter) (string, []any) {
|
||||||
|
query := `SELECT occurred_at, tenant_slug, actor, action, target, metadata FROM audit_events WHERE 1=1`
|
||||||
|
var args []any
|
||||||
|
|
||||||
|
if f.TenantSlug != "" {
|
||||||
|
args = append(args, f.TenantSlug)
|
||||||
|
query += fmt.Sprintf(" AND tenant_slug = $%d", len(args))
|
||||||
|
}
|
||||||
|
if f.Actor != "" {
|
||||||
|
args = append(args, f.Actor)
|
||||||
|
query += fmt.Sprintf(" AND actor = $%d", len(args))
|
||||||
|
}
|
||||||
|
if f.Action != "" {
|
||||||
|
args = append(args, f.Action)
|
||||||
|
query += fmt.Sprintf(" AND action = $%d", len(args))
|
||||||
|
}
|
||||||
|
if f.From != nil {
|
||||||
|
args = append(args, *f.From)
|
||||||
|
query += fmt.Sprintf(" AND occurred_at >= $%d", len(args))
|
||||||
|
}
|
||||||
|
if f.To != nil {
|
||||||
|
args = append(args, *f.To)
|
||||||
|
query += fmt.Sprintf(" AND occurred_at <= $%d", len(args))
|
||||||
|
}
|
||||||
|
query += " ORDER BY occurred_at"
|
||||||
|
return query, args
|
||||||
|
}
|
||||||
|
|
||||||
|
// StreamCSV schreibt gefilterte Audit-Eintraege direkt als CSV in w, Zeile
|
||||||
|
// fuer Zeile ueber rows.Next() — es wird zu keinem Zeitpunkt das gesamte
|
||||||
|
// Ergebnis im Speicher aufgebaut (Akzeptanzkriterium 3 / Pruefung 1).
|
||||||
|
func (l *Log) StreamCSV(ctx context.Context, filter Filter, w io.Writer) error {
|
||||||
|
query, args := buildFilterQuery(filter)
|
||||||
|
rows, err := l.pool.Query(ctx, query, args...)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("export abfragen: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
cw := csv.NewWriter(w)
|
||||||
|
if err := cw.Write([]string{"occurred_at", "tenant_slug", "actor", "action", "target", "metadata"}); err != nil {
|
||||||
|
return fmt.Errorf("csv-header schreiben: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for rows.Next() {
|
||||||
|
var occurredAt time.Time
|
||||||
|
var tenantSlug, actor, action, target string
|
||||||
|
var metadataJSON []byte
|
||||||
|
if err := rows.Scan(&occurredAt, &tenantSlug, &actor, &action, &target, &metadataJSON); err != nil {
|
||||||
|
return fmt.Errorf("zeile lesen: %w", err)
|
||||||
|
}
|
||||||
|
if err := cw.Write([]string{
|
||||||
|
occurredAt.Format(time.RFC3339), tenantSlug, actor, action, target, string(metadataJSON),
|
||||||
|
}); err != nil {
|
||||||
|
return fmt.Errorf("csv-zeile schreiben: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
cw.Flush()
|
||||||
|
if err := rows.Err(); err != nil {
|
||||||
|
return fmt.Errorf("export lesen: %w", err)
|
||||||
|
}
|
||||||
|
return cw.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
// exportRecord ist die JSON-Repraesentation einer exportierten Zeile.
|
||||||
|
type exportRecord struct {
|
||||||
|
OccurredAt time.Time `json:"occurred_at"`
|
||||||
|
TenantSlug string `json:"tenant_slug"`
|
||||||
|
Actor string `json:"actor"`
|
||||||
|
Action string `json:"action"`
|
||||||
|
Target string `json:"target"`
|
||||||
|
Metadata json.RawMessage `json:"metadata"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StreamJSON schreibt gefilterte Audit-Eintraege als JSON Lines (ein
|
||||||
|
// JSON-Objekt pro Zeile) — bewusst kein einzelnes grosses JSON-Array, da
|
||||||
|
// dessen korrektes Streaming (Kommas/Klammern ohne Zwischenpufferung)
|
||||||
|
// unnoetige Komplexitaet fuer denselben Zweck waere. Wie StreamCSV
|
||||||
|
// zeilenweise ueber rows.Next(), kein Aufbau im Speicher.
|
||||||
|
func (l *Log) StreamJSON(ctx context.Context, filter Filter, w io.Writer) error {
|
||||||
|
query, args := buildFilterQuery(filter)
|
||||||
|
rows, err := l.pool.Query(ctx, query, args...)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("export abfragen: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
enc := json.NewEncoder(w)
|
||||||
|
for rows.Next() {
|
||||||
|
var rec exportRecord
|
||||||
|
var metadataJSON []byte
|
||||||
|
if err := rows.Scan(&rec.OccurredAt, &rec.TenantSlug, &rec.Actor, &rec.Action, &rec.Target, &metadataJSON); err != nil {
|
||||||
|
return fmt.Errorf("zeile lesen: %w", err)
|
||||||
|
}
|
||||||
|
rec.Metadata = metadataJSON
|
||||||
|
if err := enc.Encode(rec); err != nil {
|
||||||
|
return fmt.Errorf("json-zeile schreiben: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return rows.Err()
|
||||||
|
}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Authorize entscheidet, ob caller den Export ausfuehren darf. Die
|
||||||
|
// eigentliche Rollen-/Rechtepruefung (RBAC-02 Policy-Enforcement) ist nicht
|
||||||
|
// Teil dieser Kachel — ExportHandler kennt nur diese schmale Schnittstelle,
|
||||||
|
// analog zum RetentionRegistrar-Muster aus AUD-05.
|
||||||
|
type Authorize func(ctx context.Context, caller string) bool
|
||||||
|
|
||||||
|
// ExportHandler stellt den Export als HTTP-Endpunkt bereit
|
||||||
|
// (Akzeptanzkriterium 2: fuer berechtigte Rollen verfuegbar).
|
||||||
|
type ExportHandler struct {
|
||||||
|
log *Log
|
||||||
|
authorize Authorize
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewExportHandler(log *Log, authorize Authorize) *ExportHandler {
|
||||||
|
return &ExportHandler{log: log, authorize: authorize}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Export liest Filter-Query-Parameter (tenant, actor, action, from, to,
|
||||||
|
// format) und schreibt DIREKT auf den ResponseWriter (io.Writer) — dieselbe
|
||||||
|
// Streaming-Funktion wie in export.go, kein zusaetzlicher Pufferungsschritt.
|
||||||
|
func (h *ExportHandler) Export(w http.ResponseWriter, r *http.Request) {
|
||||||
|
// "caller" identifiziert die anfragende Person fuer die Berechtigungs-
|
||||||
|
// pruefung — bewusst getrennt vom Filterfeld "actor" (das den
|
||||||
|
// AUDIT-Akteur meint, ueber den gefiltert wird).
|
||||||
|
caller := r.URL.Query().Get("caller")
|
||||||
|
if caller == "" || !h.authorize(r.Context(), caller) {
|
||||||
|
http.Error(w, "keine berechtigung fuer audit-log-export", http.StatusForbidden)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
filter := Filter{
|
||||||
|
TenantSlug: r.URL.Query().Get("tenant"),
|
||||||
|
Actor: r.URL.Query().Get("actor"),
|
||||||
|
Action: r.URL.Query().Get("action"),
|
||||||
|
}
|
||||||
|
if from := r.URL.Query().Get("from"); from != "" {
|
||||||
|
t, err := time.Parse(time.RFC3339, from)
|
||||||
|
if err != nil {
|
||||||
|
http.Error(w, "ungueltiges from-datum, erwartet RFC3339", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
filter.From = &t
|
||||||
|
}
|
||||||
|
if to := r.URL.Query().Get("to"); to != "" {
|
||||||
|
t, err := time.Parse(time.RFC3339, to)
|
||||||
|
if err != nil {
|
||||||
|
http.Error(w, "ungueltiges to-datum, erwartet RFC3339", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
filter.To = &t
|
||||||
|
}
|
||||||
|
|
||||||
|
switch r.URL.Query().Get("format") {
|
||||||
|
case "json":
|
||||||
|
w.Header().Set("Content-Type", "application/x-ndjson")
|
||||||
|
if err := h.log.StreamJSON(r.Context(), filter, w); err != nil {
|
||||||
|
http.Error(w, "export fehlgeschlagen", http.StatusInternalServerError)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
w.Header().Set("Content-Type", "text/csv")
|
||||||
|
if err := h.log.StreamCSV(r.Context(), filter, w); err != nil {
|
||||||
|
http.Error(w, "export fehlgeschlagen", http.StatusInternalServerError)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,222 @@
|
|||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/csv"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
func setupExportTest(t *testing.T) (*Log, 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 audit_events (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
occurred_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
tenant_slug TEXT NOT NULL CHECK (tenant_slug <> ''),
|
||||||
|
actor TEXT NOT NULL CHECK (actor <> ''),
|
||||||
|
action TEXT NOT NULL CHECK (action <> ''),
|
||||||
|
target TEXT NOT NULL,
|
||||||
|
metadata JSONB NOT NULL DEFAULT '{}'::jsonb
|
||||||
|
)`); err != nil {
|
||||||
|
t.Fatalf("schema: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
cleanup := func() { pool.Close() }
|
||||||
|
return NewLog(pool), cleanup
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1 + Pruefung 2: Filterkombinationen liefern korrekte
|
||||||
|
// Teilmengen.
|
||||||
|
func TestExport_FilterCombinations(t *testing.T) {
|
||||||
|
log, cleanup := setupExportTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
run := fmt.Sprintf("_%d", time.Now().UnixNano())
|
||||||
|
tenantA, tenantB := "test_fa"+run, "test_fb"+run
|
||||||
|
alice, bob := "alice"+run, "bob"+run
|
||||||
|
|
||||||
|
events := []Event{
|
||||||
|
{TenantSlug: tenantA, Actor: alice, Action: "login", Target: "x"},
|
||||||
|
{TenantSlug: tenantA, Actor: bob, Action: "login", Target: "x"},
|
||||||
|
{TenantSlug: tenantA, Actor: alice, Action: "logout", Target: "x"},
|
||||||
|
{TenantSlug: tenantB, Actor: alice, Action: "login", Target: "x"},
|
||||||
|
}
|
||||||
|
for _, e := range events {
|
||||||
|
if err := log.Record(ctx, e); err != nil {
|
||||||
|
t.Fatalf("record: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
filter Filter
|
||||||
|
wantLen int
|
||||||
|
}{
|
||||||
|
{"nach tenant", Filter{TenantSlug: tenantA}, 3},
|
||||||
|
{"nach tenant+actor", Filter{TenantSlug: tenantA, Actor: alice}, 2},
|
||||||
|
{"nach tenant+actor+action", Filter{TenantSlug: tenantA, Actor: alice, Action: "login"}, 1},
|
||||||
|
{"nach actor ueber beide tenants", Filter{Actor: alice, Action: "login"}, 2},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, c := range cases {
|
||||||
|
t.Run(c.name, func(t *testing.T) {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
if err := log.StreamCSV(ctx, c.filter, &buf); err != nil {
|
||||||
|
t.Fatalf("stream: %v", err)
|
||||||
|
}
|
||||||
|
rows, err := csv.NewReader(&buf).ReadAll()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("csv parsen: %v", err)
|
||||||
|
}
|
||||||
|
got := len(rows) - 1 // Header abziehen
|
||||||
|
if got != c.wantLen {
|
||||||
|
t.Fatalf("erwartet %d zeilen, habe %d", c.wantLen, got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1 + Pruefung 2: Zeitraum-Filter.
|
||||||
|
func TestExport_TimeRangeFilter(t *testing.T) {
|
||||||
|
log, cleanup := setupExportTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
tenant := fmt.Sprintf("test_tr_%d", time.Now().UnixNano())
|
||||||
|
past := time.Now().Add(-48 * time.Hour)
|
||||||
|
future := time.Now().Add(48 * time.Hour)
|
||||||
|
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: tenant, Actor: "a", Action: "x", Target: "t", OccurredAt: time.Now()}); err != nil {
|
||||||
|
t.Fatalf("record: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
if err := log.StreamCSV(ctx, Filter{TenantSlug: tenant, From: &past, To: &future}, &buf); err != nil {
|
||||||
|
t.Fatalf("stream (innerhalb range): %v", err)
|
||||||
|
}
|
||||||
|
if got := countLines(buf.String()) - 1; got != 1 {
|
||||||
|
t.Fatalf("erwartet 1 eintrag innerhalb des zeitraums, habe %d", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
farPast := time.Now().Add(-96 * time.Hour)
|
||||||
|
buf.Reset()
|
||||||
|
if err := log.StreamCSV(ctx, Filter{TenantSlug: tenant, From: &farPast, To: &past}, &buf); err != nil {
|
||||||
|
t.Fatalf("stream (ausserhalb range): %v", err)
|
||||||
|
}
|
||||||
|
if got := countLines(buf.String()) - 1; got != 0 {
|
||||||
|
t.Fatalf("erwartet 0 eintraege ausserhalb des zeitraums, habe %d", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func countLines(s string) int {
|
||||||
|
s = strings.TrimRight(s, "\n")
|
||||||
|
if s == "" {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
return len(strings.Split(s, "\n"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 3 + Pruefung 1: Export mit hoher Eintragszahl ohne
|
||||||
|
// uebermaessigen Speicherverbrauch — Stichprobe per runtime.MemStats.
|
||||||
|
func TestExport_StreamsLargeResultWithoutExcessiveMemory(t *testing.T) {
|
||||||
|
log, cleanup := setupExportTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
tenant := fmt.Sprintf("test_large_%d", time.Now().UnixNano())
|
||||||
|
const n = 20000
|
||||||
|
for i := 0; i < n; i++ {
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: tenant, Actor: "bulk", Action: "test.bulk", Target: fmt.Sprintf("obj-%d", i)}); err != nil {
|
||||||
|
t.Fatalf("record %d: %v", i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
runtime.GC()
|
||||||
|
var before runtime.MemStats
|
||||||
|
runtime.ReadMemStats(&before)
|
||||||
|
|
||||||
|
lineCount := 0
|
||||||
|
cw := &countingWriter{onWrite: func(p []byte) { lineCount += strings.Count(string(p), "\n") }}
|
||||||
|
if err := log.StreamCSV(ctx, Filter{TenantSlug: tenant}, cw); err != nil {
|
||||||
|
t.Fatalf("stream: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
runtime.GC()
|
||||||
|
var after runtime.MemStats
|
||||||
|
runtime.ReadMemStats(&after)
|
||||||
|
|
||||||
|
if lineCount != n+1 { // +1 Header
|
||||||
|
t.Fatalf("erwartet %d zeilen (inkl. header), habe %d", n+1, lineCount)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Grobe Stichprobe: ein NICHT streamender Export haette hier locker
|
||||||
|
// mehrere MB an einmal gehaltenen Zeilen/Strings erzeugt. Grosszuegige
|
||||||
|
// Schwelle, da Go-Heap-Messungen naturgemaess rauschen.
|
||||||
|
const maxAcceptableGrowth = 3 * 1024 * 1024 // 3 MB
|
||||||
|
growth := int64(after.HeapAlloc) - int64(before.HeapAlloc)
|
||||||
|
t.Logf("heap-wachstum waehrend export von %d zeilen: %d bytes (schwelle: %d)", n, growth, maxAcceptableGrowth)
|
||||||
|
if growth > maxAcceptableGrowth {
|
||||||
|
t.Fatalf("heap ist um %d bytes gewachsen, erwartet unter %d (hinweis auf vollstaendige pufferung statt streaming)", growth, maxAcceptableGrowth)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type countingWriter struct {
|
||||||
|
onWrite func(p []byte)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *countingWriter) Write(p []byte) (int, error) {
|
||||||
|
w.onWrite(p)
|
||||||
|
return len(p), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 3: Zugriff ohne passende Berechtigung wird abgewiesen.
|
||||||
|
func TestExportHandler_RejectsWithoutAuthorization(t *testing.T) {
|
||||||
|
log, cleanup := setupExportTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
|
||||||
|
handler := NewExportHandler(log, func(ctx context.Context, caller string) bool {
|
||||||
|
return caller == "berechtigte-person@example.com"
|
||||||
|
})
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/audit/export?caller=unberechtigt@example.com", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
handler.Export(rec, req)
|
||||||
|
if rec.Code != http.StatusForbidden {
|
||||||
|
t.Fatalf("unberechtigt: status = %d, want 403", rec.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
reqNoCaller := httptest.NewRequest(http.MethodGet, "/audit/export", nil)
|
||||||
|
recNoCaller := httptest.NewRecorder()
|
||||||
|
handler.Export(recNoCaller, reqNoCaller)
|
||||||
|
if recNoCaller.Code != http.StatusForbidden {
|
||||||
|
t.Fatalf("ohne caller: status = %d, want 403", recNoCaller.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
reqOK := httptest.NewRequest(http.MethodGet, "/audit/export?caller=berechtigte-person@example.com", nil)
|
||||||
|
recOK := httptest.NewRecorder()
|
||||||
|
handler.Export(recOK, reqOK)
|
||||||
|
if recOK.Code != http.StatusOK {
|
||||||
|
t.Fatalf("berechtigt: status = %d, want 200", recOK.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
// Package auditadmin implementiert Core AUD-04: die Berechtigungspruefung
|
||||||
|
// fuer die Audit-Log-Ansicht. Enthaelt bewusst KEINE eigene Filter-/
|
||||||
|
// Export-Logik — die Ansicht ist "reiner Konsument der Export-API" (AUD-03,
|
||||||
|
// internal/audit.ExportHandler); dieses Paket liefert nur die
|
||||||
|
// audit.Authorize-Implementierung, die der Entwicklungs-/Testserver
|
||||||
|
// (cmd/auditlog-devserver) einhaengt.
|
||||||
|
package auditadmin
|
||||||
|
|
||||||
|
import "crypto/subtle"
|
||||||
|
|
||||||
|
// NewTokenAuthorizer liefert eine audit.Authorize-Funktion, die den
|
||||||
|
// aufrufenden "caller"-Wert timing-safe gegen ein geteiltes Admin-Token
|
||||||
|
// vergleicht — dasselbe Muster wie internal/audit.timingsafe (AUD-02),
|
||||||
|
// NICHT ueber eine neue Rollen-/Rechteschicht, da AUD-04 ausdruecklich nur
|
||||||
|
// von AUD-03 abhaengt.
|
||||||
|
func NewTokenAuthorizer(adminToken string) func(caller string) bool {
|
||||||
|
return func(caller string) bool {
|
||||||
|
if caller == "" || adminToken == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return subtle.ConstantTimeCompare([]byte(caller), []byte(adminToken)) == 1
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
package auditadmin
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
// Grundlage fuer Akzeptanzkriterium 1/2: die Oberflaeche darf Daten und den
|
||||||
|
// Export nur bei korrektem Admin-Token abrufen.
|
||||||
|
func TestNewTokenAuthorizer_AcceptsCorrectToken(t *testing.T) {
|
||||||
|
authorize := NewTokenAuthorizer("geheimes-token")
|
||||||
|
if !authorize("geheimes-token") {
|
||||||
|
t.Fatal("erwartet true fuer korrektes token")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTokenAuthorizer_RejectsWrongToken(t *testing.T) {
|
||||||
|
authorize := NewTokenAuthorizer("geheimes-token")
|
||||||
|
if authorize("falsches-token") {
|
||||||
|
t.Fatal("erwartet false fuer falsches token")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTokenAuthorizer_RejectsEmptyCaller(t *testing.T) {
|
||||||
|
authorize := NewTokenAuthorizer("geheimes-token")
|
||||||
|
if authorize("") {
|
||||||
|
t.Fatal("erwartet false fuer leeren aufrufer")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTokenAuthorizer_RejectsWhenNoTokenConfigured(t *testing.T) {
|
||||||
|
authorize := NewTokenAuthorizer("")
|
||||||
|
if authorize("irgendwas") {
|
||||||
|
t.Fatal("erwartet false, wenn kein admin-token konfiguriert ist (fail-safe-default)")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
package cfgservice
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DefaultCacheTTL ist die dokumentierte Cache-Invalidierungszeit
|
|
||||||
// (Akzeptanzkriterium 2 / Pruefung 2 in diesem Ticket bezieht sich auf die
|
|
||||||
// Aenderungsnachvollziehbarkeit — die Cache-Frist selbst folgt demselben
|
|
||||||
// Muster wie internal/flag.DefaultCacheTTL).
|
|
||||||
const DefaultCacheTTL = 5 * time.Second
|
|
||||||
|
|
||||||
type cacheEntry struct {
|
|
||||||
value Value
|
|
||||||
expiresAt time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// Service ist die Leseseite mit Vorrangregel (Akzeptanzkriterium 1:
|
|
||||||
// Tenant-Override vor Global-Default) und lokalem TTL-Cache.
|
|
||||||
type Service struct {
|
|
||||||
store *Store
|
|
||||||
ttl time.Duration
|
|
||||||
|
|
||||||
mu sync.RWMutex
|
|
||||||
cache map[string]cacheEntry // Schluessel: key + "\x00" + tenantSlug
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(store *Store, ttl time.Duration) *Service {
|
|
||||||
if ttl <= 0 {
|
|
||||||
ttl = DefaultCacheTTL
|
|
||||||
}
|
|
||||||
return &Service{store: store, ttl: ttl, cache: make(map[string]cacheEntry)}
|
|
||||||
}
|
|
||||||
|
|
||||||
func cacheKey(key, tenantSlug string) string {
|
|
||||||
return key + "\x00" + tenantSlug
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resolve liefert den Konfigurationswert fuer einen Tenant: ein
|
|
||||||
// Tenant-spezifischer Override hat Vorrang vor dem globalen Default
|
|
||||||
// (Akzeptanzkriterium 1 / Pruefung 1). tenantSlug == "" wertet nur den
|
|
||||||
// globalen Wert aus.
|
|
||||||
func (s *Service) Resolve(ctx context.Context, tenantSlug, key string) (Value, error) {
|
|
||||||
ck := cacheKey(key, tenantSlug)
|
|
||||||
|
|
||||||
s.mu.RLock()
|
|
||||||
entry, exists := s.cache[ck]
|
|
||||||
fresh := exists && time.Now().Before(entry.expiresAt)
|
|
||||||
s.mu.RUnlock()
|
|
||||||
if fresh {
|
|
||||||
return entry.value, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
v, err := s.resolveUncached(ctx, tenantSlug, key)
|
|
||||||
if err != nil {
|
|
||||||
return Value{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
s.mu.Lock()
|
|
||||||
s.cache[ck] = cacheEntry{value: v, expiresAt: time.Now().Add(s.ttl)}
|
|
||||||
s.mu.Unlock()
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Service) resolveUncached(ctx context.Context, tenantSlug, key string) (Value, error) {
|
|
||||||
if tenantSlug != "" {
|
|
||||||
v, err := s.store.Get(ctx, key, tenantSlug)
|
|
||||||
if err == nil {
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
if !errors.Is(err, ErrNotFound) {
|
|
||||||
return Value{}, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return s.store.Get(ctx, key, GlobalScope)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Invalidate erzwingt beim naechsten Resolve-Aufruf ein sofortiges Neuladen
|
|
||||||
// fuer einen bestimmten (key, tenantSlug) statt auf den TTL-Ablauf zu warten
|
|
||||||
// — analog internal/flag.Service.Invalidate.
|
|
||||||
func (s *Service) Invalidate(key, tenantSlug string) {
|
|
||||||
s.mu.Lock()
|
|
||||||
delete(s.cache, cacheKey(key, tenantSlug))
|
|
||||||
s.mu.Unlock()
|
|
||||||
}
|
|
||||||
@@ -1,114 +0,0 @@
|
|||||||
package cfgservice
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 1: Tenant-Override hat Vorrang vor
|
|
||||||
// Global-Default, automatisiert getestet.
|
|
||||||
func TestService_TenantOverrideTakesPrecedenceOverGlobal(t *testing.T) {
|
|
||||||
store, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := store.Set(ctx, "test_precedence_key", GlobalScope, "global-wert"); err != nil {
|
|
||||||
t.Fatalf("set global: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := store.Set(ctx, "test_precedence_key", "test_acme", "tenant-wert"); err != nil {
|
|
||||||
t.Fatalf("set tenant: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
svc := NewService(store, time.Hour)
|
|
||||||
|
|
||||||
got, err := svc.Resolve(ctx, "test_acme", "test_precedence_key")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("resolve mit override: %v", err)
|
|
||||||
}
|
|
||||||
if got.Value != "tenant-wert" {
|
|
||||||
t.Fatalf("erwartet tenant-override, habe %q", got.Value)
|
|
||||||
}
|
|
||||||
|
|
||||||
gotOther, err := svc.Resolve(ctx, "test_anderer_tenant", "test_precedence_key")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("resolve ohne override: %v", err)
|
|
||||||
}
|
|
||||||
if gotOther.Value != "global-wert" {
|
|
||||||
t.Fatalf("erwartet global-default fuer tenant ohne override, habe %q", gotOther.Value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 2: Cache-Invalidierung nach
|
|
||||||
// Konfigurationsaenderung innerhalb dokumentierter Zeit gemessen.
|
|
||||||
func TestService_CacheInvalidationTiming(t *testing.T) {
|
|
||||||
store, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
const ttl = 150 * time.Millisecond
|
|
||||||
if _, err := store.Set(ctx, "test_ttl_key", GlobalScope, "alt"); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, ttl)
|
|
||||||
|
|
||||||
v, err := svc.Resolve(ctx, "", "test_ttl_key")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("resolve: %v", err)
|
|
||||||
}
|
|
||||||
if v.Value != "alt" {
|
|
||||||
t.Fatalf("erwartet 'alt', habe %q", v.Value)
|
|
||||||
}
|
|
||||||
|
|
||||||
changedAt := time.Now()
|
|
||||||
if _, err := store.Set(ctx, "test_ttl_key", GlobalScope, "neu"); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
v, err = svc.Resolve(ctx, "", "test_ttl_key")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("resolve direkt nach aenderung: %v", err)
|
|
||||||
}
|
|
||||||
if v.Value != "alt" {
|
|
||||||
t.Fatalf("cache haette den alten wert liefern sollen, habe %q", v.Value)
|
|
||||||
}
|
|
||||||
|
|
||||||
deadline := changedAt.Add(ttl + 100*time.Millisecond)
|
|
||||||
for time.Now().Before(deadline) {
|
|
||||||
v, err := svc.Resolve(ctx, "", "test_ttl_key")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("resolve: %v", err)
|
|
||||||
}
|
|
||||||
if v.Value == "neu" {
|
|
||||||
t.Logf("aenderung wurde nach %s wirksam (ziel: innerhalb %s + toleranz)", time.Since(changedAt), ttl)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
time.Sleep(10 * time.Millisecond)
|
|
||||||
}
|
|
||||||
t.Fatalf("aenderung wurde nicht innerhalb von %s wirksam", deadline.Sub(changedAt))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestService_InvalidateForcesImmediateRefresh(t *testing.T) {
|
|
||||||
store, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := store.Set(ctx, "test_invalidate_key", GlobalScope, "alt"); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, time.Hour)
|
|
||||||
_, _ = svc.Resolve(ctx, "", "test_invalidate_key")
|
|
||||||
|
|
||||||
if _, err := store.Set(ctx, "test_invalidate_key", GlobalScope, "neu"); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc.Invalidate("test_invalidate_key", "")
|
|
||||||
|
|
||||||
v, err := svc.Resolve(ctx, "", "test_invalidate_key")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("resolve: %v", err)
|
|
||||||
}
|
|
||||||
if v.Value != "neu" {
|
|
||||||
t.Fatalf("erwartet sofort sichtbaren neuen wert nach Invalidate, habe %q", v.Value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,129 +0,0 @@
|
|||||||
// Package cfgservice implementiert Core CFG-01: den zentralen Dienst fuer
|
|
||||||
// globale und tenant-spezifische Konfigurationswerte mit Versionierung und
|
|
||||||
// Cache-Invalidierung. Andere Module lesen Konfiguration AUSSCHLIESSLICH
|
|
||||||
// ueber dieses Paket (Akzeptanzkriterium 3), niemals ueber eigene Tabellen.
|
|
||||||
package cfgservice
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// GlobalScope ist der reservierte Scope-Wert fuer globale Defaults — jeder
|
|
||||||
// andere Scope-Wert ist ein Tenant-Slug (Akzeptanzkriterium 1).
|
|
||||||
const GlobalScope = "global"
|
|
||||||
|
|
||||||
var ErrNotFound = errors.New("cfgservice: kein wert fuer diesen key gefunden")
|
|
||||||
|
|
||||||
type Value struct {
|
|
||||||
Key string
|
|
||||||
Scope string
|
|
||||||
Value string
|
|
||||||
Version int
|
|
||||||
}
|
|
||||||
|
|
||||||
type HistoryEntry struct {
|
|
||||||
Key string
|
|
||||||
Scope string
|
|
||||||
Value string
|
|
||||||
Version int
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store ist die Schreib-/Verwaltungsseite. Set schreibt IMMER sowohl den
|
|
||||||
// aktuellen Stand (config_values) als auch einen Historieneintrag
|
|
||||||
// (config_value_history) in derselben Transaktion — eine Aenderung ohne
|
|
||||||
// Versionshistorie ist strukturell ausgeschlossen (Akzeptanzkriterium 2).
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool) *Store {
|
|
||||||
return &Store{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set schreibt einen neuen Wert fuer (key, scope) und erhoeht die Version um 1
|
|
||||||
// (Version 1 bei erstmaligem Setzen).
|
|
||||||
func (s *Store) Set(ctx context.Context, key, scope, value string) (Value, error) {
|
|
||||||
if scope == "" {
|
|
||||||
return Value{}, errors.New("cfgservice: scope darf nicht leer sein")
|
|
||||||
}
|
|
||||||
|
|
||||||
tx, err := s.pool.Begin(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return Value{}, fmt.Errorf("transaktion starten: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = tx.Rollback(ctx) }()
|
|
||||||
|
|
||||||
var currentVersion int
|
|
||||||
err = tx.QueryRow(ctx, `SELECT version FROM config_values WHERE key = $1 AND scope = $2`, key, scope).Scan(¤tVersion)
|
|
||||||
if err != nil && !errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return Value{}, fmt.Errorf("aktuelle version lesen: %w", err)
|
|
||||||
}
|
|
||||||
newVersion := currentVersion + 1
|
|
||||||
|
|
||||||
if _, err := tx.Exec(ctx, `
|
|
||||||
INSERT INTO config_values (key, scope, value, version, updated_at)
|
|
||||||
VALUES ($1, $2, $3, $4, now())
|
|
||||||
ON CONFLICT (key, scope) DO UPDATE SET value = $3, version = $4, updated_at = now()
|
|
||||||
`, key, scope, value, newVersion); err != nil {
|
|
||||||
return Value{}, fmt.Errorf("wert speichern: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := tx.Exec(ctx, `
|
|
||||||
INSERT INTO config_value_history (key, scope, value, version, changed_at)
|
|
||||||
VALUES ($1, $2, $3, $4, now())
|
|
||||||
`, key, scope, value, newVersion); err != nil {
|
|
||||||
return Value{}, fmt.Errorf("historie schreiben: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := tx.Commit(ctx); err != nil {
|
|
||||||
return Value{}, fmt.Errorf("transaktion committen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return Value{Key: key, Scope: scope, Value: value, Version: newVersion}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get liefert den Wert fuer GENAU EINEN Scope (kein Vorrang-Fallback) — die
|
|
||||||
// Vorrangregel (Tenant vor Global) lebt bewusst in Service.Resolve, damit
|
|
||||||
// Store rein CRUD bleibt.
|
|
||||||
func (s *Store) Get(ctx context.Context, key, scope string) (Value, error) {
|
|
||||||
var v Value
|
|
||||||
v.Key, v.Scope = key, scope
|
|
||||||
err := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT value, version FROM config_values WHERE key = $1 AND scope = $2
|
|
||||||
`, key, scope).Scan(&v.Value, &v.Version)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return Value{}, ErrNotFound
|
|
||||||
}
|
|
||||||
return Value{}, fmt.Errorf("wert lesen: %w", err)
|
|
||||||
}
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// History liefert die vollstaendige Versionshistorie eines (key, scope) in
|
|
||||||
// aufsteigender Reihenfolge (Akzeptanzkriterium 2 / Pruefung 3).
|
|
||||||
func (s *Store) History(ctx context.Context, key, scope string) ([]HistoryEntry, error) {
|
|
||||||
rows, err := s.pool.Query(ctx, `
|
|
||||||
SELECT key, scope, value, version FROM config_value_history
|
|
||||||
WHERE key = $1 AND scope = $2 ORDER BY version
|
|
||||||
`, key, scope)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("historie abfragen: %w", err)
|
|
||||||
}
|
|
||||||
defer rows.Close()
|
|
||||||
|
|
||||||
var out []HistoryEntry
|
|
||||||
for rows.Next() {
|
|
||||||
var h HistoryEntry
|
|
||||||
if err := rows.Scan(&h.Key, &h.Scope, &h.Value, &h.Version); err != nil {
|
|
||||||
return nil, fmt.Errorf("historieneintrag lesen: %w", err)
|
|
||||||
}
|
|
||||||
out = append(out, h)
|
|
||||||
}
|
|
||||||
return out, rows.Err()
|
|
||||||
}
|
|
||||||
@@ -1,119 +0,0 @@
|
|||||||
package cfgservice
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupStoreTest(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 config_values (
|
|
||||||
key TEXT NOT NULL,
|
|
||||||
scope TEXT NOT NULL CHECK (scope <> ''),
|
|
||||||
value TEXT NOT NULL,
|
|
||||||
version INT NOT NULL,
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (key, scope)
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS config_value_history (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
key TEXT NOT NULL,
|
|
||||||
scope TEXT NOT NULL,
|
|
||||||
value TEXT NOT NULL,
|
|
||||||
version INT NOT NULL,
|
|
||||||
changed_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() {
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM config_value_history WHERE key LIKE 'test\_%' ESCAPE '\'`)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM config_values WHERE key LIKE 'test\_%' ESCAPE '\'`)
|
|
||||||
pool.Close()
|
|
||||||
}
|
|
||||||
return NewStore(pool), cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStore_SetIncrementsVersion(t *testing.T) {
|
|
||||||
store, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
v1, err := store.Set(ctx, "test_key", GlobalScope, "erster-wert")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("set 1: %v", err)
|
|
||||||
}
|
|
||||||
if v1.Version != 1 {
|
|
||||||
t.Fatalf("erwartet version 1, habe %d", v1.Version)
|
|
||||||
}
|
|
||||||
|
|
||||||
v2, err := store.Set(ctx, "test_key", GlobalScope, "zweiter-wert")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("set 2: %v", err)
|
|
||||||
}
|
|
||||||
if v2.Version != 2 {
|
|
||||||
t.Fatalf("erwartet version 2, habe %d", v2.Version)
|
|
||||||
}
|
|
||||||
|
|
||||||
got, err := store.Get(ctx, "test_key", GlobalScope)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get: %v", err)
|
|
||||||
}
|
|
||||||
if got.Value != "zweiter-wert" || got.Version != 2 {
|
|
||||||
t.Fatalf("aktueller wert unerwartet: %+v", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 3: Versionierungshistorie ueber mehrere
|
|
||||||
// Aenderungen hinweg nachvollzogen.
|
|
||||||
func TestStore_HistoryTracksAllChanges(t *testing.T) {
|
|
||||||
store, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
values := []string{"v1", "v2", "v3"}
|
|
||||||
for _, v := range values {
|
|
||||||
if _, err := store.Set(ctx, "test_history_key", GlobalScope, v); err != nil {
|
|
||||||
t.Fatalf("set %q: %v", v, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
history, err := store.History(ctx, "test_history_key", GlobalScope)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("history: %v", err)
|
|
||||||
}
|
|
||||||
if len(history) != 3 {
|
|
||||||
t.Fatalf("erwartet 3 historieneintraege, habe %d", len(history))
|
|
||||||
}
|
|
||||||
for i, h := range history {
|
|
||||||
if h.Version != i+1 || h.Value != values[i] {
|
|
||||||
t.Fatalf("historieneintrag[%d] unerwartet: %+v", i, h)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStore_GetUnknownKeyReturnsNotFound(t *testing.T) {
|
|
||||||
store, cleanup := setupStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := store.Get(ctx, "test_nie_gesetzt", GlobalScope); !errors.Is(err, ErrNotFound) {
|
|
||||||
t.Fatalf("erwartet ErrNotFound, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
// Package flag implementiert Core LIC-02: einen Feature-Flag-Dienst mit
|
|
||||||
// Strategien (global an/aus, Prozentsatz, Tenant-Zielgruppe) als Kernfunktion
|
|
||||||
// des Core-Dienstes selbst — keine zusaetzliche Infrastruktur (Unleash-Server
|
|
||||||
// + eigene DB), siehe "bewusst vermeiden" im LIC-02-Ticket.
|
|
||||||
package flag
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"hash/fnv"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
var ErrNotFound = errors.New("flag: nicht gefunden")
|
|
||||||
|
|
||||||
// Flag ist die zentrale Definition — Auswertung (Evaluate) ist bewusst davon
|
|
||||||
// getrennt (Unleash-Prinzip: Flag-Verwaltung vs. Flag-Auswertung).
|
|
||||||
type Flag struct {
|
|
||||||
Key string
|
|
||||||
Enabled bool
|
|
||||||
RolloutPercentage int
|
|
||||||
TargetTenantSlugs []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store ist die Verwaltungsseite (Admin): Flags definieren/lesen.
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool) *Store {
|
|
||||||
return &Store{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Store) Set(ctx context.Context, f Flag) error {
|
|
||||||
if f.TargetTenantSlugs == nil {
|
|
||||||
f.TargetTenantSlugs = []string{} // pgx uebertraegt ein nil-Slice sonst als SQL NULL statt leerem Array.
|
|
||||||
}
|
|
||||||
_, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO feature_flags (key, enabled, rollout_percentage, target_tenant_slugs, updated_at)
|
|
||||||
VALUES ($1, $2, $3, $4, now())
|
|
||||||
ON CONFLICT (key) DO UPDATE SET
|
|
||||||
enabled = $2, rollout_percentage = $3, target_tenant_slugs = $4, updated_at = now()
|
|
||||||
`, f.Key, f.Enabled, f.RolloutPercentage, f.TargetTenantSlugs)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("flag speichern: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Store) Get(ctx context.Context, key string) (Flag, error) {
|
|
||||||
var f Flag
|
|
||||||
row := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT key, enabled, rollout_percentage, target_tenant_slugs
|
|
||||||
FROM feature_flags WHERE key = $1
|
|
||||||
`, key)
|
|
||||||
if err := row.Scan(&f.Key, &f.Enabled, &f.RolloutPercentage, &f.TargetTenantSlugs); err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return Flag{}, ErrNotFound
|
|
||||||
}
|
|
||||||
return Flag{}, fmt.Errorf("flag lesen: %w", err)
|
|
||||||
}
|
|
||||||
return f, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// evaluate wendet die Strategien in fester Reihenfolge an: globaler
|
|
||||||
// An/Aus-Schalter zuerst, dann Tenant-Zielgruppe, dann Prozentsatz-Rollout.
|
|
||||||
// Ein unbekannter/nicht getroffener Fall ergibt false — Fail-Safe-Default,
|
|
||||||
// kein Feature wird versehentlich aktiv.
|
|
||||||
func evaluate(f Flag, tenantSlug string) bool {
|
|
||||||
if f.Enabled {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
for _, target := range f.TargetTenantSlugs {
|
|
||||||
if target == tenantSlug {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if f.RolloutPercentage > 0 {
|
|
||||||
h := fnv.New32a()
|
|
||||||
_, _ = h.Write([]byte(f.Key + "|" + tenantSlug))
|
|
||||||
return int(h.Sum32()%100) < f.RolloutPercentage
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
@@ -1,43 +0,0 @@
|
|||||||
package flag
|
|
||||||
|
|
||||||
import "testing"
|
|
||||||
|
|
||||||
func TestEvaluate_GlobalEnabled(t *testing.T) {
|
|
||||||
f := Flag{Key: "k", Enabled: true}
|
|
||||||
if !evaluate(f, "irgendein-tenant") {
|
|
||||||
t.Fatal("global aktiviertes flag sollte fuer jeden tenant true liefern")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 2: Zielgruppen-Strategie.
|
|
||||||
func TestEvaluate_TargetTenantStrategy(t *testing.T) {
|
|
||||||
f := Flag{Key: "k", Enabled: false, TargetTenantSlugs: []string{"acme"}}
|
|
||||||
if !evaluate(f, "acme") {
|
|
||||||
t.Fatal("erwartet true fuer tenant in zielgruppe")
|
|
||||||
}
|
|
||||||
if evaluate(f, "globex") {
|
|
||||||
t.Fatal("erwartet false fuer tenant ausserhalb der zielgruppe")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestEvaluate_RolloutPercentageBoundaries(t *testing.T) {
|
|
||||||
full := Flag{Key: "k", RolloutPercentage: 100}
|
|
||||||
if !evaluate(full, "beliebiger-tenant-1") || !evaluate(full, "beliebiger-tenant-2") {
|
|
||||||
t.Fatal("100% rollout sollte immer true liefern")
|
|
||||||
}
|
|
||||||
|
|
||||||
none := Flag{Key: "k", RolloutPercentage: 0}
|
|
||||||
if evaluate(none, "beliebiger-tenant") {
|
|
||||||
t.Fatal("0% rollout ohne enabled/zielgruppe sollte false liefern")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestEvaluate_RolloutIsDeterministicPerTenant(t *testing.T) {
|
|
||||||
f := Flag{Key: "k", RolloutPercentage: 50}
|
|
||||||
first := evaluate(f, "stabiler-tenant")
|
|
||||||
for i := 0; i < 5; i++ {
|
|
||||||
if evaluate(f, "stabiler-tenant") != first {
|
|
||||||
t.Fatal("rollout-auswertung sollte fuer denselben tenant/key stabil sein")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,87 +0,0 @@
|
|||||||
package flag
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"log/slog"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DefaultCacheTTL ist die dokumentierte Cache-Invalidierungszeit
|
|
||||||
// (Akzeptanzkriterium 2/3): eine Aenderung wirkt spaetestens nach dieser
|
|
||||||
// Zeit auf allen Core-Instanzen, ohne dass ein Dienst neu gestartet werden
|
|
||||||
// muss (Akzeptanzkriterium 3).
|
|
||||||
const DefaultCacheTTL = 5 * time.Second
|
|
||||||
|
|
||||||
type cacheEntry struct {
|
|
||||||
flag Flag
|
|
||||||
expiresAt time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// Service ist die Auswertungsseite (SDK/Client-Analogon zu Unleash) mit
|
|
||||||
// lokalem TTL-Cache. Bewusst getrennt von Store (Verwaltung).
|
|
||||||
type Service struct {
|
|
||||||
store *Store
|
|
||||||
ttl time.Duration
|
|
||||||
|
|
||||||
mu sync.RWMutex
|
|
||||||
cache map[string]cacheEntry
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(store *Store, ttl time.Duration) *Service {
|
|
||||||
if ttl <= 0 {
|
|
||||||
ttl = DefaultCacheTTL
|
|
||||||
}
|
|
||||||
return &Service{store: store, ttl: ttl, cache: make(map[string]cacheEntry)}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsEnabled wertet ein Flag fuer einen Tenant aus. Liefert IMMER einen
|
|
||||||
// bool ohne Fehlerwert — ein nicht erreichbarer Flag-Dienst darf abhaengige
|
|
||||||
// Aufrufer nicht zum Absturz bringen oder zu Fehlerbehandlungscode zwingen,
|
|
||||||
// der leicht vergessen wird (Akzeptanzkriterium 3 / Pruefung 3: dokumentiertes
|
|
||||||
// Fallback-Verhalten = false, ggf. aus dem zuletzt bekannten Zwischenspeicher).
|
|
||||||
func (s *Service) IsEnabled(ctx context.Context, tenantSlug, key string) bool {
|
|
||||||
f, ok := s.resolve(ctx, key)
|
|
||||||
if !ok {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return evaluate(f, tenantSlug)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Service) resolve(ctx context.Context, key string) (Flag, bool) {
|
|
||||||
s.mu.RLock()
|
|
||||||
entry, exists := s.cache[key]
|
|
||||||
fresh := exists && time.Now().Before(entry.expiresAt)
|
|
||||||
s.mu.RUnlock()
|
|
||||||
if fresh {
|
|
||||||
return entry.flag, true
|
|
||||||
}
|
|
||||||
|
|
||||||
f, err := s.store.Get(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
if exists {
|
|
||||||
slog.Warn("feature-flag-dienst nicht erreichbar, nutze zwischengespeicherten stand",
|
|
||||||
"flag_key", key, "error", err)
|
|
||||||
return entry.flag, true
|
|
||||||
}
|
|
||||||
slog.Warn("feature-flag-dienst nicht erreichbar, kein zwischengespeicherter stand vorhanden, fallback: deaktiviert",
|
|
||||||
"flag_key", key, "error", err)
|
|
||||||
return Flag{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
s.mu.Lock()
|
|
||||||
s.cache[key] = cacheEntry{flag: f, expiresAt: time.Now().Add(s.ttl)}
|
|
||||||
s.mu.Unlock()
|
|
||||||
return f, true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Invalidate erzwingt beim naechsten IsEnabled-Aufruf ein sofortiges Neuladen
|
|
||||||
// aus der Datenbank statt auf den TTL-Ablauf zu warten — wird nach Store.Set
|
|
||||||
// auf derselben Instanz aufgerufen, damit der Schreiber die eigene Aenderung
|
|
||||||
// ohne Wartezeit sieht. Andere Core-Instanzen sehen sie spaetestens nach
|
|
||||||
// DefaultCacheTTL (siehe Akzeptanzkriterium 3).
|
|
||||||
func (s *Service) Invalidate(key string) {
|
|
||||||
s.mu.Lock()
|
|
||||||
delete(s.cache, key)
|
|
||||||
s.mu.Unlock()
|
|
||||||
}
|
|
||||||
@@ -1,179 +0,0 @@
|
|||||||
package flag
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupFlagStoreTest(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 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()
|
|
||||||
)`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() {
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM feature_flags WHERE key LIKE 'test\_%' ESCAPE '\'`)
|
|
||||||
pool.Close()
|
|
||||||
}
|
|
||||||
return NewStore(pool), cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 2: Zielgruppen-Strategie liefert im Test
|
|
||||||
// die erwartete Auswertung.
|
|
||||||
func TestService_TargetTenantStrategy(t *testing.T) {
|
|
||||||
store, cleanup := setupFlagStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_target_flag", TargetTenantSlugs: []string{"acme"}}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, time.Hour)
|
|
||||||
|
|
||||||
if !svc.IsEnabled(ctx, "acme", "test_target_flag") {
|
|
||||||
t.Fatal("erwartet true fuer tenant in zielgruppe")
|
|
||||||
}
|
|
||||||
if svc.IsEnabled(ctx, "globex", "test_target_flag") {
|
|
||||||
t.Fatal("erwartet false fuer tenant ausserhalb der zielgruppe")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + 3 + Pruefung 1: Flag-Aenderung wirkt innerhalb der
|
|
||||||
// dokumentierten Cache-Invalidierungszeit, automatisiert gemessen.
|
|
||||||
func TestService_CacheInvalidationTiming(t *testing.T) {
|
|
||||||
store, cleanup := setupFlagStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
const ttl = 150 * time.Millisecond
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_ttl_flag", Enabled: false}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, ttl)
|
|
||||||
|
|
||||||
if svc.IsEnabled(ctx, "acme", "test_ttl_flag") {
|
|
||||||
t.Fatal("erwartet false vor der aenderung")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Aenderung "auf einer anderen instanz" simulieren: direkt ueber den
|
|
||||||
// Store, ohne svc.Invalidate aufzurufen.
|
|
||||||
changedAt := time.Now()
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_ttl_flag", Enabled: true}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sofort danach sollte der Cache noch den alten Stand liefern.
|
|
||||||
if svc.IsEnabled(ctx, "acme", "test_ttl_flag") {
|
|
||||||
t.Fatal("cache haette den alten (false) stand liefern sollen, direkt nach der aenderung")
|
|
||||||
}
|
|
||||||
|
|
||||||
deadline := changedAt.Add(ttl + 100*time.Millisecond)
|
|
||||||
for time.Now().Before(deadline) {
|
|
||||||
if svc.IsEnabled(ctx, "acme", "test_ttl_flag") {
|
|
||||||
elapsed := time.Since(changedAt)
|
|
||||||
t.Logf("aenderung wurde nach %s wirksam (ziel: innerhalb %s + toleranz)", elapsed, ttl)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
time.Sleep(10 * time.Millisecond)
|
|
||||||
}
|
|
||||||
t.Fatalf("aenderung wurde nicht innerhalb von %s wirksam", deadline.Sub(changedAt))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestService_InvalidateForcesImmediateRefresh(t *testing.T) {
|
|
||||||
store, cleanup := setupFlagStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_invalidate_flag", Enabled: false}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, time.Hour) // lange TTL, damit Invalidate den unterschied macht
|
|
||||||
_ = svc.IsEnabled(ctx, "acme", "test_invalidate_flag")
|
|
||||||
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_invalidate_flag", Enabled: true}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc.Invalidate("test_invalidate_flag")
|
|
||||||
|
|
||||||
if !svc.IsEnabled(ctx, "acme", "test_invalidate_flag") {
|
|
||||||
t.Fatal("erwartet sofort sichtbaren neuen stand nach Invalidate")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 3: Ausfall des Flag-Dienstes fuehrt zu
|
|
||||||
// dokumentiertem Fallback-Verhalten, nicht zum Absturz.
|
|
||||||
func TestService_FallsBackOnStoreFailure(t *testing.T) {
|
|
||||||
store, cleanup := setupFlagStoreTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if err := store.Set(ctx, Flag{Key: "test_fallback_flag", Enabled: true}); err != nil {
|
|
||||||
t.Fatalf("set: %v", err)
|
|
||||||
}
|
|
||||||
svc := NewService(store, time.Hour)
|
|
||||||
|
|
||||||
// Cache vorwaermen, waehrend die DB noch erreichbar ist.
|
|
||||||
if !svc.IsEnabled(ctx, "acme", "test_fallback_flag") {
|
|
||||||
t.Fatal("erwartet true bei funktionierender db")
|
|
||||||
}
|
|
||||||
|
|
||||||
brokenPool, err := pgxpool.New(ctx, "postgresql://nonexistent-host-fuer-test:5432/x?connect_timeout=1")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("broken pool erstellen (sollte nicht sofort verbinden): %v", err)
|
|
||||||
}
|
|
||||||
brokenStore := NewStore(brokenPool)
|
|
||||||
|
|
||||||
svcWithCache := NewService(brokenStore, time.Nanosecond) // TTL sofort abgelaufen, erzwingt reload-versuch
|
|
||||||
svcWithCache.mu.Lock()
|
|
||||||
svcWithCache.cache["test_fallback_flag"] = cacheEntry{
|
|
||||||
flag: Flag{Key: "test_fallback_flag", Enabled: true},
|
|
||||||
expiresAt: time.Now().Add(-time.Hour), // bereits abgelaufen
|
|
||||||
}
|
|
||||||
svcWithCache.mu.Unlock()
|
|
||||||
|
|
||||||
func() {
|
|
||||||
defer func() {
|
|
||||||
if r := recover(); r != nil {
|
|
||||||
t.Fatalf("IsEnabled hat gepanict statt einen fallback zu liefern: %v", r)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
if !svcWithCache.IsEnabled(ctx, "acme", "test_fallback_flag") {
|
|
||||||
t.Fatal("erwartet fallback auf zwischengespeicherten (true) stand bei db-ausfall")
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
// Voellig frischer Dienst ohne jeglichen cache + kaputte db -> sicherer
|
|
||||||
// default false, kein absturz.
|
|
||||||
freshSvc := NewService(brokenStore, time.Hour)
|
|
||||||
func() {
|
|
||||||
defer func() {
|
|
||||||
if r := recover(); r != nil {
|
|
||||||
t.Fatalf("IsEnabled hat gepanict: %v", r)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
if freshSvc.IsEnabled(ctx, "acme", "test_fallback_flag") {
|
|
||||||
t.Fatal("erwartet fail-safe false ohne cache und mit kaputter db")
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
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)
|
|
||||||
}
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
// 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
|
|
||||||
}
|
|
||||||
@@ -1,161 +0,0 @@
|
|||||||
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,19 +0,0 @@
|
|||||||
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
|
|
||||||
}
|
|
||||||
@@ -1,168 +0,0 @@
|
|||||||
// 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
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,179 +0,0 @@
|
|||||||
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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
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()
|
|
||||||
}
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,99 +0,0 @@
|
|||||||
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
|
|
||||||
}
|
|
||||||
@@ -1,46 +0,0 @@
|
|||||||
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)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,120 +0,0 @@
|
|||||||
// 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
|
|
||||||
}
|
|
||||||
@@ -1,304 +0,0 @@
|
|||||||
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,81 +0,0 @@
|
|||||||
// Package notify implementiert Core CFG-02: den zentralen Benachrichtigungs-
|
|
||||||
// Dispatcher, ueber den beliebige Module Benachrichtigungen ausloesen —
|
|
||||||
// Warteschlange, Wiederholungslogik, Kanal-Abstraktion. Die tatsaechlichen
|
|
||||||
// Kanaele (E-Mail/In-App) sind CFG-03, hier gibt es nur die Sender-
|
|
||||||
// Schnittstelle als Vorbereitung.
|
|
||||||
package notify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// DefaultMaxAttempts begrenzt Wiederholungsversuche (Akzeptanzkriterium 2) —
|
|
||||||
// nach dieser Anzahl gibt der Dispatcher kontrolliert auf (status=failed)
|
|
||||||
// statt endlos zu wiederholen.
|
|
||||||
const DefaultMaxAttempts = 5
|
|
||||||
|
|
||||||
// DefaultRetryBackoff ist die Basis-Wartezeit zwischen Wiederholungen,
|
|
||||||
// linear mit der Versuchsnummer skaliert.
|
|
||||||
const DefaultRetryBackoff = 200 * time.Millisecond
|
|
||||||
|
|
||||||
type Notification struct {
|
|
||||||
ID string
|
|
||||||
Channel string
|
|
||||||
Recipient string
|
|
||||||
Payload map[string]any
|
|
||||||
Attempts int
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sender ist die schmale Schnittstelle, die ein konkreter Kanal (CFG-03)
|
|
||||||
// implementiert. Der Dispatcher selbst weiss nichts ueber E-Mail/In-App.
|
|
||||||
type Sender interface {
|
|
||||||
Send(ctx context.Context, n Notification) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dispatcher ist die EINE Schnittstelle, ueber die Module Benachrichtigungen
|
|
||||||
// ausloesen — kein Modul baut eigenen Versandcode (Akzeptanzkriterium 1).
|
|
||||||
type Dispatcher struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
maxAttempts int
|
|
||||||
retryBackoff time.Duration
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewDispatcher(pool *pgxpool.Pool) *Dispatcher {
|
|
||||||
return &Dispatcher{pool: pool, maxAttempts: DefaultMaxAttempts, retryBackoff: DefaultRetryBackoff}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithRetryPolicy erlaubt Tests/Betrieb, Versuchsanzahl und Backoff
|
|
||||||
// anzupassen, ohne die Default-Policy im Produktionscode zu veraendern.
|
|
||||||
func (d *Dispatcher) WithRetryPolicy(maxAttempts int, backoff time.Duration) *Dispatcher {
|
|
||||||
return &Dispatcher{pool: d.pool, maxAttempts: maxAttempts, retryBackoff: backoff}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Enqueue reiht eine Benachrichtigung in die Postgres-Warteschlange ein und
|
|
||||||
// kehrt sofort zurueck — die Zeile ueberlebt jeden Neustart des Dispatcher-
|
|
||||||
// Prozesses unveraendert (Akzeptanzkriterium 3), da sie ausschliesslich in
|
|
||||||
// der Datenbank existiert, nicht im Prozessspeicher.
|
|
||||||
func (d *Dispatcher) Enqueue(ctx context.Context, channel, recipient string, payload map[string]any) (string, error) {
|
|
||||||
if payload == nil {
|
|
||||||
payload = map[string]any{}
|
|
||||||
}
|
|
||||||
payloadJSON, err := json.Marshal(payload)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("payload serialisieren: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var id string
|
|
||||||
err = d.pool.QueryRow(ctx, `
|
|
||||||
INSERT INTO notification_jobs (channel, recipient, payload, max_attempts)
|
|
||||||
VALUES ($1, $2, $3, $4)
|
|
||||||
RETURNING id
|
|
||||||
`, channel, recipient, payloadJSON, d.maxAttempts).Scan(&id)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("benachrichtigung einreihen: %w", err)
|
|
||||||
}
|
|
||||||
return id, nil
|
|
||||||
}
|
|
||||||
@@ -1,219 +0,0 @@
|
|||||||
package notify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupTest(t *testing.T) (*pgxpool.Pool, 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 notification_jobs (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
channel TEXT NOT NULL,
|
|
||||||
recipient TEXT NOT NULL,
|
|
||||||
payload JSONB NOT NULL DEFAULT '{}'::jsonb,
|
|
||||||
status TEXT NOT NULL DEFAULT 'pending' CHECK (status IN ('pending', 'sent', 'failed')),
|
|
||||||
attempts INT NOT NULL DEFAULT 0,
|
|
||||||
max_attempts INT NOT NULL DEFAULT 5,
|
|
||||||
next_attempt_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
last_error TEXT,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
)`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() { pool.Close() }
|
|
||||||
return pool, cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
type fakeSender struct {
|
|
||||||
mu sync.Mutex
|
|
||||||
sentIDs []string
|
|
||||||
failUntil int
|
|
||||||
calls int
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *fakeSender) Send(ctx context.Context, n Notification) error {
|
|
||||||
f.mu.Lock()
|
|
||||||
defer f.mu.Unlock()
|
|
||||||
f.calls++
|
|
||||||
if f.calls <= f.failUntil {
|
|
||||||
return errors.New("simulierter zustellfehler")
|
|
||||||
}
|
|
||||||
f.sentIDs = append(f.sentIDs, n.ID)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *fakeSender) sentCount() int {
|
|
||||||
f.mu.Lock()
|
|
||||||
defer f.mu.Unlock()
|
|
||||||
return len(f.sentIDs)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1: Module loesen ueber Enqueue aus, keine eigene
|
|
||||||
// Versandlogik noetig.
|
|
||||||
func TestDispatcher_EnqueueAndProcess(t *testing.T) {
|
|
||||||
pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
d := NewDispatcher(pool)
|
|
||||||
id, err := d.Enqueue(ctx, "email", "alice@example.com", map[string]any{"subject": "Willkommen"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("enqueue: %v", err)
|
|
||||||
}
|
|
||||||
if id == "" {
|
|
||||||
t.Fatal("erwartet nicht-leere id")
|
|
||||||
}
|
|
||||||
|
|
||||||
sender := &fakeSender{}
|
|
||||||
sent, failed, err := d.ProcessDue(ctx, sender, 10)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("process: %v", err)
|
|
||||||
}
|
|
||||||
if sent != 1 || failed != 0 {
|
|
||||||
t.Fatalf("erwartet sent=1 failed=0, habe sent=%d failed=%d", sent, failed)
|
|
||||||
}
|
|
||||||
if sender.sentCount() != 1 {
|
|
||||||
t.Fatalf("erwartet 1 zustellung, habe %d", sender.sentCount())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 2: Wiederholungslogik greift bei
|
|
||||||
// simuliertem Fehler und bricht nach definierter Anzahl kontrolliert ab.
|
|
||||||
func TestProcessDue_RetriesThenGivesUpAfterMaxAttempts(t *testing.T) {
|
|
||||||
pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
d := NewDispatcher(pool).WithRetryPolicy(3, time.Millisecond)
|
|
||||||
id, err := d.Enqueue(ctx, "email", "bob@example.com", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("enqueue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
sender := &fakeSender{failUntil: 100} // schlaegt bei jedem versuch fehl
|
|
||||||
|
|
||||||
for i := 0; i < 3; i++ {
|
|
||||||
time.Sleep(5 * time.Millisecond) // next_attempt_at abwarten
|
|
||||||
if _, _, err := d.ProcessDue(ctx, sender, 10); err != nil {
|
|
||||||
t.Fatalf("process %d: %v", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var status string
|
|
||||||
var attempts int
|
|
||||||
if err := pool.QueryRow(ctx, `SELECT status, attempts FROM notification_jobs WHERE id = $1`, id).Scan(&status, &attempts); err != nil {
|
|
||||||
t.Fatalf("status lesen: %v", err)
|
|
||||||
}
|
|
||||||
if status != "failed" {
|
|
||||||
t.Fatalf("erwartet status failed nach max_attempts, habe %q", status)
|
|
||||||
}
|
|
||||||
if attempts != 3 {
|
|
||||||
t.Fatalf("erwartet 3 versuche, habe %d", attempts)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Weiteres ProcessDue darf den bereits aufgegebenen job nicht mehr anfassen.
|
|
||||||
sent, failed, err := d.ProcessDue(ctx, sender, 10)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("process nach abbruch: %v", err)
|
|
||||||
}
|
|
||||||
if sent != 0 || failed != 0 {
|
|
||||||
t.Fatalf("erwartet keine weitere verarbeitung, habe sent=%d failed=%d", sent, failed)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 1: Neustart des Dienstes waehrend offener
|
|
||||||
// Zustellung verliert keine Nachricht — simuliert durch eine komplett neue
|
|
||||||
// Dispatcher/Pool-Instanz nach dem Enqueue, bevor irgendetwas verarbeitet wurde.
|
|
||||||
func TestQueue_SurvivesRestartWithoutMessageLoss(t *testing.T) {
|
|
||||||
pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
firstInstance := NewDispatcher(pool)
|
|
||||||
id, err := firstInstance.Enqueue(ctx, "email", "carol@example.com", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("enqueue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// "Neustart": eine voellig neue Dispatcher-Instanz (repraesentiert einen
|
|
||||||
// neuen Prozess) verbindet sich neu und verarbeitet die Warteschlange —
|
|
||||||
// die Nachricht existiert ausschliesslich in Postgres, nicht im
|
|
||||||
// Prozessspeicher der ersten Instanz.
|
|
||||||
restartedInstance := NewDispatcher(pool)
|
|
||||||
sender := &fakeSender{}
|
|
||||||
sent, failed, err := restartedInstance.ProcessDue(ctx, sender, 10)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("process nach neustart: %v", err)
|
|
||||||
}
|
|
||||||
if sent != 1 || failed != 0 {
|
|
||||||
t.Fatalf("erwartet sent=1 nach neustart, habe sent=%d failed=%d", sent, failed)
|
|
||||||
}
|
|
||||||
if len(sender.sentIDs) != 1 || sender.sentIDs[0] != id {
|
|
||||||
t.Fatalf("erwartet zustellung der urspruenglichen nachricht %q, habe %v", id, sender.sentIDs)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 3: zwei gleichzeitig ausloesende Module,
|
|
||||||
// beide Nachrichten werden korrekt (und nicht doppelt) zugestellt.
|
|
||||||
func TestProcessDue_ConcurrentDispatchBothDelivered(t *testing.T) {
|
|
||||||
pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
d := NewDispatcher(pool)
|
|
||||||
idA, err := d.Enqueue(ctx, "email", "modul-a@example.com", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("enqueue a: %v", err)
|
|
||||||
}
|
|
||||||
idB, err := d.Enqueue(ctx, "email", "modul-b@example.com", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("enqueue b: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
sender := &fakeSender{}
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
for i := 0; i < 2; i++ {
|
|
||||||
wg.Add(1)
|
|
||||||
go func() {
|
|
||||||
defer wg.Done()
|
|
||||||
if _, _, err := d.ProcessDue(ctx, sender, 10); err != nil {
|
|
||||||
t.Errorf("process: %v", err)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
|
|
||||||
if sender.sentCount() != 2 {
|
|
||||||
t.Fatalf("erwartet genau 2 zustellungen, habe %d: %v", sender.sentCount(), sender.sentIDs)
|
|
||||||
}
|
|
||||||
seen := map[string]bool{}
|
|
||||||
for _, id := range sender.sentIDs {
|
|
||||||
if seen[id] {
|
|
||||||
t.Fatalf("nachricht %q wurde doppelt zugestellt", id)
|
|
||||||
}
|
|
||||||
seen[id] = true
|
|
||||||
}
|
|
||||||
if !seen[idA] || !seen[idB] {
|
|
||||||
t.Fatalf("erwartet beide nachrichten zugestellt, habe %v", sender.sentIDs)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
package notify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ProcessDue holt bis zu limit faellige Benachrichtigungen und versucht sie
|
|
||||||
// ueber sender zuzustellen. FOR UPDATE SKIP LOCKED serialisiert konkurrierende
|
|
||||||
// Aufrufe (Akzeptanzkriterium 3 / Pruefung 3: zwei gleichzeitig ausloesende
|
|
||||||
// Module duerfen sich nicht gegenseitig blockieren oder Nachrichten doppelt
|
|
||||||
// zustellen) — dieselbe Konvention wie internal/tenant.Lifecycle.ProcessDueDeletions.
|
|
||||||
func (d *Dispatcher) ProcessDue(ctx context.Context, sender Sender, limit int) (sent, failed int, err error) {
|
|
||||||
tx, err := d.pool.Begin(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, fmt.Errorf("transaktion starten: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = tx.Rollback(ctx) }()
|
|
||||||
|
|
||||||
rows, err := tx.Query(ctx, `
|
|
||||||
SELECT id, channel, recipient, payload, attempts, max_attempts
|
|
||||||
FROM notification_jobs
|
|
||||||
WHERE status = 'pending' AND next_attempt_at <= now()
|
|
||||||
ORDER BY created_at
|
|
||||||
FOR UPDATE SKIP LOCKED
|
|
||||||
LIMIT $1
|
|
||||||
`, limit)
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, fmt.Errorf("faellige benachrichtigungen abfragen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
type due struct {
|
|
||||||
id, channel, recipient string
|
|
||||||
payload []byte
|
|
||||||
attempts, maxAttempts int
|
|
||||||
}
|
|
||||||
var candidates []due
|
|
||||||
for rows.Next() {
|
|
||||||
var c due
|
|
||||||
if err := rows.Scan(&c.id, &c.channel, &c.recipient, &c.payload, &c.attempts, &c.maxAttempts); err != nil {
|
|
||||||
rows.Close()
|
|
||||||
return 0, 0, fmt.Errorf("faellige benachrichtigung lesen: %w", err)
|
|
||||||
}
|
|
||||||
candidates = append(candidates, c)
|
|
||||||
}
|
|
||||||
rows.Close()
|
|
||||||
if err := rows.Err(); err != nil {
|
|
||||||
return 0, 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, c := range candidates {
|
|
||||||
var payload map[string]any
|
|
||||||
if err := json.Unmarshal(c.payload, &payload); err != nil {
|
|
||||||
payload = map[string]any{}
|
|
||||||
}
|
|
||||||
|
|
||||||
sendErr := sender.Send(ctx, Notification{
|
|
||||||
ID: c.id, Channel: c.channel, Recipient: c.recipient, Payload: payload, Attempts: c.attempts,
|
|
||||||
})
|
|
||||||
|
|
||||||
if sendErr == nil {
|
|
||||||
if _, err := tx.Exec(ctx, `
|
|
||||||
UPDATE notification_jobs SET status = 'sent', updated_at = now() WHERE id = $1
|
|
||||||
`, c.id); err != nil {
|
|
||||||
return sent, failed, fmt.Errorf("erfolg speichern: %w", err)
|
|
||||||
}
|
|
||||||
sent++
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
newAttempts := c.attempts + 1
|
|
||||||
if newAttempts >= c.maxAttempts {
|
|
||||||
// Akzeptanzkriterium 2: kontrollierter Abbruch nach definierter
|
|
||||||
// Anzahl Versuche, kein endloses Wiederholen.
|
|
||||||
if _, err := tx.Exec(ctx, `
|
|
||||||
UPDATE notification_jobs
|
|
||||||
SET status = 'failed', attempts = $2, last_error = $3, updated_at = now()
|
|
||||||
WHERE id = $1
|
|
||||||
`, c.id, newAttempts, sendErr.Error()); err != nil {
|
|
||||||
return sent, failed, fmt.Errorf("fehlschlag speichern: %w", err)
|
|
||||||
}
|
|
||||||
failed++
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
nextAttempt := time.Now().Add(time.Duration(newAttempts) * d.retryBackoff)
|
|
||||||
if _, err := tx.Exec(ctx, `
|
|
||||||
UPDATE notification_jobs
|
|
||||||
SET attempts = $2, next_attempt_at = $3, last_error = $4, updated_at = now()
|
|
||||||
WHERE id = $1
|
|
||||||
`, c.id, newAttempts, nextAttempt, sendErr.Error()); err != nil {
|
|
||||||
return sent, failed, fmt.Errorf("wiederholung planen: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := tx.Commit(ctx); err != nil {
|
|
||||||
return 0, 0, fmt.Errorf("transaktion committen: %w", err)
|
|
||||||
}
|
|
||||||
return sent, failed, nil
|
|
||||||
}
|
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
DROP TABLE IF EXISTS audit_events;
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
-- Zentrales Audit-Log-Modell (AUD-01, siehe core-kanban/tickets/AUD-01.md).
|
||||||
|
-- Getrennt vom allgemeinen Anwendungs-Log (Akzeptanzkriterium 2): eigene
|
||||||
|
-- Tabelle, eigenes Paket (internal/audit), kein Log-Framework.
|
||||||
|
-- tenant_slug ist NOT NULL + darf nicht leer sein (Akzeptanzkriterium 2 /
|
||||||
|
-- Pruefung 2) — mandantenuebergreifende Ereignisse nutzen den reservierten
|
||||||
|
-- Wert 'system', niemals NULL oder leeren String.
|
||||||
|
CREATE TABLE audit_events (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
occurred_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
tenant_slug TEXT NOT NULL CHECK (tenant_slug <> ''),
|
||||||
|
actor TEXT NOT NULL CHECK (actor <> ''),
|
||||||
|
action TEXT NOT NULL CHECK (action <> ''),
|
||||||
|
target TEXT NOT NULL,
|
||||||
|
metadata JSONB NOT NULL DEFAULT '{}'::jsonb
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE INDEX audit_events_tenant_slug_idx ON audit_events (tenant_slug, occurred_at);
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS config_value_history;
|
|
||||||
DROP TABLE IF EXISTS config_values;
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
-- Zentraler Konfigurationsdienst (CFG-01, siehe core-kanban/tickets/CFG-01.md).
|
|
||||||
-- scope = 'global' fuer globale Defaults, sonst der Tenant-Slug. config_values
|
|
||||||
-- haelt den AKTUELLEN Stand je (key, scope); config_value_history haelt JEDE
|
|
||||||
-- Aenderung fest (Akzeptanzkriterium 2: versioniert nachvollziehbar).
|
|
||||||
CREATE TABLE config_values (
|
|
||||||
key TEXT NOT NULL,
|
|
||||||
scope TEXT NOT NULL CHECK (scope <> ''),
|
|
||||||
value TEXT NOT NULL,
|
|
||||||
version INT NOT NULL,
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (key, scope)
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE TABLE config_value_history (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
key TEXT NOT NULL,
|
|
||||||
scope TEXT NOT NULL,
|
|
||||||
value TEXT NOT NULL,
|
|
||||||
version INT NOT NULL,
|
|
||||||
changed_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE INDEX config_value_history_key_scope_idx ON config_value_history (key, scope, version);
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS feature_flags;
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
-- 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,2 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS module_credentials;
|
|
||||||
DROP TABLE IF EXISTS modules;
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
-- 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 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS notification_jobs;
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
-- Benachrichtigungs-Dispatcher-Warteschlange (CFG-02, siehe
|
|
||||||
-- core-kanban/tickets/CFG-02.md). Postgres-basiert statt Redis/AMQP
|
|
||||||
-- (Projekt-Konvention, siehe nexarch-state.json techstack.job_queue) —
|
|
||||||
-- Zeilen ueberleben einen Neustart des Dispatcher-Prozesses unveraendert
|
|
||||||
-- (Akzeptanzkriterium 3).
|
|
||||||
CREATE TABLE notification_jobs (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
channel TEXT NOT NULL,
|
|
||||||
recipient TEXT NOT NULL,
|
|
||||||
payload JSONB NOT NULL DEFAULT '{}'::jsonb,
|
|
||||||
status TEXT NOT NULL DEFAULT 'pending' CHECK (status IN ('pending', 'sent', 'failed')),
|
|
||||||
attempts INT NOT NULL DEFAULT 0,
|
|
||||||
max_attempts INT NOT NULL DEFAULT 5,
|
|
||||||
next_attempt_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
last_error TEXT,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
|
|
||||||
CREATE INDEX notification_jobs_due_idx ON notification_jobs (status, next_attempt_at);
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
DROP TABLE alert_debounce_state;
|
|
||||||
DROP TABLE alert_rules;
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
-- OPS-05: Schwellwert-Regeln fuer Alerting auf den aus OPS-03 aggregierten
|
|
||||||
-- Metriken. Lebt wie config_values/notification_jobs (CFG-01/02) in der
|
|
||||||
-- zentralen Registry-DB — modulübergreifende Betriebskonfiguration, keine
|
|
||||||
-- Mandanten-Geschaeftsdaten.
|
|
||||||
CREATE TABLE alert_rules (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
metric_name TEXT NOT NULL,
|
|
||||||
comparison TEXT NOT NULL CHECK (comparison IN ('gt', 'lt')),
|
|
||||||
threshold DOUBLE PRECISION NOT NULL,
|
|
||||||
label_filters JSONB NOT NULL DEFAULT '{}'::jsonb,
|
|
||||||
recipient TEXT NOT NULL,
|
|
||||||
description TEXT NOT NULL DEFAULT '',
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
|
|
||||||
-- Haelt fest, wann eine Regel zuletzt tatsaechlich einen Alarm ausgeloest
|
|
||||||
-- hat (Akzeptanzkriterium 3: Drosselung wiederholter Alarmierung fuer
|
|
||||||
-- denselben anhaltenden Zustand). rule_key kombiniert Regel-ID mit den
|
|
||||||
-- tatsaechlichen Label-Werten der ausloesenden Zeitreihe, damit dieselbe
|
|
||||||
-- Regel fuer unterschiedliche Tenants/Module unabhaengig gedrosselt wird.
|
|
||||||
CREATE TABLE alert_debounce_state (
|
|
||||||
rule_key TEXT PRIMARY KEY,
|
|
||||||
last_fired_at TIMESTAMPTZ NOT NULL
|
|
||||||
);
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
DROP TABLE metrics_sources;
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
-- 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
|
|
||||||
);
|
|
||||||
@@ -15,8 +15,6 @@ 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;"
|
||||||
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP TABLE IF EXISTS audit_events CASCADE;"
|
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP TABLE IF EXISTS audit_events CASCADE;"
|
||||||
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP TABLE IF EXISTS config_value_history CASCADE;"
|
|
||||||
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP TABLE IF EXISTS config_values 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
|
||||||
|
|||||||
@@ -0,0 +1,30 @@
|
|||||||
|
import { ThemeProvider, I18nProvider, ToastProvider, typography } from "@nexarch/shl";
|
||||||
|
|
||||||
|
export const metadata = {
|
||||||
|
title: "NEXARCH Audit-Log",
|
||||||
|
};
|
||||||
|
|
||||||
|
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>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,159 @@
|
|||||||
|
"use client";
|
||||||
|
|
||||||
|
import { useState } from "react";
|
||||||
|
import { fetchRecords, exportURL, type AuditRecord, type AuditFilter } from "@/lib/api";
|
||||||
|
|
||||||
|
const EMPTY_FILTER: AuditFilter = { tenant: "", actor: "", action: "", from: "", to: "" };
|
||||||
|
|
||||||
|
export default function Page() {
|
||||||
|
const [caller, setCaller] = useState("");
|
||||||
|
const [filter, setFilter] = useState<AuditFilter>(EMPTY_FILTER);
|
||||||
|
const [records, setRecords] = useState<AuditRecord[] | null>(null);
|
||||||
|
const [selected, setSelected] = useState<AuditRecord | null>(null);
|
||||||
|
const [error, setError] = useState<string | null>(null);
|
||||||
|
|
||||||
|
async function onSearch() {
|
||||||
|
setError(null);
|
||||||
|
setSelected(null);
|
||||||
|
try {
|
||||||
|
const data = await fetchRecords(caller.trim(), filter);
|
||||||
|
setRecords(data);
|
||||||
|
} catch (e: any) {
|
||||||
|
setError(e.message ?? "Unbekannter Fehler");
|
||||||
|
setRecords(null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function onExport(format: "csv" | "json") {
|
||||||
|
const url = exportURL(caller.trim(), filter, format);
|
||||||
|
// Echter Datei-Download ueber Browser-Navigation, KEIN erneutes Parsen
|
||||||
|
// im Frontend (Akzeptanzkriterium 2: Export aus AUD-03 direkt ausloesbar).
|
||||||
|
window.open(url, "_blank");
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<main style={{ maxWidth: 1000, margin: "0 auto", padding: "2rem 1rem" }}>
|
||||||
|
<h1>Audit-Log</h1>
|
||||||
|
|
||||||
|
<div style={{ display: "grid", gap: "0.5rem", gridTemplateColumns: "repeat(3, 1fr)", marginBottom: "1rem" }}>
|
||||||
|
<input
|
||||||
|
value={caller}
|
||||||
|
onChange={(e) => setCaller(e.target.value)}
|
||||||
|
placeholder="Admin-Token (Berechtigung)"
|
||||||
|
style={{ padding: "0.5rem", gridColumn: "span 3" }}
|
||||||
|
/>
|
||||||
|
<input
|
||||||
|
value={filter.tenant}
|
||||||
|
onChange={(e) => setFilter({ ...filter, tenant: e.target.value })}
|
||||||
|
placeholder="Tenant"
|
||||||
|
style={{ padding: "0.5rem" }}
|
||||||
|
/>
|
||||||
|
<input
|
||||||
|
value={filter.actor}
|
||||||
|
onChange={(e) => setFilter({ ...filter, actor: e.target.value })}
|
||||||
|
placeholder="Akteur"
|
||||||
|
style={{ padding: "0.5rem" }}
|
||||||
|
/>
|
||||||
|
<input
|
||||||
|
value={filter.action}
|
||||||
|
onChange={(e) => setFilter({ ...filter, action: e.target.value })}
|
||||||
|
placeholder="Aktion"
|
||||||
|
style={{ padding: "0.5rem" }}
|
||||||
|
/>
|
||||||
|
<label>
|
||||||
|
Von
|
||||||
|
<input
|
||||||
|
type="datetime-local"
|
||||||
|
value={filter.from}
|
||||||
|
onChange={(e) =>
|
||||||
|
setFilter({ ...filter, from: e.target.value ? new Date(e.target.value).toISOString() : "" })
|
||||||
|
}
|
||||||
|
style={{ width: "100%", padding: "0.4rem" }}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
<label>
|
||||||
|
Bis
|
||||||
|
<input
|
||||||
|
type="datetime-local"
|
||||||
|
value={filter.to}
|
||||||
|
onChange={(e) =>
|
||||||
|
setFilter({ ...filter, to: e.target.value ? new Date(e.target.value).toISOString() : "" })
|
||||||
|
}
|
||||||
|
style={{ width: "100%", padding: "0.4rem" }}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div style={{ display: "flex", gap: "0.5rem", marginBottom: "1rem" }}>
|
||||||
|
<button onClick={onSearch}>Suchen</button>
|
||||||
|
<button onClick={() => onExport("csv")}>Export als CSV</button>
|
||||||
|
<button onClick={() => onExport("json")}>Export als JSON</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{error && (
|
||||||
|
<p style={{ color: "#c62828" }} role="alert">
|
||||||
|
Fehler: {error}
|
||||||
|
</p>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{records && (
|
||||||
|
<table style={{ width: "100%", borderCollapse: "collapse", background: "white" }}>
|
||||||
|
<thead>
|
||||||
|
<tr style={{ textAlign: "left", borderBottom: "2px solid #ddd" }}>
|
||||||
|
<th style={{ padding: "0.5rem" }}>Zeitpunkt</th>
|
||||||
|
<th style={{ padding: "0.5rem" }}>Tenant</th>
|
||||||
|
<th style={{ padding: "0.5rem" }}>Akteur</th>
|
||||||
|
<th style={{ padding: "0.5rem" }}>Aktion</th>
|
||||||
|
<th style={{ padding: "0.5rem" }}></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
{records.map((r, i) => (
|
||||||
|
<tr key={i} style={{ borderBottom: "1px solid #eee" }}>
|
||||||
|
<td style={{ padding: "0.5rem" }}>{new Date(r.occurred_at).toLocaleString("de-DE")}</td>
|
||||||
|
<td style={{ padding: "0.5rem" }}>{r.tenant_slug}</td>
|
||||||
|
<td style={{ padding: "0.5rem" }}>{r.actor}</td>
|
||||||
|
<td style={{ padding: "0.5rem" }}>{r.action}</td>
|
||||||
|
<td style={{ padding: "0.5rem" }}>
|
||||||
|
<button onClick={() => setSelected(r)}>Details</button>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
))}
|
||||||
|
{records.length === 0 && (
|
||||||
|
<tr>
|
||||||
|
<td colSpan={5} style={{ padding: "0.5rem" }}>
|
||||||
|
Keine Einträge gefunden.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
)}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{selected && (
|
||||||
|
<section style={{ background: "white", padding: "1rem", borderRadius: 8, marginTop: "1.5rem" }}>
|
||||||
|
<h2>Eintrag-Details</h2>
|
||||||
|
<dl>
|
||||||
|
<dt>Zeitpunkt</dt>
|
||||||
|
<dd>{new Date(selected.occurred_at).toLocaleString("de-DE")}</dd>
|
||||||
|
<dt>Tenant</dt>
|
||||||
|
<dd>{selected.tenant_slug}</dd>
|
||||||
|
<dt>Akteur</dt>
|
||||||
|
<dd>{selected.actor}</dd>
|
||||||
|
<dt>Aktion</dt>
|
||||||
|
<dd>{selected.action}</dd>
|
||||||
|
<dt>Ziel</dt>
|
||||||
|
<dd>{selected.target}</dd>
|
||||||
|
<dt>Metadaten</dt>
|
||||||
|
<dd>
|
||||||
|
<pre style={{ whiteSpace: "pre-wrap", background: "#f5f6f8", padding: "0.5rem" }}>
|
||||||
|
{JSON.stringify(selected.metadata, null, 2)}
|
||||||
|
</pre>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
<button onClick={() => setSelected(null)}>Schließen</button>
|
||||||
|
</section>
|
||||||
|
)}
|
||||||
|
</main>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
// Duenner Client der AUD-03-Export-API (internal/audit.ExportHandler) —
|
||||||
|
// keine eigene Aggregations-/Filterlogik im Frontend (Ticket-Vorgabe:
|
||||||
|
// "reiner Konsument der Export-API"). Die JSON-Lines-Antwort wird nur
|
||||||
|
// dekodiert, nicht neu berechnet oder gefiltert.
|
||||||
|
export type AuditRecord = {
|
||||||
|
occurred_at: string;
|
||||||
|
tenant_slug: string;
|
||||||
|
actor: string;
|
||||||
|
action: string;
|
||||||
|
target: string;
|
||||||
|
metadata: unknown;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type AuditFilter = {
|
||||||
|
tenant: string;
|
||||||
|
actor: string;
|
||||||
|
action: string;
|
||||||
|
from: string; // RFC3339, leer = kein Filter
|
||||||
|
to: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
function apiBase(): string {
|
||||||
|
const base = process.env.NEXT_PUBLIC_AUDITLOG_API_URL;
|
||||||
|
if (!base) {
|
||||||
|
throw new Error(
|
||||||
|
"NEXT_PUBLIC_AUDITLOG_API_URL ist nicht gesetzt (Umgebungsvariable erforderlich)"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return base;
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildParams(caller: string, filter: AuditFilter, format: "json" | "csv"): URLSearchParams {
|
||||||
|
const params = new URLSearchParams({ caller, format });
|
||||||
|
if (filter.tenant) params.set("tenant", filter.tenant);
|
||||||
|
if (filter.actor) params.set("actor", filter.actor);
|
||||||
|
if (filter.action) params.set("action", filter.action);
|
||||||
|
if (filter.from) params.set("from", filter.from);
|
||||||
|
if (filter.to) params.set("to", filter.to);
|
||||||
|
return params;
|
||||||
|
}
|
||||||
|
|
||||||
|
// exportURL liefert die Adresse desselben Endpunkts, den auch die
|
||||||
|
// Export-Datei-Funktion (Akzeptanzkriterium 2) verwendet — Liste und Export
|
||||||
|
// sind bewusst DERSELBE API-Aufruf mit unterschiedlichem "format".
|
||||||
|
export function exportURL(caller: string, filter: AuditFilter, format: "json" | "csv"): string {
|
||||||
|
return `${apiBase()}/audit/export?${buildParams(caller, filter, format)}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// fetchRecords laedt die Liste als JSON-Lines und dekodiert Zeile fuer
|
||||||
|
// Zeile — dieselben Filterparameter wie ein direkter API-Aufruf
|
||||||
|
// (Akzeptanzkriterium 1 / Pruefung 1).
|
||||||
|
export async function fetchRecords(caller: string, filter: AuditFilter): Promise<AuditRecord[]> {
|
||||||
|
const res = await fetch(exportURL(caller, filter, "json"), { cache: "no-store" });
|
||||||
|
if (!res.ok) {
|
||||||
|
const text = await res.text().catch(() => "");
|
||||||
|
throw new Error(text || `Anfrage fehlgeschlagen (${res.status})`);
|
||||||
|
}
|
||||||
|
const text = await res.text();
|
||||||
|
return text
|
||||||
|
.split("\n")
|
||||||
|
.filter((line) => line.trim() !== "")
|
||||||
|
.map((line) => JSON.parse(line) as AuditRecord);
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
/** @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;
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
{
|
||||||
|
"name": "nexarch-audit-log",
|
||||||
|
"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"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"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"]
|
||||||
|
}
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
# @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
|
||||||
|
```
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
// 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");
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
// 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);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
"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>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
// 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>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
"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>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
// 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>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
"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;
|
||||||
|
}
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
"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;
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
// Ö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";
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
{
|
||||||
|
"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"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
"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];
|
||||||
|
}
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
// 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;
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"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"]
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
import { defineConfig } from "vitest/config";
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
test: {
|
||||||
|
environment: "jsdom",
|
||||||
|
setupFiles: ["./vitest.setup.ts"],
|
||||||
|
},
|
||||||
|
});
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
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