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.

Sign up for GitHub

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

Rate-Limit header info updated according to standards #5

Merged
merged 9 commits into from
Feb 22, 2023
Merged

Rate-Limit header info updated according to standards #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6f6b2ad
Update go.mod
sercanarga Feb 21, 2023
d3584c5
Rate-Limit-Reset replaced with unixtime
sercanarga Feb 22, 2023
4fb2434
Update gin_rate_limit.go
sercanarga Feb 22, 2023
67a9fc1
Added limit info in info structure
sercanarga Feb 22, 2023
8507291
added header X-Rate-Limit-Limit
sercanarga Feb 22, 2023
e32cd97
changed module name
sercanarga Feb 22, 2023
a91497e
Update go.mod
sercanarga Feb 22, 2023
2c1ce27
package name fixed
sercanarga Feb 22, 2023
b089895
Edited Info structure in redis.go file. Edited the example in README.…
sercanarga Feb 22, 2023
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,12 +117,14 @@ type CustomStore struct {
func (s *CustomStore) Limit(key string, c *gin.Context) Info {
if UserWentOverLimit {
return Info{
Limit: 100,
RateLimited: true,
ResetTime: reset,
RemainingHits: 0,
}
}
return Info{
Limit: 100,
RateLimited: false,
ResetTime: reset,
RemainingHits: remaining,
Expand Down
7 changes: 5 additions & 2 deletions gin_rate_limit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
)

type Info struct {
Limit uint
RateLimited bool
ResetTime time.Time
RemainingHits uint
Expand All @@ -31,14 +32,16 @@ func RateLimiter(s Store, options *Options) gin.HandlerFunc {
}
if options.ErrorHandler == nil {
options.ErrorHandler = func(c *gin.Context, info Info) {
c.Header("X-Rate-Limit-Reset", fmt.Sprintf("%.2f", time.Until(info.ResetTime).Seconds()))
c.Header("X-Rate-Limit-Limit", fmt.Sprintf("%d", info.Limit))
c.Header("X-Rate-Limit-Reset", fmt.Sprintf("%d", info.ResetTime.Unix()))
c.String(429, "Too many requests")
}
}
if options.BeforeResponse == nil {
options.BeforeResponse = func(c *gin.Context, info Info) {
c.Header("X-Rate-Limit-Limit", fmt.Sprintf("%d", info.Limit))
c.Header("X-Rate-Limit-Remaining", fmt.Sprintf("%v", info.RemainingHits))
c.Header("X-Rate-Limit-Reset", fmt.Sprintf("%.2f", time.Until(info.ResetTime).Seconds()))
c.Header("X-Rate-Limit-Reset", fmt.Sprintf("%d", info.ResetTime.Unix()))
}
}
if options.KeyFunc == nil {
Expand Down
3 changes: 3 additions & 0 deletions in_memory.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,15 @@ func (s *inMemoryStoreType) Limit(key string, c *gin.Context) Info {
}
if s.skip != nil && s.skip(c) {
return Info{
Limit: s.limit,
RateLimited: false,
ResetTime: time.Now().Add(time.Duration((s.rate - (time.Now().Unix() - u.ts)) * time.Second.Nanoseconds())),
RemainingHits: u.tokens,
}
}
if u.tokens <= 0 {
return Info{
Limit: s.limit,
RateLimited: true,
ResetTime: time.Now().Add(time.Duration((s.rate - (time.Now().Unix() - u.ts)) * time.Second.Nanoseconds())),
RemainingHits: 0,
Expand All @@ -59,6 +61,7 @@ func (s *inMemoryStoreType) Limit(key string, c *gin.Context) Info {
u.ts = time.Now().Unix()
s.data.Store(key, u)
return Info{
Limit: s.limit,
RateLimited: false,
ResetTime: time.Now().Add(time.Duration((s.rate - (time.Now().Unix() - u.ts)) * time.Second.Nanoseconds())),
RemainingHits: u.tokens,
Expand Down
5 changes: 5 additions & 0 deletions redis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ func (s *redisStoreType) Limit(key string, c *gin.Context) Info {
}
if s.skip != nil && s.skip(c) {
return Info{
Limit: s.limit,
RateLimited: false,
ResetTime: time.Now().Add(time.Duration((s.rate - (time.Now().Unix() - ts)) * time.Second.Nanoseconds())),
RemainingHits: s.limit - uint(hits),
Expand All @@ -50,13 +51,15 @@ func (s *redisStoreType) Limit(key string, c *gin.Context) Info {
panic(err)
} else {
return Info{
Limit: s.limit,
RateLimited: false,
ResetTime: time.Now().Add(time.Duration((s.rate - (time.Now().Unix() - ts)) * time.Second.Nanoseconds())),
RemainingHits: 0,
}
}
}
return Info{
Limit: s.limit,
RateLimited: true,
ResetTime: time.Now().Add(time.Duration((s.rate - (time.Now().Unix() - ts)) * time.Second.Nanoseconds())),
RemainingHits: 0,
Expand All @@ -74,13 +77,15 @@ func (s *redisStoreType) Limit(key string, c *gin.Context) Info {
panic(err)
} else {
return Info{
Limit: s.limit,
RateLimited: false,
ResetTime: time.Now().Add(time.Duration((s.rate - (time.Now().Unix() - ts)) * time.Second.Nanoseconds())),
RemainingHits: s.limit - uint(hits),
}
}
}
return Info{
Limit: s.limit,
RateLimited: false,
ResetTime: time.Now().Add(time.Duration((s.rate - (time.Now().Unix() - ts)) * time.Second.Nanoseconds())),
RemainingHits: s.limit - uint(hits),
Expand Down