-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlimiter_allow_test.go
More file actions
1431 lines (1234 loc) · 60.1 KB
/
limiter_allow_test.go
File metadata and controls
1431 lines (1234 loc) · 60.1 KB
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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package rate
import (
"fmt"
"sync"
"testing"
"time"
"github.com/clipperhouse/ntime"
"github.com/stretchr/testify/require"
)
func TestLimiter_Allow(t *testing.T) {
t.Parallel()
t.Run("SingleBucket", func(t *testing.T) {
t.Parallel()
t.Run("SingleLimit", func(t *testing.T) {
t.Parallel()
t.Run("Basic", func(t *testing.T) {
t.Parallel()
keyFunc := func(input string) string {
return input
}
limit := NewLimit(9, time.Second)
limiter := NewLimiter(keyFunc, limit)
now := ntime.Now()
for range limit.Count() {
require.True(t, limiter.allow("test", now))
}
require.False(t, limiter.allow("test", now))
// A token is ~111ms
now = now.Add(limit.durationPerToken)
require.True(t, limiter.allow("test", now))
})
t.Run("Func", func(t *testing.T) {
t.Parallel()
keyFunc := func(input string) string {
return input
}
limit := NewLimit(9, time.Second)
limitFunc := func(input string) Limit { return limit }
limiter := NewLimiterFunc(keyFunc, limitFunc)
now := ntime.Now()
for range limit.Count() {
require.True(t, limiter.allow("test", now))
}
require.False(t, limiter.allow("test", now))
// A token is ~111ms
now = now.Add(limit.durationPerToken)
require.True(t, limiter.allow("test", now))
})
})
t.Run("MultipleLimits", func(t *testing.T) {
t.Parallel()
t.Run("Basic", func(t *testing.T) {
t.Parallel()
keyFunc := func(input string) string {
return input
}
// Set up a limiter with multiple limits:
// - 2 requests per second (more restrictive)
// - 3 requests per minute (less restrictive per-second, but more restrictive overall)
// This demonstrates that ALL limits must allow for a token to be consumed
perSecond := NewLimit(2, time.Second)
perMinute := NewLimit(3, time.Minute)
limiter := NewLimiter(keyFunc, perSecond, perMinute)
now := ntime.Now()
// Consume tokens up to the per-second limit
calls := perSecond.Count() // 2
for i := range calls {
allowed := limiter.allow("test", now)
require.True(t, allowed, "should allow token %d", i+1)
}
//...leaving 0 in the per-second bucket and 1 in the per-minute bucket
// 2 tokens should have been consumed from both buckets
_, details1 := limiter.peekWithDebug("test", now)
require.Equal(t, perSecond.Count()-calls, details1[0].TokensRemaining(), "per-second bucket should be exhausted")
require.Equal(t, perMinute.Count()-calls, details1[1].TokensRemaining(), "per-minute bucket should have 1 token remaining")
// Per-second limit exhausted, but per-minute has 1 token left,
// should fail because we require all limits to allow
allowed := limiter.allow("test", now)
require.False(t, allowed, "should not allow when per-second limit is exhausted")
// Verify that no tokens were consumed from any bucket,
// because the above request was denied
_, details2 := limiter.peekWithDebug("test", now)
require.Equal(t, details1, details2, "details should be the same before and after the failed request")
// Refill per-second bucket (to 2), by forwarding time; per-minute still has 1
now = now.Add(time.Second)
// Consume 1 token from both buckets
allowed = limiter.allow("test", now)
require.True(t, allowed, "should allow after per-second bucket refills")
// ...leaving 1 in the per-second bucket, 0 in the per-minute bucket
// Even though per-second has 1 token, should fail because per-minute is exhausted
allowed = limiter.allow("test", now)
require.False(t, allowed, "should not allow when per-minute limit is exhausted")
// Verify per-second bucket was not affected by the failed request
_, details3 := limiter.peekWithDebug("test", now)
require.Equal(t, int64(1), details3[0].TokensRemaining(), "per-second bucket should be unchanged after denial")
require.Equal(t, int64(0), details3[1].TokensRemaining(), "per-minute bucket should remain exhausted")
// Refill both buckets by advancing time
now = now.Add(time.Minute)
// Should work now that per-minute is refilled
allowed = limiter.allow("test", now)
require.True(t, allowed, "should allow after per-minute bucket refills")
})
})
t.Run("AlwaysPersists", func(t *testing.T) {
t.Parallel()
keyFunc := func(input int) string {
return fmt.Sprintf("bucket-allow-always-persists-%d", input)
}
limit1 := NewLimit(9, time.Second)
limit2 := NewLimit(99, time.Second)
limiter := NewLimiter(keyFunc, limit1, limit2)
const buckets = 3
now := ntime.Now()
for bucketID := range buckets {
limiter.allow(bucketID, now)
}
expected := buckets * len(limiter.limits)
require.Equal(t, int64(expected), limiter.buckets.count(), "buckets should have persisted after allow")
})
})
t.Run("MultipleBuckets", func(t *testing.T) {
t.Parallel()
t.Run("SingleLimit", func(t *testing.T) {
t.Parallel()
t.Run("Basic", func(t *testing.T) {
t.Parallel()
keyFunc := func(input int) string {
return fmt.Sprintf("test-bucket-%d", input)
}
const buckets = 3
limit := NewLimit(9, time.Second)
limiter := NewLimiter(keyFunc, limit)
now := ntime.Now()
for bucketID := range buckets {
for range 9 {
require.True(t, limiter.allow(bucketID, now))
}
require.False(t, limiter.allow(bucketID, now))
}
})
t.Run("Func", func(t *testing.T) {
t.Parallel()
keyFunc := func(input string) string {
return input
}
const buckets = 3
limit := NewLimit(9, time.Second)
limitFunc := func(input string) Limit { return limit }
limiter := NewLimiterFunc(keyFunc, limitFunc)
now := ntime.Now()
for i := range buckets {
for range 9 {
limiter.allow(fmt.Sprintf("test-%d", i), now)
}
require.False(t, limiter.allow(fmt.Sprintf("test-%d", i), now))
}
})
t.Run("Concurrent", func(t *testing.T) {
t.Parallel()
keyFunc := func(bucketID int) string {
return fmt.Sprintf("test-bucket-%d", bucketID)
}
const buckets = 3
limit := NewLimit(9, time.Second)
limiter := NewLimiter(keyFunc, limit)
start := ntime.Now()
// Enough concurrent processes for each bucket to precisely exhaust the limit
{
var wg sync.WaitGroup
for bucketID := range buckets {
for processID := range limit.Count() {
wg.Add(1)
go func(bucketID int, processID int64) {
defer wg.Done()
allowed := limiter.allow(bucketID, start)
require.True(t, allowed, "process %d for bucket %s should be allowed", processID, keyFunc(bucketID))
}(bucketID, processID)
}
}
wg.Wait()
}
// Verify that additional requests are rejected, all buckets should be exhausted
for bucketID := range buckets {
allowed := limiter.allow(bucketID, start)
require.False(t, allowed, "bucket %d should be exhausted after %d requests", bucketID, limit.Count())
}
// Complete refill
now := start.Add(limit.period)
{
var wg sync.WaitGroup
for bucketID := range buckets {
wg.Add(1)
go func(bucketID int) {
defer wg.Done()
for range limit.Count() {
allowed := limiter.allow(bucketID, now)
require.True(t, allowed, "bucket %d should be refilled after 1 second", bucketID)
}
}(bucketID)
}
wg.Wait()
}
t.Run("Func", func(t *testing.T) {
t.Parallel()
keyFunc := func(bucketID int) string {
return fmt.Sprintf("test-bucket-%d", bucketID)
}
const buckets = 3
limit := NewLimit(9, time.Second)
limitFunc := func(input int) Limit { return limit }
limiter := NewLimiterFunc(keyFunc, limitFunc)
start := ntime.Now()
// Enough concurrent processes for each bucket to precisely exhaust the limit
{
var wg sync.WaitGroup
for bucketID := range buckets {
for processID := range limit.Count() {
wg.Add(1)
go func(bucketID int, processID int64) {
defer wg.Done()
allowed := limiter.allow(bucketID, start)
require.True(t, allowed, "process %d for bucket %s should be allowed", processID, keyFunc(bucketID))
}(bucketID, processID)
}
}
wg.Wait()
}
// Verify that additional requests are rejected, all buckets should be exhausted
{
var wg sync.WaitGroup
for bucketID := range buckets {
wg.Add(1)
go func(bucketID int) {
defer wg.Done()
allowed := limiter.allow(bucketID, start)
require.False(t, allowed, "bucket %d should be exhausted after %d requests", bucketID, limit.Count())
}(bucketID)
}
wg.Wait()
}
// Complete refill
now := start.Add(limit.period)
{
var wg sync.WaitGroup
for bucketID := range buckets {
wg.Add(1)
go func(bucketID int) {
defer wg.Done()
for range limit.Count() {
allowed := limiter.allow(bucketID, now)
require.True(t, allowed, "bucket %d should be refilled after 1 second", bucketID)
}
}(bucketID)
}
wg.Wait()
}
})
})
})
t.Run("MultipleLimits", func(t *testing.T) {
t.Parallel()
t.Run("Basic", func(t *testing.T) {
t.Parallel()
keyFunc := func(input int) string {
return fmt.Sprintf("test-bucket-%d", input)
}
const buckets = 2
perSecond := NewLimit(2, time.Second)
perMinute := NewLimit(3, time.Minute)
limiter := NewLimiter(keyFunc, perSecond, perMinute)
executionTime := ntime.Now()
for bucketID := range buckets {
for range perSecond.Count() {
// exhaust the per-second limit
require.True(t, limiter.allow(bucketID, executionTime), "bucket %d should allow request", bucketID)
}
// per-second limit exhausted, per-minute has 1 token remaining
require.False(t, limiter.allow(bucketID, executionTime), "bucket %d should not allow request", bucketID)
// other buckets should be unaffected
require.True(t, limiter.peek(bucketID+1, executionTime), "bucket %d should allow request", bucketID+1)
require.True(t, limiter.peek(bucketID+2, executionTime), "bucket %d should allow request", bucketID+2)
// refill per-second limit
executionTime = executionTime.Add(time.Second)
require.True(t, limiter.allow(bucketID, executionTime), "bucket %d should allow request", bucketID)
}
})
t.Run("Concurrent", func(t *testing.T) {
t.Parallel()
keyFunc := func(bucketID int) string {
return fmt.Sprintf("test-bucket-%d", bucketID)
}
const buckets = 3
perSecond := NewLimit(2, time.Second)
perMinute := NewLimit(3, time.Minute)
limiter := NewLimiter(keyFunc, perSecond, perMinute)
executionTime := ntime.Now()
// Enough concurrent processes for each bucket to precisely exhaust the per-second limit
{
var wg sync.WaitGroup
for bucketID := range buckets {
for processID := range perSecond.Count() {
wg.Add(1)
go func(bucketID int, processID int64) {
defer wg.Done()
allowed := limiter.allow(bucketID, executionTime)
require.True(t, allowed, "process %d for bucket %s should be allowed", processID, keyFunc(bucketID))
}(bucketID, processID)
}
}
wg.Wait()
}
// Verify that additional requests are rejected, all buckets should be exhausted on per-second limit
{
var wg sync.WaitGroup
for bucketID := range buckets {
wg.Add(1)
go func(bucketID int) {
defer wg.Done()
allowed := limiter.allow(bucketID, executionTime)
require.False(t, allowed, "bucket %d should be exhausted after %d requests", bucketID, perSecond.Count())
}(bucketID)
}
wg.Wait()
}
// Refill per-second limit by advancing time
executionTime = executionTime.Add(time.Second)
// Each bucket should now have 1 more token available from per-second limit,
// but per-minute limit should still have 1 token remaining (3-2=1)
{
var wg sync.WaitGroup
for bucketID := range buckets {
wg.Add(1)
go func(bucketID int) {
defer wg.Done()
allowed := limiter.allow(bucketID, executionTime)
require.True(t, allowed, "bucket %d should allow request after per-second refill", bucketID)
}(bucketID)
}
wg.Wait()
}
// Now all buckets should be exhausted on per-minute limit (used all 3 tokens: 2 initially + 1 after refill)
{
var wg sync.WaitGroup
for bucketID := range buckets {
wg.Add(1)
go func(bucketID int) {
defer wg.Done()
allowed := limiter.allow(bucketID, executionTime)
require.False(t, allowed, "bucket %d should be exhausted on per-minute limit", bucketID)
}(bucketID)
}
wg.Wait()
}
// Complete refill by advancing to refill both limits
executionTime = executionTime.Add(time.Minute)
// Test concurrent access after full refill
{
var wg sync.WaitGroup
for bucketID := range buckets {
for processID := range perSecond.Count() {
wg.Add(1)
go func(bucketID int, processID int64) {
defer wg.Done()
allowed := limiter.allow(bucketID, executionTime)
require.True(t, allowed, "process %d for bucket %s should be allowed after refill", processID, keyFunc(bucketID))
}(bucketID, processID)
}
}
wg.Wait()
}
})
})
})
}
func TestLimiter_AllowN_SingleBucket(t *testing.T) {
t.Parallel()
keyFunc := func(input string) string {
return input
}
limit := NewLimit(9, time.Second)
limiter := NewLimiter(keyFunc, limit)
now := ntime.Now()
require.True(t, limiter.allowN("test", now, 1))
require.True(t, limiter.allowN("test", now, 8))
require.False(t, limiter.allowN("test", now, 1))
now = now.Add(3 * limit.durationPerToken)
require.True(t, limiter.allowN("test", now, 2))
require.True(t, limiter.allowN("test", now, 1))
require.False(t, limiter.allowN("test", now, 1))
}
func TestLimiter_AllowNWithDebug_SingleBucket(t *testing.T) {
t.Parallel()
keyFunc := func(input string) string {
return input + "-key"
}
perSecond := NewLimit(9, time.Second)
perHour := NewLimit(99, time.Hour)
limiter := NewLimiter(keyFunc, perSecond, perHour)
now := ntime.Now()
// previously consumed, running tally
consumed := int64(0)
{
consume := int64(3)
allowed, debugs := limiter.allowNWithDebug("test-allow-with-debug", now, consume)
require.True(t, allowed)
require.Len(t, debugs, 2, "should have debugs for both limits")
d0 := debugs[0]
require.True(t, d0.Allowed())
require.Equal(t, d0.Input(), "test-allow-with-debug")
require.Equal(t, d0.Key(), "test-allow-with-debug-key")
// require.Equal(t, d0.ExecutionTime(), now.ToTime())
require.Equal(t, d0.TokensRequested(), consume)
require.Equal(t, d0.TokensConsumed(), consume)
require.Equal(t, d0.TokensRemaining(), perSecond.Count()-consume)
require.Equal(t, time.Duration(0), d0.RetryAfter(), "per-second RetryAfter should be 0 when allowed")
d1 := debugs[1]
require.True(t, d1.Allowed())
require.Equal(t, d1.Input(), "test-allow-with-debug")
require.Equal(t, d1.Key(), "test-allow-with-debug-key")
// require.Equal(t, d1.ExecutionTime(), now.ToTime())
require.Equal(t, d1.TokensRequested(), consume)
require.Equal(t, d1.TokensConsumed(), consume)
require.Equal(t, d1.TokensRemaining(), perHour.Count()-consume)
require.Equal(t, time.Duration(0), d1.RetryAfter(), "per-hour RetryAfter should be 0 when allowed")
consumed += consume
}
// should still be ok
{
consume := int64(6)
allowed, debugs := limiter.allowNWithDebug("test-allow-with-debug", now, consume)
require.True(t, allowed)
require.Len(t, debugs, 2, "should have debugs for both limits")
d0 := debugs[0]
require.True(t, d0.Allowed())
require.Equal(t, d0.Input(), "test-allow-with-debug")
require.Equal(t, d0.Key(), "test-allow-with-debug-key")
// require.Equal(t, d0.ExecutionTime(), now.ToTime())
require.Equal(t, d0.TokensRequested(), consume)
require.Equal(t, d0.TokensConsumed(), consume)
require.Equal(t, d0.TokensRemaining(), perSecond.Count()-consume-consumed)
require.Equal(t, time.Duration(0), d0.RetryAfter(), "per-second RetryAfter should be 0 when allowed")
d1 := debugs[1]
require.True(t, d1.Allowed())
require.Equal(t, d1.Input(), "test-allow-with-debug")
require.Equal(t, d1.Key(), "test-allow-with-debug-key")
// require.Equal(t, d1.ExecutionTime(), now.ToTime())
require.Equal(t, d1.TokensRequested(), consume)
require.Equal(t, d1.TokensConsumed(), consume)
require.Equal(t, d1.TokensRemaining(), perHour.Count()-consume-consumed)
require.Equal(t, time.Duration(0), d1.RetryAfter(), "per-hour RetryAfter should be 0 when allowed")
consumed += consume
}
// per-second now exhausted, should be denied, no tokens consumed
{
consume := int64(2)
allowed, debugs := limiter.allowNWithDebug("test-allow-with-debug", now, consume)
require.False(t, allowed)
require.Len(t, debugs, 2, "should have debugs for both limits")
d0 := debugs[0]
require.False(t, d0.Allowed())
require.Equal(t, d0.Input(), "test-allow-with-debug")
require.Equal(t, d0.Key(), "test-allow-with-debug-key")
// require.Equal(t, d0.ExecutionTime(), now.ToTime())
require.Equal(t, d0.TokensRequested(), consume)
require.Equal(t, d0.TokensConsumed(), int64(0))
require.Equal(t, d0.TokensRemaining(), perSecond.Count()-consumed)
// per-second limit is exhausted, so we need to wait for 2 tokens to refill
rounding := time.Nanosecond
require.Equal(t, 2*perSecond.durationPerToken, d0.RetryAfter()+rounding, "per-second RetryAfter should be time to refill %d tokens", consume)
d1 := debugs[1]
require.True(t, d1.Allowed())
require.Equal(t, d1.Input(), "test-allow-with-debug")
require.Equal(t, d1.Key(), "test-allow-with-debug-key")
// require.Equal(t, d1.ExecutionTime(), now.ToTime())
require.Equal(t, d1.TokensRequested(), consume)
require.Equal(t, d1.TokensConsumed(), int64(0))
require.Equal(t, d1.TokensRemaining(), perHour.Count()-consumed)
require.Equal(t, time.Duration(0), d1.RetryAfter(), "per-hour RetryAfter should be 0 when tokens are available")
consumed += 0
}
refilled := int64(3)
now = now.Add(time.Duration(refilled) * perSecond.durationPerToken)
// per-second refilled
{
consume := int64(2)
allowed, debugs := limiter.allowNWithDebug("test-allow-with-debug", now, consume)
require.True(t, allowed)
require.Len(t, debugs, 2, "should have debugs for both limits")
d0 := debugs[0]
require.True(t, d0.Allowed())
require.Equal(t, d0.Input(), "test-allow-with-debug")
require.Equal(t, d0.Key(), "test-allow-with-debug-key")
// require.Equal(t, d0.ExecutionTime(), now.ToTime())
require.Equal(t, d0.TokensRequested(), consume)
require.Equal(t, d0.TokensConsumed(), consume)
require.Equal(t, d0.TokensRemaining(), perSecond.Count()-consume-consumed+refilled)
require.Equal(t, time.Duration(0), d0.RetryAfter(), "per-second RetryAfter should be 0 when allowed after refill")
d1 := debugs[1]
require.True(t, d1.Allowed())
require.Equal(t, d1.Input(), "test-allow-with-debug")
require.Equal(t, d1.Key(), "test-allow-with-debug-key")
// require.Equal(t, d1.ExecutionTime(), now.ToTime())
require.Equal(t, d1.TokensRequested(), consume)
require.Equal(t, d1.TokensConsumed(), consume)
require.Equal(t, d1.TokensRemaining(), perHour.Count()-consume-consumed+0) // time passing not enough to refill per-hour
require.Equal(t, time.Duration(0), d1.RetryAfter(), "per-hour RetryAfter should be 0 when allowed")
}
}
func TestLimiter_AllowWithDebug_SingleBucket_MultipleLimits(t *testing.T) {
t.Parallel()
keyFunc := func(input string) string {
return input
}
perSecond := NewLimit(2, time.Second)
perMinute := NewLimit(3, time.Minute)
limiter := NewLimiter(keyFunc, perSecond, perMinute)
const bucketID = "test-allow-with-debug"
executionTime := ntime.Now()
{
// exhaust the per-second limit, but per-minute should still have 1 token
for i := range perSecond.Count() {
allowed, debugs := limiter.allowWithDebug(bucketID, executionTime)
require.True(t, allowed)
require.Len(t, debugs, 2, "should have debugs for both limits")
d0 := debugs[0]
require.Equal(t, perSecond, d0.Limit(), "should have per-second limit in debug")
require.Equal(t, allowed, d0.Allowed(), "allowed should match for per-second limit")
// require.Equal(t, executionTime.ToTime(), d0.ExecutionTime(), "execution time should match for per-second limit")
require.Equal(t, bucketID, d0.Input(), "input should match for per-second limit")
require.Equal(t, bucketID, d0.Key(), "bucket key should match for per-second limit")
require.Equal(t, int64(1), d0.TokensRequested(), "per-second limit should request 1 token")
require.Equal(t, int64(1), d0.TokensConsumed(), "per-second limit should consume 1 token when allowed")
require.Equal(t, perSecond.Count()-i-1, d0.TokensRemaining(), "remaining tokens should match for per-second limit")
require.Equal(t, time.Duration(0), d0.RetryAfter(), "per-second RetryAfter should be 0 when allowed")
d1 := debugs[1]
require.Equal(t, perMinute, d1.Limit(), "should have per-minute limit in debug")
require.Equal(t, allowed, d1.Allowed(), "allowed should match for per-minute limit")
// require.Equal(t, executionTime.ToTime(), d1.ExecutionTime(), "execution time should match for per-minute limit")
require.Equal(t, bucketID, d1.Input(), "input should match for per-minute limit")
require.Equal(t, bucketID, d1.Key(), "bucket key should match for per-minute limit")
require.Equal(t, int64(1), d1.TokensRequested(), "per-minute limit should request 1 token")
require.Equal(t, int64(1), d1.TokensConsumed(), "per-minute limit should consume 1 token when allowed")
require.Equal(t, perMinute.Count()-i-1, d1.TokensRemaining(), "remaining tokens should match for per-minute limit")
require.Equal(t, time.Duration(0), d1.RetryAfter(), "per-minute RetryAfter should be 0 when allowed")
}
}
{
allowed, debugs := limiter.allowWithDebug(bucketID, executionTime)
require.False(t, allowed)
require.Len(t, debugs, 2, "should have debugs for both limits")
// per-second should have been denied
d0 := debugs[0]
require.False(t, d0.Allowed(), "allowed should match for per-second limit")
require.Equal(t, int64(0), d0.TokensRemaining(), "remaining tokens should match for per-second limit")
require.Equal(t, perSecond, d0.Limit(), "should have per-second limit in debug")
require.Equal(t, executionTime.ToTime(), d0.ExecutionTime(), "execution time should match for per-second limit")
require.Equal(t, bucketID, d0.Input(), "input should match for per-second limit")
require.Equal(t, bucketID, d0.Key(), "bucket key should match for per-second limit")
require.Equal(t, int64(1), d0.TokensRequested(), "per-second limit should request 1 token")
require.Equal(t, int64(0), d0.TokensConsumed(), "per-second limit should consume 0 tokens when denied")
// per-second limit is exhausted, so we need to wait for 1 token to refill
expectedRetryAfter := perSecond.durationPerToken
require.Equal(t, expectedRetryAfter, d0.RetryAfter(), "per-second RetryAfter should be time to refill 1 token")
// per-minute still has 1 token
d1 := debugs[1]
require.True(t, d1.Allowed(), "allowed should match for per-minute limit")
require.Equal(t, int64(1), d1.TokensRemaining(), "per-minute limit should have 1 remaining token")
require.Equal(t, perMinute, d1.Limit(), "should have per-minute limit in debug")
require.Equal(t, executionTime.ToTime(), d1.ExecutionTime(), "execution time should match for per-minute limit")
require.Equal(t, bucketID, d1.Input(), "input should match for per-minute limit")
require.Equal(t, bucketID, d1.Key(), "bucket key should match for per-minute limit")
require.Equal(t, int64(1), d1.TokensRequested(), "per-minute limit should request 1 token")
require.Equal(t, int64(0), d1.TokensConsumed(), "per-minute limit should consume 0 tokens when overall request is denied")
require.Equal(t, time.Duration(0), d1.RetryAfter(), "per-minute RetryAfter should be 0 when tokens are available")
}
}
func TestLimiter_AllowWithDebug_MultipleBuckets_MultipleLimits_Concurrent(t *testing.T) {
t.Parallel()
keyFunc := func(bucketID int) string {
return fmt.Sprintf("test-bucket-%d", bucketID)
}
const buckets = 3
perSecond := NewLimit(2, time.Second)
perMinute := NewLimit(3, time.Minute)
limiter := NewLimiter(keyFunc, perSecond, perMinute)
executionTime := ntime.Now()
// Enough concurrent processes for each bucket to precisely exhaust the per-second limit
{
results := make([][]Debug[int, string], buckets*int(perSecond.Count()))
resultIndex := 0
var wg sync.WaitGroup
for bucketID := range buckets {
for processID := range perSecond.Count() {
wg.Add(1)
go func(bucketID int, processID int64, index int) {
defer wg.Done()
allowed, debugs := limiter.allowWithDebug(bucketID, executionTime)
require.True(t, allowed, "process %d for bucket %d should be allowed", processID, bucketID)
require.Len(t, debugs, 2, "should have debugs for both limits")
results[index] = debugs
}(bucketID, processID, resultIndex)
resultIndex++
}
}
wg.Wait()
// Verify all results have the correct structure
for i, debugs := range results {
bucketID := i / int(perSecond.Count()) // Calculate bucketID from index
expectedKey := fmt.Sprintf("test-bucket-%d", bucketID)
d0 := debugs[0]
require.Equal(t, perSecond, d0.Limit(), "debug %d should have per-second limit", i)
require.True(t, d0.Allowed(), "debug %d per-second should be allowed", i)
require.Equal(t, executionTime.ToTime(), d0.ExecutionTime(), "debug %d execution time should match", i)
require.Equal(t, bucketID, d0.Input(), "debug %d input should match", i)
require.Equal(t, expectedKey, d0.Key(), "debug %d key should match", i)
require.Equal(t, int64(1), d0.TokensRequested(), "debug %d should request 1 token", i)
require.Equal(t, int64(1), d0.TokensConsumed(), "debug %d should consume 1 token when allowed", i)
require.Equal(t, time.Duration(0), d0.RetryAfter(), "debug %d RetryAfter should be 0 when allowed", i)
d1 := debugs[1]
require.Equal(t, perMinute, d1.Limit(), "debug %d should have per-minute limit", i)
require.True(t, d1.Allowed(), "debug %d per-minute should be allowed", i)
require.Equal(t, executionTime.ToTime(), d1.ExecutionTime(), "debug %d execution time should match", i)
require.Equal(t, bucketID, d1.Input(), "debug %d input should match", i)
require.Equal(t, expectedKey, d1.Key(), "debug %d key should match", i)
require.Equal(t, int64(1), d1.TokensRequested(), "debug %d should request 1 token", i)
require.Equal(t, int64(1), d1.TokensConsumed(), "debug %d should consume 1 token when allowed", i)
require.Equal(t, time.Duration(0), d1.RetryAfter(), "debug %d RetryAfter should be 0 when allowed", i)
}
}
// Verify that additional requests are rejected, all buckets should be exhausted on per-second limit
{
results := make([][]Debug[int, string], buckets)
var wg sync.WaitGroup
for bucketID := range buckets {
wg.Add(1)
go func(bucketID int) {
defer wg.Done()
allowed, debugs := limiter.allowWithDebug(bucketID, executionTime)
require.False(t, allowed, "bucket %d should be exhausted after %d requests", bucketID, perSecond.Count())
require.Len(t, debugs, 2, "should have debugs for both limits")
results[bucketID] = debugs
}(bucketID)
}
wg.Wait()
// Verify all results show exhaustion correctly
for bucketID, debugs := range results {
expectedKey := fmt.Sprintf("test-bucket-%d", bucketID)
// per-second should be denied
d0 := debugs[0]
require.False(t, d0.Allowed(), "bucket %d per-second should be denied", bucketID)
require.Equal(t, int64(0), d0.TokensRemaining(), "bucket %d per-second should have 0 tokens", bucketID)
require.Equal(t, perSecond, d0.Limit(), "bucket %d should have per-second limit", bucketID)
require.Equal(t, executionTime.ToTime(), d0.ExecutionTime(), "bucket %d execution time should match", bucketID)
require.Equal(t, bucketID, d0.Input(), "bucket %d input should match", bucketID)
require.Equal(t, expectedKey, d0.Key(), "bucket %d key should match", bucketID)
require.Equal(t, int64(1), d0.TokensRequested(), "bucket %d should request 1 token", bucketID)
require.Equal(t, int64(0), d0.TokensConsumed(), "bucket %d should consume 0 tokens when denied", bucketID)
require.Equal(t, perSecond.durationPerToken, d0.RetryAfter(), "bucket %d RetryAfter should be time to refill 1 token", bucketID)
// per-minute still has 1 token
d1 := debugs[1]
require.True(t, d1.Allowed(), "bucket %d per-minute should still allow", bucketID)
require.Equal(t, int64(1), d1.TokensRemaining(), "bucket %d per-minute should have 1 token", bucketID)
require.Equal(t, perMinute, d1.Limit(), "bucket %d should have per-minute limit", bucketID)
require.Equal(t, executionTime.ToTime(), d1.ExecutionTime(), "bucket %d execution time should match", bucketID)
require.Equal(t, bucketID, d1.Input(), "bucket %d input should match", bucketID)
require.Equal(t, expectedKey, d1.Key(), "bucket %d key should match", bucketID)
require.Equal(t, int64(1), d1.TokensRequested(), "bucket %d should request 1 token", bucketID)
require.Equal(t, int64(0), d1.TokensConsumed(), "bucket %d should consume 0 tokens when overall request is denied", bucketID)
require.Equal(t, time.Duration(0), d1.RetryAfter(), "bucket %d RetryAfter should be 0 when tokens are available", bucketID)
}
}
// Refill per-second limit by advancing time
executionTime = executionTime.Add(time.Second)
// Per-second bucket should now have 1 more token available
{
results := make([][]Debug[int, string], buckets)
var wg sync.WaitGroup
for bucketID := range buckets {
wg.Add(1)
go func(bucketID int) {
defer wg.Done()
allowed, debugs := limiter.allowWithDebug(bucketID, executionTime)
require.True(t, allowed, "bucket %d should allow request after per-second refill", bucketID)
require.Len(t, debugs, 2, "should have debugs for both limits")
results[bucketID] = debugs
}(bucketID)
}
wg.Wait()
// Verify all results show successful consumption
for bucketID, debugs := range results {
expectedKey := fmt.Sprintf("test-bucket-%d", bucketID)
d0 := debugs[0]
require.True(t, d0.Allowed(), "bucket %d per-second should allow", bucketID)
require.Equal(t, perSecond.Count()-1, d0.TokensRemaining(), "bucket %d per-second should have 1 token remaining", bucketID)
require.Equal(t, perSecond, d0.Limit(), "bucket %d should have per-second limit", bucketID)
require.Equal(t, executionTime.ToTime(), d0.ExecutionTime(), "bucket %d execution time should match", bucketID)
require.Equal(t, bucketID, d0.Input(), "bucket %d input should match", bucketID)
require.Equal(t, expectedKey, d0.Key(), "bucket %d key should match", bucketID)
require.Equal(t, int64(1), d0.TokensRequested(), "bucket %d should request 1 token", bucketID)
require.Equal(t, int64(1), d0.TokensConsumed(), "bucket %d should consume 1 token when allowed", bucketID)
require.Equal(t, time.Duration(0), d0.RetryAfter(), "bucket %d RetryAfter should be 0 when allowed", bucketID)
d1 := debugs[1]
require.True(t, d1.Allowed(), "bucket %d per-minute should allow", bucketID)
require.Equal(t, int64(0), d1.TokensRemaining(), "bucket %d per-minute should have 0 tokens remaining", bucketID)
require.Equal(t, perMinute, d1.Limit(), "bucket %d should have per-minute limit", bucketID)
require.Equal(t, executionTime.ToTime(), d1.ExecutionTime(), "bucket %d execution time should match", bucketID)
require.Equal(t, bucketID, d1.Input(), "bucket %d input should match", bucketID)
require.Equal(t, expectedKey, d1.Key(), "bucket %d key should match", bucketID)
require.Equal(t, int64(1), d1.TokensRequested(), "bucket %d should request 1 token", bucketID)
require.Equal(t, int64(1), d1.TokensConsumed(), "bucket %d should consume 1 token when allowed", bucketID)
require.Equal(t, time.Duration(0), d1.RetryAfter(), "bucket %d RetryAfter should be 0 when allowed", bucketID)
}
}
// Now all buckets should be exhausted on per-minute limit
{
results := make([][]Debug[int, string], buckets)
var wg sync.WaitGroup
for bucketID := range buckets {
wg.Add(1)
go func(bucketID int) {
defer wg.Done()
allowed, debugs := limiter.allowWithDebug(bucketID, executionTime)
require.False(t, allowed, "bucket %d should be exhausted on per-minute limit", bucketID)
require.Len(t, debugs, 2, "should have debugs for both limits")
results[bucketID] = debugs
}(bucketID)
}
wg.Wait()
// Verify all results show per-minute exhaustion
for bucketID, debugs := range results {
expectedKey := fmt.Sprintf("test-bucket-%d", bucketID)
// per-second should still allow
d0 := debugs[0]
require.True(t, d0.Allowed(), "bucket %d per-second should still allow", bucketID)
require.Equal(t, perSecond.Count()-1, d0.TokensRemaining(), "bucket %d per-second should have 1 token remaining", bucketID)
require.Equal(t, perSecond, d0.Limit(), "bucket %d should have per-second limit", bucketID)
require.Equal(t, executionTime.ToTime(), d0.ExecutionTime(), "bucket %d execution time should match", bucketID)
require.Equal(t, bucketID, d0.Input(), "bucket %d input should match", bucketID)
require.Equal(t, expectedKey, d0.Key(), "bucket %d key should match", bucketID)
require.Equal(t, int64(1), d0.TokensRequested(), "bucket %d should request 1 token", bucketID)
require.Equal(t, int64(0), d0.TokensConsumed(), "bucket %d should consume 0 tokens when overall request is denied", bucketID)
require.Equal(t, time.Duration(0), d0.RetryAfter(), "bucket %d per-second RetryAfter should be 0 when tokens are available", bucketID)
// per-minute should be exhausted
d1 := debugs[1]
require.False(t, d1.Allowed(), "bucket %d per-minute should be denied", bucketID)
require.Equal(t, int64(0), d1.TokensRemaining(), "bucket %d per-minute should have 0 tokens", bucketID)
require.Equal(t, perMinute, d1.Limit(), "bucket %d should have per-minute limit", bucketID)
require.Equal(t, executionTime.ToTime(), d1.ExecutionTime(), "bucket %d execution time should match", bucketID)
require.Equal(t, bucketID, d1.Input(), "bucket %d input should match", bucketID)
require.Equal(t, expectedKey, d1.Key(), "bucket %d key should match", bucketID)
require.Equal(t, int64(1), d1.TokensRequested(), "bucket %d should request 1 token", bucketID)
require.Equal(t, int64(0), d1.TokensConsumed(), "bucket %d should consume 0 tokens when denied", bucketID)
// we moved forward by one second above, so the per-minute limit should be
// 20s - 1s = 19s from its next token
require.Equal(t, perMinute.durationPerToken-time.Second, d1.RetryAfter(), "bucket %d per-minute RetryAfter should be time to refill 1 token", bucketID)
}
}
// Complete refill by advancing to refill both limits
executionTime = executionTime.Add(time.Minute)
// Test concurrent access after full refill
{
var wg sync.WaitGroup
results := make([][]Debug[int, string], buckets*int(perSecond.Count()))
resultIndex := 0
for bucketID := range buckets {
for processID := range perSecond.Count() {
wg.Add(1)
go func(bucketID int, processID int64, index int) {
defer wg.Done()
allowed, debugs := limiter.allowWithDebug(bucketID, executionTime)
require.True(t, allowed, "process %d for bucket %d should be allowed after refill", processID, bucketID)
require.Len(t, debugs, 2, "should have debugs for both limits")
results[index] = debugs
}(bucketID, processID, resultIndex)
resultIndex++
}
}
wg.Wait()
// Verify all results after refill
for i, debugs := range results {
bucketID := i / int(perSecond.Count()) // Calculate bucketID from index
expectedKey := fmt.Sprintf("test-bucket-%d", bucketID)
d0 := debugs[0]
require.True(t, d0.Allowed(), "debug %d per-second should be allowed", i)
require.Equal(t, perSecond, d0.Limit(), "debug %d should have per-second limit", i)
require.Equal(t, executionTime.ToTime(), d0.ExecutionTime(), "debug %d execution time should match", i)
require.Equal(t, bucketID, d0.Input(), "debug %d input should match", i)
require.Equal(t, expectedKey, d0.Key(), "debug %d key should match", i)
require.Equal(t, int64(1), d0.TokensRequested(), "debug %d should request 1 token", i)
require.Equal(t, int64(1), d0.TokensConsumed(), "debug %d should consume 1 token when allowed", i)
require.Equal(t, time.Duration(0), d0.RetryAfter(), "debug %d RetryAfter should be 0 when allowed", i)
d1 := debugs[1]
require.True(t, d1.Allowed(), "debug %d per-minute should be allowed", i)
require.Equal(t, perMinute, d1.Limit(), "debug %d should have per-minute limit", i)
require.Equal(t, executionTime.ToTime(), d1.ExecutionTime(), "debug %d execution time should match", i)
require.Equal(t, bucketID, d1.Input(), "debug %d input should match", i)
require.Equal(t, expectedKey, d1.Key(), "debug %d key should match", i)
require.Equal(t, int64(1), d1.TokensRequested(), "debug %d should request 1 token", i)
require.Equal(t, int64(1), d1.TokensConsumed(), "debug %d should consume 1 token when allowed", i)
require.Equal(t, time.Duration(0), d1.RetryAfter(), "debug %d RetryAfter should be 0 when allowed", i)
}
}
}
func TestLimiter_AllowWithDebug(t *testing.T) {
t.Parallel()
t.Run("SingleBucket", func(t *testing.T) {
t.Parallel()
t.Run("MultipleLimits", func(t *testing.T) {
t.Parallel()
keyFunc := func(input string) string {
return input
}
perSecond := NewLimit(2, time.Second)
perMinute := NewLimit(3, time.Minute)
limiter := NewLimiter(keyFunc, perSecond, perMinute)
const bucketID = "test-allow-with-debug"
executionTime := ntime.Now()
{
// exhaust the per-second limit, but per-minute should still have 1 token
for i := range perSecond.Count() {
allowed, debugs := limiter.allowWithDebug(bucketID, executionTime)
require.True(t, allowed)
require.Len(t, debugs, 2, "should have debugs for both limits")
d0 := debugs[0]
require.Equal(t, perSecond, d0.Limit(), "should have per-second limit in debug")
require.Equal(t, allowed, d0.Allowed(), "allowed should match for per-second limit")
require.Equal(t, executionTime.ToTime(), d0.ExecutionTime(), "execution time should match for per-second limit")
require.Equal(t, bucketID, d0.Input(), "input should match for per-second limit")
require.Equal(t, bucketID, d0.Key(), "bucket key should match for per-second limit")
require.Equal(t, int64(1), d0.TokensRequested(), "per-second limit should request 1 token")
require.Equal(t, int64(1), d0.TokensConsumed(), "per-second limit should consume 1 token when allowed")
require.Equal(t, perSecond.Count()-i-1, d0.TokensRemaining(), "remaining tokens should match for per-second limit")
require.Equal(t, time.Duration(0), d0.RetryAfter(), "per-second RetryAfter should be 0 when allowed")
d1 := debugs[1]
require.Equal(t, perMinute, d1.Limit(), "should have per-minute limit in debug")
require.Equal(t, allowed, d1.Allowed(), "allowed should match for per-minute limit")
require.Equal(t, executionTime.ToTime(), d1.ExecutionTime(), "execution time should match for per-minute limit")
require.Equal(t, bucketID, d1.Input(), "input should match for per-minute limit")
require.Equal(t, bucketID, d1.Key(), "bucket key should match for per-minute limit")
require.Equal(t, int64(1), d1.TokensRequested(), "per-minute limit should request 1 token")
require.Equal(t, int64(1), d1.TokensConsumed(), "per-minute limit should consume 1 token when allowed")
require.Equal(t, perMinute.Count()-i-1, d1.TokensRemaining(), "remaining tokens should match for per-minute limit")
require.Equal(t, time.Duration(0), d1.RetryAfter(), "per-minute RetryAfter should be 0 when allowed")
}
}
{
allowed, debugs := limiter.allowWithDebug(bucketID, executionTime)
require.False(t, allowed)
require.Len(t, debugs, 2, "should have debugs for both limits")
// per-second should have been denied
d0 := debugs[0]
require.False(t, d0.Allowed(), "allowed should match for per-second limit")
require.Equal(t, int64(0), d0.TokensRemaining(), "remaining tokens should match for per-second limit")
require.Equal(t, perSecond, d0.Limit(), "should have per-second limit in debug")
require.Equal(t, executionTime.ToTime(), d0.ExecutionTime(), "execution time should match for per-second limit")
require.Equal(t, bucketID, d0.Input(), "input should match for per-second limit")
require.Equal(t, bucketID, d0.Key(), "bucket key should match for per-second limit")
require.Equal(t, int64(1), d0.TokensRequested(), "per-second limit should request 1 token")
require.Equal(t, int64(0), d0.TokensConsumed(), "per-second limit should consume 0 tokens when denied")
// per-second limit is exhausted, so we need to wait for 1 token to refill
expectedRetryAfter := perSecond.durationPerToken
require.Equal(t, expectedRetryAfter, d0.RetryAfter(), "per-second RetryAfter should be time to refill 1 token")
// per-minute still has 1 token
d1 := debugs[1]
require.True(t, d1.Allowed(), "allowed should match for per-minute limit")
require.Equal(t, int64(1), d1.TokensRemaining(), "per-minute limit should have 1 remaining token")
require.Equal(t, perMinute, d1.Limit(), "should have per-minute limit in debug")
require.Equal(t, executionTime.ToTime(), d1.ExecutionTime(), "execution time should match for per-minute limit")