From e943c70524df55e57bf9800086e5acce0e5a46db Mon Sep 17 00:00:00 2001 From: sunhailinLeo <379978424@qq.com> Date: Thu, 22 Sep 2022 19:09:25 +0800 Subject: [PATCH] add adapters for fiber --- pkg/adapters/fiber/doc.go | 2 + pkg/adapters/fiber/go.mod | 10 ++ pkg/adapters/fiber/go.sum | 86 ++++++++++++ pkg/adapters/fiber/middleware.go | 41 ++++++ pkg/adapters/fiber/middleware_test.go | 134 +++++++++++++++++++ pkg/adapters/fiber/middlware_example_test.go | 29 ++++ pkg/adapters/fiber/option.go | 34 +++++ 7 files changed, 336 insertions(+) create mode 100644 pkg/adapters/fiber/doc.go create mode 100644 pkg/adapters/fiber/go.mod create mode 100644 pkg/adapters/fiber/go.sum create mode 100644 pkg/adapters/fiber/middleware.go create mode 100644 pkg/adapters/fiber/middleware_test.go create mode 100644 pkg/adapters/fiber/middlware_example_test.go create mode 100644 pkg/adapters/fiber/option.go diff --git a/pkg/adapters/fiber/doc.go b/pkg/adapters/fiber/doc.go new file mode 100644 index 000000000..5bd7651f3 --- /dev/null +++ b/pkg/adapters/fiber/doc.go @@ -0,0 +1,2 @@ +// This package provides Sentinel middleware for fiber. +package fiber diff --git a/pkg/adapters/fiber/go.mod b/pkg/adapters/fiber/go.mod new file mode 100644 index 000000000..d1ff4cd57 --- /dev/null +++ b/pkg/adapters/fiber/go.mod @@ -0,0 +1,10 @@ +module github.com/alibaba/sentinel-golang/pkg/adapters/fiber + +go 1.13 + +require ( + github.com/StackExchange/wmi v1.2.1 // indirect + github.com/alibaba/sentinel-golang v1.0.2 + github.com/gofiber/fiber/v2 v2.37.1 + github.com/stretchr/testify v1.5.1 +) diff --git a/pkg/adapters/fiber/go.sum b/pkg/adapters/fiber/go.sum new file mode 100644 index 000000000..26ca0403a --- /dev/null +++ b/pkg/adapters/fiber/go.sum @@ -0,0 +1,86 @@ +github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= +github.com/StackExchange/wmi v1.2.1 h1:VIkavFPXSjcnS+O8yTq7NI32k0R5Aj+v39y29VYDOSA= +github.com/StackExchange/wmi v1.2.1/go.mod h1:rcmrprowKIVzvc+NUiLncP2uuArMWLCbu9SBzvHz7e8= +github.com/alibaba/sentinel-golang v1.0.2 h1:Acopq74hOtZN4MV1v811MQ6QcqPFLDSczTrRXv9zpIg= +github.com/alibaba/sentinel-golang v1.0.2/go.mod h1:QsB99f/z35D2AiMrAWwgWE85kDTkBUIkcmPrRt+61NI= +github.com/andybalholm/brotli v1.0.4 h1:V7DdXeJtZscaqfNuAdSRuRFzuiKlHSC/Zh3zl9qY3JY= +github.com/andybalholm/brotli v1.0.4/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= +github.com/go-ole/go-ole v1.2.5 h1:t4MGB5xEDZvXI+0rMjjsfBsD7yAgp/s9ZDkL1JndXwY= +github.com/go-ole/go-ole v1.2.5/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0= +github.com/gofiber/fiber/v2 v2.37.1 h1:QK2032gjv0ulegpv/qlTEBoXQD3eFFzCHXcNN12UZCs= +github.com/gofiber/fiber/v2 v2.37.1/go.mod h1:j3UslgQeJQP3mNhBxHnLLE8TPqA1Fd/lrl4gD25rRUY= +github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= +github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY= +github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= +github.com/klauspost/compress v1.15.0 h1:xqfchp4whNFxn5A4XFyyYtitiWI8Hy5EW59jEwcyL6U= +github.com/klauspost/compress v1.15.0/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk= +github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= +github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= +github.com/shirou/gopsutil v3.20.11+incompatible h1:LJr4ZQK4mPpIV5gOa4jCOKOGb4ty4DZO54I4FGqIpto= +github.com/shirou/gopsutil v3.20.11+incompatible/go.mod h1:5b4v6he4MtMOwMlS0TUMTu2PcXUg8+E1lC7eC3UO/RA= +github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4= +github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= +github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw= +github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= +github.com/valyala/fasthttp v1.40.0 h1:CRq/00MfruPGFLTQKY8b+8SfdK60TxNztjRMnH0t1Yc= +github.com/valyala/fasthttp v1.40.0/go.mod h1:t/G+3rLek+CyY9bnIE+YlMRddxVAAGjhxndDB4i4C0I= +github.com/valyala/tcplisten v1.0.0 h1:rBHj/Xf+E1tRGZyWIWwJDiRY0zc1Js+CV5DqwacVSA8= +github.com/valyala/tcplisten v1.0.0/go.mod h1:T0xQ8SeCZGxckz9qRXTfG43PvQ/mcWh7FwZEA7Ioqkc= +go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ= +go.uber.org/multierr v1.5.0/go.mod h1:FeouvMocqHpRaaGuG9EjoKcStLC43Zu/fmqdUMPcKYU= +go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20220214200702-86341886e292/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9 h1:nhht2DYV/Sn3qOayu8lM+cU1ii9sTLUeBQwQQfUHtrs= +golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= diff --git a/pkg/adapters/fiber/middleware.go b/pkg/adapters/fiber/middleware.go new file mode 100644 index 000000000..3732ac79d --- /dev/null +++ b/pkg/adapters/fiber/middleware.go @@ -0,0 +1,41 @@ +package fiber + +import ( + "net/http" + + sentinel "github.com/alibaba/sentinel-golang/api" + "github.com/alibaba/sentinel-golang/core/base" + "github.com/gofiber/fiber/v2" +) + +// SentinelMiddleware returns new gin.HandlerFunc +// Default resource name is {method}:{path}, such as "GET:/api/users/:id" +// Default block fallback is returning 429 code +// Define your own behavior by setting options +func SentinelMiddleware(opts ...Option) fiber.Handler { + options := evaluateOptions(opts) + return func(ctx *fiber.Ctx) error { + resourceName := ctx.Route().Method + ":" + string(ctx.Context().Path()) + + if options.resourceExtract != nil { + resourceName = options.resourceExtract(ctx) + } + + entry, entryErr := sentinel.Entry( + resourceName, + sentinel.WithResourceType(base.ResTypeWeb), + sentinel.WithTrafficType(base.Inbound), + ) + + if entryErr != nil { + if options.blockFallback != nil { + return options.blockFallback(ctx) + } else { + return ctx.SendStatus(http.StatusTooManyRequests) + } + } + + defer entry.Exit() + return ctx.Next() + } +} diff --git a/pkg/adapters/fiber/middleware_test.go b/pkg/adapters/fiber/middleware_test.go new file mode 100644 index 000000000..873e4becd --- /dev/null +++ b/pkg/adapters/fiber/middleware_test.go @@ -0,0 +1,134 @@ +package fiber + +import ( + "io" + "net/http" + "net/http/httptest" + "testing" + + sentinel "github.com/alibaba/sentinel-golang/api" + "github.com/alibaba/sentinel-golang/core/flow" + "github.com/gofiber/fiber/v2" + "github.com/stretchr/testify/assert" +) + +func initSentinel(t *testing.T) { + err := sentinel.InitDefault() + if err != nil { + t.Fatalf("Unexpected error: %+v", err) + } + + _, err = flow.LoadRules([]*flow.Rule{ + { + Resource: "GET:/ping", + Threshold: 1.0, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, + StatIntervalInMs: 1000, + }, + { + Resource: "/api/users/123", + Threshold: 0.0, + TokenCalculateStrategy: flow.Direct, + ControlBehavior: flow.Reject, + StatIntervalInMs: 1000, + }, + }) + if err != nil { + t.Fatalf("Unexpected error: %+v", err) + return + } +} + +func TestSentinelMiddleware(t *testing.T) { + type args struct { + opts []Option + method string + path string + reqPath string + handler func(ctx *fiber.Ctx) error + body io.Reader + } + type want struct { + code int + } + var ( + tests = []struct { + name string + args args + want want + }{ + { + name: "default get", + args: args{ + opts: []Option{}, + method: http.MethodGet, + path: "/ping", + reqPath: "/ping", + handler: func(ctx *fiber.Ctx) error { + return ctx.Send([]byte("ping")) + }, + body: nil, + }, + want: want{ + code: http.StatusOK, + }, + }, + { + name: "customize resource extract", + args: args{ + opts: []Option{ + WithResourceExtractor(func(ctx *fiber.Ctx) string { + return string(ctx.Context().Path()) + }), + }, + method: http.MethodPost, + path: "/api/users/:id", + reqPath: "/api/users/123", + handler: func(ctx *fiber.Ctx) error { + return ctx.Send([]byte("ping")) + }, + body: nil, + }, + want: want{ + code: http.StatusTooManyRequests, + }, + }, + { + name: "customize block fallback", + args: args{ + opts: []Option{ + WithBlockFallback(func(ctx *fiber.Ctx) error { + return ctx.Status(http.StatusBadRequest).Send([]byte("block")) + }), + }, + method: http.MethodGet, + path: "/ping", + reqPath: "/ping", + handler: func(ctx *fiber.Ctx) error { + return ctx.Status(http.StatusOK).Send([]byte("ping")) + }, + body: nil, + }, + want: want{ + code: http.StatusBadRequest, + }, + }, + } + ) + initSentinel(t) + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + app := fiber.New() + app.Use(SentinelMiddleware(tt.args.opts...)) + app.Add(tt.args.method, tt.args.path, tt.args.handler) + r := httptest.NewRequest(tt.args.method, tt.args.reqPath, tt.args.body) + resp, err := app.Test(r) + //body, _ := io.ReadAll(resp.Body) + //fmt.Println(string(body)) + assert.Equal(t, nil, err) + assert.Equal(t, tt.want.code, resp.StatusCode) + }) + } +} diff --git a/pkg/adapters/fiber/middlware_example_test.go b/pkg/adapters/fiber/middlware_example_test.go new file mode 100644 index 000000000..f60f72504 --- /dev/null +++ b/pkg/adapters/fiber/middlware_example_test.go @@ -0,0 +1,29 @@ +package fiber + +import "github.com/gofiber/fiber/v2" + +func Example() { + app := fiber.New() + app.Use( + SentinelMiddleware( + // customize resource extractor if required + // method_path by default + WithResourceExtractor(func(ctx *fiber.Ctx) string { + return ctx.GetReqHeaders()["X-Real-IP"] + }), + // customize block fallback if required + // abort with status 429 by default + WithBlockFallback(func(ctx *fiber.Ctx) error { + return ctx.Status(400).JSON(struct { + Error string `json:"error"` + Code int `json:"code"` + }{ + "too many request; the quota used up", + 10222, + }) + })), + ) + + app.Get("/test", func(ctx *fiber.Ctx) error { return nil }) + _ = app.Listen(":8080") +} diff --git a/pkg/adapters/fiber/option.go b/pkg/adapters/fiber/option.go new file mode 100644 index 000000000..ad014befe --- /dev/null +++ b/pkg/adapters/fiber/option.go @@ -0,0 +1,34 @@ +package fiber + +import "github.com/gofiber/fiber/v2" + +type ( + Option func(*options) + options struct { + resourceExtract func(*fiber.Ctx) string + blockFallback func(*fiber.Ctx) error + } +) + +func evaluateOptions(opts []Option) *options { + optCopy := &options{} + for _, opt := range opts { + opt(optCopy) + } + + return optCopy +} + +// WithResourceExtractor sets the resource extractor of the web requests. +func WithResourceExtractor(fn func(*fiber.Ctx) string) Option { + return func(opts *options) { + opts.resourceExtract = fn + } +} + +// WithBlockFallback sets the fallback handler when requests are blocked. +func WithBlockFallback(fn func(ctx *fiber.Ctx) error) Option { + return func(opts *options) { + opts.blockFallback = fn + } +}