/
server.go
443 lines (358 loc) · 10.1 KB
/
server.go
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
package gogo
import (
"context"
"fmt"
"net/http"
"net/url"
"os"
"os/signal"
"regexp"
"strconv"
"strings"
"sync"
"time"
"github.com/dolab/gogo/internal/listeners"
"github.com/dolab/gogo/pkgs/hooks"
"github.com/dolab/gogo/pkgs/interceptors"
"github.com/dolab/gogo/pkgs/interceptors/debugger"
"golang.org/x/net/http2"
)
var (
network2addr = regexp.MustCompile(`(?i)^(http|https|tcp|tcp4|tcp6|unix|unixpacket):/{1,3}?(.+)?`)
)
// AppServer defines a server component of gogo
type AppServer struct {
*AppGroup
*hooks.ServerHooks
config Configer
logger Logger
requestID string // request id header name
filterFields []string // filter out params when logging
localMux sync.RWMutex
localSig chan os.Signal
localAddr string
localIfaces []interface{}
localServ *http.Server
}
// NewAppServer returns *AppServer inited with args
func NewAppServer(config Configer, logger Logger) *AppServer {
server := &AppServer{
config: config,
logger: logger,
requestID: DefaultRequestIDKey,
localIfaces: []interface{}{
debugger.NewRegistry(),
},
}
// init AppGroup for server
server.AppGroup = NewAppGroup("/", server)
// init ServerHooks
server.ServerHooks = hooks.NewServerHooks()
return server
}
// Mode returns run mode of the app server
func (s *AppServer) Mode() string {
return s.config.RunMode().String()
}
// Config returns app config of the app server
func (s *AppServer) Config() Configer {
return s.config
}
// Address returns app listen address
func (s *AppServer) Address() string {
s.localMux.RLock()
defer s.localMux.RUnlock()
return s.localAddr
}
// WithInterceptors tries to register all interceptors defined by iface
func (s *AppServer) WithInterceptors(iface interface{}) {
if registry, ok := iface.(interceptors.RequestReceivedInterceptor); ok {
for _, m := range registry.RequestReceived() {
s.WithRequestReceived(m)
}
}
if registry, ok := iface.(interceptors.RequestRoutedInterceptor); ok {
for _, m := range registry.RequestRouted() {
s.WithRequestRouted(m)
}
}
if registry, ok := iface.(interceptors.ResponseReadyInterceptor); ok {
for _, m := range registry.ResponseReady() {
s.WithResponseReady(m)
}
}
if registry, ok := iface.(interceptors.ResponseAlwaysInterceptor); ok {
for _, m := range registry.ResponseAlways() {
s.WithResponseAlways(m)
}
}
}
// WithRequestReceived registers interceptors at request received phase
func (s *AppServer) WithRequestReceived(m interceptors.Interface) error {
s.localMux.Lock()
defer s.localMux.Unlock()
name := m.Name()
if s.RequestReceived.Has(name) {
return fmt.Errorf("Middleware conflict, %q has registered for request received phase", name)
}
applier, err := m.Register(s.config.Interceptors())
if err != nil {
return err
}
s.RequestReceived.PushBackNamed(hooks.NamedHook{
Name: name,
Apply: applier,
Priority: m.Priority(),
})
return nil
}
// WithRequestRouted registers interceptors at request routed phase
func (s *AppServer) WithRequestRouted(m interceptors.Interface) error {
s.localMux.Lock()
defer s.localMux.Unlock()
name := m.Name()
if s.RequestRouted.Has(name) {
return fmt.Errorf("Middleware conflict, %q has registered for request routed phase", name)
}
applier, err := m.Register(s.config.Interceptors())
if err != nil {
return err
}
s.RequestRouted.PushBackNamed(hooks.NamedHook{
Name: name,
Apply: applier,
Priority: m.Priority(),
})
return nil
}
// WithResponseReady registers interceptors at response ready phase
func (s *AppServer) WithResponseReady(m interceptors.Interface) error {
s.localMux.Lock()
defer s.localMux.Unlock()
name := m.Name()
if s.ResponseReady.Has(name) {
return fmt.Errorf("Middleware conflict, %q has registered for response ready phase", name)
}
applier, err := m.Register(s.config.Interceptors())
if err != nil {
return err
}
s.ResponseReady.PushBackNamed(hooks.NamedHook{
Name: name,
Apply: applier,
Priority: m.Priority(),
})
return nil
}
// WithResponseAlways registers interceptors at response always phase
func (s *AppServer) WithResponseAlways(m interceptors.Interface) error {
s.localMux.Lock()
defer s.localMux.Unlock()
name := m.Name()
if s.ResponseAlways.Has(name) {
return fmt.Errorf("Middleware conflict, %q has registered for response always phase", name)
}
applier, err := m.Register(s.config.Interceptors())
if err != nil {
return err
}
s.ResponseAlways.PushBackNamed(hooks.NamedHook{
Name: name,
Apply: applier,
Priority: m.Priority(),
})
return nil
}
// NewService register all resources of service with interceptorss
func (s *AppServer) NewService(svc Servicer) *AppServer {
// first, try to register all interceptorss defined by service
s.WithInterceptors(svc)
// second, try to register all resources with filters
s.localMux.Lock()
defer s.localMux.Unlock()
svc.Init(s.config, s.AppGroup)
// register filters
svc.Middlewares()
// register resources
svc.Resources()
return s
}
// NewResources register all resources of service without filters. It's useful
// for testing cases.
func (s *AppServer) NewResources(svc Servicer) *AppServer {
// first, try to register all middlewares defined by service
s.WithInterceptors(svc)
// second, try to register all resources with filters
s.localMux.Lock()
defer s.localMux.Unlock()
svc.Init(s.config, s.AppGroup)
// register resources
svc.Resources()
return s
}
// Run starts the http server with AppGroup as http.Handler.
//
// NOTE: Run apply throughput and concurrency to http.Server.
func (s *AppServer) Run() {
var (
config = s.config.Section()
network = "tcp"
addr = config.Server.Addr
port = config.Server.Port
rtimeout = DefaultRequestTimeout
wtimeout = DefaultResponseTimeout
maxHeaderBytes = 0
)
// register all middlewares of internal
for _, iface := range s.localIfaces {
s.WithInterceptors(iface)
}
// register healthz
if config.Server.Healthz {
s.registerHealthz()
}
// throughput of rate limit
if config.Server.Throttle > 0 {
s.RequestReceived.PushFrontNamed(
hooks.NewServerThrottleHook(config.Server.Throttle),
)
}
// concurrency of bucket token
if config.Server.Demotion > 0 {
s.RequestReceived.PushBackNamed(
hooks.NewServerDemotionHook(config.Server.Demotion, config.Server.RTimeout),
)
}
// adjust app server request id if specified
if config.Server.RequestID != "" {
s.requestID = config.Server.RequestID
}
// adjust app logger filter sensitive fields
s.filterFields = config.Logger.FilterFields
// If the port is zero, treat the address as a fully qualified local address.
// This address must be prefixed with the network type followed by a colon,
// e.g. unix:/tmp/gogo.socket or tcp6:::1 (equivalent to tcp6:0:0:0:0:0:0:0:1)
matches := network2addr.FindStringSubmatch(addr)
if len(matches) == 3 {
switch strings.ToLower(matches[1]) {
case "http", "https":
// ignore
default:
network = matches[1]
}
addr = "/" + strings.TrimPrefix(matches[2], "/")
}
if port != 0 {
addr += ":" + strconv.Itoa(port)
}
if config.Server.RTimeout > 0 {
rtimeout = config.Server.RTimeout
}
if config.Server.WTimeout > 0 {
wtimeout = config.Server.WTimeout
}
if config.Server.MaxHeaderBytes > 0 {
maxHeaderBytes = config.Server.MaxHeaderBytes
}
// register server
log := s.loggerNew("GOGO")
listener := listeners.New(config.Server.HTTP2)
s.RequestReceived.PushFrontNamed(listener.RequestReceivedHook())
conn, err := listener.Listen(network, addr)
if err != nil {
log.Fatalf("listeners.Listen(%s, %s): %v", network, addr, err)
}
log.Infof("Listened on %s://%s", network, addr)
server := &http.Server{
Addr: addr,
Handler: s.AppGroup,
ReadHeaderTimeout: time.Duration(rtimeout) * time.Second,
ReadTimeout: time.Duration(rtimeout) * time.Second,
WriteTimeout: time.Duration(wtimeout) * time.Second,
MaxHeaderBytes: maxHeaderBytes,
}
server.RegisterOnShutdown(listener.Shutdown)
// register locals
s.localMux.Lock()
s.localAddr = addr
s.localServ = server
s.localMux.Unlock()
if config.Server.Ssl {
msg := "ServeTLS(%s:%s): %v"
if config.Server.HTTP2 {
err := http2.ConfigureServer(server, nil)
if err != nil {
log.Fatalf("http2.ConfigureServer(%T, nil): %v", server, err)
}
msg = "ServeHTTP2(%s:%s): %v"
}
if err := server.ServeTLS(conn, config.Server.SslCert, config.Server.SslKey); err != nil {
if strings.Contains(err.Error(), "http: Server closed") {
log.Info("Server shutdown")
} else {
log.Fatalf(msg, network, addr, err)
}
}
} else {
if err := server.Serve(conn); err != nil {
if strings.Contains(err.Error(), "http: Server closed") {
log.Info("Server shutdown")
} else {
log.Fatalf("Serve(%s:%s): %v", network, addr, err)
}
}
}
}
// RunWithHandler runs the http server with given handler
// It's useful for embbedding third-party golang applications.
func (s *AppServer) RunWithHandler(handler Handler) {
s.SetHandler(handler)
s.Run()
}
// Serve runs a server with graceful shutdown feature
func (s *AppServer) Serve() {
s.localSig = make(chan os.Signal, 1)
signal.Notify(s.localSig, os.Interrupt)
go s.Run()
<-s.localSig
close(s.localSig)
log := s.loggerNew("GOGO")
log.Info("Shutting down server ....")
// NOTE: 500*time.Millinsecond is copied from net/http
ctx, _ := context.WithTimeout(context.Background(), 500*time.Millisecond)
s.localServ.Shutdown(ctx)
select {
case <-ctx.Done():
os.Exit(0)
}
}
// Shutdown shuts down AppServer gracefully by emitting os.Interrupt
func (s *AppServer) Shutdown() {
if s.localSig == nil {
return
}
// use interrupt sig
s.localSig <- os.Interrupt
}
func (s *AppServer) loggerNew(tag string) Logger {
return s.logger.New(tag)
}
func (s *AppServer) loggerReuse(l Logger) {
s.logger.Reuse(l)
}
func (s *AppServer) hasRequestID() bool {
return len(s.requestID) > 0
}
func (s *AppServer) filterParameters(lru *url.URL) string {
ss := lru.Path
query := lru.Query()
if len(query) > 0 {
for _, key := range s.filterFields {
if _, ok := query[key]; ok {
query.Set(key, "[FILTERED]")
}
}
ss += "?" + query.Encode()
}
return ss
}