Skip to content

Commit 0d804bb

Browse files
sunhailin-Leosunhailin-Leo
authored
Add adapter for gofiber/fiber (#486)
1 parent 31069ba commit 0d804bb

File tree

7 files changed

+336
-0
lines changed

7 files changed

+336
-0
lines changed

‎pkg/adapters/fiber/doc.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// This package provides Sentinel middleware for fiber.
2+
package fiber

‎pkg/adapters/fiber/go.mod‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
module github.com/alibaba/sentinel-golang/pkg/adapters/fiber
2+
3+
go 1.13
4+
5+
require (
6+
github.com/StackExchange/wmi v1.2.1 // indirect
7+
github.com/alibaba/sentinel-golang v1.0.2
8+
github.com/gofiber/fiber/v2 v2.37.1
9+
github.com/stretchr/testify v1.5.1
10+
)

‎pkg/adapters/fiber/go.sum‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
2+
github.com/StackExchange/wmi v1.2.1 h1:VIkavFPXSjcnS+O8yTq7NI32k0R5Aj+v39y29VYDOSA=
3+
github.com/StackExchange/wmi v1.2.1/go.mod h1:rcmrprowKIVzvc+NUiLncP2uuArMWLCbu9SBzvHz7e8=
4+
github.com/alibaba/sentinel-golang v1.0.2 h1:Acopq74hOtZN4MV1v811MQ6QcqPFLDSczTrRXv9zpIg=
5+
github.com/alibaba/sentinel-golang v1.0.2/go.mod h1:QsB99f/z35D2AiMrAWwgWE85kDTkBUIkcmPrRt+61NI=
6+
github.com/andybalholm/brotli v1.0.4 h1:V7DdXeJtZscaqfNuAdSRuRFzuiKlHSC/Zh3zl9qY3JY=
7+
github.com/andybalholm/brotli v1.0.4/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig=
8+
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
9+
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
10+
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
11+
github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
12+
github.com/go-ole/go-ole v1.2.5 h1:t4MGB5xEDZvXI+0rMjjsfBsD7yAgp/s9ZDkL1JndXwY=
13+
github.com/go-ole/go-ole v1.2.5/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0=
14+
github.com/gofiber/fiber/v2 v2.37.1 h1:QK2032gjv0ulegpv/qlTEBoXQD3eFFzCHXcNN12UZCs=
15+
github.com/gofiber/fiber/v2 v2.37.1/go.mod h1:j3UslgQeJQP3mNhBxHnLLE8TPqA1Fd/lrl4gD25rRUY=
16+
github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
17+
github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY=
18+
github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
19+
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
20+
github.com/klauspost/compress v1.15.0 h1:xqfchp4whNFxn5A4XFyyYtitiWI8Hy5EW59jEwcyL6U=
21+
github.com/klauspost/compress v1.15.0/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk=
22+
github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
23+
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
24+
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
25+
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
26+
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
27+
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
28+
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
29+
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
30+
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
31+
github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
32+
github.com/shirou/gopsutil v3.20.11+incompatible h1:LJr4ZQK4mPpIV5gOa4jCOKOGb4ty4DZO54I4FGqIpto=
33+
github.com/shirou/gopsutil v3.20.11+incompatible/go.mod h1:5b4v6he4MtMOwMlS0TUMTu2PcXUg8+E1lC7eC3UO/RA=
34+
github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
35+
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
36+
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
37+
github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
38+
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
39+
github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
40+
github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc=
41+
github.com/valyala/fasthttp v1.40.0 h1:CRq/00MfruPGFLTQKY8b+8SfdK60TxNztjRMnH0t1Yc=
42+
github.com/valyala/fasthttp v1.40.0/go.mod h1:t/G+3rLek+CyY9bnIE+YlMRddxVAAGjhxndDB4i4C0I=
43+
github.com/valyala/tcplisten v1.0.0 h1:rBHj/Xf+E1tRGZyWIWwJDiRY0zc1Js+CV5DqwacVSA8=
44+
github.com/valyala/tcplisten v1.0.0/go.mod h1:T0xQ8SeCZGxckz9qRXTfG43PvQ/mcWh7FwZEA7Ioqkc=
45+
go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=
46+
go.uber.org/multierr v1.5.0/go.mod h1:FeouvMocqHpRaaGuG9EjoKcStLC43Zu/fmqdUMPcKYU=
47+
go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA=
48+
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
49+
golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
50+
golang.org/x/crypto v0.0.0-20220214200702-86341886e292/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
51+
golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
52+
golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc=
53+
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
54+
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
55+
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
56+
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
57+
golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
58+
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
59+
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
60+
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
61+
golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
62+
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
63+
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
64+
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
65+
golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
66+
golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9 h1:nhht2DYV/Sn3qOayu8lM+cU1ii9sTLUeBQwQQfUHtrs=
67+
golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
68+
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
69+
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
70+
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
71+
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
72+
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
73+
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
74+
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
75+
golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
76+
golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
77+
golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
78+
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
79+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
80+
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
81+
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
82+
gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
83+
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
84+
gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
85+
gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
86+
honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=

‎pkg/adapters/fiber/middleware.go‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
package fiber
2+
3+
import (
4+
"net/http"
5+
6+
sentinel "github.com/alibaba/sentinel-golang/api"
7+
"github.com/alibaba/sentinel-golang/core/base"
8+
"github.com/gofiber/fiber/v2"
9+
)
10+
11+
// SentinelMiddleware returns new gin.HandlerFunc
12+
// Default resource name is {method}:{path}, such as "GET:/api/users/:id"
13+
// Default block fallback is returning 429 code
14+
// Define your own behavior by setting options
15+
func SentinelMiddleware(opts ...Option) fiber.Handler {
16+
options := evaluateOptions(opts)
17+
return func(ctx *fiber.Ctx) error {
18+
resourceName := ctx.Route().Method + ":" + string(ctx.Context().Path())
19+
20+
if options.resourceExtract != nil {
21+
resourceName = options.resourceExtract(ctx)
22+
}
23+
24+
entry, entryErr := sentinel.Entry(
25+
resourceName,
26+
sentinel.WithResourceType(base.ResTypeWeb),
27+
sentinel.WithTrafficType(base.Inbound),
28+
)
29+
30+
if entryErr != nil {
31+
if options.blockFallback != nil {
32+
return options.blockFallback(ctx)
33+
} else {
34+
return ctx.SendStatus(http.StatusTooManyRequests)
35+
}
36+
}
37+
38+
defer entry.Exit()
39+
return ctx.Next()
40+
}
41+
}

‎pkg/adapters/fiber/middleware_test.go‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
package fiber
2+
3+
import (
4+
"io"
5+
"net/http"
6+
"net/http/httptest"
7+
"testing"
8+
9+
sentinel "github.com/alibaba/sentinel-golang/api"
10+
"github.com/alibaba/sentinel-golang/core/flow"
11+
"github.com/gofiber/fiber/v2"
12+
"github.com/stretchr/testify/assert"
13+
)
14+
15+
func initSentinel(t *testing.T) {
16+
err := sentinel.InitDefault()
17+
if err != nil {
18+
t.Fatalf("Unexpected error: %+v", err)
19+
}
20+
21+
_, err = flow.LoadRules([]*flow.Rule{
22+
{
23+
Resource: "GET:/ping",
24+
Threshold: 1.0,
25+
TokenCalculateStrategy: flow.Direct,
26+
ControlBehavior: flow.Reject,
27+
StatIntervalInMs: 1000,
28+
},
29+
{
30+
Resource: "/api/users/123",
31+
Threshold: 0.0,
32+
TokenCalculateStrategy: flow.Direct,
33+
ControlBehavior: flow.Reject,
34+
StatIntervalInMs: 1000,
35+
},
36+
})
37+
if err != nil {
38+
t.Fatalf("Unexpected error: %+v", err)
39+
return
40+
}
41+
}
42+
43+
func TestSentinelMiddleware(t *testing.T) {
44+
type args struct {
45+
opts []Option
46+
method string
47+
path string
48+
reqPath string
49+
handler func(ctx *fiber.Ctx) error
50+
body io.Reader
51+
}
52+
type want struct {
53+
code int
54+
}
55+
var (
56+
tests = []struct {
57+
name string
58+
args args
59+
want want
60+
}{
61+
{
62+
name: "default get",
63+
args: args{
64+
opts: []Option{},
65+
method: http.MethodGet,
66+
path: "/ping",
67+
reqPath: "/ping",
68+
handler: func(ctx *fiber.Ctx) error {
69+
return ctx.Send([]byte("ping"))
70+
},
71+
body: nil,
72+
},
73+
want: want{
74+
code: http.StatusOK,
75+
},
76+
},
77+
{
78+
name: "customize resource extract",
79+
args: args{
80+
opts: []Option{
81+
WithResourceExtractor(func(ctx *fiber.Ctx) string {
82+
return string(ctx.Context().Path())
83+
}),
84+
},
85+
method: http.MethodPost,
86+
path: "/api/users/:id",
87+
reqPath: "/api/users/123",
88+
handler: func(ctx *fiber.Ctx) error {
89+
return ctx.Send([]byte("ping"))
90+
},
91+
body: nil,
92+
},
93+
want: want{
94+
code: http.StatusTooManyRequests,
95+
},
96+
},
97+
{
98+
name: "customize block fallback",
99+
args: args{
100+
opts: []Option{
101+
WithBlockFallback(func(ctx *fiber.Ctx) error {
102+
return ctx.Status(http.StatusBadRequest).Send([]byte("block"))
103+
}),
104+
},
105+
method: http.MethodGet,
106+
path: "/ping",
107+
reqPath: "/ping",
108+
handler: func(ctx *fiber.Ctx) error {
109+
return ctx.Status(http.StatusOK).Send([]byte("ping"))
110+
},
111+
body: nil,
112+
},
113+
want: want{
114+
code: http.StatusBadRequest,
115+
},
116+
},
117+
}
118+
)
119+
initSentinel(t)
120+
121+
for _, tt := range tests {
122+
t.Run(tt.name, func(t *testing.T) {
123+
app := fiber.New()
124+
app.Use(SentinelMiddleware(tt.args.opts...))
125+
app.Add(tt.args.method, tt.args.path, tt.args.handler)
126+
r := httptest.NewRequest(tt.args.method, tt.args.reqPath, tt.args.body)
127+
resp, err := app.Test(r)
128+
//body, _ := io.ReadAll(resp.Body)
129+
//fmt.Println(string(body))
130+
assert.Equal(t, nil, err)
131+
assert.Equal(t, tt.want.code, resp.StatusCode)
132+
})
133+
}
134+
}

‎pkg/adapters/fiber/middlware_example_test.go‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
package fiber
2+
3+
import "github.com/gofiber/fiber/v2"
4+
5+
func Example() {
6+
app := fiber.New()
7+
app.Use(
8+
SentinelMiddleware(
9+
// customize resource extractor if required
10+
// method_path by default
11+
WithResourceExtractor(func(ctx *fiber.Ctx) string {
12+
return ctx.GetReqHeaders()["X-Real-IP"]
13+
}),
14+
// customize block fallback if required
15+
// abort with status 429 by default
16+
WithBlockFallback(func(ctx *fiber.Ctx) error {
17+
return ctx.Status(400).JSON(struct {
18+
Error string `json:"error"`
19+
Code int `json:"code"`
20+
}{
21+
"too many request; the quota used up",
22+
10222,
23+
})
24+
})),
25+
)
26+
27+
app.Get("/test", func(ctx *fiber.Ctx) error { return nil })
28+
_ = app.Listen(":8080")
29+
}

‎pkg/adapters/fiber/option.go‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
package fiber
2+
3+
import "github.com/gofiber/fiber/v2"
4+
5+
type (
6+
Option func(*options)
7+
options struct {
8+
resourceExtract func(*fiber.Ctx) string
9+
blockFallback func(*fiber.Ctx) error
10+
}
11+
)
12+
13+
func evaluateOptions(opts []Option) *options {
14+
optCopy := &options{}
15+
for _, opt := range opts {
16+
opt(optCopy)
17+
}
18+
19+
return optCopy
20+
}
21+
22+
// WithResourceExtractor sets the resource extractor of the web requests.
23+
func WithResourceExtractor(fn func(*fiber.Ctx) string) Option {
24+
return func(opts *options) {
25+
opts.resourceExtract = fn
26+
}
27+
}
28+
29+
// WithBlockFallback sets the fallback handler when requests are blocked.
30+
func WithBlockFallback(fn func(ctx *fiber.Ctx) error) Option {
31+
return func(opts *options) {
32+
opts.blockFallback = fn
33+
}
34+
}

0 commit comments

Comments
 (0)