Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert "drivers/middleware/gin: add ExcludedKey Option" #3

Merged
merged 1 commit into from
Mar 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions drivers/middleware/gin/middleware.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ type Middleware struct {
OnError ErrorHandler
OnLimitReached LimitReachedHandler
KeyGetter KeyGetter
ExcludedKey ExcludedKey
}

// NewMiddleware return a new instance of a gin middleware.
Expand All @@ -38,11 +37,6 @@ func NewMiddleware(limiter *limiter.Limiter, options ...Option) gin.HandlerFunc
// Handle gin request.
func (middleware *Middleware) Handle(c *gin.Context) {
key := middleware.KeyGetter(c)
if middleware.ExcludedKey != nil && middleware.ExcludedKey(key) {
c.Next()
return
}

context, err := middleware.Limiter.Get(c, key)
if err != nil {
middleware.OnError(c, err)
Expand Down
30 changes: 0 additions & 30 deletions drivers/middleware/gin/middleware_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,34 +125,4 @@ func TestHTTPMiddleware(t *testing.T) {
is.Equal(http.StatusOK, resp.Code, strconv.FormatInt(i, 10))
}

//
// Test ExcludedKey
//
store = memory.NewStore()
is.NotZero(store)
counter = int64(0)
middleware = gin.NewMiddleware(limiter.New(store, rate),
gin.WithKeyGetter(func(c *libgin.Context) string {
v := atomic.AddInt64(&counter, 1)
return strconv.FormatInt(v%2, 10)
}),
gin.WithExcludedKey(gin.DefaultExcludedKey([]string{"1"})),
)
is.NotZero(middleware)

router = libgin.New()
router.Use(middleware)
router.GET("/", func(c *libgin.Context) {
c.String(http.StatusOK, "hello")
})
success = 20
for i := int64(1); i < clients; i++ {
resp := httptest.NewRecorder()
router.ServeHTTP(resp, request)
if i <= success || i%2 == 1 {
is.Equal(http.StatusOK, resp.Code, strconv.FormatInt(i, 10))
} else {
is.Equal(resp.Code, http.StatusTooManyRequests)
}
}
}
23 changes: 0 additions & 23 deletions drivers/middleware/gin/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,26 +62,3 @@ func WithKeyGetter(KeyGetter KeyGetter) Option {
func DefaultKeyGetter(c *gin.Context) string {
return c.ClientIP()
}

// ExcludedKey is function type used to check whether the key should be excluded or not
type ExcludedKey func(key string) bool


// DefaultExcludedKey is the default function returns ExcludedKey
func DefaultExcludedKey(keys []string) ExcludedKey {
m := make(map[string]struct{}, len(keys))
for _, key := range keys {
m[key] = struct{}{}
}
return func(key string) bool {
_, ok := m[key]
return ok
}
}

// WithExcludedKey will configure the Middleware to use the given ExcludedKey.
func WithExcludedKey(fn ExcludedKey) Option {
return option(func(middleware *Middleware) {
middleware.ExcludedKey = fn
})
}