Repository navigation
Expand file tree
/
Copy pathhooks.go
More file actions
489 lines (408 loc) · 13.5 KB
/
Copy pathhooks.go
File metadata and controls
489 lines (408 loc) · 13.5 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
package fiber
import (
"slices"
"github.com/gofiber/fiber/v3/log"
)
type (
// OnRouteHandler defines the hook signature invoked whenever a route is registered.
// OnNameHandler shares the OnRouteHandler signature for route naming callbacks.
>
// OnGroupHandler defines the hook signature invoked whenever a group is registered.
error
// OnGroupNameHandler shares the OnGroupHandler signature for group naming callbacks.
>
// OnListenHandler runs when the application begins listening and receives the listener details.
error
// OnPreStartupMessageHandler runs before Fiber prints the startup banner.
error
// OnPostStartupMessageHandler runs after Fiber prints (or skips) the startup banner.
error
// OnPreShutdownHandler runs before the application shuts down.
error
// OnPostShutdownHandler runs after shutdown and receives the shutdown result.
error
// OnForkHandler runs in the prefork master process each time it starts a child process and receives that child's PID.
error
// OnMountHandler runs after a sub-application mounts to a parent and receives the parent app reference.
error
)
// Hooks is a struct to use it with App.
type Hooks struct {
// Embed app
app *App
// Hooks
onRoute []OnRouteHandler
onName []OnNameHandler
onGroup []OnGroupHandler
onGroupName []OnGroupNameHandler
onListen []OnListenHandler
onPreStartup []OnPreStartupMessageHandler
onPostStartup []OnPostStartupMessageHandler
onPreShutdown []OnPreShutdownHandler
onPostShutdown []OnPostShutdownHandler
onFork []OnForkHandler
onMount []OnMountHandler
}
type StartupMessageLevel int
const (
// StartupMessageLevelInfo represents informational startup message entries.
StartupMessageLevelInfo StartupMessageLevel = iota
// StartupMessageLevelWarning represents warning startup message entries.
StartupMessageLevelWarning
// StartupMessageLevelError represents error startup message entries.
StartupMessageLevelError
)
const errString = "ERROR"
// startupMessageEntry represents a single line of startup message information.
type startupMessageEntry struct {
key string
title string
value string
priority int
level StartupMessageLevel
}
// ListenData contains the listener metadata provided to OnListenHandler.
type ListenData struct {
ColorScheme Colors
Host string
Port string
Version string
AppName string
ChildPIDs []int
HandlerCount int
ProcessCount int
PID int
TLS bool
Prefork bool
}
// PreStartupMessageData contains metadata exposed to OnPreStartupMessage hooks.
type PreStartupMessageData struct {
*ListenData
// BannerHeader allows overriding the ASCII art banner displayed at startup.
BannerHeader string
entries []startupMessageEntry
// PreventDefault, when set to true, suppresses the default startup message.
PreventDefault bool
}
// AddInfo adds an informational entry to the startup message with "INFO" label.
func (sm *PreStartupMessageData) AddInfo(key, title, value string, priority ...int) {
pri := -1
if len(priority) > 0 {
pri = priority[0]
}
sm.addEntry(key, title, value, pri, StartupMessageLevelInfo)
}
// AddWarning adds a warning entry to the startup message with "WARN" label.
func (sm *PreStartupMessageData) AddWarning(key, title, value string, priority ...int) {
pri := -1
if len(priority) > 0 {
pri = priority[0]
}
sm.addEntry(key, title, value, pri, StartupMessageLevelWarning)
}
// AddError adds an error entry to the startup message with "ERROR" label.
func (sm *PreStartupMessageData) AddError(key, title, value string, priority ...int) {
pri := -1
if len(priority) > 0 {
pri = priority[0]
}
sm.addEntry(key, title, value, pri, StartupMessageLevelError)
}
// EntryKeys returns all entry keys currently present in the startup message.
func (sm *PreStartupMessageData) EntryKeys() []string {
keys := make([]string, 0, len(sm.entries))
for _, entry := range sm.entries {
keys = append(keys, entry.key)
}
return keys
}
// ResetEntries removes all existing entries from the startup message.
func (sm *PreStartupMessageData) ResetEntries() {
sm.entries = sm.entries[:0]
}
// DeleteEntry removes a specific entry from the startup message by its key.
func (sm *PreStartupMessageData) DeleteEntry(key string) {
if sm.entries == nil {
return
}
for i, entry := range sm.entries {
if entry.key == key {
sm.entries = append(sm.entries[:i], sm.entries[i+1:]...)
return
}
}
}
func (sm *PreStartupMessageData) addEntry(key, title, value string, priority int, level StartupMessageLevel) {
if sm.entries == nil {
sm.entries = make([]startupMessageEntry, 0, 8)
}
for i, entry := range sm.entries {
if entry.key != key {
continue
}
sm.entries[i].value = value
sm.entries[i].title = title
sm.entries[i].level = level
sm.entries[i].priority = priority
return
}
sm.entries = append(sm.entries, startupMessageEntry{
key: key,
title: title,
value: value,
priority: priority,
level: level,
})
}
func newPreStartupMessageData(listenData *ListenData) *PreStartupMessageData {
return &PreStartupMessageData{ListenData: listenData}
}
// PostStartupMessageData contains metadata exposed to OnPostStartupMessage hooks.
type PostStartupMessageData struct {
*ListenData
// Disabled indicates whether the startup message was disabled via configuration.
Disabled bool
// IsChild indicates whether the current process is a child in prefork mode.
IsChild bool
// Prevented indicates whether the startup message was suppressed by a pre-startup hook using PreventDefault property.
Prevented bool
}
func newPostStartupMessageData(listenData *ListenData, disabled, isChild, prevented bool) *PostStartupMessageData {
clone := *listenData
if len(listenData.ChildPIDs) > 0 {
clone.ChildPIDs = slices.Clone(listenData.ChildPIDs)
}
return &PostStartupMessageData{
ListenData: &clone,
Disabled: disabled,
IsChild: isChild,
Prevented: prevented,
}
}
func newHooks(app *App) *Hooks {
return &Hooks{
app: app,
onRoute: make([]OnRouteHandler, 0),
onGroup: make([]OnGroupHandler, 0),
onGroupName: make([]OnGroupNameHandler, 0),
onName: make([]OnNameHandler, 0),
onListen: make([]OnListenHandler, 0),
onPreStartup: make([]OnPreStartupMessageHandler, 0),
onPostStartup: make([]OnPostStartupMessageHandler, 0),
onPreShutdown: make([]OnPreShutdownHandler, 0),
onPostShutdown: make([]OnPostShutdownHandler, 0),
onFork: make([]OnForkHandler, 0),
onMount: make([]OnMountHandler, 0),
}
}
// OnRoute is a hook to execute user functions on each route registration.
// Also you can get route properties by route parameter.
func (h *Hooks) OnRoute(handler ...OnRouteHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnName is a hook to execute user functions on each route naming.
// Also you can get route properties by route parameter.
//
// WARN: OnName only works with naming routes, not groups.
func (h *Hooks) OnName(handler ...OnNameHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnGroup is a hook to execute user functions on each group registration.
// Also you can get group properties by group parameter.
func (h *Hooks) OnGroup(handler ...OnGroupHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnGroupName is a hook to execute user functions on each group naming.
// Also you can get group properties by group parameter.
//
// WARN: OnGroupName only works with naming groups, not routes.
func (h *Hooks) OnGroupName(handler ...OnGroupNameHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnListen is a hook to execute user functions on Listen or Listener.
func (h *Hooks) OnListen(handler ...OnListenHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnPreStartupMessage is a hook to execute user functions before the startup message is printed.
func (h *Hooks) OnPreStartupMessage(handler ...OnPreStartupMessageHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnPostStartupMessage is a hook to execute user functions after the startup message is printed (or skipped).
func (h *Hooks) OnPostStartupMessage(handler ...OnPostStartupMessageHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnPreShutdown is a hook to execute user functions before Shutdown.
func (h *Hooks) OnPreShutdown(handler ...OnPreShutdownHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnPostShutdown is a hook to execute user functions after Shutdown.
func (h *Hooks) OnPostShutdown(handler ...OnPostShutdownHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnFork is a hook to execute user functions in the prefork master process each time it starts a child process,
// including a child it starts again after a crash. The handler receives the PID of that child; the children do not run it.
func (h *Hooks) OnFork(handler ...OnForkHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
// OnMount is a hook to execute user function after mounting process.
// The mount event is fired when sub-app is mounted on a parent app. The parent app is passed as a parameter.
// It works for app and group mounting.
func (h *Hooks) OnMount(handler ...OnMountHandler) {
h.app.mutex.Lock()
h. handler...)
h.app.mutex.Unlock()
}
func (h *Hooks) executeOnRouteHooks(route *Route) error {
if route == nil {
return nil
}
cloned := *route
// Check mounting
if h.app.mountFields.mountPath != "" {
cloned.path = h.app.mountFields.mountPath + cloned.path
cloned.Path = cloned.path
}
for _, v := range h.onRoute {
if err := v(cloned); err != nil {
return err
}
}
return nil
}
func (h *Hooks) executeOnNameHooks(route *Route) error {
if route == nil {
return nil
}
cloned := *route
// Check mounting
if h.app.mountFields.mountPath != "" {
cloned.path = h.app.mountFields.mountPath + cloned.path
cloned.Path = cloned.path
}
for _, v := range h.onName {
if err := v(cloned); err != nil {
return err
}
}
return nil
}
func (h *Hooks) executeOnGroupHooks(group Group) error {
// Check mounting
if h.app.mountFields.mountPath != "" {
group.Prefix = h.app.mountFields.mountPath + group.Prefix
}
for _, v := range h.onGroup {
if err := v(group); err != nil {
return err
}
}
return nil
}
func (h *Hooks) executeOnGroupNameHooks(group Group) error {
// Check mounting
if h.app.mountFields.mountPath != "" {
group.Prefix = h.app.mountFields.mountPath + group.Prefix
}
for _, v := range h.onGroupName {
if err := v(group); err != nil {
return err
}
}
return nil
}
func (h *Hooks) executeOnListenHooks(listenData *ListenData) error {
for _, v := range h.onListen {
if err := v(*listenData); err != nil {
return err
}
}
return nil
}
func (h *Hooks) executeOnPreStartupMessageHooks(data *PreStartupMessageData) error {
for _, handler := range h.onPreStartup {
if err := handler(data); err != nil {
return err
}
}
return nil
}
func (h *Hooks) executeOnPostStartupMessageHooks(data *PostStartupMessageData) error {
for _, handler := range h.onPostStartup {
if err := handler(data); err != nil {
return err
}
}
return nil
}
// snapshotOnPreShutdown copies the registered pre-shutdown hooks under the app
// mutex, so a hook may register others without deadlocking on the iteration.
func (h *Hooks) snapshotOnPreShutdown() []OnPreShutdownHandler {
if h.app == nil {
return h.onPreShutdown
}
h.app.mutex.Lock()
defer h.app.mutex.Unlock()
return append([]OnPreShutdownHandler(nil), h.onPreShutdown...)
}
// snapshotOnPostShutdown copies the registered post-shutdown hooks under the
// app mutex, for the same reason as snapshotOnPreShutdown.
func (h *Hooks) snapshotOnPostShutdown() []OnPostShutdownHandler {
if h.app == nil {
return h.onPostShutdown
}
h.app.mutex.Lock()
defer h.app.mutex.Unlock()
return append([]OnPostShutdownHandler(nil), h.onPostShutdown...)
}
func (h *Hooks) executeOnPreShutdownHooks() {
// Snapshot under the app mutex the registration appends under: shutdown no
// longer holds it while draining, so iterating the slice directly races.
for _, v := range h.snapshotOnPreShutdown() {
if err := v(); err != nil {
log.Errorf("failed to call pre shutdown hook: %v", err)
}
}
}
func (h *Hooks) executeOnPostShutdownHooks(err error) {
for _, v := range h.snapshotOnPostShutdown() {
if hookErr := v(err); hookErr != nil {
log.Errorf("failed to call post shutdown hook: %v", hookErr)
}
}
}
func (h *Hooks) executeOnForkHooks(pid int) {
for _, v := range h.onFork {
if err := v(pid); err != nil {
log.Errorf("failed to call fork hook: %v", err)
}
}
}
func (h *Hooks) executeOnMountHooks(app *App) error {
for _, v := range h.onMount {
if err := v(app); err != nil {
return err
}
}
return nil
}