Rene Nochebuena
ad2a9e465e
Standalone net/http middleware for panic recovery, CORS, request ID injection, and request logging. What's included: - Recover(): panic -> 500, captures debug.Stack, no logger required - CORS(origins): OPTIONS 204 preflight, origin allowlist, package-wide method/header constants - RequestID(generator): injects ID via logz.WithRequestID, sets X-Request-ID response header - RequestLogger(logger): logs method/path/status/latency/request_id; Error for 5xx, Info otherwise - Logger interface: Info, Error, With — duck-typed; satisfied by logz.Logger - StatusRecorder: exported http.ResponseWriter wrapper that captures written status code - Direct logz import for context helpers (documented exception to ADR-001) Tested-via: todo-api POC integration Reviewed-against: docs/adr/
2.6 KiB
2.6 KiB
Changelog
All notable changes to this module will be documented in this file.
The format is based on Keep a Changelog, and this module adheres to Semantic Versioning.
0.9.0 - 2026-03-18
Added
Recover() func(http.Handler) http.Handler— catches panics from inner handlers viadefer/recover, captures the stack trace withdebug.Stack, and writes HTTP 500; requires no configuration or logger injectionCORS(origins []string) func(http.Handler) http.Handler— setsAccess-Control-Allow-Origin,Access-Control-Allow-Methods(GET, HEAD, PUT, PATCH, POST, DELETE, OPTIONS), andAccess-Control-Allow-Headers(Content-Type, Authorization, X-Request-ID) for matching origins; short-circuits OPTIONS preflight requests with HTTP 204; pass[]string{"*"}for development environmentsRequestID(generator func() string) func(http.Handler) http.Handler— callsgenerator(e.g.uuid.NewString) to produce a unique ID per request, stores it in the context vialogz.WithRequestID, and writes it to theX-Request-IDresponse headerRequestLogger(logger Logger) func(http.Handler) http.Handler— logs method, path, status code, latency, and request ID after the inner handler returns; useslogger.Errorfor 5xx responses andlogger.Infofor all others; reads the request ID from context vialogz.GetRequestIDLoggerinterface — duck-typed logger accepted byRequestLogger; satisfied bylogz.Logger:Info(msg string, args ...any),Error(msg string, err error, args ...any),With(args ...any) LoggerStatusRecorderstruct — exportedhttp.ResponseWriterwrapper that captures the written status code in itsStatusfield; used internally byRequestLoggerand available for custom logging middleware
Design Notes
RequestIDandRequestLoggeruselogz.WithRequestIDandlogz.GetRequestIDdirectly rather than a locally defined context key; this ensures the request ID is visible to anylogz.Loggerthat calls.WithContext(ctx)downstream, which would break if the key were re-implemented here.Recoverintentionally requires no logger injection in this release: it captures the stack trace but does not log it, keeping the middleware usable with zero configuration; logger injection is deferred to a future release.- No middleware is installed by default; the package exports independent functions and the application chooses the chain and order (recommended:
Recover→RequestID→RequestLogger→CORS).