-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathrouter.go
More file actions
882 lines (755 loc) · 24 KB
/
router.go
File metadata and controls
882 lines (755 loc) · 24 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
// ⚡️ Fiber is an Express inspired web framework written in Go with ☕️
// 🤖 GitHub Repository: https://github.com/gofiber/fiber
// 📌 API Documentation: https://docs.gofiber.io
package fiber
import (
"fmt"
"slices"
"sync/atomic"
"github.com/gofiber/utils/v2"
utilsstrings "github.com/gofiber/utils/v2/strings"
"github.com/valyala/bytebufferpool"
"github.com/valyala/fasthttp"
)
// Router defines all router handle interface, including app and group router.
type Router interface {
Use(args ...any) Router
Get(path string, handler any, handlers ...any) Router
Head(path string, handler any, handlers ...any) Router
Post(path string, handler any, handlers ...any) Router
Put(path string, handler any, handlers ...any) Router
Delete(path string, handler any, handlers ...any) Router
Connect(path string, handler any, handlers ...any) Router
Options(path string, handler any, handlers ...any) Router
Trace(path string, handler any, handlers ...any) Router
Patch(path string, handler any, handlers ...any) Router
Add(methods []string, path string, handler any, handlers ...any) Router
All(path string, handler any, handlers ...any) Router
Group(prefix string, handlers ...any) Router
Domain(host string) Router
RouteChain(path string) Register
Route(prefix string, fn func(router Router), name ...string) Router
Name(name string) Router
}
// Route is a struct that holds all metadata for each registered handler.
type Route struct {
// ### important: always keep in sync with the copy method "app.copyRoute" and all creations of Route struct ###
group *Group // Group instance. used for routes in groups
path string // Prettified path
// Public fields
Method string `json:"method"` // HTTP method
Name string `json:"name"` // Route's name
//nolint:revive // Having both a Path (uppercase) and a path (lowercase) is fine
Path string `json:"path"` // Original registered route path
Params []string `json:"params"` // Case-sensitive param keys
Handlers []Handler `json:"-"` // Ctx handlers
routeParser routeParser // Parameter parser
// Data for routing
use bool // USE matches path prefixes
mount bool // Indicated a mounted app on a specific route
star bool // Path equals '*'
root bool // Path equals '/'
autoHead bool // Automatically generated HEAD route
caseSensitive bool // Whether parameter matching is case-sensitive
}
var (
defaultGreedyParameterKeys = []string{"*", "+"}
preferredWildcardGreedyParameters = []string{"*", "+"}
preferredPlusGreedyParameters = []string{"+", "*"}
)
// URL generates a URL from the route path and parameters.
// This method fills in the route parameters with the provided values.
// Parameter matching respects the app's CaseSensitive configuration:
// case-insensitive by default, case-sensitive when CaseSensitive is true.
//
// Example:
//
// app.Get("/user/:name/:id", handler).Name("user")
// url, err := app.GetRoute("user").URL(Map{"name": "john", "id": "123"})
// // Returns: "/user/john/123"
//
//nolint:gocritic // hugeParam: app.GetRoute returns a value, so URL must be callable on that value directly.
func (r Route) URL(params Map) (string, error) {
if r.Path == "" {
return "", ErrNotFound
}
return buildRouteURL(&r, params)
}
// buildRouteURL generates a URL from route segments and parameters.
// This shared helper is used by both Route.URL() and DefaultRes.getLocationFromRoute()
// to ensure consistent URL generation behavior across APIs.
//
// Parameter resolution uses a deterministic three-step lookup:
// 1. Exact key match on segment.ParamName
// 2. Case-insensitive fallback picking the lexicographically-smallest matching key (when !caseSensitive)
// 3. Greedy parameter fallback for wildcard (*) and plus (+) parameters
func buildRouteURL(route *Route, params Map) (string, error) {
if len(route.routeParser.segs) == 0 {
return route.Path, nil
}
buf := bytebufferpool.Get()
defer bytebufferpool.Put(buf)
for _, segment := range route.routeParser.segs {
if !segment.IsParam {
_, err := buf.WriteString(segment.Const)
if err != nil {
return "", fmt.Errorf("failed to write string: %w", err)
}
continue
}
var (
val any
found bool
)
// Prefer an exact parameter name match
if val, found = params[segment.ParamName]; !found && !route.caseSensitive {
// Fall back to a case-insensitive match using a deterministic winner
var matchedKey string
foundMatch := false
for key := range params {
if utils.EqualFold(key, segment.ParamName) && (!foundMatch || key < matchedKey) {
matchedKey = key
foundMatch = true
}
}
if foundMatch {
val = params[matchedKey]
found = true
}
}
// For greedy parameters, fall back to generic greedy keys
if !found && segment.IsGreedy {
for _, greedyKey := range preferredGreedyParameters(segment.ParamName) {
if val, found = params[greedyKey]; found {
break
}
}
}
if found {
_, err := buf.WriteString(utils.ToString(val))
if err != nil {
return "", fmt.Errorf("failed to write string: %w", err)
}
}
}
return buf.String(), nil
}
// preferredGreedyParameters returns the generic greedy fallback lookup order
// for a route parameter name.
// Parameter names starting with '+' prefer '+' before '*', names starting with
// '*' prefer '*' before '+', and all other names fall back to the default order.
func preferredGreedyParameters(paramName string) []string {
if paramName != "" {
switch paramName[0] {
case plusParam:
return preferredPlusGreedyParameters
case wildcardParam:
return defaultGreedyParameterKeys
}
}
return defaultGreedyParameterKeys
}
func (r *Route) match(detectionPath, path string, params *[maxParams]string) bool {
// root detectionPath check
if r.root && len(detectionPath) == 1 && detectionPath[0] == '/' {
return true
}
// '*' wildcard matches any detectionPath
if r.star {
if len(path) > 1 {
params[0] = path[1:]
} else {
params[0] = ""
}
return true
}
// Does this route have parameters?
if len(r.Params) > 0 {
// Match params using precomputed routeParser
if r.routeParser.getMatch(detectionPath, path, params, r.use) {
return true
}
}
// Middleware route?
if r.use {
// Single slash or prefix match
plen := len(r.path)
if r.root {
// If r.root is '/', it matches everything starting at '/'
if detectionPath != "" && detectionPath[0] == '/' {
return true
}
} else if len(detectionPath) >= plen && detectionPath[:plen] == r.path {
if hasPartialMatchBoundary(detectionPath, plen) {
return true
}
}
} else if len(r.path) == len(detectionPath) && detectionPath == r.path {
// Check exact match
return true
}
// No match
return false
}
func (app *App) next(c *DefaultCtx) (bool, error) {
methodInt := c.methodInt
treeHash := c.treePathHash
// Get stack length
tree, ok := app.treeStack[methodInt][treeHash]
if !ok {
tree = app.treeStack[methodInt][0]
}
lenr := len(tree) - 1
indexRoute := c.indexRoute
// Loop over the route stack starting from previous index
for indexRoute < lenr {
// Increment route index
indexRoute++
// Get *Route
route := tree[indexRoute]
if route.mount {
continue
}
// Check if it matches the request path
if !route.match(utils.UnsafeString(c.detectionPath), utils.UnsafeString(c.path), &c.values) {
continue
}
if c.skipNonUseRoutes && !route.use {
continue
}
// Pass route reference and param values
c.route = route
// Non use handler matched
if !route.use {
c.matched = true
}
// Execute first handler of route
if len(route.Handlers) > 0 {
c.indexHandler = 0
c.indexRoute = indexRoute
return true, route.Handlers[0](c)
}
return true, nil // Stop scanning the stack
}
// If c.Next() does not match, return 404
// If no match, scan stack again if other methods match the request
// Moved from app.handler because middleware may break the route chain
if c.matched {
return false, ErrNotFound
}
exists := false
methods := app.config.RequestMethods
for i := range methods {
// Skip original method
if methodInt == i {
continue
}
// Reset stack index
indexRoute := -1
tree, ok := app.treeStack[i][treeHash]
if !ok {
tree = app.treeStack[i][0]
}
// Get stack length
lenr := len(tree) - 1
// Loop over the route stack starting from previous index
for indexRoute < lenr {
// Increment route index
indexRoute++
// Get *Route
route := tree[indexRoute]
// Skip use routes
if route.use {
continue
}
// Check if it matches the request path
// No match, next route
if route.match(utils.UnsafeString(c.detectionPath), utils.UnsafeString(c.path), &c.values) {
// We matched
exists = true
// Add method to Allow header
c.Append(HeaderAllow, methods[i])
// Break stack loop
break
}
}
c.indexRoute = indexRoute
}
if exists {
return false, ErrMethodNotAllowed
}
return false, ErrNotFound
}
func (app *App) nextCustom(c CustomCtx) (bool, error) {
methodInt := c.getMethodInt()
treeHash := c.getTreePathHash()
// Get stack length
tree, ok := app.treeStack[methodInt][treeHash]
if !ok {
tree = app.treeStack[methodInt][0]
}
lenr := len(tree) - 1
indexRoute := c.getIndexRoute()
// Loop over the route stack starting from previous index
for indexRoute < lenr {
// Increment route index
indexRoute++
// Get *Route
route := tree[indexRoute]
if route.mount {
continue
}
// Check if it matches the request path
if !route.match(c.getDetectionPath(), c.Path(), c.getValues()) {
continue
}
if c.getSkipNonUseRoutes() && !route.use {
continue
}
// Pass route reference and param values
c.setRoute(route)
// Non use handler matched
if !route.use {
c.setMatched(true)
}
// Execute first handler of route
if len(route.Handlers) > 0 {
c.setIndexHandler(0)
c.setIndexRoute(indexRoute)
return true, route.Handlers[0](c)
}
return true, nil // Stop scanning the stack
}
// If c.Next() does not match, return 404
// If no match, scan stack again if other methods match the request
// Moved from app.handler because middleware may break the route chain
if c.getMatched() {
return false, ErrNotFound
}
exists := false
methods := app.config.RequestMethods
for i := range methods {
// Skip original method
if methodInt == i {
continue
}
// Reset stack index
indexRoute := -1
tree, ok := app.treeStack[i][treeHash]
if !ok {
tree = app.treeStack[i][0]
}
// Get stack length
lenr := len(tree) - 1
// Loop over the route stack starting from previous index
for indexRoute < lenr {
// Increment route index
indexRoute++
// Get *Route
route := tree[indexRoute]
// Skip use routes
if route.use {
continue
}
// Check if it matches the request path
// No match, next route
if route.match(c.getDetectionPath(), c.Path(), c.getValues()) {
// We matched
exists = true
// Add method to Allow header
c.Append(HeaderAllow, methods[i])
// Break stack loop
break
}
}
c.setIndexRoute(indexRoute)
}
if exists {
return false, ErrMethodNotAllowed
}
return false, ErrNotFound
}
func (app *App) requestHandler(rctx *fasthttp.RequestCtx) {
// Acquire context from the pool
ctx := app.AcquireCtx(rctx)
defer app.ReleaseCtx(ctx)
var err error
// Attempt to match a route and execute the chain
if d, isDefault := ctx.(*DefaultCtx); isDefault {
// Check if the HTTP method is valid
if d.methodInt == -1 {
_ = d.SendStatus(StatusNotImplemented) //nolint:errcheck // Always return nil
return
}
// Optional: check flash messages (hot path, see hasFlashCookie).
if hasFlashCookie(&d.Request().Header) {
d.Redirect().parseAndClearFlashMessages()
}
_, err = app.next(d)
} else {
// Check if the HTTP method is valid
if ctx.getMethodInt() == -1 {
_ = ctx.SendStatus(StatusNotImplemented) //nolint:errcheck // Always return nil
return
}
// Optional: check flash messages (hot path, see hasFlashCookie).
if hasFlashCookie(&ctx.Request().Header) {
ctx.Redirect().parseAndClearFlashMessages()
}
_, err = app.nextCustom(ctx)
}
if err != nil {
if catch := ctx.App().ErrorHandler(ctx, err); catch != nil {
_ = ctx.SendStatus(StatusInternalServerError) //nolint:errcheck // Always return nil
}
return
}
}
func (app *App) addPrefixToRoute(prefix string, route *Route) *Route {
prefixedPath := getGroupPath(prefix, route.Path)
prettyPath := prefixedPath
// Case-sensitive routing, all to lowercase
if !app.config.CaseSensitive {
prettyPath = utilsstrings.ToLower(prettyPath)
}
// Strict routing, remove trailing slashes
if !app.config.StrictRouting && len(prettyPath) > 1 {
prettyPath = utils.TrimRight(prettyPath, '/')
}
route.Path = prefixedPath
route.path = RemoveEscapeChar(prettyPath)
route.routeParser = parseRoute(prettyPath, app.customConstraints...)
route.root = false
route.star = false
route.caseSensitive = app.config.CaseSensitive
return route
}
func (*App) copyRoute(route *Route) *Route {
return &Route{
// Router booleans
use: route.use,
mount: route.mount,
star: route.star,
root: route.root,
autoHead: route.autoHead,
caseSensitive: route.caseSensitive,
// Path data
path: route.path,
routeParser: route.routeParser,
// Public data
Path: route.Path,
Params: route.Params,
Name: route.Name,
Method: route.Method,
Handlers: route.Handlers,
}
}
func (app *App) normalizePath(path string) string {
if path == "" {
path = "/"
}
if path[0] != '/' {
path = "/" + path
}
if !app.config.CaseSensitive {
path = utilsstrings.ToLower(path)
}
if !app.config.StrictRouting && len(path) > 1 {
path = utils.TrimRight(path, '/')
}
return RemoveEscapeChar(path)
}
// RemoveRoute is used to remove a route from the stack by path.
// If no methods are specified, it will remove the route for all methods defined in the app.
// You should call RebuildTree after using this to ensure consistency of the tree.
func (app *App) RemoveRoute(path string, methods ...string) {
// Normalize same as register uses
norm := app.normalizePath(path)
pathMatchFunc := func(r *Route) bool {
return r.path == norm // compare private normalized path
}
app.deleteRoute(methods, pathMatchFunc)
}
// RemoveRouteByName is used to remove a route from the stack by name.
// If no methods are specified, it will remove the route for all methods defined in the app.
// You should call RebuildTree after using this to ensure consistency of the tree.
func (app *App) RemoveRouteByName(name string, methods ...string) {
matchFunc := func(r *Route) bool { return r.Name == name }
app.deleteRoute(methods, matchFunc)
}
// RemoveRouteFunc is used to remove a route from the stack by a custom match function.
// If no methods are specified, it will remove the route for all methods defined in the app.
// You should call RebuildTree after using this to ensure consistency of the tree.
// Note: The route.Path is original path, not the normalized path.
func (app *App) RemoveRouteFunc(matchFunc func(r *Route) bool, methods ...string) {
app.deleteRoute(methods, matchFunc)
}
func (app *App) deleteRoute(methods []string, matchFunc func(r *Route) bool) {
if len(methods) == 0 {
methods = app.config.RequestMethods
}
app.mutex.Lock()
defer app.mutex.Unlock()
removedUseRoutes := make(map[string]struct{})
for _, method := range methods {
// Uppercase HTTP methods
method = utilsstrings.ToUpper(method)
// Get unique HTTP method identifier
m := app.methodInt(method)
if m == -1 {
continue // Skip invalid HTTP methods
}
for i := len(app.stack[m]) - 1; i >= 0; i-- {
route := app.stack[m][i]
if !matchFunc(route) {
continue // Skip if route does not match
}
app.stack[m] = append(app.stack[m][:i], app.stack[m][i+1:]...)
app.routesRefreshed = true
// Decrement global handler count. In middleware routes, only decrement once
if _, ok := removedUseRoutes[route.path]; (route.use && slices.Equal(methods, app.config.RequestMethods) && !ok) || !route.use {
if route.use {
removedUseRoutes[route.path] = struct{}{}
}
atomic.AddUint32(&app.handlersCount, ^uint32(len(route.Handlers)-1)) //nolint:gosec // G115 - handler count is always small
}
if method == MethodGet && !route.use && !route.mount {
app.pruneAutoHeadRouteLocked(route.path)
}
}
}
}
// pruneAutoHeadRouteLocked removes an automatically generated HEAD route so a
// later explicit registration can take its place without duplicating handler
// chains. The caller must already hold app.mutex.
func (app *App) pruneAutoHeadRouteLocked(path string) {
headIndex := app.methodInt(MethodHead)
if headIndex == -1 {
return
}
norm := app.normalizePath(path)
headStack := app.stack[headIndex]
for i := len(headStack) - 1; i >= 0; i-- {
headRoute := headStack[i]
if headRoute.path != norm || headRoute.mount || headRoute.use || !headRoute.autoHead {
continue
}
app.stack[headIndex] = append(headStack[:i], headStack[i+1:]...)
app.routesRefreshed = true
atomic.AddUint32(&app.handlersCount, ^uint32(len(headRoute.Handlers)-1)) //nolint:gosec // G115 - handler count is always small
return
}
}
func (app *App) register(methods []string, pathRaw string, group *Group, handlers ...Handler) {
// A regular route requires at least one ctx handler
if len(handlers) == 0 && group == nil {
panic(fmt.Sprintf("missing handler/middleware in route: %s\n", pathRaw))
}
// No nil handlers allowed
for _, h := range handlers {
if h == nil {
panic(fmt.Sprintf("nil handler in route: %s\n", pathRaw))
}
}
// Precompute path normalization ONCE
if pathRaw == "" {
pathRaw = "/"
}
if pathRaw[0] != '/' {
pathRaw = "/" + pathRaw
}
pathPretty := pathRaw
if !app.config.CaseSensitive {
pathPretty = utilsstrings.ToLower(pathPretty)
}
if !app.config.StrictRouting && len(pathPretty) > 1 {
pathPretty = utils.TrimRight(pathPretty, '/')
}
pathClean := RemoveEscapeChar(pathPretty)
parsedRaw := parseRoute(pathRaw, app.customConstraints...)
parsedPretty := parseRoute(pathPretty, app.customConstraints...)
isMount := group != nil && group.app != app
for _, method := range methods {
method = utilsstrings.ToUpper(method)
if method != methodUse && app.methodInt(method) == -1 {
panic(fmt.Sprintf("add: invalid http method %s\n", method))
}
isUse := method == methodUse
isStar := pathClean == "/*"
isRoot := pathClean == "/"
route := Route{
use: isUse,
mount: isMount,
star: isStar,
root: isRoot,
caseSensitive: app.config.CaseSensitive,
path: pathClean,
routeParser: parsedPretty,
Params: parsedRaw.params,
group: group,
Path: pathRaw,
Method: method,
Handlers: handlers,
}
// Increment global handler count
atomic.AddUint32(&app.handlersCount, uint32(len(handlers))) //nolint:gosec // G115 - handler count is always small
// Middleware route matches all HTTP methods
if isUse {
// Add route to all HTTP methods stack
for _, m := range app.config.RequestMethods {
// Create a route copy to avoid duplicates during compression
r := route
app.addRoute(m, &r)
}
} else {
// Add route to stack
app.addRoute(method, &route)
}
}
}
func (app *App) addRoute(method string, route *Route) {
app.mutex.Lock()
defer app.mutex.Unlock()
// Get unique HTTP method identifier
m := app.methodInt(method)
if method == MethodHead && !route.mount && !route.use {
app.pruneAutoHeadRouteLocked(route.path)
}
// prevent identically route registration
l := len(app.stack[m])
if l > 0 && app.stack[m][l-1].Path == route.Path && route.use == app.stack[m][l-1].use && !route.mount && !app.stack[m][l-1].mount {
preRoute := app.stack[m][l-1]
preRoute.Handlers = append(preRoute.Handlers, route.Handlers...)
} else {
route.Method = method
// Add route to the stack
app.stack[m] = append(app.stack[m], route)
app.routesRefreshed = true
}
// Execute onRoute hooks & change latestRoute if not adding mounted route
if !route.mount {
app.latestRoute = route
if err := app.hooks.executeOnRouteHooks(route); err != nil {
panic(err)
}
}
}
func (app *App) ensureAutoHeadRoutes() {
app.mutex.Lock()
defer app.mutex.Unlock()
app.ensureAutoHeadRoutesLocked()
}
func (app *App) ensureAutoHeadRoutesLocked() {
if app.config.DisableHeadAutoRegister {
return
}
headIndex := app.methodInt(MethodHead)
getIndex := app.methodInt(MethodGet)
if headIndex == -1 || getIndex == -1 {
return
}
headStack := app.stack[headIndex]
existing := make(map[string]struct{}, len(headStack))
for _, route := range headStack {
if route.mount || route.use {
continue
}
existing[route.path] = struct{}{}
}
if len(app.stack[getIndex]) == 0 {
return
}
var added bool
for _, route := range app.stack[getIndex] {
if route.mount || route.use {
continue
}
if _, ok := existing[route.path]; ok {
continue
}
headRoute := app.copyRoute(route)
headRoute.group = route.group
headRoute.Method = MethodHead
headRoute.autoHead = true
// Fasthttp automatically omits response bodies when transmitting
// HEAD responses, so the copied GET handler stack can execute
// unchanged while still producing an empty body on the wire.
headStack = append(headStack, headRoute)
existing[route.path] = struct{}{}
app.routesRefreshed = true
added = true
atomic.AddUint32(&app.handlersCount, uint32(len(headRoute.Handlers))) //nolint:gosec // G115 - handler count is always small
app.latestRoute = headRoute
if err := app.hooks.executeOnRouteHooks(headRoute); err != nil {
panic(err)
}
}
if added {
app.stack[headIndex] = headStack
}
}
// RebuildTree rebuilds the prefix tree from the previously registered routes.
// This method is useful when you want to register routes dynamically after the app has started.
// It is not recommended to use this method on production environments because rebuilding
// the tree is performance-intensive and not thread-safe in runtime. Since building the tree
// is only done in the startupProcess of the app, this method does not make sure that the
// routeTree is being safely changed, as it would add a great deal of overhead in the request.
// Latest benchmark results showed a degradation from 82.79 ns/op to 94.48 ns/op and can be found in:
// https://github.com/gofiber/fiber/issues/2769#issuecomment-2227385283
func (app *App) RebuildTree() *App {
app.mutex.Lock()
defer app.mutex.Unlock()
return app.buildTree()
}
// buildTree build the prefix tree from the previously registered routes
func (app *App) buildTree() *App {
// If routes haven't been refreshed, nothing to do
if !app.routesRefreshed {
return app
}
// 1) First loop: determine all possible 3-char prefixes ("treePaths") for each method
for method := range app.config.RequestMethods {
routes := app.stack[method]
treePaths := make([]int, len(routes))
globalCount := 0
prefixCounts := make(map[int]int, len(routes))
for i, route := range routes {
if len(route.routeParser.segs) > 0 && len(route.routeParser.segs[0].Const) >= maxDetectionPaths {
treePaths[i] = int(route.routeParser.segs[0].Const[0])<<16 |
int(route.routeParser.segs[0].Const[1])<<8 |
int(route.routeParser.segs[0].Const[2])
}
if treePaths[i] == 0 {
globalCount++
continue
}
prefixCounts[treePaths[i]]++
}
prevBuckets := app.treeStack[method]
tsMap := make(map[int][]*Route, len(prefixCounts)+1)
tsMap[0] = reuseRouteBucket(prevBuckets, 0, globalCount)
for treePath, count := range prefixCounts {
tsMap[treePath] = reuseRouteBucket(prevBuckets, treePath, count+globalCount)
}
for i, route := range routes {
treePath := treePaths[i]
if treePath == 0 {
for bucket := range tsMap {
tsMap[bucket] = append(tsMap[bucket], route)
}
continue
}
tsMap[treePath] = append(tsMap[treePath], route)
}
app.treeStack[method] = tsMap
}
// reset the flag and return
app.routesRefreshed = false
return app
}
func reuseRouteBucket(prev map[int][]*Route, key, capHint int) []*Route {
if bucket, ok := prev[key]; ok && cap(bucket) >= capHint {
return bucket[:0]
}
return make([]*Route, 0, capHint)
}