Let fx own signals and the exit code in the server example (closes #86)
check / check (push) Waiting to run
check / check (push) Waiting to run
The lifecycle example computed an exit code that never reached os.Exit, installed its own SIGINT/SIGTERM handler beside the one fx's Run() installs, and exited from a goroutine when Sentry failed to start, so no stop hook ran. Now only fx handles those signals; a listen error asks fx to shut down with exit code 1 through fx.Shutdowner; Sentry's error is returned from the server's start hook; and the server's stop hook shuts the HTTP server down within 5 seconds and fails when requests are still running. A new paragraph says who owns signals and the exit code. SIGPIPE is still ignored, now in main. Model: opus-5-5
This commit is contained in:
@@ -21,6 +21,15 @@ fmt-check, and commit.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-04: Fixed the server lifecycle example in
|
||||||
|
`prompts/GO_HTTP_SERVER_CONVENTIONS.md` (issue 86). Only fx handles SIGINT and
|
||||||
|
SIGTERM, and `Run()` in `main` exits with the shutdown's exit code. A listen
|
||||||
|
error asks fx to shut down with exit code 1 through `fx.Shutdowner`; a Sentry
|
||||||
|
start failure is returned from the server's start hook instead of calling
|
||||||
|
`os.Exit` from a goroutine, so the stop hooks of what had started still run.
|
||||||
|
The server's stop hook shuts the HTTP server down within 5 seconds and fails
|
||||||
|
when requests are still running. A new paragraph says who owns signals and the
|
||||||
|
exit code.
|
||||||
- 2026-10-04: `REPO_POLICIES.md` now says how a Go tool a repo needs on the host
|
- 2026-10-04: `REPO_POLICIES.md` now says how a Go tool a repo needs on the host
|
||||||
is pinned (issue 37): installed with `go install` pinned to a commit hash,
|
is pinned (issue 37): installed with `go install` pinned to a commit hash,
|
||||||
never tracked as a `go.mod` tool dependency or through a `tools.go` file.
|
never tracked as a `go.mod` tool dependency or through a `tools.go` file.
|
||||||
|
|||||||
@@ -106,6 +106,9 @@ project-root/
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"os/signal"
|
||||||
|
"syscall"
|
||||||
|
|
||||||
"yourproject/internal/config"
|
"yourproject/internal/config"
|
||||||
"yourproject/internal/database"
|
"yourproject/internal/database"
|
||||||
"yourproject/internal/globals"
|
"yourproject/internal/globals"
|
||||||
@@ -126,6 +129,9 @@ func main() {
|
|||||||
globals.Appname = Appname
|
globals.Appname = Appname
|
||||||
globals.Version = Version
|
globals.Version = Version
|
||||||
|
|
||||||
|
// A write to a closed stdout or stderr must not end the process.
|
||||||
|
signal.Ignore(syscall.SIGPIPE)
|
||||||
|
|
||||||
fx.New(
|
fx.New(
|
||||||
fx.Provide(
|
fx.Provide(
|
||||||
config.New,
|
config.New,
|
||||||
@@ -198,7 +204,8 @@ Providers are resolved automatically by fx, but conceptually follow this order:
|
|||||||
Database)
|
Database)
|
||||||
6. `middleware.New` - Middleware (depends on Logger, Globals, Config)
|
6. `middleware.New` - Middleware (depends on Logger, Globals, Config)
|
||||||
7. `handlers.New` - Handlers (depends on Logger, Globals, Database, Healthcheck)
|
7. `handlers.New` - Handlers (depends on Logger, Globals, Database, Healthcheck)
|
||||||
8. `server.New` - Server (depends on all above)
|
8. `server.New` - Server (depends on all above, and on `fx.Shutdowner`, which fx
|
||||||
|
provides itself)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -217,16 +224,14 @@ type ServerParams struct {
|
|||||||
Config *config.Config
|
Config *config.Config
|
||||||
Middleware *middleware.Middleware
|
Middleware *middleware.Middleware
|
||||||
Handlers *handlers.Handlers
|
Handlers *handlers.Handlers
|
||||||
|
Shutdowner fx.Shutdowner
|
||||||
}
|
}
|
||||||
|
|
||||||
type Server struct {
|
type Server struct {
|
||||||
startupTime time.Time
|
startupTime time.Time
|
||||||
port int
|
port int
|
||||||
exitCode int
|
|
||||||
sentryEnabled bool
|
sentryEnabled bool
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
ctx context.Context
|
|
||||||
cancelFunc context.CancelFunc
|
|
||||||
httpServer *http.Server
|
httpServer *http.Server
|
||||||
router *chi.Mux
|
router *chi.Mux
|
||||||
params ServerParams
|
params ServerParams
|
||||||
@@ -248,13 +253,15 @@ func New(lc fx.Lifecycle, params ServerParams) (*Server, error) {
|
|||||||
lc.Append(fx.Hook{
|
lc.Append(fx.Hook{
|
||||||
OnStart: func(ctx context.Context) error {
|
OnStart: func(ctx context.Context) error {
|
||||||
s.startupTime = time.Now()
|
s.startupTime = time.Now()
|
||||||
go s.Run()
|
if err := s.enableSentry(); err != nil {
|
||||||
return nil
|
return err
|
||||||
},
|
}
|
||||||
OnStop: func(ctx context.Context) error {
|
s.SetupRoutes()
|
||||||
// Server shutdown logic
|
s.httpServer = s.newHTTPServer()
|
||||||
|
go s.serveUntilShutdown()
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
|
OnStop: s.cleanShutdown,
|
||||||
})
|
})
|
||||||
return s, nil
|
return s, nil
|
||||||
}
|
}
|
||||||
@@ -264,23 +271,25 @@ func New(lc fx.Lifecycle, params ServerParams) (*Server, error) {
|
|||||||
|
|
||||||
```go
|
```go
|
||||||
// internal/server/http.go
|
// internal/server/http.go
|
||||||
func (s *Server) serveUntilShutdown() {
|
func (s *Server) newHTTPServer() *http.Server {
|
||||||
listenAddr := fmt.Sprintf(":%d", s.params.Config.Port)
|
return &http.Server{
|
||||||
s.httpServer = &http.Server{
|
Addr: fmt.Sprintf(":%d", s.params.Config.Port),
|
||||||
Addr: listenAddr,
|
|
||||||
ReadTimeout: 10 * time.Second,
|
ReadTimeout: 10 * time.Second,
|
||||||
WriteTimeout: 10 * time.Second,
|
WriteTimeout: 10 * time.Second,
|
||||||
MaxHeaderBytes: 1 << 20,
|
MaxHeaderBytes: 1 << 20,
|
||||||
Handler: s,
|
Handler: s,
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
s.SetupRoutes()
|
// serveUntilShutdown returns when the stop hook shuts the HTTP server down.
|
||||||
|
// If it stops for any other reason, such as its port being taken, it asks fx
|
||||||
s.log.Info("http begin listen", "listenaddr", listenAddr)
|
// to shut down with exit code 1.
|
||||||
|
func (s *Server) serveUntilShutdown() {
|
||||||
|
s.log.Info("http begin listen", "listenaddr", s.httpServer.Addr)
|
||||||
if err := s.httpServer.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
if err := s.httpServer.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
||||||
s.log.Error("listen error", "error", err)
|
s.log.Error("listen error", "error", err)
|
||||||
if s.cancelFunc != nil {
|
if err := s.params.Shutdowner.Shutdown(fx.ExitCode(1)); err != nil {
|
||||||
s.cancelFunc()
|
s.log.Error("shutdown request failed", "error", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -292,43 +301,30 @@ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
|
|
||||||
## Signal Handling and Graceful Shutdown
|
## Signal Handling and Graceful Shutdown
|
||||||
|
|
||||||
|
fx owns SIGINT, SIGTERM and the exit code. `Run()` in `main` waits for one of
|
||||||
|
those signals or for a call to `Shutdown()` on `fx.Shutdowner`, runs the stop
|
||||||
|
hooks, and exits 0 after a signal, or with the code the call gave in
|
||||||
|
`fx.ExitCode`. It exits 1 instead when a start hook or a stop hook returns an
|
||||||
|
error; when a start hook fails, fx first runs the stop hooks of everything
|
||||||
|
already started. No other code calls `signal.Notify` or `os.Exit`: the listen
|
||||||
|
error above asks fx to shut down with `fx.ExitCode(1)`, and a Sentry start
|
||||||
|
failure is returned from the start hook. Each component releases its own
|
||||||
|
resources in its own stop hook, which fx runs in the reverse order of start.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func (s *Server) serve() int {
|
// cleanShutdown is the server's stop hook. It fails when requests are still
|
||||||
s.ctx, s.cancelFunc = context.WithCancel(context.Background())
|
// running after 5 seconds.
|
||||||
|
func (s *Server) cleanShutdown(ctx context.Context) error {
|
||||||
// Signal watcher
|
ctxShutdown, shutdownCancel := context.WithTimeout(ctx, 5*time.Second)
|
||||||
go func() {
|
defer shutdownCancel()
|
||||||
c := make(chan os.Signal, 1)
|
err := s.httpServer.Shutdown(ctxShutdown)
|
||||||
signal.Ignore(syscall.SIGPIPE)
|
|
||||||
signal.Notify(c, os.Interrupt, syscall.SIGTERM)
|
|
||||||
sig := <-c
|
|
||||||
s.log.Info("signal received", "signal", sig)
|
|
||||||
if s.cancelFunc != nil {
|
|
||||||
s.cancelFunc()
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
go s.serveUntilShutdown()
|
|
||||||
|
|
||||||
for range s.ctx.Done() {
|
|
||||||
}
|
|
||||||
s.cleanShutdown()
|
|
||||||
return s.exitCode
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Server) cleanShutdown() {
|
|
||||||
s.exitCode = 0
|
|
||||||
ctxShutdown, shutdownCancel := context.WithTimeout(context.Background(), 5*time.Second)
|
|
||||||
if err := s.httpServer.Shutdown(ctxShutdown); err != nil {
|
|
||||||
s.log.Error("server clean shutdown failed", "error", err)
|
|
||||||
}
|
|
||||||
if shutdownCancel != nil {
|
|
||||||
shutdownCancel()
|
|
||||||
}
|
|
||||||
s.cleanupForExit()
|
|
||||||
if s.sentryEnabled {
|
if s.sentryEnabled {
|
||||||
sentry.Flush(2 * time.Second)
|
sentry.Flush(2 * time.Second)
|
||||||
}
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("http server shutdown: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -1160,11 +1156,11 @@ s.router.Get("/.well-known/healthcheck", s.h.HandleHealthCheck())
|
|||||||
Sentry is conditionally enabled based on `SENTRY_DSN` environment variable:
|
Sentry is conditionally enabled based on `SENTRY_DSN` environment variable:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func (s *Server) enableSentry() {
|
func (s *Server) enableSentry() error {
|
||||||
s.sentryEnabled = false
|
s.sentryEnabled = false
|
||||||
|
|
||||||
if s.params.Config.SentryDSN == "" {
|
if s.params.Config.SentryDSN == "" {
|
||||||
return
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
err := sentry.Init(sentry.ClientOptions{
|
err := sentry.Init(sentry.ClientOptions{
|
||||||
@@ -1172,15 +1168,17 @@ func (s *Server) enableSentry() {
|
|||||||
Release: fmt.Sprintf("%s-%s", s.params.Globals.Appname, s.params.Globals.Version),
|
Release: fmt.Sprintf("%s-%s", s.params.Globals.Appname, s.params.Globals.Version),
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.log.Error("sentry init failure", "error", err)
|
return fmt.Errorf("sentry init failure: %w", err)
|
||||||
os.Exit(1)
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
s.log.Info("sentry error reporting activated")
|
s.log.Info("sentry error reporting activated")
|
||||||
s.sentryEnabled = true
|
s.sentryEnabled = true
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The server's start hook calls `enableSentry()` and returns its error, so a DSN
|
||||||
|
Sentry rejects stops startup and fx exits 1.
|
||||||
|
|
||||||
Sentry middleware with repanic (bubbles panics to chi's Recoverer):
|
Sentry middleware with repanic (bubbles panics to chi's Recoverer):
|
||||||
|
|
||||||
```go
|
```go
|
||||||
@@ -1192,7 +1190,7 @@ if s.sentryEnabled {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Flush Sentry on shutdown:
|
Flush Sentry in the server's stop hook, `cleanShutdown()`:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
if s.sentryEnabled {
|
if s.sentryEnabled {
|
||||||
|
|||||||
Reference in New Issue
Block a user