Go · 7050 bytes Raw Blame History
1 // SPDX-License-Identifier: AGPL-3.0-or-later
2
3 // Package web boots the shithub HTTP server. The full middleware stack
4 // (recover, request_id, logging, real-IP, timeout, compress, secure
5 // headers, CSRF, session, CORS, metrics, tracing), the chi router, the
6 // session store, the styled error pages, and the observability sinks
7 // (logging, metrics, tracing, error reporting) are composed here.
8 package web
9
10 import (
11 "context"
12 "encoding/base64"
13 "errors"
14 "fmt"
15 "log/slog"
16 "net/http"
17 "os"
18 "os/signal"
19 "syscall"
20 "time"
21
22 "github.com/go-chi/chi/v5"
23 "github.com/jackc/pgx/v5/pgxpool"
24 "golang.org/x/crypto/chacha20poly1305"
25
26 "github.com/tenseleyFlow/shithub/internal/auth/session"
27 "github.com/tenseleyFlow/shithub/internal/infra/config"
28 "github.com/tenseleyFlow/shithub/internal/infra/db"
29 "github.com/tenseleyFlow/shithub/internal/infra/errrep"
30 infralog "github.com/tenseleyFlow/shithub/internal/infra/log"
31 "github.com/tenseleyFlow/shithub/internal/infra/metrics"
32 "github.com/tenseleyFlow/shithub/internal/infra/tracing"
33 "github.com/tenseleyFlow/shithub/internal/web/handlers"
34 "github.com/tenseleyFlow/shithub/internal/web/middleware"
35 )
36
37 // Options configures the web server. Addr overrides config when non-empty
38 // (preserves the existing --addr CLI flag behavior).
39 type Options struct {
40 Addr string
41 }
42
43 // Run boots the web server and blocks until shutdown.
44 func Run(ctx context.Context, opts Options) error {
45 cfg, err := config.Load(nil)
46 if err != nil {
47 return err
48 }
49 if opts.Addr != "" {
50 cfg.Web.Addr = opts.Addr
51 }
52
53 logger := infralog.New(infralog.Options{
54 Level: cfg.Log.Level,
55 Format: cfg.Log.Format,
56 Writer: os.Stderr,
57 })
58
59 // Error reporting (no-op when DSN empty).
60 flushErrRep, err := errrep.Init(errrep.Config{
61 DSN: cfg.ErrorReporting.DSN,
62 Environment: cfg.ErrorReporting.Environment,
63 Release: cfg.ErrorReporting.Release,
64 })
65 if err != nil {
66 return fmt.Errorf("errrep: %w", err)
67 }
68 defer func() { _ = flushErrRep(context.Background()) }()
69 if cfg.ErrorReporting.DSN != "" {
70 // Wrap the slog handler so error-level records are reported.
71 // We rebuild the logger so every component that pulls it from
72 // here gets the wrapped chain.
73 logger = slog.New(&errrep.SlogHandler{Inner: logger.Handler()})
74 }
75
76 // Tracing (no-op when disabled).
77 flushTracing, err := tracing.Init(ctx, tracing.Config{
78 Enabled: cfg.Tracing.Enabled,
79 Endpoint: cfg.Tracing.Endpoint,
80 SampleRate: cfg.Tracing.SampleRate,
81 ServiceName: cfg.Tracing.ServiceName,
82 })
83 if err != nil {
84 return fmt.Errorf("tracing: %w", err)
85 }
86 defer func() { _ = flushTracing(context.Background()) }()
87
88 logoBytes, err := LogoSVG()
89 if err != nil {
90 return fmt.Errorf("load logo: %w", err)
91 }
92
93 sessionStore, err := buildSessionStore(cfg.Session, logger)
94 if err != nil {
95 return err
96 }
97
98 // Optional DB pool (carried over from S01); now driven by config.
99 var pool *pgxpool.Pool
100 if cfg.DB.URL != "" {
101 //nolint:gosec // G115: max_conns is operator-configured with small numeric values (typ. 10–100).
102 p, err := db.Open(ctx, db.Config{
103 URL: cfg.DB.URL,
104 MaxConns: int32(cfg.DB.MaxConns),
105 MinConns: int32(cfg.DB.MinConns),
106 ConnectTimeout: cfg.DB.ConnectTimeout,
107 })
108 if err != nil {
109 logger.Warn("db: open failed; /readyz will report unhealthy", "error", err)
110 } else {
111 pool = p
112 defer p.Close()
113 metrics.ObserveDBPool(ctx, pool, 10*time.Second)
114 }
115 }
116
117 r := chi.NewRouter()
118
119 // Middleware stack — outermost first.
120 r.Use(middleware.RequestID)
121 r.Use(middleware.RealIP(middleware.RealIPConfig{}))
122 r.Use(middleware.AccessLog(logger))
123 r.Use(middleware.Metrics)
124 if cfg.Tracing.Enabled {
125 r.Use(tracing.Middleware)
126 }
127 r.Use(middleware.SecureHeaders(middleware.DefaultSecureHeaders()))
128 r.Use(middleware.Compress)
129 r.Use(middleware.Timeout(30 * time.Second))
130 r.Use(middleware.SessionLoader(sessionStore, logger))
131
132 deps := handlers.Deps{
133 Logger: logger,
134 TemplatesFS: TemplatesFS(),
135 StaticFS: StaticFS(),
136 LogoSVG: string(logoBytes),
137 SessionStore: sessionStore,
138 }
139 if pool != nil {
140 deps.ReadyCheck = func(ctx context.Context) error { return pool.Ping(ctx) }
141 }
142 if cfg.Metrics.Enabled {
143 deps.MetricsHandler = metrics.Handler(cfg.Metrics.BasicAuthUser, cfg.Metrics.BasicAuthPass)
144 }
145
146 _, panicHandler, notFoundHandler, err := handlers.RegisterChi(r, deps)
147 if err != nil {
148 return fmt.Errorf("register handlers: %w", err)
149 }
150 r.NotFound(notFoundHandler)
151
152 rootHandler := middleware.Recover(logger, panicHandler)(r)
153
154 srv := &http.Server{
155 Addr: cfg.Web.Addr,
156 Handler: rootHandler,
157 ReadHeaderTimeout: 10 * time.Second,
158 ReadTimeout: cfg.Web.ReadTimeout,
159 WriteTimeout: cfg.Web.WriteTimeout,
160 IdleTimeout: 120 * time.Second,
161 }
162
163 errCh := make(chan error, 1)
164 go func() {
165 logger.Info(
166 "shithub web server starting",
167 "addr", srv.Addr,
168 "env", cfg.Env,
169 "db", pool != nil,
170 "metrics", cfg.Metrics.Enabled,
171 "tracing", cfg.Tracing.Enabled,
172 "errrep", cfg.ErrorReporting.DSN != "",
173 )
174 if err := srv.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
175 errCh <- err
176 }
177 close(errCh)
178 }()
179
180 sigCh := make(chan os.Signal, 1)
181 signal.Notify(sigCh, syscall.SIGINT, syscall.SIGTERM)
182 defer signal.Stop(sigCh)
183
184 select {
185 case err, ok := <-errCh:
186 if !ok {
187 return nil
188 }
189 return err
190 case sig := <-sigCh:
191 logger.Info("shutdown signal received", "signal", sig.String())
192 case <-ctx.Done():
193 logger.Info("context canceled, shutting down")
194 }
195
196 shutdownCtx, cancel := context.WithTimeout(context.Background(), cfg.Web.ShutdownTimeout)
197 defer cancel()
198 if err := srv.Shutdown(shutdownCtx); err != nil {
199 return fmt.Errorf("shutdown: %w", err)
200 }
201 return nil
202 }
203
204 // buildSessionStore constructs the cookie session store from the config's
205 // session block. SHITHUB_SESSION_KEY (env) overrides cfg.KeyB64 when set.
206 func buildSessionStore(cfg config.SessionConfig, logger *slog.Logger) (session.Store, error) {
207 keyB64 := os.Getenv("SHITHUB_SESSION_KEY")
208 if keyB64 == "" {
209 keyB64 = cfg.KeyB64
210 }
211 var key []byte
212 if keyB64 != "" {
213 decoded, err := base64.StdEncoding.DecodeString(keyB64)
214 if err != nil {
215 return nil, fmt.Errorf("session key: invalid base64: %w", err)
216 }
217 if len(decoded) != chacha20poly1305.KeySize {
218 return nil, fmt.Errorf("session key: must be %d bytes, got %d",
219 chacha20poly1305.KeySize, len(decoded))
220 }
221 key = decoded
222 } else {
223 generated, err := session.GenerateKey()
224 if err != nil {
225 return nil, fmt.Errorf("session key: generate: %w", err)
226 }
227 key = generated
228 logger.Warn(
229 "session: no key configured; generated an ephemeral key (sessions will not survive restart)",
230 "hint", "set SHITHUB_SESSION_KEY=<base64 32-byte> or session.key_b64 in production",
231 )
232 }
233 store, err := session.NewCookieStore(session.CookieStoreConfig{
234 Key: key,
235 MaxAge: cfg.MaxAge,
236 Secure: cfg.Secure,
237 })
238 if err != nil {
239 return nil, fmt.Errorf("session: build store: %w", err)
240 }
241 return store, nil
242 }
243