1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
|
package ratelimit
import (
"sync"
"testing"
"time"
"go.uber.org/atomic"
"github.com/benbjohnson/clock"
"github.com/stretchr/testify/assert"
)
type testRunner interface {
// createLimiter builds a limiter with given options.
createLimiter(int64, ...Option) Limiter
// takeOnceAfter attempts to Take at a specific time.
takeOnceAfter(time.Duration, Limiter)
// startTaking tries to Take() on passed in limiters in a loop/goroutine.
startTaking(rls ...Limiter)
// assertCountAt asserts the limiters have Taken() a number of times at the given time.
// It's a thin wrapper around afterFunc to reduce boilerplate code.
assertCountAt(d time.Duration, count int)
// afterFunc executes a func at a given time.
// not using clock.AfterFunc because andres-erbsen/clock misses a nap there.
afterFunc(d time.Duration, fn func())
// some tests want raw access to the clock.
getClock() *clock.Mock
}
type runnerImpl struct {
t *testing.T
clock *clock.Mock
constructor func(int64, ...Option) Limiter
count atomic.Int32
// maxDuration is the time we need to move into the future for a test.
// It's populated automatically based on assertCountAt/afterFunc.
maxDuration time.Duration
doneCh chan struct{}
wg sync.WaitGroup
}
func runTest(t *testing.T, fn func(testRunner)) {
impls := []struct {
name string
constructor func(int64, ...Option) Limiter
}{
{
name: "mutex",
constructor: func(rate int64, opts ...Option) Limiter {
return newMutexBased(rate, opts...)
},
},
{
name: "atomic",
constructor: func(rate int64, opts ...Option) Limiter {
return newAtomicBased(rate, opts...)
},
},
{
name: "atomic_int64",
constructor: func(rate int64, opts ...Option) Limiter {
return newAtomicInt64Based(rate, opts...)
},
},
}
for _, tt := range impls {
t.Run(tt.name, func(t *testing.T) {
// Set a non-default time.Time since some limiters (int64 in particular) use
// the default value as "non-initialized" state.
clockMock := clock.NewMock()
clockMock.Set(time.Now())
r := runnerImpl{
t: t,
clock: clockMock,
constructor: tt.constructor,
doneCh: make(chan struct{}),
}
defer close(r.doneCh)
defer r.wg.Wait()
fn(&r)
r.clock.Add(r.maxDuration)
})
}
}
// createLimiter builds a limiter with given options.
func (r *runnerImpl) createLimiter(rate int64, opts ...Option) Limiter {
opts = append(opts, WithClock(r.clock))
return r.constructor(rate, opts...)
}
func (r *runnerImpl) getClock() *clock.Mock {
return r.clock
}
// startTaking tries to Take() on passed in limiters in a loop/goroutine.
func (r *runnerImpl) startTaking(rls ...Limiter) {
r.goWait(func() {
for {
for _, rl := range rls {
rl.Take()
}
r.count.Inc()
select {
case <-r.doneCh:
return
default:
}
}
})
}
// takeOnceAfter attempts to Take at a specific time.
func (r *runnerImpl) takeOnceAfter(d time.Duration, rl Limiter) {
r.wg.Add(1)
r.afterFunc(d, func() {
rl.Take()
r.count.Inc()
r.wg.Done()
})
}
// assertCountAt asserts the limiters have Taken() a number of times at a given time.
func (r *runnerImpl) assertCountAt(d time.Duration, count int) {
r.wg.Add(1)
r.afterFunc(d, func() {
assert.Equal(r.t, int32(count), r.count.Load(), "count not as expected")
r.wg.Done()
})
}
// afterFunc executes a func at a given time.
func (r *runnerImpl) afterFunc(d time.Duration, fn func()) {
if d > r.maxDuration {
r.maxDuration = d
}
r.goWait(func() {
select {
case <-r.doneCh:
return
case <-r.clock.After(d):
}
fn()
})
}
// goWait runs a function in a goroutine and makes sure the goroutine was scheduled.
func (r *runnerImpl) goWait(fn func()) {
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
wg.Done()
fn()
}()
wg.Wait()
}
func TestUnlimited(t *testing.T) {
t.Skip()
t.Parallel()
now := time.Now()
rl := NewUnlimited()
for i := 0; i < 1000; i++ {
rl.Take()
}
assert.Condition(t, func() bool { return time.Since(now) < 1*time.Millisecond }, "no artificial delay")
}
func TestRateLimiter(t *testing.T) {
t.Parallel()
runTest(t, func(r testRunner) {
rl := r.createLimiter(100, WithoutSlack)
// Create copious counts concurrently.
r.startTaking(rl)
r.startTaking(rl)
r.startTaking(rl)
r.startTaking(rl)
r.assertCountAt(1*time.Second, 100)
r.assertCountAt(2*time.Second, 200)
r.assertCountAt(3*time.Second, 300)
})
}
func TestDelayedRateLimiter(t *testing.T) {
t.Parallel()
runTest(t, func(r testRunner) {
slow := r.createLimiter(10, WithoutSlack)
fast := r.createLimiter(100, WithoutSlack)
r.startTaking(slow, fast)
r.afterFunc(20*time.Second, func() {
r.startTaking(fast)
r.startTaking(fast)
r.startTaking(fast)
r.startTaking(fast)
})
r.assertCountAt(30*time.Second, 1200)
})
}
func TestPer(t *testing.T) {
t.Parallel()
runTest(t, func(r testRunner) {
rl := r.createLimiter(7, WithoutSlack, Per(time.Minute))
r.startTaking(rl)
r.startTaking(rl)
r.assertCountAt(1*time.Second, 1)
r.assertCountAt(1*time.Minute, 8)
r.assertCountAt(2*time.Minute, 15)
})
}
// TestInitial verifies that the initial sequence is scheduled as expected.
func TestInitial(t *testing.T) {
t.Parallel()
tests := []struct {
msg string
opts []Option
}{
{
msg: "With Slack",
},
{
msg: "Without Slack",
opts: []Option{WithoutSlack},
},
}
for _, tt := range tests {
t.Run(tt.msg, func(t *testing.T) {
runTest(t, func(r testRunner) {
rl := r.createLimiter(10, tt.opts...)
var (
clk = r.getClock()
prev = clk.Now()
results = make(chan time.Time)
have []time.Duration
startWg sync.WaitGroup
)
startWg.Add(3)
for i := 0; i < 3; i++ {
go func() {
startWg.Done()
results <- rl.Take()
}()
}
startWg.Wait()
clk.Add(time.Second)
for i := 0; i < 3; i++ {
ts := <-results
have = append(have, ts.Sub(prev))
prev = ts
}
assert.Equal(t,
[]time.Duration{
0,
time.Millisecond * 100,
time.Millisecond * 100,
},
have,
"bad timestamps for inital takes",
)
})
})
}
}
func TestMaxSlack(t *testing.T) {
t.Parallel()
runTest(t, func(r testRunner) {
rl := r.createLimiter(1, WithSlack(1))
r.takeOnceAfter(time.Nanosecond, rl)
r.takeOnceAfter(2*time.Second+1*time.Nanosecond, rl)
r.takeOnceAfter(2*time.Second+2*time.Nanosecond, rl)
r.takeOnceAfter(2*time.Second+3*time.Nanosecond, rl)
r.takeOnceAfter(2*time.Second+4*time.Nanosecond, rl)
r.assertCountAt(3*time.Second, 3)
r.assertCountAt(10*time.Second, 5)
})
}
func TestSlack(t *testing.T) {
t.Parallel()
// To simulate slack, we combine two limiters.
// - First, we start a single goroutine with both of them,
// during this time the slow limiter will dominate,
// and allow the fast limiter to accumulate slack.
// - After 2 seconds, we start another goroutine with
// only the faster limiter. This will allow it to max out,
// and consume all the slack.
// - After 3 seconds, we look at the final result, and we expect,
// a sum of:
// - slower limiter running for 3 seconds
// - faster limiter running for 1 second
// - slack accumulated by the faster limiter during the two seconds.
// it was blocked by slower limiter.
tests := []struct {
msg string
opt []Option
want int
}{
{
msg: "no option, defaults to 10",
// 2*10 + 1*100 + 1*10 (slack)
want: 130,
},
{
msg: "slack of 10, like default",
opt: []Option{WithSlack(10)},
// 2*10 + 1*100 + 1*10 (slack)
want: 130,
},
{
msg: "slack of 20",
opt: []Option{WithSlack(20)},
// 2*10 + 1*100 + 1*20 (slack)
want: 140,
},
{
// Note this is bigger then the rate of the limiter.
msg: "slack of 150",
opt: []Option{WithSlack(150)},
// 2*10 + 1*100 + 1*150 (slack)
want: 270,
},
{
msg: "no option, defaults to 10, with per",
// 2*(10*2) + 1*(100*2) + 1*10 (slack)
opt: []Option{Per(500 * time.Millisecond)},
want: 230,
},
{
msg: "slack of 10, like default, with per",
opt: []Option{WithSlack(10), Per(500 * time.Millisecond)},
// 2*(10*2) + 1*(100*2) + 1*10 (slack)
want: 230,
},
{
msg: "slack of 20, with per",
opt: []Option{WithSlack(20), Per(500 * time.Millisecond)},
// 2*(10*2) + 1*(100*2) + 1*20 (slack)
want: 240,
},
{
// Note this is bigger then the rate of the limiter.
msg: "slack of 150, with per",
opt: []Option{WithSlack(150), Per(500 * time.Millisecond)},
// 2*(10*2) + 1*(100*2) + 1*150 (slack)
want: 370,
},
}
for _, tt := range tests {
t.Run(tt.msg, func(t *testing.T) {
runTest(t, func(r testRunner) {
slow := r.createLimiter(10, WithoutSlack)
fast := r.createLimiter(100, tt.opt...)
r.startTaking(slow, fast)
r.afterFunc(2*time.Second, func() {
r.startTaking(fast)
r.startTaking(fast)
})
// limiter with 10hz dominates here - we're always at 10.
r.assertCountAt(1*time.Second, 10)
r.assertCountAt(3*time.Second, tt.want)
})
})
}
}
|