-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathserver.go
More file actions
981 lines (865 loc) · 30.4 KB
/
Copy pathserver.go
File metadata and controls
981 lines (865 loc) · 30.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
package zerohttp
import (
"context"
"crypto/tls"
"errors"
"fmt"
"net"
"net/http"
"sync"
"time"
"github.com/alexferl/zerohttp/config"
"github.com/alexferl/zerohttp/extensions/autocert"
"github.com/alexferl/zerohttp/extensions/http3"
"github.com/alexferl/zerohttp/extensions/websocket"
"github.com/alexferl/zerohttp/extensions/webtransport"
zconfig "github.com/alexferl/zerohttp/internal/config"
"github.com/alexferl/zerohttp/log"
"github.com/alexferl/zerohttp/metrics"
"github.com/alexferl/zerohttp/sse"
)
const (
DefaultReadTimeout = 10 * time.Second
DefaultReadHeaderTimeout = 5 * time.Second
DefaultWriteTimeout = 15 * time.Second
// DefaultIdleTimeout is explicitly set to 60s.
// Note: If IdleTimeout is 0, Go falls back to ReadTimeout. We set this
// explicitly to avoid confusion and ensure the intended timeout is used.
DefaultIdleTimeout = 60 * time.Second
DefaultMaxHeaderBytes = 16 * 1024 // 16 KB -> actual limit is ~20 KB (Go adds +4096)
)
// DefaultHTTPServer returns a new http.Server with sensible defaults.
// Use this as a base when you need to customize only specific server fields
// while keeping the other defaults.
//
// Example:
//
// srv := zerohttp.DefaultHTTPServer()
// srv.ReadTimeout = 30 * time.Second
// app := zerohttp.New(zerohttp.Config{
// Server: srv,
// })
func DefaultHTTPServer() *http.Server {
return &http.Server{
ReadTimeout: DefaultReadTimeout,
ReadHeaderTimeout: DefaultReadHeaderTimeout,
WriteTimeout: DefaultWriteTimeout,
IdleTimeout: DefaultIdleTimeout,
MaxHeaderBytes: DefaultMaxHeaderBytes,
}
}
// DefaultTLSServer returns a new http.Server with sensible defaults for TLS.
// Use this as a base when you need to customize only specific TLS server fields
// while keeping the other defaults.
//
// Example:
//
// srv := zerohttp.DefaultTLSServer()
// srv.ReadTimeout = 30 * time.Second
// app := zerohttp.New(zerohttp.Config{
// TLS: TLSConfig{
// Server: srv,
// },
// })
func DefaultTLSServer() *http.Server {
return &http.Server{
ReadTimeout: DefaultReadTimeout,
ReadHeaderTimeout: DefaultReadHeaderTimeout,
WriteTimeout: DefaultWriteTimeout,
IdleTimeout: DefaultIdleTimeout,
MaxHeaderBytes: DefaultMaxHeaderBytes,
TLSConfig: &tls.Config{
MinVersion: tls.VersionTLS12,
NextProtos: []string{"h2", "http/1.1"},
},
}
}
// Server represents a zerohttp server instance that wraps Go's standard HTTP server
// with additional functionality including middleware support, TLS configuration,
// automatic certificate management, and structured logging.
//
// The Server embeds a Router interface, providing direct access to HTTP routing
// methods (GET, POST, PUT, DELETE, etc.) and middleware management.
type Server struct {
// Router provides HTTP routing functionality including method-specific
// route registration, middleware support, and request handling.
Router
// mu protects concurrent access to server fields during startup,
// shutdown, and configuration operations.
mu sync.RWMutex
// baseCtx is the root context for all requests.
// It is cancelled when Shutdown is called to signal request cancellation.
baseCtx context.Context
// cancelBaseCtx cancels the base context.
cancelBaseCtx context.CancelFunc
// server is the HTTP server instance for handling plain HTTP traffic.
// If nil, HTTP server will not be started.
server *http.Server
// listener is the network listener for HTTP traffic. If nil, a default
// listener will be created using the server's configured address.
listener net.Listener
// tlsServer is the HTTPS server instance for handling encrypted traffic.
// If nil, HTTPS server will not be started.
tlsServer *http.Server
// tlsListener is the network listener for HTTPS traffic. If nil, a default
// TLS listener will be created using the tlsServer's configured address.
tlsListener net.Listener
// certFile is the file path to the TLS certificate in PEM format.
// Used when serving HTTPS traffic with certificate files.
certFile string
// keyFile is the file path to the TLS private key in PEM format.
// Used when serving HTTPS traffic with certificate files.
keyFile string
// redirectHTTP enables automatic HTTP to HTTPS redirects when both HTTP and
// HTTPS servers are configured and running.
redirectHTTP bool
// logger is the structured logger used by the server and its middleware
// for recording HTTP requests, errors, and server lifecycle events.
logger log.Logger
// preStartupHooks execute sequentially before any startup hooks.
preStartupHooks []StartupHookConfig
// startupHooks execute sequentially before the server starts accepting connections.
// If any startup hook returns an error, the server will not start.
startupHooks []StartupHookConfig
// postStartupHooks execute sequentially after the server has started.
postStartupHooks []StartupHookConfig
// preShutdownHooks execute sequentially before server shutdown begins.
preShutdownHooks []ShutdownHookConfig
// shutdownHooks execute concurrently with server shutdown.
shutdownHooks []ShutdownHookConfig
// postShutdownHooks execute sequentially after all servers are shut down.
postShutdownHooks []ShutdownHookConfig
// validator is an optional struct validator for validating request data.
// Users can inject their own implementation (e.g., go-playground/validator/v10).
// If nil, the default built-in validator will be used.
validator Validator
// metricsRegistry holds the metrics registry for collecting and exposing metrics.
// If nil, metrics collection is disabled.
metricsRegistry metrics.Registry
// metricsServer is a dedicated HTTP server for serving metrics.
// When Metrics.ServerAddr is set, metrics are served on this separate server
// bound to the specified address (typically localhost for security).
metricsServer *http.Server
// metricsListener is the network listener for the metrics server.
metricsListener net.Listener
// metricsServerAddr is the configured address for the metrics server.
metricsServerAddr string
// autocertManager handles automatic certificate provisioning and renewal
// using Let's Encrypt ACME protocol. If set, enables automatic TLS.
// Users must provide their own implementation (e.g., golang.org/x/crypto/acme/autocert.Manager).
autocertManager autocert.Manager
// http3Server is an optional HTTP/3 server for handling HTTP/3 traffic over QUIC.
// Users can inject their own implementation (e.g., quic-go/http3) to enable HTTP/3.
// If nil, HTTP/3 server will not be started.
http3Server http3.Server
// sseProvider is an optional SSE provider for handling Server-Sent Events connections.
// Users can inject their own implementation or use the built-in stdlib provider.
// If nil, SSE is not available but users can still handle SSE manually in their handlers.
sseProvider sse.Provider
// webSocketUpgrader is an optional WebSocket upgrader for handling WebSocket connections.
// Users provide their own implementation using their preferred WebSocket library.
// If nil, WebSocket is not available but users can still handle upgrades manually.
webSocketUpgrader websocket.Upgrader
// webTransportServer is an optional WebTransport server for handling WebTransport sessions.
// Users can inject their own implementation (e.g., quic-go/webtransport-go) to enable WebTransport.
// If nil, WebTransport support will not be enabled.
// The server will be started automatically when ListenAndServeTLS or Start is called.
webTransportServer webtransport.Server
}
// New creates and configures a new Server instance with the provided
// It initializes the server with sensible defaults that can be overridden
// using the provided
//
// The server includes:
// - HTTP and HTTPS support
// - Middleware integration
// - Structured logging
// - Automatic metrics collection (enabled by default)
// - Request binding and validation
//
// Example - Basic usage with defaults:
//
// app := zh.New()
// app.GET("/", handler)
// log.Fatal(app.Start())
//
// Example - With custom configuration:
//
// app := zh.New(Config{
// Addr: ":8080",
// Server: &http.Server{
// ReadTimeout: 10 * time.Second,
// WriteTimeout: 15 * time.Second,
// },
// Logger: myLogger,
// Metrics: metrics.Config{
// Enabled: config.Bool(false), // Disable metrics
// },
// })
//
// Example - Customizing only specific server fields (keeps other defaults):
//
// srv := zh.DefaultHTTPServer()
// srv.ReadTimeout = 30 * time.Second
// app := zh.New(Config{
// Addr: ":8080",
// Server: srv,
// })
//
// Example - With pluggable validator:
//
// app := zh.New(Config{
// Validator: myCustomValidator,
// })
func New(cfg ...Config) *Server {
c := mergeConfig(cfg...)
router := NewRouter()
logger := createLogger(c)
router.SetLogger(logger)
router.SetConfig(c)
server := createHTTPServer(c, logger)
tlsServer := createTLSServer(c, logger)
registry := createMetricsRegistry(c)
metricsServer := createMetricsServer(c, registry, logger)
baseCtx, cancelBaseCtx := context.WithCancel(context.Background())
s := &Server{
Router: router,
server: server,
listener: c.Listener,
tlsServer: tlsServer,
tlsListener: c.TLS.Listener,
certFile: c.TLS.CertFile,
keyFile: c.TLS.KeyFile,
redirectHTTP: c.TLS.RedirectHTTP,
autocertManager: c.Extensions.AutocertManager,
http3Server: c.Extensions.HTTP3Server,
webTransportServer: c.Extensions.WebTransportServer,
webSocketUpgrader: c.Extensions.WebSocketUpgrader,
sseProvider: c.Extensions.SSEProvider,
metricsRegistry: registry,
metricsServer: metricsServer,
metricsServerAddr: config.StringOrDefault(c.Metrics.ServerAddr, ""),
validator: c.Validator,
logger: logger,
preStartupHooks: c.Lifecycle.PreStartupHooks,
startupHooks: c.Lifecycle.StartupHooks,
postStartupHooks: c.Lifecycle.PostStartupHooks,
preShutdownHooks: c.Lifecycle.PreShutdownHooks,
shutdownHooks: c.Lifecycle.ShutdownHooks,
postShutdownHooks: c.Lifecycle.PostShutdownHooks,
baseCtx: baseCtx,
cancelBaseCtx: cancelBaseCtx,
}
setupMiddleware(s, c, registry)
setupServerHandlers(s, router)
registerMetricsEndpoint(s, c, registry)
// Finalize router to register catch-all handler with middleware
if r, ok := router.(interface{ finalize() }); ok {
r.finalize()
}
return s
}
// ListenAndServe starts the HTTP server and begins accepting connections.
// It creates a listener if one is not already configured and serves HTTP
// traffic on the configured address. If the server is not configured,
// this method logs a debug message and returns nil without error.
//
// This method blocks until the server encounters an error or is shut down.
// Returns any error encountered while starting or running the server.
func (s *Server) ListenAndServe() error {
s.mu.Lock()
if s.server == nil {
s.mu.Unlock()
s.logger.Debug("HTTP server not configured, skipping")
return nil
}
var err error
if s.listener == nil {
s.logger.Debug("Creating HTTP listener", log.F("addr", s.server.Addr))
s.listener, err = net.Listen("tcp", s.server.Addr)
if err != nil {
s.mu.Unlock()
return err
}
}
s.mu.Unlock()
s.logger.Info("Starting HTTP server", log.F("addr", fmtHTTPAddr(s.listener.Addr().String())))
return s.server.Serve(s.listener)
}
// Start begins serving HTTP, HTTPS, and metrics traffic concurrently.
// It starts all configured servers (HTTP, HTTPS, metrics, HTTP/3, WebTransport)
// in separate goroutines and blocks until all servers exit.
//
// For HTTPS, the server will start if:
// - TLS server is configured AND
// - Either certificates are loaded in TLS config OR certificate files are specified
//
// Start blocks until all servers exit. If any server encounters an unexpected
// error (i.e. not ErrServerClosed), that error is returned immediately.
// Returns nil when all servers shut down cleanly (e.g. via Shutdown()).
func (s *Server) Start() error {
s.logger.Info("Starting server...")
// Run pre-startup hooks first
if err := s.runPreStartupHooks(s.baseCtx); err != nil {
s.logger.Error("Pre-startup hook failed, server not starting", log.E(err))
return err
}
handler := s.Router
// Determine if we should start HTTPS server
shouldStartTLS := s.tlsServer != nil &&
((s.tlsServer.TLSConfig != nil &&
(len(s.tlsServer.TLSConfig.Certificates) > 0 || s.tlsServer.TLSConfig.GetCertificate != nil)) ||
(s.certFile != "" && s.keyFile != ""))
// Validate and load certificates before starting any goroutines.
// This avoids orphaning the HTTP/metrics server goroutines on cert failure.
if shouldStartTLS {
if s.tlsServer.TLSConfig == nil {
s.tlsServer.TLSConfig = &tls.Config{
MinVersion: tls.VersionTLS12,
}
}
s.tlsServer.Handler = handler
// Load cert/key if paths are specified
if s.certFile != "" && s.keyFile != "" &&
(len(s.tlsServer.TLSConfig.Certificates) == 0 && s.tlsServer.TLSConfig.GetCertificate == nil) {
cert, err := tls.LoadX509KeyPair(s.certFile, s.keyFile)
if err != nil {
s.logger.Error("Failed to load TLS certificate", log.E(err))
return fmt.Errorf("failed to load certificate files: %w", err)
}
s.tlsServer.TLSConfig.Certificates = []tls.Certificate{cert}
}
}
var wg sync.WaitGroup
// Calculate actual number of servers that will start for error channel capacity
serverCount := 0
if s.metricsServer != nil {
serverCount++
}
if s.server != nil {
serverCount++
}
if shouldStartTLS {
serverCount++ // HTTPS server
}
if s.http3Server != nil && shouldStartTLS {
serverCount++
}
if s.webTransportServer != nil && shouldStartTLS {
serverCount++
}
errCh := make(chan error, serverCount)
// Start metrics server if configured
if s.metricsServer != nil {
wg.Add(1)
go func() {
defer wg.Done()
s.logger.Info("Starting metrics server...", log.F("addr", fmtHTTPAddr(s.metricsServer.Addr)))
if err := s.startMetricsServer(); err != nil && !errors.Is(err, http.ErrServerClosed) {
errCh <- fmt.Errorf("metrics server error: %w", err)
}
}()
}
// Start HTTP server
if s.server != nil {
// Use redirect handler if configured and TLS is enabled
if s.redirectHTTP && shouldStartTLS {
s.server.Handler = s.createHTTPSRedirectHandler()
s.logger.Info("HTTP to HTTPS redirect enabled", log.F("https_addr", s.tlsServer.Addr))
} else {
s.server.Handler = handler
}
wg.Add(1)
go func() {
defer wg.Done()
s.logger.Info("Starting HTTP server...", log.F("addr", fmtHTTPAddr(s.server.Addr)))
if err := s.server.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
errCh <- fmt.Errorf("HTTP server error: %w", err)
}
}()
}
// Start HTTPS server
if shouldStartTLS {
wg.Add(1)
go func() {
defer wg.Done()
s.logger.Info("Starting HTTPS server...",
log.F("addr", fmtHTTPSAddr(s.tlsServer.Addr)),
log.F("cert_file", s.certFile),
log.F("key_file", s.keyFile))
// Pass empty strings - certs are already loaded in TLSConfig.Certificates
if err := s.tlsServer.ListenAndServeTLS("", ""); err != nil && !errors.Is(err, http.ErrServerClosed) {
errCh <- fmt.Errorf("HTTPS server error: %w", err)
}
}()
}
// Start HTTP/3 server if configured and we have TLS
if s.http3Server != nil && shouldStartTLS {
go func() {
s.logger.Info("Starting HTTP/3 server...",
log.F("cert_file", s.certFile),
log.F("key_file", s.keyFile))
// Pass empty strings - certs are already loaded in TLSConfig.Certificates
if err := s.http3Server.ListenAndServeTLS("", ""); err != nil {
s.logger.Error("HTTP/3 server error", log.E(err))
}
}()
}
// Start WebTransport server if configured and we have TLS
if s.webTransportServer != nil && shouldStartTLS {
go func() {
s.logger.Info("Starting WebTransport server...",
log.F("cert_file", s.certFile),
log.F("key_file", s.keyFile))
// Pass empty strings - certs are already loaded in TLSConfig.Certificates
if err := s.webTransportServer.ListenAndServeTLS("", ""); err != nil {
s.logger.Error("WebTransport server error", log.E(err))
}
}()
}
// Guard against hanging if no servers were started
started := 0
if s.metricsServer != nil {
started++
}
if s.server != nil {
started++
}
if shouldStartTLS {
started++
}
if started == 0 {
s.logger.Warn("No servers configured, Start() returning immediately")
return nil
}
// Run startup hooks concurrently with servers
startupHookErrCh := make(chan error, 1)
go func() {
if err := s.runStartupHooks(s.baseCtx); err != nil {
s.logger.Error("Startup hook failed, initiating shutdown", log.E(err))
startupHookErrCh <- err
// Trigger shutdown to stop the servers
shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
_ = s.Shutdown(shutdownCtx)
return
}
close(startupHookErrCh)
// Run post-startup hooks after startup hooks complete successfully
if err := s.runPostStartupHooks(s.baseCtx); err != nil {
s.logger.Error("Post-startup hook failed", log.E(err))
// Non-fatal - continue running
}
}()
// Close errCh when all goroutines complete, then range to collect any errors
go func() {
wg.Wait()
close(errCh)
}()
// Check for server errors or startup hook errors
var hookErr error
select {
case err := <-errCh:
if err != nil {
return err
}
hookErr = <-startupHookErrCh
case hookErr = <-startupHookErrCh:
if hookErr != nil {
// Drain errCh
go func() {
for range errCh {
}
}()
return hookErr
}
err := <-errCh
if err != nil {
return err
}
}
return hookErr
}
// ListenerAddr returns the network address that the HTTP server is listening on.
// If a listener is configured, it returns the listener's actual address.
// If no listener is configured but a server is configured, it returns the server's configured address.
// If neither is configured, it returns an empty string.
//
// This method is thread-safe and can be called concurrently.
// The returned address includes both host and port (e.g., "127.0.0.1:8080").
func (s *Server) ListenerAddr() string {
s.mu.RLock()
defer s.mu.RUnlock()
if s.listener != nil {
return s.listener.Addr().String()
}
if s.server != nil {
return s.server.Addr
}
return ""
}
// Logger returns the structured logger instance used by the server.
// This logger is used for recording HTTP requests, errors, server lifecycle events,
// and can be used by application code for consistent logging.
//
// The returned logger implements the log.Logger interface and provides
// structured logging capabilities with fields and different log levels.
func (s *Server) Logger() log.Logger {
return s.logger
}
// SetValidator sets the struct validator instance. This can be used to inject
// a custom validation implementation (e.g., go-playground/validator/v10) after
// creating the server. If nil, the default built-in validator will be used.
//
// Example:
//
// import "github.com/go-playground/validator/v10"
//
// app := zerohttp.New()
// app.SetValidator(&myValidator{v: validator.New()})
//
// Parameters:
// - validator: A validator instance implementing the Validator interface
func (s *Server) SetValidator(validator Validator) {
s.mu.Lock()
defer s.mu.Unlock()
s.validator = validator
}
// Validator returns the configured struct validator (if any).
// Returns nil if no custom validator has been configured - in this case,
// the default built-in validator (zh.V) should be used.
func (s *Server) Validator() Validator {
s.mu.RLock()
defer s.mu.RUnlock()
return s.validator
}
// Shutdown gracefully shuts down both HTTP and HTTPS servers without interrupting
// any active connections. It waits for active connections to finish or for the
// provided context to be cancelled.
//
// Parameters:
// - ctx: Context that controls the shutdown timeout. If the context is cancelled
// before shutdown completes, the servers will be forcefully closed.
//
// The shutdown process runs concurrently for both servers. If any server
// encounters an error during shutdown, that error is returned.
// Shutdown hooks are executed during the shutdown process:
// - Pre-shutdown hooks run sequentially before server shutdown begins
// - Shutdown hooks run concurrently with server shutdown
// - Post-shutdown hooks run sequentially after all servers are shut down
//
// Returns the first error encountered during shutdown, or nil if successful.
func (s *Server) Shutdown(ctx context.Context) error {
s.logger.Info("Shutting down server...")
// Cancel the base context to signal all requests to close
// This happens before pre-shutdown hooks so requests can start terminating
if s.cancelBaseCtx != nil {
s.cancelBaseCtx()
}
// Execute pre-shutdown hooks sequentially
if err := s.runPreShutdownHooks(ctx); err != nil {
s.logger.Error("Pre-shutdown hook error", log.E(err))
// Return context errors as they indicate shutdown was cancelled
if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
return err
}
}
// Start shutdown hooks concurrently and wait for them
hookWg, hookErrCh := s.startShutdownHooks(ctx)
var wg sync.WaitGroup
errCh := make(chan error, 5) // 5 potential goroutines: server, tlsServer, webTransport, http3, metrics
if s.server != nil {
wg.Add(1)
go func() {
defer wg.Done()
s.logger.Info("Shutting down HTTP server")
if err := s.server.Shutdown(ctx); err != nil {
s.logger.Error("Error shutting down HTTP server", log.F("error", err))
errCh <- err
} else {
s.logger.Info("HTTP server shutdown complete")
}
}()
}
if s.tlsServer != nil {
wg.Add(1)
go func() {
defer wg.Done()
s.logger.Info("Shutting down HTTPS server")
if err := s.tlsServer.Shutdown(ctx); err != nil {
s.logger.Error("Error shutting down HTTPS server", log.F("error", err))
errCh <- err
} else {
s.logger.Info("HTTPS server shutdown complete")
}
}()
}
// Shutdown WebTransport and HTTP/3 concurrently
if s.webTransportServer != nil {
wg.Add(1)
go func() {
defer wg.Done()
s.logger.Info("Closing WebTransport server")
if err := s.webTransportServer.Close(); err != nil {
s.logger.Error("Error closing WebTransport server", log.F("error", err))
errCh <- err
} else {
s.logger.Info("WebTransport server closed")
}
}()
}
if s.http3Server != nil {
wg.Add(1)
go func() {
defer wg.Done()
s.logger.Info("Shutting down HTTP/3 server")
if err := s.http3Server.Shutdown(ctx); err != nil {
s.logger.Error("Error shutting down HTTP/3 server", log.F("error", err))
errCh <- err
} else {
s.logger.Info("HTTP/3 server shutdown complete")
}
}()
}
// Shutdown metrics server
if s.metricsServer != nil {
wg.Add(1)
go func() {
defer wg.Done()
s.logger.Info("Shutting down metrics server")
if err := s.metricsServer.Shutdown(ctx); err != nil {
s.logger.Error("Error shutting down metrics server", log.F("error", err))
errCh <- err
} else {
s.logger.Info("Metrics server shutdown complete")
}
}()
}
wg.Wait()
close(errCh)
// Collect errors from servers and return the first one
var firstErr error
for err := range errCh {
if err != nil && firstErr == nil {
firstErr = err
}
}
// Wait for shutdown hooks to complete
hookWg.Wait()
close(hookErrCh)
// Drain hook errors (log them but don't fail shutdown)
for err := range hookErrCh {
if err != nil {
s.logger.Error("Shutdown hook error", log.E(err))
}
}
// Execute post-shutdown hooks sequentially
if err := s.runPostShutdownHooks(ctx); err != nil {
s.logger.Error("Post-shutdown hook error", log.E(err))
}
s.logger.Info("Server shutdown complete")
return firstErr
}
// Close immediately closes all server listeners, terminating any active connections.
// Unlike Shutdown, this method does not wait for connections to finish gracefully.
// It closes both HTTP and HTTPS listeners concurrently.
//
// This method is thread-safe and can be called multiple times safely.
// Returns the last error encountered while closing listeners, or nil if successful.
func (s *Server) Close() error {
s.mu.Lock()
defer s.mu.Unlock()
s.logger.Debug("Closing server listeners...")
var lastErr error
// Close HTTP server directly - works for both ListenAndServe() and Start()
if s.server != nil {
s.logger.Debug("Closing HTTP server")
if err := s.server.Close(); err != nil {
s.logger.Error("Error closing HTTP server", log.F("error", err))
lastErr = err
}
}
// Close HTTPS server directly - works for both ListenAndServe() and Start()
if s.tlsServer != nil {
s.logger.Debug("Closing HTTPS server")
if err := s.tlsServer.Close(); err != nil {
s.logger.Error("Error closing HTTPS server", log.F("error", err))
lastErr = err
}
}
if s.http3Server != nil {
s.logger.Debug("Closing HTTP/3 server")
if err := s.http3Server.Close(); err != nil {
s.logger.Error("Error closing HTTP/3 server", log.F("error", err))
lastErr = err
}
}
if s.webTransportServer != nil {
s.logger.Debug("Closing WebTransport server")
if err := s.webTransportServer.Close(); err != nil {
s.logger.Error("Error closing WebTransport server", log.F("error", err))
lastErr = err
}
}
// Close metrics server directly - works for both ListenAndServe() and Start()
if s.metricsServer != nil {
s.logger.Debug("Closing metrics server")
if err := s.metricsServer.Close(); err != nil {
s.logger.Error("Error closing metrics server", log.F("error", err))
lastErr = err
}
}
if lastErr == nil {
s.logger.Debug("All listeners closed successfully")
}
return lastErr
}
// mergeConfig merges user config with defaults.
func mergeConfig(cfg ...Config) Config {
c := DefaultConfig
if len(cfg) > 0 {
userCfg := cfg[0]
zconfig.Merge(&c, userCfg)
// Handle fields that must always be copied (even if zero value)
// ServerAddr can be set to empty string to disable separate metrics server
if userCfg.Metrics.ServerAddr != nil {
c.Metrics.ServerAddr = userCfg.Metrics.ServerAddr
}
}
return c
}
// createLogger creates a logger instance from config or returns default.
func createLogger(c Config) log.Logger {
if c.Logger != nil {
return c.Logger
}
return log.NewDefaultLogger()
}
// createHTTPServer creates the HTTP server from config.
func createHTTPServer(c Config, logger log.Logger) *http.Server {
if c.Server != nil {
if c.Server.ErrorLog == nil {
c.Server.ErrorLog = log.StdLogger(logger)
}
return c.Server
}
srv := DefaultHTTPServer()
srv.Addr = c.Addr
srv.ErrorLog = log.StdLogger(logger)
return srv
}
// createTLSServer creates the TLS server from config if TLS is configured.
func createTLSServer(c Config, logger log.Logger) *http.Server {
if c.TLS.Server != nil {
if c.TLS.Server.ErrorLog == nil {
c.TLS.Server.ErrorLog = log.StdLogger(logger)
}
return c.TLS.Server
}
if !needsTLSServer(c) {
return nil
}
srv := DefaultTLSServer()
srv.Addr = c.TLS.Addr
srv.ErrorLog = log.StdLogger(logger)
return srv
}
// needsTLSServer returns true if the config requires a TLS server to be created.
func needsTLSServer(c Config) bool {
return c.TLS.CertFile != "" ||
c.TLS.KeyFile != "" ||
c.Extensions.AutocertManager != nil ||
c.TLS.Listener != nil ||
c.Extensions.HTTP3Server != nil
}
// createMetricsRegistry creates metrics registry if enabled.
// Metrics are only enabled when explicitly set to true (not nil).
func createMetricsRegistry(c Config) metrics.Registry {
if c.Metrics.Enabled == nil || !*c.Metrics.Enabled {
return nil
}
return metrics.NewRegistry()
}
// createMetricsServer creates a separate metrics server if ServerAddr indicates a separate server.
// Returns nil if ServerAddr is empty (metrics on main server) or metrics disabled.
func createMetricsServer(c Config, registry metrics.Registry, logger log.Logger) *http.Server {
if registry == nil {
return nil
}
serverAddr := config.StringOrDefault(c.Metrics.ServerAddr, "localhost:9090")
if serverAddr == "" {
return nil // Metrics on main server, not a separate server
}
metricsHandler := metrics.Handler(registry)
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Only serve metrics on the configured endpoint
if r.URL.Path != c.Metrics.Endpoint {
http.NotFound(w, r)
return
}
metricsHandler.ServeHTTP(w, r)
})
return &http.Server{
Addr: serverAddr,
ReadTimeout: DefaultReadTimeout,
ReadHeaderTimeout: DefaultReadHeaderTimeout,
WriteTimeout: DefaultWriteTimeout,
IdleTimeout: DefaultIdleTimeout,
Handler: handler,
ErrorLog: log.StdLogger(logger),
}
}
// setupMiddleware configures the middleware chain on the server.
func setupMiddleware(s *Server, c Config, registry metrics.Registry) {
var middlewares []MiddlewareFunc
// Add metrics middleware first so it will be innermost after reverse,
// running inside Recover and able to capture status codes written by other middleware
if registry != nil {
middlewares = append(middlewares, metrics.NewMiddleware(registry, c.Metrics))
}
if c.DisableDefaultMiddlewares {
middlewares = append(middlewares, c.DefaultMiddlewares...)
} else if c.DefaultMiddlewares == nil {
middlewares = append(middlewares, DefaultMiddlewares(c, s.logger)...)
} else {
defaults := DefaultMiddlewares(c, s.logger)
middlewares = append(middlewares, defaults...)
middlewares = append(middlewares, c.DefaultMiddlewares...)
}
if len(middlewares) > 0 {
s.Use(middlewares...)
}
}
// setupServerHandlers sets the router and base context on server instances.
func setupServerHandlers(s *Server, router Router) {
if s.server != nil {
s.server.Handler = router
s.server.BaseContext = func(net.Listener) context.Context {
return s.baseCtx
}
}
if s.tlsServer != nil {
s.tlsServer.Handler = router
s.tlsServer.BaseContext = func(net.Listener) context.Context {
return s.baseCtx
}
}
}
// registerMetricsEndpoint registers the metrics endpoint on the main router if needed.
func registerMetricsEndpoint(s *Server, c Config, registry metrics.Registry) {
// Register on main server only if ServerAddr is explicitly set to empty string
serverAddr := ""
if c.Metrics.ServerAddr != nil {
serverAddr = *c.Metrics.ServerAddr
}
if registry != nil && c.Metrics.ServerAddr != nil && serverAddr == "" {
s.logger.Warn("Metrics endpoint registered on main server (set Metrics.ServerAddr to isolate)", log.F("endpoint", c.Metrics.Endpoint))
s.GET(c.Metrics.Endpoint, metrics.Handler(registry))
}
}
func fmtHTTPAddr(addr string) string {
return fmt.Sprintf("http://%s", addr)
}
func fmtHTTPSAddr(addr string) string {
return fmt.Sprintf("https://%s", addr)
}