Repository navigation
Expand file tree
/
Copy pathRedisRateLimiterTest.java
More file actions
551 lines (520 loc) · 29.9 KB
/
Copy pathRedisRateLimiterTest.java
File metadata and controls
551 lines (520 loc) · 29.9 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
package dev.jinhyeon.notificationlab.ratelimit;
import com.github.dockerjava.api.model.PortBinding;
import com.github.dockerjava.api.model.Ports;
import dev.jinhyeon.notificationlab.config.RateLimitProperties;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
import java.net.InetAddress;
import java.net.ServerSocket;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import org.junit.jupiter.api.Test;
import org.springframework.core.io.ClassPathResource;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.utility.MountableFile;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.exceptions.JedisDataException;
import static dev.jinhyeon.notificationlab.ratelimit.RedisRateLimiter.Outcome.ALLOWED;
import static dev.jinhyeon.notificationlab.ratelimit.RedisRateLimiter.Outcome.LIMITED;
import static dev.jinhyeon.notificationlab.ratelimit.RedisRateLimiter.Outcome.UNAVAILABLE;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.awaitility.Awaitility.await;
import static org.junit.jupiter.api.Assertions.assertTimeout;
@Testcontainers
class RedisRateLimiterTest {
@Container
static final GenericContainer<?> REDIS = new GenericContainer<>("redis:7.4.11-alpine")
.withExposedPorts(6379)
.withCommand("redis-server", "--maxmemory", "32mb", "--maxmemory-policy", "noeviction")
.withCreateContainerCmdModifier(cmd -> cmd.getHostConfig().withPortBindings(
Arrays.stream(cmd.getExposedPorts()).map(port ->
new PortBinding(Ports.Binding.bindIpAndPort("127.0.0.1", 0), port)).toList()));
@Test
void firstEvalTimeoutIsBoundedRedactedAndNotReplacedByRecoveryOrClosedPool() {
String key = key(); var registry = new SimpleMeterRegistry();
var client = new RedisRateLimiter(new RateLimitProperties("127.0.0.1", REDIS.getMappedPort(6379), key, 1, 1, 1, 250), registry);
try (client; Jedis admin = admin()) {
seed(admin, key, 1, 1, 1000, now(admin));
assertThat(client.tryAcquire().outcome()).isEqualTo(ALLOWED);
admin.clientPause(1000);
try {
assertThat(client.tryAcquire().failureReason()).isEqualTo(RedisRateLimiter.FailureReason.TIMEOUT);
} finally { admin.clientUnpause(); }
var first = client.diagnostics().get("firstUnavailable");
assertThat(first.toString()).contains("reason=TIMEOUT", "phase=EVAL", "configuredTimeoutMillis=250")
.doesNotContain(key, "127.0.0.1", "Exception", "Read timed out");
await().atMost(Duration.ofSeconds(3)).until(() -> client.tryAcquire().outcome() == ALLOWED);
assertThat(client.diagnostics().get("firstUnavailable")).isEqualTo(first);
client.close();
assertThat(client.tryAcquire().failureReason()).isEqualTo(RedisRateLimiter.FailureReason.POOL_CLOSED);
assertThat(client.diagnostics().get("firstUnavailable")).isEqualTo(first);
}
}
@Test
void splitReservationsRemainEightAndTwoAcrossIndependentClients() throws Exception {
String key = key();
var clients = new ArrayList<RedisRateLimiter>();
try (Jedis admin = admin(); var executor = Executors.newFixedThreadPool(4)) {
initializeSplit(admin, key);
admin.hset(key, Map.of("realtime_credit", "8000", "campaign_credit", "2000", "last_ms", Long.toString(now(admin) + 10000)));
var start = new CountDownLatch(1);
var tasks = new ArrayList<Future<Integer>>();
for (int i = 0; i < 4; i++) {
var client = splitClient(key, i < 2 ? "REALTIME" : "CAMPAIGN");
clients.add(client);
tasks.add(executor.submit(() -> {
assertThat(start.await(2, TimeUnit.SECONDS)).isTrue();
int allowed = 0;
for (int j = 0; j < 12; j++) {
var result = client.tryAcquire();
assertThat(result.outcome()).isIn(ALLOWED, LIMITED);
if (result.outcome() == ALLOWED) allowed++;
}
return allowed;
}));
}
start.countDown();
int realtime = tasks.get(0).get(5, TimeUnit.SECONDS) + tasks.get(1).get(5, TimeUnit.SECONDS);
int campaign = tasks.get(2).get(5, TimeUnit.SECONDS) + tasks.get(3).get(5, TimeUnit.SECONDS);
assertThat(realtime).isEqualTo(8);
assertThat(campaign).isEqualTo(2);
assertThat(admin.hget(key, "realtime_credit")).isEqualTo("0");
assertThat(admin.hget(key, "campaign_credit")).isEqualTo("0");
assertThat(admin.pttl(key)).isEqualTo(-1);
System.out.println("TRAFFIC_BURST clients=4 attempts=48 realtime=8 campaign=2 total=10");
} finally { clients.forEach(RedisRateLimiter::close); }
}
@Test
void splitLiveClockPreservesBothRateEnvelopesAndDoesNotBorrowIdleBudget() throws Exception {
String key = key();
try (Jedis admin = admin(); var realtime = splitClient(key, "REALTIME"); var campaign = splitClient(key, "CAMPAIGN")) {
initializeSplit(admin, key);
long began = Long.parseLong(admin.hget(key, "last_ms"));
int rt = 0, cp = 0;
for (int i = 0; i < 60; i++) {
var a = realtime.tryAcquire(); var b = campaign.tryAcquire();
assertThat(a.outcome()).isIn(ALLOWED, LIMITED);
assertThat(b.outcome()).isIn(ALLOWED, LIMITED);
if (a.outcome() == ALLOWED) rt++;
if (b.outcome() == ALLOWED) cp++;
long elapsed = now(admin) - began;
assertThat(rt).isLessThanOrEqualTo((int) (elapsed * 8 / 1000));
assertThat(cp).isLessThanOrEqualTo((int) (elapsed * 2 / 1000));
TimeUnit.MILLISECONDS.sleep(25);
}
assertThat(rt).isGreaterThan(8); assertThat(cp).isGreaterThanOrEqualTo(2);
admin.hset(key, Map.of("realtime_credit", "8000", "campaign_credit", "0", "last_ms", Long.toString(now(admin) + 5000)));
assertThat(campaign.tryAcquire().outcome()).isEqualTo(LIMITED);
assertThat(admin.hget(key, "realtime_credit")).isEqualTo("8000");
assertThat(realtime.tryAcquire().outcome()).isEqualTo(ALLOWED);
}
}
@Test
void splitRejectsMissingExpiredLegacyMismatchedAndCorruptStateWithoutMutation() {
String key = key();
try (Jedis admin = admin(); var realtime = splitClient(key, "REALTIME"); var campaign = splitClient(key, "CAMPAIGN")) {
assertThat(realtime.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
assertThat(admin.exists(key)).isFalse();
seed(admin, key, 10, 10, 10000, now(admin));
var legacy = admin.hgetAll(key);
assertThat(realtime.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
assertThat(admin.hgetAll(key)).isEqualTo(legacy);
admin.del(key); initializeSplit(admin, key);
var valid = admin.hgetAll(key);
for (var bad : List.of(Map.of("campaign_rate", "3"), Map.of("campaign_credit", "-1"), Map.of("realtime_credit", "8001"))) {
admin.hset(key, bad); var before = admin.hgetAll(key);
assertThat(realtime.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
assertThat(campaign.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
assertThat(admin.hgetAll(key)).isEqualTo(before); admin.hset(key, valid);
}
try (var old = client(key, 10, 10, new SimpleMeterRegistry())) {
assertThat(old.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
}
admin.pexpire(key, 10000);
assertThat(realtime.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
assertThat(admin.hgetAll(key)).isEqualTo(valid);
assertThat(admin.pttl(key)).isPositive();
}
}
@Test
void splitInitializationCreatesOnlyEmptyAbsentStateAndRejectsInvalidAllocation() throws Exception {
String key = key();
String script = new ClassPathResource("redis/initialize-split-quota.lua").getContentAsString(StandardCharsets.UTF_8);
try (Jedis admin = admin()) {
for (var args : List.of(List.of("10", "10", "10", "2"), List.of("10", "10", "2", "0"),
List.of("10", "10", "1.5", "2"), List.of("10", "10", "2", "10"))) {
assertThatThrownBy(() -> admin.eval(script, List.of(key), args)).isInstanceOf(JedisDataException.class);
assertThat(admin.exists(key)).isFalse();
}
initializeSplit(admin, key);
assertThat(admin.hget(key, "realtime_credit")).isEqualTo("0");
assertThat(admin.hget(key, "campaign_credit")).isEqualTo("0");
assertThat(admin.hlen(key)).isEqualTo(8);
var before = admin.hgetAll(key);
assertThatThrownBy(() -> initializeSplit(admin, key)).isInstanceOf(JedisDataException.class);
assertThat(admin.hgetAll(key)).isEqualTo(before);
}
}
private RedisRateLimiter splitClient(String key, String lane) {
return new RedisRateLimiter(new RateLimitProperties("127.0.0.1", REDIS.getMappedPort(6379), key, 10, 10, 1, 250),
new dev.jinhyeon.notificationlab.config.TrafficProperties(
dev.jinhyeon.notificationlab.config.TrafficProperties.Lane.valueOf(lane), true, 2, 2), new SimpleMeterRegistry());
}
private void initializeSplit(Jedis redis, String key) {
try {
String script = new ClassPathResource("redis/initialize-split-quota.lua").getContentAsString(StandardCharsets.UTF_8);
assertThat(redis.eval(script, List.of(key), List.of("10", "10", "2", "2"))).isEqualTo("QUOTA_INITIALIZED_EMPTY");
} catch (java.io.IOException failure) { throw new java.io.UncheckedIOException(failure); }
}
@Test
void independentClientsShareOneBurstUnderConcurrentAcquisition() throws Exception {
String key = key();
var registry = new SimpleMeterRegistry();
var clients = new ArrayList<RedisRateLimiter>();
try (Jedis admin = admin(); var executor = Executors.newFixedThreadPool(4)) {
for (int i = 0; i < 4; i++) clients.add(client(key, 1, 7, registry));
// Freeze refill via persisted future time, not a test clock in the production script.
seed(admin, key, 1, 7, 7000, now(admin) + 10000);
var start = new CountDownLatch(1);
List<Future<List<RedisRateLimiter.Outcome>>> tasks = new ArrayList<>();
for (var client : clients) tasks.add(executor.submit(() -> {
assertThat(start.await(2, TimeUnit.SECONDS)).isTrue();
var outcomes = new ArrayList<RedisRateLimiter.Outcome>();
for (int j = 0; j < 10; j++) outcomes.add(client.tryAcquire().outcome());
return outcomes;
}));
start.countDown();
var results = new ArrayList<RedisRateLimiter.Outcome>();
for (var task : tasks) results.addAll(task.get(5, TimeUnit.SECONDS));
assertThat(results.stream().filter(o -> o == ALLOWED).count()).isEqualTo(7);
assertThat(results.stream().filter(o -> o == LIMITED).count()).isEqualTo(33);
assertThat(results).doesNotContain(UNAVAILABLE);
assertThat(admin.hget(key, "credit")).isEqualTo("0");
assertThat(registry.get("notification.rate.limit.decisions").tag("outcome", "allowed").counter().count()).isEqualTo(7);
assertThat(registry.get("notification.rate.limit.decisions").tag("outcome", "limited").counter().count()).isEqualTo(33);
System.out.println("REDIS_QUOTA clients=4 requests=40 allowed=7 limited=33 unavailable=0");
} finally { clients.forEach(RedisRateLimiter::close); }
}
@Test
void realServerTimeRefillsFractionalCreditAcrossRepeatedDenials() {
String key = key();
try (var client = client(key, 2, 1, new SimpleMeterRegistry()); Jedis admin = admin()) {
seed(admin, key, 2, 1, 1000, now(admin));
assertThat(client.tryAcquire().outcome()).isEqualTo(ALLOWED);
long started = Long.parseLong(admin.hget(key, "last_ms"));
var denied = client.tryAcquire();
assertThat(denied.outcome()).isEqualTo(LIMITED);
assertThat(denied.retryAfterMs()).isBetween(1L, 500L);
await().pollInterval(Duration.ofMillis(20)).atMost(Duration.ofSeconds(2))
.until(() -> client.tryAcquire().outcome() == ALLOWED);
assertThat(Long.parseLong(admin.hget(key, "last_ms")) - started).isGreaterThanOrEqualTo(500);
assertThat(client.tryAcquire().outcome()).isEqualTo(LIMITED);
}
}
@Test
void concurrentClientsWithLiveClockStayWithinSharedRateAndBurstEnvelope() throws Exception {
String key = key();
var clients = new ArrayList<RedisRateLimiter>();
try (Jedis admin = admin(); var executor = Executors.newFixedThreadPool(4)) {
for (int i = 0; i < 4; i++) clients.add(client(key, 10, 3, new SimpleMeterRegistry()));
var start = new CountDownLatch(1);
var tasks = new ArrayList<Future<Integer>>();
for (var client : clients) tasks.add(executor.submit(() -> {
assertThat(start.await(2, TimeUnit.SECONDS)).isTrue();
int admitted = 0;
for (int j = 0; j < 20; j++) {
var result = client.tryAcquire();
assertThat(result.outcome()).isIn(ALLOWED, LIMITED);
if (result.outcome() == ALLOWED) admitted++;
TimeUnit.MILLISECONDS.sleep(25);
}
return admitted;
}));
seed(admin, key, 10, 3, 3000, now(admin));
long began = now(admin);
start.countDown();
int admitted = 0;
for (var task : tasks) admitted += task.get(5, TimeUnit.SECONDS);
long elapsed = now(admin) - began;
assertThat(admitted).isGreaterThan(3).isLessThanOrEqualTo((int) (3 + elapsed * 10 / 1000));
System.out.println("REDIS_RATE clients=4 requests=80 rate=10 burst=3 allowed=" + admitted + " elapsedMs=" + elapsed);
} finally { clients.forEach(RedisRateLimiter::close); }
}
@Test
void refusedConnectionNeverGrantsPermission() throws Exception {
int port;
try (var socket = new ServerSocket(0, 1, InetAddress.getByName("127.0.0.1"))) {
port = socket.getLocalPort();
}
try (var client = new RedisRateLimiter(new RateLimitProperties("127.0.0.1", port, key(), 10, 10, 1, 100),
new SimpleMeterRegistry())) {
assertTimeout(Duration.ofSeconds(2), () -> assertThat(client.tryAcquire().outcome()).isEqualTo(UNAVAILABLE));
}
}
@Test
void connectingClientAlsoOccupiesCapacityWithoutQueueingOtherCalls() throws Exception {
// Accept TCP but deliberately never answer the Redis handshake.
try (var server = new ServerSocket(0, 1, InetAddress.getByName("127.0.0.1"));
var client = new RedisRateLimiter(new RateLimitProperties("127.0.0.1", server.getLocalPort(),
key(), 10, 10, 1, 1000), new SimpleMeterRegistry());
var executor = Executors.newSingleThreadExecutor()) {
server.setSoTimeout(2000);
var connecting = executor.submit(client::tryAcquire);
try (var accepted = server.accept()) {
assertTimeout(Duration.ofMillis(200), () -> assertThat(client.tryAcquire().outcome()).isEqualTo(UNAVAILABLE));
assertThat(connecting.get(3, TimeUnit.SECONDS).outcome()).isEqualTo(UNAVAILABLE);
}
}
}
@Test
void idleRefillIsCappedAndClientRestartDoesNotResetBudget() {
String key = key();
try (Jedis admin = admin()) {
seed(admin, key, 1, 3, 0, now(admin) - 86400000);
try (var client = client(key, 1, 3, new SimpleMeterRegistry())) {
for (int i = 0; i < 3; i++) assertThat(client.tryAcquire().outcome()).isEqualTo(ALLOWED);
assertThat(client.tryAcquire().outcome()).isEqualTo(LIMITED);
}
try (var restarted = client(key, 1, 3, new SimpleMeterRegistry())) {
assertThat(restarted.tryAcquire().outcome()).isEqualTo(LIMITED);
}
assertThat(admin.pttl(key)).isEqualTo(-1); // One persistent provider bucket, no premature expiry.
assertThat(admin.hlen(key)).isEqualTo(5);
}
}
@Test
void backwardsClockDoesNotMintTokensOrMoveStoredTimeBackwards() {
String key = key();
try (Jedis admin = admin(); var client = client(key, 10, 10, new SimpleMeterRegistry())) {
long future = now(admin) + 10000;
seed(admin, key, 10, 10, 0, future);
var denied = client.tryAcquire();
assertThat(denied.outcome()).isEqualTo(LIMITED);
assertThat(denied.retryAfterMs()).isBetween(9000L, 10100L);
assertThat(admin.hget(key, "last_ms")).isEqualTo(Long.toString(future));
assertThat(admin.hget(key, "credit")).isEqualTo("0");
}
}
@Test
void conflictingPolicyOrCorruptStateFailsClosedWithoutOverwritingIt() {
String key = key();
try (Jedis admin = admin(); var client = client(key, 10, 10, new SimpleMeterRegistry())) {
for (Map<String, String> state : List.of(
Map.of("version", "2", "rate", "20", "burst", "10", "credit", "10000", "last_ms", "1"),
Map.of("version", "2", "rate", "10", "burst", "20", "credit", "10000", "last_ms", "1"),
Map.of("version", "1", "rate", "10", "burst", "10", "credit", "10000", "last_ms", "1"),
Map.of("version", "2", "rate", "10", "burst", "10", "credit", "-1", "last_ms", "1"),
Map.of("version", "2", "rate", "10", "burst", "10", "credit", "10001", "last_ms", "1"),
Map.of("version", "2", "rate", "10", "burst", "10", "credit", "0.5", "last_ms", "1"),
Map.of("version", "2", "rate", "10", "burst", "10", "credit", "0", "last_ms", "bad"),
Map.of("version", "2"))) {
admin.del(key); admin.hset(key, state);
assertThat(client.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
assertThat(admin.hgetAll(key)).isEqualTo(state);
}
admin.del(key); admin.set(key, "wrong-type");
assertThat(client.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
assertThat(admin.get(key)).isEqualTo("wrong-type");
}
}
@Test
void scriptCacheFlushDoesNotResetBudgetOrRequireUnsafeRetry() {
String key = key();
try (Jedis admin = admin(); var client = client(key, 1, 1, new SimpleMeterRegistry())) {
seed(admin, key, 1, 1, 1000, now(admin));
assertThat(client.tryAcquire().outcome()).isEqualTo(ALLOWED);
admin.scriptFlush();
assertThat(client.tryAcquire().outcome()).isEqualTo(LIMITED);
}
}
@Test
void redisPauseTimesOutAndFullPoolRejectsWithoutQueueing() throws Exception {
String key = key();
var registry = new SimpleMeterRegistry();
var settings = new RateLimitProperties("127.0.0.1", REDIS.getMappedPort(6379), key, 1, 1, 1, 250);
try (Jedis admin = admin(); var client = new RedisRateLimiter(settings, registry);
var executor = Executors.newSingleThreadExecutor()) {
seed(admin, key, 1, 1, 1000, now(admin));
assertThat(client.tryAcquire().outcome()).isEqualTo(ALLOWED); // Warm the sole connection.
admin.clientPause(1500);
try {
var pending = executor.submit(client::tryAcquire);
await().pollInterval(Duration.ofMillis(5)).atMost(Duration.ofMillis(200)).until(() ->
registry.get("notification.rate.limit.connections.active").gauge().value() == 1);
assertTimeout(Duration.ofMillis(200), () -> {
var rejected = client.tryAcquire();
assertThat(rejected.outcome()).isEqualTo(UNAVAILABLE);
assertThat(rejected.failureReason()).isEqualTo(RedisRateLimiter.FailureReason.SLOT_BUSY);
});
var timeout = pending.get(1, TimeUnit.SECONDS);
assertThat(timeout.outcome()).isEqualTo(UNAVAILABLE);
assertThat(timeout.failureReason()).isEqualTo(RedisRateLimiter.FailureReason.TIMEOUT);
assertThat(registry.get("notification.rate.limit.decisions").tag("outcome", "unavailable").counter().count()).isEqualTo(2);
} finally { admin.clientUnpause(); }
await().atMost(Duration.ofSeconds(3)).until(() -> client.tryAcquire().outcome() == ALLOWED);
}
}
@Test
void missingOrDeletedBudgetNeverCreatesPermitsAndExplicitInitializationStartsEmpty() throws Exception {
String key = key();
try (Jedis admin = admin(); var client = client(key, 1, 2, new SimpleMeterRegistry())) {
for (int i = 0; i < 3; i++) assertThat(client.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
assertThat(admin.exists(key)).isFalse();
assertThat(initialize(admin, key, 1, 2)).isEqualTo("QUOTA_INITIALIZED_EMPTY");
assertThat(admin.hget(key, "credit")).isEqualTo("0");
assertThat(admin.pttl(key)).isEqualTo(-1);
long initialized = Long.parseLong(admin.hget(key, "last_ms"));
assertThat(client.tryAcquire().outcome()).isEqualTo(LIMITED);
await().pollInterval(Duration.ofMillis(20)).atMost(Duration.ofSeconds(3))
.until(() -> client.tryAcquire().outcome() == ALLOWED);
assertThat(Long.parseLong(admin.hget(key, "last_ms")) - initialized).isGreaterThanOrEqualTo(1000);
admin.del(key);
assertThat(client.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
try (var restarted = client(key, 1, 2, new SimpleMeterRegistry())) {
assertThat(restarted.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
}
assertThat(admin.exists(key)).isFalse();
}
}
@Test
void initializationNeverOverwritesExistingOrInvalidState() throws Exception {
String key = key();
try (Jedis admin = admin()) {
for (Map<String, String> state : List.of(
Map.of("version", "2", "rate", "1", "burst", "2", "credit", "0", "last_ms", "1"),
Map.of("version", "1"), Map.of("broken", "state"))) {
admin.del(key); admin.hset(key, state);
assertThatThrownBy(() -> initialize(admin, key, 1, 2)).isInstanceOf(JedisDataException.class);
assertThat(admin.hgetAll(key)).isEqualTo(state);
}
admin.del(key); admin.set(key, "wrong-type");
assertThatThrownBy(() -> initialize(admin, key, 1, 2)).isInstanceOf(JedisDataException.class);
assertThat(admin.get(key)).isEqualTo("wrong-type");
}
}
@Test
void concurrentInitializersCreateExactlyOneEmptyBucket() throws Exception {
String key = key();
try (var executor = Executors.newFixedThreadPool(4); Jedis admin = admin()) {
var start = new CountDownLatch(1);
var tasks = new ArrayList<Future<Boolean>>();
for (int i = 0; i < 4; i++) tasks.add(executor.submit(() -> {
try (Jedis connection = admin()) {
assertThat(start.await(2, TimeUnit.SECONDS)).isTrue();
try { initialize(connection, key, 1, 2); return true; }
catch (JedisDataException exists) { return false; }
}
}));
start.countDown();
int created = 0;
for (var task : tasks) if (task.get(3, TimeUnit.SECONDS)) created++;
assertThat(created).isEqualTo(1);
assertThat(admin.hget(key, "credit")).isEqualTo("0");
assertThat(admin.hget(key, "version")).isEqualTo("2");
assertThat(admin.hlen(key)).isEqualTo(5);
}
}
@Test
void expiringBudgetFailsClosedWithoutRemovingItsExpiryOrChangingCredit() throws Exception {
String key = key();
try (Jedis admin = admin(); var client = client(key, 1, 2, new SimpleMeterRegistry())) {
initialize(admin, key, 1, 2);
var original = admin.hgetAll(key);
admin.pexpire(key, 60000);
assertThat(client.tryAcquire().outcome()).isEqualTo(UNAVAILABLE);
assertThat(admin.hgetAll(key)).isEqualTo(original);
assertThat(admin.pttl(key)).isBetween(1L, 60000L);
}
}
@Test
void initializationRejectsInvalidPolicyWithoutCreatingState() throws Exception {
String key = key();
try (Jedis admin = admin()) {
for (int[] bounds : List.of(new int[]{0, 1}, new int[]{10001, 1}, new int[]{1, 0}, new int[]{1, 10001})) {
assertThatThrownBy(() -> initialize(admin, key, bounds[0], bounds[1])).isInstanceOf(JedisDataException.class);
}
assertThatThrownBy(() -> initialize(admin, "bad key", 1, 1)).isInstanceOf(JedisDataException.class);
assertThat(admin.exists(key)).isFalse();
assertThat(admin.exists("bad key")).isFalse();
}
}
@Test
void splitInitializationCliRejectsExistingBudgetWithoutOverwriting() throws Exception {
String key = key();
REDIS.copyFileToContainer(MountableFile.forClasspathResource("redis/initialize-split-quota.lua"), "/tmp/quota-split-init.lua");
String[] command = {"sh", "-c", "redis-cli -e --eval /dev/stdin \"$1\" , 10 10 2 2 < /tmp/quota-split-init.lua", "quota-init", key};
var first = REDIS.execInContainer(command);
assertThat(first.getExitCode()).isZero();
assertThat(first.getStdout().trim()).isEqualTo("QUOTA_INITIALIZED_EMPTY");
try (Jedis admin = admin()) {
var state = admin.hgetAll(key);
var second = REDIS.execInContainer(command);
assertThat(second.getExitCode()).isNotZero();
assertThat(admin.hgetAll(key)).isEqualTo(state);
}
}
@Test
void documentedCliInitializesFromStdinAndReturnsNonzeroForExistingBudget() throws Exception {
String key = key();
REDIS.copyFileToContainer(MountableFile.forClasspathResource("redis/initialize-provider-quota.lua"), "/tmp/quota-init.lua");
String[] command = {"sh", "-c", "redis-cli -e --eval /dev/stdin \"$1\" , 1 2 < /tmp/quota-init.lua", "quota-init", key};
var first = REDIS.execInContainer(command);
assertThat(first.getExitCode()).isZero();
assertThat(first.getStdout().trim()).isEqualTo("QUOTA_INITIALIZED_EMPTY");
try (Jedis admin = admin()) {
var state = admin.hgetAll(key);
var second = REDIS.execInContainer(command);
assertThat(second.getExitCode()).isNotZero();
assertThat(admin.hgetAll(key)).isEqualTo(state);
}
}
@Test
void structurallyValidSnapshotRollbackIsNotDetectableAndNeedsQuiescedReinitialization() throws Exception {
String key = key();
try (Jedis admin = admin(); var client = client(key, 10, 2, new SimpleMeterRegistry())) {
// Controlled stale-snapshot injection, not an actual replica promotion or clock-change experiment.
seed(admin, key, 10, 2, 2000, now(admin) + 10000);
var stale = admin.hgetAll(key);
assertThat(client.tryAcquire().outcome()).isEqualTo(ALLOWED);
assertThat(client.tryAcquire().outcome()).isEqualTo(ALLOWED);
assertThat(client.tryAcquire().outcome()).isEqualTo(LIMITED);
admin.hset(key, stale);
assertThat(client.tryAcquire().outcome()).isEqualTo(ALLOWED); // Known limit: no external epoch authority.
// No participating sender/in-flight permit remains in this isolated test. Drain + B/r quiet period.
TimeUnit.MILLISECONDS.sleep(250);
admin.del(key);
initialize(admin, key, 10, 2);
assertThat(admin.hget(key, "credit")).isEqualTo("0");
assertThat(client.tryAcquire().outcome()).isEqualTo(LIMITED);
}
}
private static String initialize(Jedis admin, String key, int rate, int burst) throws java.io.IOException {
String script = new ClassPathResource("redis/initialize-provider-quota.lua").getContentAsString(StandardCharsets.UTF_8);
return (String) admin.eval(script, List.of(key), List.of(Integer.toString(rate), Integer.toString(burst)));
}
private static RedisRateLimiter client(String key, int rate, int burst, SimpleMeterRegistry registry) {
return new RedisRateLimiter(new RateLimitProperties("127.0.0.1", REDIS.getMappedPort(6379), key,
rate, burst, 2, 1000), registry);
}
private static Jedis admin() { return new Jedis("127.0.0.1", REDIS.getMappedPort(6379), 3000); }
private static String key() { return "test:provider:" + UUID.randomUUID(); }
private static long now(Jedis admin) {
var time = admin.time();
return Long.parseLong(time.get(0)) * 1000 + Long.parseLong(time.get(1)) / 1000;
}
private static void seed(Jedis admin, String key, int rate, int burst, long credit, long time) {
admin.hset(key, Map.of("version", "2", "rate", Integer.toString(rate), "burst", Integer.toString(burst),
"credit", Long.toString(credit), "last_ms", Long.toString(time)));
}
}