Skip to content

fix(runner): avoid data race by retaining rate limiter pointer (#2653) #2656

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

Open
TassioSales wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

fix(runner): avoid data race by retaining rate limiter pointer (#2653) #2656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions runner/runner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ type Runner struct {
hm *hybrid.HybridMap
excludeCdn bool
stats clistats.StatisticsClient
ratelimiter ratelimit.Limiter
ratelimiter *ratelimit.Limiter
HostErrorsCache gcache.Cache[string, int]
browser *Browser
ditClassifier *dit.Classifier
Expand Down Expand Up @@ -416,11 +416,11 @@ func New(options *Options) (*Runner, error) {
runner.hm = hm

if options.RateLimitMinute > 0 {
runner.ratelimiter = *ratelimit.New(context.Background(), uint(options.RateLimitMinute), time.Minute)
runner.ratelimiter = ratelimit.New(context.Background(), uint(options.RateLimitMinute), time.Minute)
} else if options.RateLimit > 0 {
runner.ratelimiter = *ratelimit.New(context.Background(), uint(options.RateLimit), time.Second)
runner.ratelimiter = ratelimit.New(context.Background(), uint(options.RateLimit), time.Second)
} else {
runner.ratelimiter = *ratelimit.NewUnlimited(context.Background())
runner.ratelimiter = ratelimit.NewUnlimited(context.Background())
}

if options.HostMaxErrors >= 0 {
Expand Down Expand Up @@ -917,7 +917,9 @@ func (r *Runner) Close() {
// nolint:errcheck // ignore
r.hm.Close()
r.hp.Dialer.Close()
r.ratelimiter.Stop()
if r.ratelimiter != nil {
r.ratelimiter.Stop()
}

if r.options.HostMaxErrors >= 0 {
r.HostErrorsCache.Purge()
Expand Down
29 changes: 29 additions & 0 deletions runner/runner_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1166,3 +1166,32 @@ func TestHandshakeThenCloseKeepsPlainResult(t *testing.T) {
require.EqualValues(t, 1, atomic.LoadInt64(&tlsHandshakes),
"the failed HTTPS request must complete its TLS handshake first")
}

func TestRunner_RateLimiterInitialization(t *testing.T) {
t.Run("default unlimited rate limiter is non-nil pointer", func(t *testing.T) {
r, err := New(&Options{})
require.NoError(t, err)
defer r.Close()

require.NotNil(t, r.ratelimiter)
r.ratelimiter.Take()
})

t.Run("per-second rate limiter is non-nil pointer", func(t *testing.T) {
r, err := New(&Options{RateLimit: 50})
require.NoError(t, err)
defer r.Close()

require.NotNil(t, r.ratelimiter)
r.ratelimiter.Take()
})

t.Run("per-minute rate limiter is non-nil pointer", func(t *testing.T) {
r, err := New(&Options{RateLimitMinute: 60})
require.NoError(t, err)
defer r.Close()

require.NotNil(t, r.ratelimiter)
r.ratelimiter.Take()
})
}