Files
web/doc.go

34 lines
1.2 KiB
Go
Raw Permalink Normal View History

feat(web): initial implementation — server, mw, httputil, health (v1.0.0) Introduces code.nochebuena.dev/einherjar/web — the HTTP transport layer of the Einherjar framework. Absorbs httpserver, httpmw, and httputil from micro-lib, replacing gorilla/mux with chi, adopting SecurityBag-native middleware, and centralizing error handling through a single httputil.Error function. server: - Server interface — embeds lifecycle.Component and chi.Router - Config struct (EINHERJAR_SERVER_* env vars); DefaultConfig - New(logger, cfg, opts...) Server; WithMiddleware option - Binds TCP synchronously in OnStart; logs "server: listening" on success - Graceful shutdown within ShutdownTimeout on OnStop mw: - Recover — catches panics, returns 500, logs at Error - RequestID — injects UUID v7 (UUID v4 fallback) into context and X-Request-ID header - RequestLogger — structured access log per request - CORS / CORSAllowAll — chi-based, applied only when origins non-empty - IPRateLimit / UserRateLimit — pluggable RateLimiterStore interface - InMemoryRateLimiterStore — token-bucket backed by golang.org/x/time/rate; background goroutine evicts stale entries every 5 minutes - StatusRecorder — wraps ResponseWriter to capture HTTP status code httputil: - Handle[Req, Res] / HandleNoBody[Res] / HandleEmpty[Req] — generic handler adapters - Error(logger, w, r, err) — derives log level from status (≥500→Error, 4xx→Warn, 499→Info); writes standardized JSON body; logz enriches *xerrors.Err automatically - JSON(w, status, v) / NoContent(w) — response helpers - HandlerFunc adapter type health: - NewHandler / NewHandlerWithConfig — runs all Checkable checks concurrently; returns JSON {status, components} with per-component latency and error - Config struct (EINHERJAR_HEALTH_CHECK_TIMEOUT, default 5s) Root factory: - web.New(logger, cfg...) Server — composes Recover+RequestID+RequestLogger+CORS in outermost-first order; CORS applied only when AllowedOrigins non-empty - server.Server interface and web/server/identifiable.go: embeds observability.Identifiable; ModulePath and ModuleVersion read via runtime/debug.ReadBuildInfo() — prints in launcher banner
2026-05-29 15:48:11 +00:00
// Package web provides the HTTP foundation for Einherjar services.
//
// The root package exposes [New] — a factory that returns a lifecycle-managed
// chi server with the recommended middleware stack pre-applied (request ID,
// panic recovery, request logging). Import the sub-packages directly for full
// control over individual components.
//
// Sub-packages:
//
// - [code.nochebuena.dev/einherjar/web/server] — lifecycle-managed chi HTTP server
// - [code.nochebuena.dev/einherjar/web/mw] — transport middleware: recover, CORS, request ID, request logger, rate limiting
// - [code.nochebuena.dev/einherjar/web/httputil] — typed handler adapters and HTTP response helpers
// - [code.nochebuena.dev/einherjar/web/health] — concurrent health check handler
//
// # Happy path
//
// logger := logz.New(logz.Config{JSON: true})
// lc := launcher.New(logger)
//
// srv := web.New(logger)
// srv.Get("/health", health.NewHandler(logger, db, cache))
//
// lc.Append(srv)
// lc.BeforeStart(func() error {
// // register routes
// return nil
// })
//
// if err := lc.Run(); err != nil {
// logger.Error("launcher failed", err)
// os.Exit(1)
// }
package web