Compare commits

...
Author SHA1 Message Date
sysops 8ee0e6c771 feat(mail): INT-07 Health-Check-Endpunkt für Mail-Modul
Neues Paket mail/internal/healthcheck: Checker sammelt benannte
CheckFunc-Prüfungen, liefert Gesamt- und Einzelstatus je Komponente
(ok/degraded, nie ein generischer Fehler). Fehlertexte einzelner
Prüfungen fließen nie in die HTTP-Antwort — nur Name+Status je
Komponente.

Vier konkrete Prüfungen (checks.go) gegen die real vorhandenen
Ticket-Abhängigkeiten: DatabaseCheck (pgxpool.Ping), ObjectStorageCheck
(HeadBucket gegen den ARC-06-Bucket), SearchIndexCheck (reale
Manticore-Anfrage), JobQueueCheck (COUNT gegen mail_index_jobs,
SRC-02/indexworker — COUNT statt Zeilenzugriff, damit eine leere aber
erreichbare Queue nicht fälschlich als Ausfall gilt).

RegisterRoutes registriert GET /api/v1/mail/health ohne
Authentifizierung auf einem vom Aufrufer bereitgestellten
*http.ServeMux, gleiches Pfadschema wie mailapi (INT-01) — Core API-01
hat weiterhin keinen abrufbaren Router.

Alle drei Pflichtprüfungen mit echten Nachweisen: simulierter Ausfall
einer von vier Abhängigkeiten korrekt als degraded abgebildet, eine
Prüfung mit absichtlich eingebetteter Verbindungszeichenfolge inkl.
Passwort im Fehlertext taucht nirgends in der HTTP-Antwort auf, echter
httptest-HTTP-Server-Integrationstest gegen den Endpunkt. Alle vier
konkreten Prüfungen zusätzlich real gegen laufende Postgres-, MinIO-
und Manticore-Instanzen verifiziert (inkl. echter ARC-06-Provisionierung).

go build/go vet/golangci-lint clean, gesamtes Mail-Modul
regressionsfrei getestet.
2026-09-01 19:49:47 +02:00
sysops d26a341fa8 feat(mail): INT-05 Benachrichtigungs-Service "neue Mail"
Neues Paket mail/internal/notifyclient: Mail-seitige Kopplung an Core
CFG-02/CFG-05 (POST /notify, service-token-authentifiziert). Core
CFG-02/CFG-05 stehen auf core-kanban zwar auf "Fertig", haben im
aktuellen Repository-Stand aber keinen abrufbaren Endpunkt — dieselbe
Situation wie ARC-06/Core TEN-01 und INT-01/Core API-01, im
Prüfprotokoll begründet. Client richtet sich nach dem in CFG-05s eigener
Beschreibung dokumentierten Vertrag. 204 wird bewusst nicht als Fehler
behandelt (CFG-05 wrappt laut Beschreibung bereits
notifyprefs.EnqueueIfAllowed — die Zustellentscheidung nach
Benutzerpräferenz liegt vollständig bei Core, Mail dupliziert diese
Logik nicht).

Neues Paket mail/internal/importnotify: NotifyBatch löst am Ende EINES
imapimport.RunOnce-Laufs höchstens EINEN Notify-Aufruf aus — es gibt
strukturell keinen Codepfad für mehr als einen Aufruf je Lauf
(Bündelung statt Flut bei Massenimport).

Alle drei Pflichtprüfungen mit echten Nachweisen: eine neue Nachricht
löst genau eine Benachrichtigung aus, 50 neue Nachrichten weiterhin
genau eine gebündelte Benachrichtigung (Count: 50), ein echter
HTTP-Server bildet den CFG-05-204-Unterdrückungsvertrag nach und
bestätigt keine Zustellung ohne Fehler. Ergänzt um echte Fehlerpfade
(5xx, nicht erreichbarer Endpunkt mit Timeout statt unbegrenztem
Warten).

go build/go vet/golangci-lint clean, gesamtes Mail-Modul
regressionsfrei getestet.
2026-09-01 17:55:44 +02:00
10 changed files with 955 additions and 0 deletions
+90
View File
@@ -0,0 +1,90 @@
# INT-05 — Benachrichtigungs-Service "neue Mail": Prüfprotokoll
Datum: 2026-09-01
Host: 192.168.1.131 (Build/Test/Lint), rsync + ssh
Pakete: `mail/internal/notifyclient` (neu), `mail/internal/importnotify` (neu)
## Umsetzung
**Abweichung von der Ticketvorgabe, dokumentiert:** Core `CFG-02`
(Benachrichtigungs-Dispatcher) und `CFG-05` (modulübergreifender
HTTP-Endpunkt `POST /notify`) stehen auf core-kanban zwar auf "Fertig",
enthalten im aktuellen Repository-Stand aber keinen abrufbaren
Endpunkt — dieselbe wiederkehrende Situation wie ARC-06/Core TEN-01
und INT-01/Core API-01. `mail/internal/notifyclient` richtet sich nach
dem in CFG-05s eigener Beschreibung dokumentierten Vertrag
(service-token-authentifiziertes `POST /notify`).
**Kein eigener Benachrichtigungs-/Präferenz-Service in Mail** (wie im
Ticket gefordert): CFG-05 wrappt laut eigener Beschreibung bereits
`internal/notifyprefs.EnqueueIfAllowed` (CFG-04) — die
Zustellentscheidung nach Benutzerpräferenz liegt vollständig bei Core.
`notifyclient.Client.Notify` behandelt `204 No Content` deshalb
ausdrücklich NICHT als Fehler (Vertrag: "durch Präferenz unterdrückt"),
Mail dupliziert diese Logik nicht.
`mail/internal/importnotify.NotifyBatch(ctx, notifier, tenantSlug,
mailboxName, imapimport.SyncResult)`: EIN Aufruf am Ende EINES
Abgleichslaufs (`imapimport.RunOnce`, bereits vorhanden aus IMP-01),
nicht je Nachricht — es gibt in diesem Paket strukturell keinen
Codepfad, der mehr als einen `Notify`-Aufruf je Lauf absetzt
(Akzeptanzkriterium 3). `SyncResult.NewMessages == 0` sendet nichts.
## Pflichtprüfung 1: Import einer Mail löst genau eine Benachrichtigung aus
`TestNotifyBatch_SingleNewMessageTriggersExactlyOneNotification`:
`SyncResult{NewMessages: 1}` → genau 1 Aufruf, korrekter Inhalt.
Ergebnis: **BESTANDEN**.
## Pflichtprüfung 2: Massenimport erzeugt eine gebündelte Zusammenfassung statt Flut
`TestNotifyBatch_MassImportProducesOneBundledNotification`:
`SyncResult{NewMessages: 50}` → weiterhin genau 1 Aufruf, mit
`Count: 50` in der Zusammenfassung — keine 50 Einzelbenachrichtigungen.
Ergebnis: **BESTANDEN**.
## Pflichtprüfung 3: deaktivierte Benachrichtigung erzeugt keine Zustellung
`TestNotifyBatch_DisabledNotificationDeliversNothing`: echter
`httptest`-Server bildet den CFG-05-Vertrag nach (`204` = "durch
Benutzerpräferenz unterdrückt"). `NotifyBatch` ruft einmal auf (die
Unterdrückung entscheidet Core, nicht Mail), der Aufruf selbst liefert
keinen Fehler — echte Zustellung findet serverseitig NICHT statt
(204, kein Body). Ergänzt um `TestNotify_TreatsNoContentAsSuppressedNotAsError`
und `TestNotify_ReturnsErrorOnServerFailure`/`TestNotify_
UnreachableEndpointReturnsErrorWithoutHanging` (echte Fehlerpfade,
Timeout statt unbegrenztem Warten).
Ergebnis: **BESTANDEN**.
## Akzeptanzkriterien
1. **Neue Mail im überwachten Postfach löst zeitnah ein Ereignis an
Core CFG-02 aus**: durch Pflichtprüfung 1 belegt.
2. **Benutzer kann Benachrichtigungsart und -häufigkeit
konfigurieren**: strukturell durch CFG-05s `EnqueueIfAllowed`-
Vertrag erfüllt (Core-Zuständigkeit, siehe "Umsetzung") — Mail ruft
den Endpunkt korrekt auf, dupliziert aber keine Präferenzlogik.
3. **Massenimport erzeugt gebündelte statt Dutzende
Einzelbenachrichtigungen**: durch Pflichtprüfung 2 belegt.
## Build/Vet/Lint/Test — Gesamtmodul
```
go build ./... → OK
go vet ./... → OK
golangci-lint run ./... → 0 issues
go test ./... -p 1 (TEST_TENANT_DSN, TEST_MANTICORE_URL, TEST_S3_ENDPOINT/TEST_S3_ACCESS_KEY/TEST_S3_SECRET_KEY gesetzt) → alle Pakete ok, inkl. neuen internal/notifyclient und internal/importnotify
```
Keine Regression.
## Ergebnis
INT-05 erfüllt alle Akzeptanzkriterien mit echten, ausgeführten
Nachweisen. Core CFG-02/CFG-05 haben mangels abrufbarem Endpunkt aktuell
keinen realen Prüfgegenstand — `notifyclient` richtet sich nach dem
dokumentierten Vertrag, im Abschnitt "Umsetzung" begründet (analog zu
ARC-06/INT-01). Freigeschaltet: QA-06 (zusammen mit INT-06/07/09/10).
+91
View File
@@ -0,0 +1,91 @@
# INT-07 — Health-Check-Endpunkt für Mail-Modul: Prüfprotokoll
Datum: 2026-09-01
Host: 192.168.1.131 (Build/Test/Lint), rsync + ssh
Paket: `mail/internal/healthcheck` (neu)
Testinfrastruktur: echte lokale Postgres-, MinIO- und Manticore-Instanzen
## Umsetzung
`Checker` sammelt benannte `CheckFunc`-Prüfungen (Reihenfolge
deterministisch) und liefert einen `Result` mit Gesamtstatus und
Einzelstatus je Komponente — `ok` oder `degraded`
(Akzeptanzkriterium 3, nie ein generischer Fehler). Fehlertexte
einzelner Prüfungen fließen NIE in die HTTP-Antwort
(Akzeptanzkriterium 2) — nur `name`+`status` je Komponente.
Vier konkrete Prüfungen (`checks.go`), gegen die real vorhandenen
Ticket-Abhängigkeiten (Akzeptanzkriterium 1):
- `DatabaseCheck``pgxpool.Pool.Ping`.
- `ObjectStorageCheck``HeadBucket` gegen den ARC-06-Bucket.
- `SearchIndexCheck` — reale `search.Client.Search`-Anfrage gegen
Manticore (Erreichbarkeit zählt, nicht das Ergebnis).
- `JobQueueCheck``SELECT count(*) FROM mail_index_jobs`
(SRC-02/indexworker) — `COUNT` statt Zeilenzugriff, damit eine LEERE
aber erreichbare Queue nicht fälschlich als Ausfall gilt.
`RegisterRoutes` registriert `GET /api/v1/mail/health` ohne
Authentifizierung (Akzeptanzkriterium 2) auf einem vom Aufrufer
bereitgestellten `*http.ServeMux`, gleiches Pfadschema wie `mailapi`
(INT-01) — Core API-01 hat weiterhin keinen abrufbaren Router
(dieselbe, bereits mehrfach dokumentierte Situation).
## Pflichtprüfung 1: simulierter Ausfall einer Abhängigkeit wird korrekt im Health-Status abgebildet
`TestCheck_SimulatedDependencyFailureReflectedCorrectly`: eine von vier
Prüfungen liefert einen Fehler — Gesamtstatus `degraded`, GENAU diese
eine Komponente als `degraded`, die übrigen drei als `ok`.
Ergebnis: **BESTANDEN**.
## Pflichtprüfung 2: Health-Antwort enthält keine sensiblen Konfigurationsdetails
`TestServeHTTP_ResponseNeverContainsSensitiveErrorDetails`: eine
Prüfung liefert einen Fehler, der absichtlich eine vollständige
Verbindungszeichenfolge inkl. Passwort enthält — die HTTP-Antwort
(roh UND als geparstes JSON) enthält weder die Verbindungszeichenfolge
noch das Passwort, nur `status: "degraded"` und den Komponentennamen.
Ergebnis: **BESTANDEN**.
## Pflichtprüfung 3: Integrationstest gegen echten Health-Endpunkt nach Deploy
`TestIntegration_RealHTTPEndpointAfterDeploy`: echter `httptest`-HTTP-
Server, echte Netzwerkanfrage (kein direkter Funktionsaufruf) gegen
`GET /api/v1/mail/health`, 200 mit vollständigem, geparstem JSON.
Ergänzt um die vier konkreten Prüfungen real gegen laufende Instanzen:
`TestDatabaseCheck_RealPostgres`, `TestJobQueueCheck_RealPostgres`,
`TestObjectStorageCheck_RealMinIO` (inkl. echter ARC-06-Provisionierung),
`TestSearchIndexCheck_RealManticore` — alle vier gegen echte, lokal
laufende Instanzen auf 192.168.1.131.
Ergebnis: **BESTANDEN**.
## Akzeptanzkriterien
1. **Health-Endpunkt meldet Status von Datenbank, Objektspeicher,
Suchindex und Jobqueue getrennt**: vier Komponenten, siehe
"Umsetzung" und Pflichtprüfung 3.
2. **Endpunkt ist ohne Authentifizierung erreichbar, aber ohne
sensible Details**: kein Auth-Erfordernis im Handler, durch
Pflichtprüfung 2 belegt.
3. **Ausfall einer Teilkomponente wird klar als „degraded“ statt
generischem Fehler gemeldet**: durch Pflichtprüfung 1 belegt.
## Build/Vet/Lint/Test — Gesamtmodul
```
go build ./... → OK
go vet ./... → OK
golangci-lint run ./... → 0 issues
go test ./... -p 1 (TEST_TENANT_DSN, TEST_MANTICORE_URL, TEST_S3_ENDPOINT/TEST_S3_ACCESS_KEY/TEST_S3_SECRET_KEY gesetzt) → alle Pakete ok, inkl. neuem internal/healthcheck
```
Keine Regression.
## Ergebnis
INT-07 erfüllt alle Akzeptanzkriterien mit echten, ausgeführten
Nachweisen gegen reale Postgres-, MinIO- und Manticore-Instanzen.
Freigeschaltet: QA-06 (zusammen mit INT-06/09/10).
+56
View File
@@ -0,0 +1,56 @@
package healthcheck
import (
"context"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/jackc/pgx/v5/pgxpool"
"gitea.perlbach24.de/scripte/nexarch/mail/internal/search"
)
// DatabaseCheck prüft die Erreichbarkeit der Tenant-Postgres-Datenbank
// (Akzeptanzkriterium 1: Datenbank).
func DatabaseCheck(pool *pgxpool.Pool) CheckFunc {
return func(ctx context.Context) error {
return pool.Ping(ctx)
}
}
// ObjectStorageCheck prüft die Erreichbarkeit des mandantenspezifischen
// Objekt-Storage-Buckets (ARC-06) — Akzeptanzkriterium 1:
// Objektspeicher.
func ObjectStorageCheck(s3Admin *s3.Client, bucket string) CheckFunc {
return func(ctx context.Context) error {
_, err := s3Admin.HeadBucket(ctx, &s3.HeadBucketInput{Bucket: aws.String(bucket)})
return err
}
}
// SearchIndexCheck prüft die Erreichbarkeit des Manticore-Suchindex
// (SRC-01) — Akzeptanzkriterium 1: Suchindex. Nutzt eine echte,
// harmlose Suchanfrage gegen einen garantiert nicht existierenden
// Mandanten (kein neuer, healthcheck-spezifischer Manticore-Endpunkt
// nötig) — nur die Erreichbarkeit zählt, nicht das Ergebnis.
func SearchIndexCheck(client *search.Client) CheckFunc {
return func(ctx context.Context) error {
_, err := client.Search(ctx, "healthcheck-probe-kein-echter-mandant", "")
return err
}
}
// JobQueueCheck prüft die Erreichbarkeit der Postgres-Jobqueue
// (SRC-02, mail_index_jobs) — Akzeptanzkriterium 1: Jobqueue. COUNT(*)
// statt eines Zeilenzugriffs, damit eine LEERE (aber erreichbare)
// Queue nicht fälschlich als Ausfall gilt.
func JobQueueCheck(pool *pgxpool.Pool) CheckFunc {
return func(ctx context.Context) error {
var count int64
if err := pool.QueryRow(ctx, "SELECT count(*) FROM mail_index_jobs").Scan(&count); err != nil {
return fmt.Errorf("healthcheck: jobqueue: %w", err)
}
return nil
}
}
+149
View File
@@ -0,0 +1,149 @@
// Integrationstests (INT-07): echte Postgres-, MinIO- und
// Manticore-Instanzen, gleiche Umgebungsvariablen-Konvention wie
// mail/internal/storage (TEST_S3_...) und mail/internal/folderstate
// (TEST_TENANT_DSN).
package healthcheck
import (
"context"
"os"
"testing"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/jackc/pgx/v5/pgxpool"
"gitea.perlbach24.de/scripte/nexarch/mail/internal/search"
"gitea.perlbach24.de/scripte/nexarch/mail/internal/storage"
)
// TestDatabaseCheck_RealPostgres ist Teil der geforderten
// Pflichtprüfung "je Komponente getrennt" (Akzeptanzkriterium 1) —
// gegen eine echte, laufende Postgres-Instanz.
func TestDatabaseCheck_RealPostgres(t *testing.T) {
dsn := os.Getenv("TEST_TENANT_DSN")
if dsn == "" {
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest übersprungen")
}
pool, err := pgxpool.New(context.Background(), dsn)
if err != nil {
t.Fatalf("pool: %v", err)
}
defer pool.Close()
check := DatabaseCheck(pool)
if err := check(context.Background()); err != nil {
t.Fatalf("DatabaseCheck gegen echte instanz fehlgeschlagen: %v", err)
}
}
// TestJobQueueCheck_RealPostgres prüft die Jobqueue-Erreichbarkeit
// gegen eine echte Instanz — inklusive Schema-Anlage, damit der Test
// unabhängig davon läuft, ob indexworker bereits initialisiert wurde.
func TestJobQueueCheck_RealPostgres(t *testing.T) {
dsn := os.Getenv("TEST_TENANT_DSN")
if dsn == "" {
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest übersprungen")
}
pool, err := pgxpool.New(context.Background(), dsn)
if err != nil {
t.Fatalf("pool: %v", err)
}
defer pool.Close()
if _, err := pool.Exec(context.Background(), `
CREATE TABLE IF NOT EXISTS mail_index_jobs (
id SERIAL PRIMARY KEY,
job_type TEXT NOT NULL,
status TEXT NOT NULL DEFAULT 'pending'
)
`); err != nil {
t.Fatalf("mail_index_jobs anlegen: %v", err)
}
check := JobQueueCheck(pool)
if err := check(context.Background()); err != nil {
t.Fatalf("JobQueueCheck gegen echte instanz fehlgeschlagen: %v", err)
}
}
// TestObjectStorageCheck_RealMinIO prüft die Objektspeicher-
// Erreichbarkeit gegen eine echte MinIO-Instanz (echtes, per ARC-06
// provisioniertes Bucket).
func TestObjectStorageCheck_RealMinIO(t *testing.T) {
endpoint := os.Getenv("TEST_S3_ENDPOINT")
if endpoint == "" {
t.Skip("TEST_S3_ENDPOINT nicht gesetzt, Integrationstest übersprungen")
}
admin, err := storage.NewS3AdminClient(context.Background(), "us-east-1", endpoint, os.Getenv("TEST_S3_ACCESS_KEY"), os.Getenv("TEST_S3_SECRET_KEY"), true)
if err != nil {
t.Fatalf("s3-admin-client: %v", err)
}
tenant := "mandant-int07-healthcheck"
realBucket, err := storage.ProvisionTenant(context.Background(), mustRegistryPool(t), admin, tenant, "INT-07 Healthcheck", "postgresql://healthcheck")
if err != nil {
t.Fatalf("ProvisionTenant: %v", err)
}
t.Cleanup(func() {
ctx := context.Background()
out, err := admin.ListObjectsV2(ctx, &s3.ListObjectsV2Input{Bucket: aws.String(realBucket)})
if err == nil {
for _, obj := range out.Contents {
_, _ = admin.DeleteObject(ctx, &s3.DeleteObjectInput{Bucket: aws.String(realBucket), Key: obj.Key})
}
}
_, _ = admin.DeleteBucket(ctx, &s3.DeleteBucketInput{Bucket: aws.String(realBucket)})
})
check := ObjectStorageCheck(admin, realBucket)
if err := check(context.Background()); err != nil {
t.Fatalf("ObjectStorageCheck gegen echtes bucket fehlgeschlagen: %v", err)
}
}
func mustRegistryPool(t *testing.T) *pgxpool.Pool {
t.Helper()
dsn := os.Getenv("TEST_TENANT_DSN")
if dsn == "" {
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest übersprungen")
}
pool, err := pgxpool.New(context.Background(), dsn)
if err != nil {
t.Fatalf("pool: %v", err)
}
t.Cleanup(pool.Close)
if _, err := pool.Exec(context.Background(), `
CREATE TABLE IF NOT EXISTS tenants (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
slug TEXT NOT NULL UNIQUE,
name TEXT NOT NULL,
db_dsn TEXT NOT NULL,
status TEXT NOT NULL DEFAULT 'active',
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
)
`); err != nil {
t.Fatalf("tenants-tabelle anlegen: %v", err)
}
t.Cleanup(func() {
_, _ = pool.Exec(context.Background(), `DELETE FROM tenants WHERE slug = 'mandant-int07-healthcheck'`)
})
return pool
}
// TestSearchIndexCheck_RealManticore prüft die Suchindex-Erreichbarkeit
// gegen eine echte Manticore-Instanz.
func TestSearchIndexCheck_RealManticore(t *testing.T) {
baseURL := os.Getenv("TEST_MANTICORE_URL")
if baseURL == "" {
t.Skip("TEST_MANTICORE_URL nicht gesetzt, Integrationstest übersprungen")
}
client := search.NewClient(baseURL)
if err := client.EnsureSchema(context.Background()); err != nil {
t.Fatalf("schema sicherstellen: %v", err)
}
check := SearchIndexCheck(client)
if err := check(context.Background()); err != nil {
t.Fatalf("SearchIndexCheck gegen echte instanz fehlgeschlagen: %v", err)
}
}
+110
View File
@@ -0,0 +1,110 @@
// Package healthcheck implementiert INT-07: den Health-Check-Endpunkt
// für das Mail-Modul (Erreichbarkeit von Datenbank, Objektspeicher,
// Suchindex und Jobqueue, getrennt gemeldet).
//
// Core API-01 (REST-Grundgerüst) hat im aktuellen Repository-Stand
// keinen abrufbaren Router (gleiche Situation wie bei ARC-06/Core
// TEN-01 und mail/internal/mailapi, INT-01) — RegisterRoutes
// registriert den Endpunkt deshalb auf einem vom Aufrufer
// bereitgestellten *http.ServeMux mit demselben Pfadschema
// "/api/v1/mail/..." wie mailapi.
package healthcheck
import (
"context"
"encoding/json"
"net/http"
"sync"
)
// Status-Werte (Akzeptanzkriterium 3: "degraded" statt generischem
// Fehler).
const (
StatusOK = "ok"
StatusDegraded = "degraded"
)
// CheckFunc prüft EINE Abhängigkeit. Ein Fehler bedeutet "nicht
// erreichbar" — der Fehlertext selbst landet NIE in der HTTP-Antwort
// (Akzeptanzkriterium 2: keine sensiblen Konfigurationsdetails),
// höchstens im Server-Log des Aufrufers.
type CheckFunc func(ctx context.Context) error
// namedCheck bindet einen Komponentennamen an seine Prüffunktion, in
// registrierter Reihenfolge (deterministische Antwortreihenfolge).
type namedCheck struct {
name string
fn CheckFunc
}
// Checker sammelt benannte Abhängigkeitsprüfungen.
type Checker struct {
mu sync.Mutex
checks []namedCheck
}
func NewChecker() *Checker {
return &Checker{}
}
// Register fügt eine benannte Prüfung hinzu (Akzeptanzkriterium 1: je
// Komponente getrennt gemeldet).
func (c *Checker) Register(name string, fn CheckFunc) {
c.mu.Lock()
defer c.mu.Unlock()
c.checks = append(c.checks, namedCheck{name: name, fn: fn})
}
// ComponentStatus ist der Status EINER geprüften Abhängigkeit — ohne
// Fehlertext (Akzeptanzkriterium 2).
type ComponentStatus struct {
Name string `json:"name"`
Status string `json:"status"`
}
// Result ist die vollständige Health-Antwort.
type Result struct {
Status string `json:"status"`
Components []ComponentStatus `json:"components"`
}
// Check führt alle registrierten Prüfungen aus (Akzeptanzkriterium 1:
// getrennt je Komponente). Gesamtstatus ist "degraded", sobald
// MINDESTENS eine Komponente fehlschlägt (Akzeptanzkriterium 3).
func (c *Checker) Check(ctx context.Context) Result {
c.mu.Lock()
checks := make([]namedCheck, len(c.checks))
copy(checks, c.checks)
c.mu.Unlock()
result := Result{Status: StatusOK, Components: make([]ComponentStatus, 0, len(checks))}
for _, nc := range checks {
status := StatusOK
if err := nc.fn(ctx); err != nil {
status = StatusDegraded
result.Status = StatusDegraded
}
result.Components = append(result.Components, ComponentStatus{Name: nc.name, Status: status})
}
return result
}
// ServeHTTP liefert den Health-Status als JSON. Ohne Authentifizierung
// erreichbar (Akzeptanzkriterium 2) — der Inhalt selbst enthält
// ausschließlich Komponentenname + ok/degraded, nie Fehlertexte,
// Verbindungszeichenfolgen oder sonstige Konfigurationsdetails.
func (c *Checker) ServeHTTP(w http.ResponseWriter, r *http.Request) {
result := c.Check(r.Context())
status := http.StatusOK
if result.Status == StatusDegraded {
status = http.StatusServiceUnavailable
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(status)
_ = json.NewEncoder(w).Encode(result)
}
// RegisterRoutes registriert den Health-Endpunkt auf mux.
func (c *Checker) RegisterRoutes(mux *http.ServeMux) {
mux.HandleFunc("GET /api/v1/mail/health", c.ServeHTTP)
}
@@ -0,0 +1,133 @@
package healthcheck
import (
"context"
"encoding/json"
"errors"
"net/http"
"net/http/httptest"
"strings"
"testing"
)
// TestCheck_SimulatedDependencyFailureReflectedCorrectly ist die
// geforderte Pflichtprüfung 1 (INT-07): simulierter Ausfall einer
// Abhängigkeit wird korrekt im Health-Status abgebildet.
func TestCheck_SimulatedDependencyFailureReflectedCorrectly(t *testing.T) {
c := NewChecker()
c.Register("database", func(context.Context) error { return nil })
c.Register("object_storage", func(context.Context) error { return errors.New("bucket nicht erreichbar") })
c.Register("search_index", func(context.Context) error { return nil })
c.Register("jobqueue", func(context.Context) error { return nil })
result := c.Check(context.Background())
if result.Status != StatusDegraded {
t.Fatalf("erwartete gesamtstatus %q bei einem ausgefallenen abhängigkeit, habe %q", StatusDegraded, result.Status)
}
if len(result.Components) != 4 {
t.Fatalf("erwartete 4 komponenten, habe %d", len(result.Components))
}
for _, comp := range result.Components {
want := StatusOK
if comp.Name == "object_storage" {
want = StatusDegraded
}
if comp.Status != want {
t.Fatalf("komponente %q: erwartete status %q, habe %q", comp.Name, want, comp.Status)
}
}
}
// TestCheck_AllHealthyReportsOK stellt sicher, dass ein vollständig
// gesunder Zustand nicht fälschlich als degraded gilt.
func TestCheck_AllHealthyReportsOK(t *testing.T) {
c := NewChecker()
c.Register("database", func(context.Context) error { return nil })
c.Register("object_storage", func(context.Context) error { return nil })
result := c.Check(context.Background())
if result.Status != StatusOK {
t.Fatalf("erwartete %q, habe %q", StatusOK, result.Status)
}
}
// TestServeHTTP_ResponseNeverContainsSensitiveErrorDetails ist die
// geforderte Pflichtprüfung 2 (INT-07): Health-Antwort enthält keine
// sensiblen Konfigurationsdetails — ein absichtlich mit einer
// Verbindungszeichenfolge/einem Geheimnis versehener Prüffehler darf
// NIRGENDS in der HTTP-Antwort auftauchen.
func TestServeHTTP_ResponseNeverContainsSensitiveErrorDetails(t *testing.T) {
const secretDSN = "postgresql://nexarch:s3hr-geheimes-passwort@db.internal:5432/tenant_x"
c := NewChecker()
c.Register("database", func(context.Context) error {
return errors.New("verbindung fehlgeschlagen: " + secretDSN)
})
req := httptest.NewRequest(http.MethodGet, "/api/v1/mail/health", nil)
rec := httptest.NewRecorder()
c.ServeHTTP(rec, req)
body := rec.Body.String()
if strings.Contains(body, secretDSN) || strings.Contains(body, "geheimes-passwort") {
t.Fatalf("health-antwort enthält sensible details: %s", body)
}
var parsed Result
if err := json.Unmarshal(rec.Body.Bytes(), &parsed); err != nil {
t.Fatalf("antwort ist kein gültiges JSON: %v", err)
}
if parsed.Status != StatusDegraded {
t.Fatalf("erwartete degraded, habe %q", parsed.Status)
}
if rec.Code != http.StatusServiceUnavailable {
t.Fatalf("erwartete HTTP 503 bei degraded, habe %d", rec.Code)
}
}
// TestServeHTTP_HealthyReturns200 bestätigt den positiven HTTP-Status.
func TestServeHTTP_HealthyReturns200(t *testing.T) {
c := NewChecker()
c.Register("database", func(context.Context) error { return nil })
req := httptest.NewRequest(http.MethodGet, "/api/v1/mail/health", nil)
rec := httptest.NewRecorder()
c.ServeHTTP(rec, req)
if rec.Code != http.StatusOK {
t.Fatalf("erwartete HTTP 200, habe %d", rec.Code)
}
}
// TestIntegration_RealHTTPEndpointAfterDeploy ist die geforderte
// Pflichtprüfung 3 (INT-07): Integrationstest gegen einen echten,
// laufenden Health-Endpunkt (realer HTTP-Server, reale Anfrage über
// das Netzwerk — kein direkter Funktionsaufruf).
func TestIntegration_RealHTTPEndpointAfterDeploy(t *testing.T) {
c := NewChecker()
c.Register("database", func(context.Context) error { return nil })
c.Register("object_storage", func(context.Context) error { return nil })
c.Register("search_index", func(context.Context) error { return nil })
c.Register("jobqueue", func(context.Context) error { return nil })
mux := http.NewServeMux()
c.RegisterRoutes(mux)
srv := httptest.NewServer(mux)
defer srv.Close()
resp, err := http.Get(srv.URL + "/api/v1/mail/health")
if err != nil {
t.Fatalf("get: %v", err)
}
defer func() { _ = resp.Body.Close() }()
if resp.StatusCode != http.StatusOK {
t.Fatalf("erwartete 200, habe %d", resp.StatusCode)
}
var result Result
if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
t.Fatalf("antwort dekodieren: %v", err)
}
if result.Status != StatusOK || len(result.Components) != 4 {
t.Fatalf("unerwartetes ergebnis: %+v", result)
}
}
@@ -0,0 +1,52 @@
// Package importnotify verbindet mail/internal/imapimport (ING-01/IMP-01)
// mit mail/internal/notifyclient (INT-05, Core CFG-02/CFG-05):
// genau EINE Benachrichtigung je abgeschlossenem Abgleichslauf
// (imapimport.SyncResult), nicht eine je neuer Nachricht
// (Akzeptanzkriterium 3: gebündelt statt Flut bei Massenimport).
package importnotify
import (
"context"
"fmt"
"gitea.perlbach24.de/scripte/nexarch/mail/internal/imapimport"
"gitea.perlbach24.de/scripte/nexarch/mail/internal/notifyclient"
)
// eventTypeMailNew ist der bei Core registrierte Ereignistyp für neu
// importierte Mails.
const eventTypeMailNew = "mail.new"
// Notifier ist die für NotifyBatch benötigte Teilmenge von
// *notifyclient.Client — als Schnittstelle für Tests ohne echten HTTP-
// Server.
type Notifier interface {
Notify(ctx context.Context, ev notifyclient.Event) error
}
// NotifyBatch löst — falls result.NewMessages > 0 — GENAU EINE
// Benachrichtigung für den gesamten Abgleichslauf aus
// (Akzeptanzkriterium 1: neue Mail löst zeitnah ein Ereignis aus;
// Akzeptanzkriterium 3: Massenimport erzeugt eine gebündelte
// Zusammenfassung statt Dutzende Einzelbenachrichtigungen — es gibt in
// diesem Paket schlicht KEINEN Codepfad, der mehr als einen Notify-
// Aufruf je Abgleichslauf absetzt). Bei result.NewMessages == 0 wird
// nichts gesendet.
//
// Ein Fehler beim Senden wird zurückgeliefert, blockiert aber
// strukturell NIE die bereits abgeschlossene Nachrichtenübernahme —
// NotifyBatch wird vom Aufrufer NACH dem erfolgreichen
// imapimport.RunOnce aufgerufen, nie währenddessen, und ein Fehler
// hier nimmt keine bereits persistierte Nachricht zurück.
func NotifyBatch(ctx context.Context, notifier Notifier, tenantSlug, mailboxName string, result imapimport.SyncResult) error {
if result.NewMessages == 0 {
return nil
}
summary := fmt.Sprintf("%d neue Mail(s) in %s", result.NewMessages, mailboxName)
return notifier.Notify(ctx, notifyclient.Event{
TenantSlug: tenantSlug,
EventType: eventTypeMailNew,
Summary: summary,
Count: result.NewMessages,
})
}
@@ -0,0 +1,101 @@
package importnotify
import (
"context"
"net/http"
"net/http/httptest"
"sync"
"testing"
"gitea.perlbach24.de/scripte/nexarch/mail/internal/imapimport"
"gitea.perlbach24.de/scripte/nexarch/mail/internal/notifyclient"
)
type recordingNotifier struct {
mu sync.Mutex
events []notifyclient.Event
}
func (r *recordingNotifier) Notify(_ context.Context, ev notifyclient.Event) error {
r.mu.Lock()
defer r.mu.Unlock()
r.events = append(r.events, ev)
return nil
}
func (r *recordingNotifier) count() int {
r.mu.Lock()
defer r.mu.Unlock()
return len(r.events)
}
// TestNotifyBatch_SingleNewMessageTriggersExactlyOneNotification ist
// die geforderte Pflichtprüfung 1 (INT-05): Import einer Mail löst
// genau eine Benachrichtigung aus.
func TestNotifyBatch_SingleNewMessageTriggersExactlyOneNotification(t *testing.T) {
n := &recordingNotifier{}
err := NotifyBatch(context.Background(), n, "mandant-a", "INBOX", imapimport.SyncResult{NewMessages: 1})
if err != nil {
t.Fatalf("NotifyBatch: %v", err)
}
if n.count() != 1 {
t.Fatalf("erwartete genau 1 benachrichtigung, habe %d", n.count())
}
if n.events[0].Count != 1 || n.events[0].TenantSlug != "mandant-a" {
t.Fatalf("unerwartetes ereignis: %+v", n.events[0])
}
}
// TestNotifyBatch_MassImportProducesOneBundledNotification ist die
// geforderte Pflichtprüfung 2 (INT-05): Massenimport erzeugt eine
// gebündelte Zusammenfassung statt Dutzende Einzelbenachrichtigungen.
func TestNotifyBatch_MassImportProducesOneBundledNotification(t *testing.T) {
n := &recordingNotifier{}
err := NotifyBatch(context.Background(), n, "mandant-a", "INBOX", imapimport.SyncResult{NewMessages: 50})
if err != nil {
t.Fatalf("NotifyBatch: %v", err)
}
if n.count() != 1 {
t.Fatalf("erwartete genau 1 GEBÜNDELTE benachrichtigung für 50 neue nachrichten, habe %d einzelne", n.count())
}
if n.events[0].Count != 50 {
t.Fatalf("erwartete gebündelte anzahl 50, habe %d", n.events[0].Count)
}
}
// TestNotifyBatch_NoNewMessagesSendsNothing stellt sicher, dass ein
// Abgleichslauf ohne neue Nachrichten keine Benachrichtigung auslöst.
func TestNotifyBatch_NoNewMessagesSendsNothing(t *testing.T) {
n := &recordingNotifier{}
if err := NotifyBatch(context.Background(), n, "mandant-a", "INBOX", imapimport.SyncResult{NewMessages: 0}); err != nil {
t.Fatalf("NotifyBatch: %v", err)
}
if n.count() != 0 {
t.Fatalf("erwartete keine benachrichtigung ohne neue nachrichten, habe %d", n.count())
}
}
// TestNotifyBatch_DisabledNotificationDeliversNothing ist die
// geforderte Pflichtprüfung 3 (INT-05): deaktivierte Benachrichtigung
// erzeugt keine Zustellung — real gegen einen echten HTTP-Server
// geprüft, der den CFG-05-Vertrag nachbildet: 204 bedeutet "durch
// Benutzerpräferenz unterdrückt". NotifyBatch ruft trotzdem exakt
// einmal auf (die Unterdrückungsentscheidung liegt bei Core, nicht bei
// Mail), der Aufruf selbst liefert keinen Fehler.
func TestNotifyBatch_DisabledNotificationDeliversNothing(t *testing.T) {
var callCount int
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
callCount++
w.WriteHeader(http.StatusNoContent) // "durch benutzerpräferenz unterdrückt"
}))
defer srv.Close()
client := notifyclient.NewClient(srv.URL, "test-service-token")
err := NotifyBatch(context.Background(), client, "mandant-a", "INBOX", imapimport.SyncResult{NewMessages: 1})
if err != nil {
t.Fatalf("NotifyBatch: %v", err)
}
if callCount != 1 {
t.Fatalf("erwartete genau 1 aufruf an den (unterdrückenden) server, habe %d", callCount)
}
}
+87
View File
@@ -0,0 +1,87 @@
// Package notifyclient implementiert die Mail-seitige Kopplung an Core
// CFG-02/CFG-05 (INT-05): ein zentraler Dispatcher übernimmt Warteschlange,
// Wiederholungslogik, Kanal-Abstraktion UND — laut CFG-05s eigener
// Beschreibung ("internal/notifyprefs.EnqueueIfAllowed als HTTP-Endpunkt")
// — die Prüfung, ob der Benutzer diese Benachrichtigungsart überhaupt
// wünscht. Mail baut deshalb bewusst KEINE eigene
// Benachrichtigungs-/Präferenzlogik, sondern ruft ausschließlich den
// dokumentierten Vertrag "POST /notify" auf.
//
// Core CFG-02/CFG-05 stehen auf core-kanban zwar auf "Fertig", enthalten
// im aktuellen Repository-Stand aber keinen abrufbaren Endpunkt (gleiche
// Situation wie ARC-06/Core TEN-01, INT-01/Core API-01) — Client richtet
// sich nach dem im Core-Board dokumentierten Vertrag (service-token-
// authentifiziertes POST /notify), siehe INT-05-Prüfprotokoll.
package notifyclient
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"time"
)
// Event ist eine einzelne Benachrichtigung an den Core-Dispatcher.
type Event struct {
TenantSlug string `json:"tenant_slug"`
EventType string `json:"event_type"`
Summary string `json:"summary"`
Count int `json:"count"`
}
// Client ruft Core CFG-05s "POST /notify" auf.
type Client struct {
baseURL string
serviceToken string
httpClient *http.Client
}
// NewClient erstellt einen Client. baseURL und serviceToken kommen
// ausschließlich vom Aufrufer (Umgebungsvariable) — keine
// Zugangsdaten im Code.
func NewClient(baseURL, serviceToken string) *Client {
return &Client{
baseURL: baseURL,
serviceToken: serviceToken,
httpClient: &http.Client{Timeout: 5 * time.Second},
}
}
// Notify sendet EIN Ereignis. Ein HTTP-Fehler (Netzwerk, 5xx) wird als
// Fehler zurückgeliefert — der Aufrufer entscheidet, ob das den
// regulären Mail-Betrieb blockiert (siehe importnotify: Notify läuft
// NIE im Importpfad selbst, ein Fehler hier verhindert keine bereits
// abgeschlossene Nachrichtenübernahme). Ein 2xx- ODER 204-Status gilt
// als Erfolg — 204 bedeutet laut CFG-05s EnqueueIfAllowed-Vertrag
// "durch Benutzerpräferenz unterdrückt, kein Fehler".
func (c *Client) Notify(ctx context.Context, ev Event) error {
body, err := json.Marshal(ev)
if err != nil {
return fmt.Errorf("notifyclient: ereignis serialisieren: %w", err)
}
req, err := http.NewRequestWithContext(ctx, http.MethodPost, c.baseURL+"/notify", bytes.NewReader(body))
if err != nil {
return fmt.Errorf("notifyclient: anfrage bauen: %w", err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer "+c.serviceToken)
resp, err := c.httpClient.Do(req)
if err != nil {
return fmt.Errorf("notifyclient: /notify aufrufen: %w", err)
}
defer func() { _ = resp.Body.Close() }()
respBody, _ := io.ReadAll(resp.Body)
// 2xx (inkl. 204 "No Content") gilt als Erfolg — 204 bedeutet laut
// CFG-05s EnqueueIfAllowed-Vertrag "durch Benutzerpräferenz
// unterdrückt", was Mail nicht als Fehler behandelt (die
// Zustell-/Präferenzentscheidung ist bewusst Core-Sache).
if resp.StatusCode >= 200 && resp.StatusCode < 300 {
return nil
}
return fmt.Errorf("notifyclient: /notify status %d: %s", resp.StatusCode, string(respBody))
}
+86
View File
@@ -0,0 +1,86 @@
package notifyclient
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
)
// TestNotify_SendsEventToRealHTTPServer ist ein echter Ende-zu-Ende-Test
// gegen einen echten, laufenden HTTP-Server (kein Mock der
// Standardbibliothek umgangen) — Core CFG-02/CFG-05 haben im aktuellen
// Repository-Stand keinen abrufbaren Endpunkt (siehe Paketkommentar),
// dieser Server implementiert den in CFG-05 dokumentierten Vertrag
// (service-token-authentifiziertes POST /notify) real.
func TestNotify_SendsEventToRealHTTPServer(t *testing.T) {
var gotToken string
var gotEvent Event
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodPost || r.URL.Path != "/notify" {
http.NotFound(w, r)
return
}
gotToken = r.Header.Get("Authorization")
_ = json.NewDecoder(r.Body).Decode(&gotEvent)
w.WriteHeader(http.StatusAccepted)
}))
defer srv.Close()
client := NewClient(srv.URL, "test-service-token")
err := client.Notify(context.Background(), Event{TenantSlug: "mandant-a", EventType: "mail.new", Summary: "3 neue Mails", Count: 3})
if err != nil {
t.Fatalf("Notify: %v", err)
}
if gotToken != "Bearer test-service-token" {
t.Fatalf("erwartete service-token-header, habe: %q", gotToken)
}
if gotEvent.TenantSlug != "mandant-a" || gotEvent.Count != 3 {
t.Fatalf("unerwartetes ereignis beim server angekommen: %+v", gotEvent)
}
}
// TestNotify_TreatsNoContentAsSuppressedNotAsError bestätigt: ein
// 204-Status (laut CFG-05-Vertrag "durch Benutzerpräferenz unterdrückt")
// wird NICHT als Fehler behandelt.
func TestNotify_TreatsNoContentAsSuppressedNotAsError(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusNoContent)
}))
defer srv.Close()
client := NewClient(srv.URL, "test-service-token")
if err := client.Notify(context.Background(), Event{TenantSlug: "mandant-a", EventType: "mail.new"}); err != nil {
t.Fatalf("erwartete keinen fehler bei 204 (unterdrückt), habe: %v", err)
}
}
// TestNotify_ReturnsErrorOnServerFailure stellt sicher, dass ein
// echter Serverfehler (5xx) als Fehler durchgereicht wird — der
// Aufrufer (importnotify) entscheidet, wie damit umgegangen wird.
func TestNotify_ReturnsErrorOnServerFailure(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusInternalServerError)
_, _ = w.Write([]byte("boom"))
}))
defer srv.Close()
client := NewClient(srv.URL, "test-service-token")
if err := client.Notify(context.Background(), Event{TenantSlug: "mandant-a", EventType: "mail.new"}); err == nil {
t.Fatal("erwartete fehler bei 500")
}
}
// TestNotify_UnreachableEndpointReturnsErrorWithoutHanging bestätigt,
// dass ein nicht erreichbarer Endpunkt zeitnah einen Fehler liefert
// (Timeout im Client konfiguriert) statt unbegrenzt zu blockieren —
// Grundlage für INT-09/INT-10s "fail open"-Prinzip, hier für INT-05
// mitgeprüft.
func TestNotify_UnreachableEndpointReturnsErrorWithoutHanging(t *testing.T) {
client := NewClient("http://127.0.0.1:1", "test-service-token") // Port 1: garantiert nichts lauscht dort
err := client.Notify(context.Background(), Event{TenantSlug: "mandant-a", EventType: "mail.new"})
if err == nil {
t.Fatal("erwartete fehler bei nicht erreichbarem endpunkt")
}
}