RetailCRM-Mirror/mg-transport-api-client-go
1
0
Fork 0
mirror of synced 2024-11-22 04:56:06 +03:00
Code Issues Projects Releases Wiki Activity

noop limiter & interface for limiter

Browse Source
This commit is contained in:
Pavel 2024-04-17 11:24:02 +03:00
parent c2c33aeb7d
commit 6814216f80
3 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
v1/client.go
View File

@ -36,7 +36,7 @@ func (c *MgClient) WithLogger(logger BasicLogger) *MgClient {
} }
// WithLimiter sets the provided limiter instance into the Client. // WithLimiter sets the provided limiter instance into the Client.
func (c *MgClient) WithLimiter(limiter *TokensBucket) *MgClient { func (c *MgClient) WithLimiter(limiter Limiter) *MgClient {
c.limiter = limiter c.limiter = limiter
return c return c
} }

18
v1/rate_limit.go
View File

@ -7,11 +7,21 @@ import (
"time" "time"
) )
// NoopLimiter implements Limiter but doesn't limit anything.
var NoopLimiter Limiter = &noopLimiter{}
type token struct { type token struct {
rps atomic.Uint32 rps atomic.Uint32
lastUse atomic.Value lastUse atomic.Value
} }
// Limiter implements some form of rate limiting.
type Limiter interface {
// Obtain the right to send a request. Should lock the execution if current goroutine needs to wait.
Obtain(string)
}
// TokensBucket implements basic Limiter with fixed window and fixed amount of tokens per window.
type TokensBucket struct { type TokensBucket struct {
maxRPS uint32 maxRPS uint32
tokens sync.Map tokens sync.Map
@ -21,7 +31,8 @@ type TokensBucket struct {
sleep sleeper sleep sleeper
} }
func NewTokensBucket(maxRPS uint32, unusedTokenTime, checkTokenTime time.Duration) *TokensBucket { // NewTokensBucket constructs TokensBucket with provided parameters.
func NewTokensBucket(maxRPS uint32, unusedTokenTime, checkTokenTime time.Duration) Limiter {
bucket := &TokensBucket{ bucket := &TokensBucket{
maxRPS: maxRPS, maxRPS: maxRPS,
unusedTokenTime: unusedTokenTime, unusedTokenTime: unusedTokenTime,
@ -79,6 +90,11 @@ func (m *TokensBucket) deleteUnusedToken() {
} }
} }
type noopLimiter struct{}
func (l *noopLimiter) Obtain(string) {}
// sleeper sleeps. This thing is necessary for tests.
type sleeper interface { type sleeper interface {
Sleep(time.Duration) Sleep(time.Duration)
} }

12
v1/types.go
View File

@ -78,12 +78,12 @@ const (
// MgClient type. // MgClient type.
type MgClient struct { type MgClient struct {
URL string `json:"url"` URL string `json:"url"`
Token string `json:"token"` Token string `json:"token"`
Debug bool `json:"debug"` Debug bool `json:"debug"`
httpClient *http.Client `json:"-"` httpClient *http.Client `json:"-"`
logger BasicLogger `json:"-"` logger BasicLogger `json:"-"`
limiter *TokensBucket `json:"-"` limiter Limiter `json:"-"`
} }
// Channel type. // Channel type.