// Go: consumer.go (rateLimitBps config, rate limiting in consumer delivery) using NATS.Server.JetStream.Consumers; namespace NATS.Server.JetStream.Tests.JetStream.Consumers; public class TokenBucketTests { // ------------------------------------------------------------------------- // Test 1 — TryConsume succeeds when enough tokens are available // // Go reference: consumer.go — rate limiter allows delivery when token // bucket has sufficient capacity for the message payload size. // ------------------------------------------------------------------------- [Fact] public void TryConsume_succeeds_when_tokens_available() { var limiter = new TokenBucketRateLimiter(bytesPerSecond: 1000); // Full bucket — consume 100 bytes should succeed var result = limiter.TryConsume(100); result.ShouldBeTrue(); } // ------------------------------------------------------------------------- // Test 2 — TryConsume fails when insufficient tokens remain // // Go reference: consumer.go — delivery is gated when bucket is drained. // ------------------------------------------------------------------------- [Fact] public void TryConsume_fails_when_insufficient_tokens() { // Burst = 2x rate = 200 bytes var limiter = new TokenBucketRateLimiter(bytesPerSecond: 100); // Drain all tokens (200 byte burst) limiter.TryConsume(200).ShouldBeTrue(); // Next consume should fail — no tokens left var result = limiter.TryConsume(1); result.ShouldBeFalse(); } // ------------------------------------------------------------------------- // Test 3 — TryConsume always returns true when rate is zero (unlimited) // // Go reference: consumer.go — rateLimitBps=0 means no rate limiting. // ------------------------------------------------------------------------- [Fact] public void TryConsume_unlimited_when_rate_zero() { var limiter = new TokenBucketRateLimiter(bytesPerSecond: 0); // Should always succeed regardless of size limiter.TryConsume(1_000_000).ShouldBeTrue(); limiter.TryConsume(1_000_000).ShouldBeTrue(); limiter.TryConsume(long.MaxValue / 2).ShouldBeTrue(); } // ------------------------------------------------------------------------- // Test 4 — AvailableTokens starts at burst size // // Go reference: consumer.go — bucket starts full so initial burst is allowed. // ------------------------------------------------------------------------- [Fact] public void AvailableTokens_starts_at_burst_size() { var limiter = new TokenBucketRateLimiter(bytesPerSecond: 1000, burstSize: 500); limiter.AvailableTokens.ShouldBe(500.0, tolerance: 1.0); } // ------------------------------------------------------------------------- // Test 5 — AvailableTokens refills over time // // Go reference: consumer.go — token bucket refills at configured bytes/sec // so that a drained bucket recovers proportionally with elapsed time. // ------------------------------------------------------------------------- [SlopwatchSuppress("SW004", "Token bucket refill is driven by real elapsed wall-clock time; no synchronisation primitive can replace observing time-based token accumulation")] [Fact] public async Task AvailableTokens_refills_over_time() { // 10,000 bytes/sec = 10 bytes/ms; burst = 20,000 bytes var limiter = new TokenBucketRateLimiter(bytesPerSecond: 10_000); // Drain entire bucket limiter.TryConsume(20_000).ShouldBeTrue(); limiter.AvailableTokens.ShouldBeLessThan(1.0); // Wait 50ms — should refill ~500 bytes (10 bytes/ms * 50ms) await Task.Delay(50); limiter.AvailableTokens.ShouldBeGreaterThan(100.0); } // ------------------------------------------------------------------------- // Test 6 — EstimateWait returns zero when tokens are available // // Go reference: consumer.go — no delay when bucket has capacity. // ------------------------------------------------------------------------- [Fact] public void EstimateWait_returns_zero_when_tokens_available() { var limiter = new TokenBucketRateLimiter(bytesPerSecond: 1000); var wait = limiter.EstimateWait(100); wait.ShouldBe(TimeSpan.Zero); } // ------------------------------------------------------------------------- // Test 7 — EstimateWait returns positive duration when tokens are insufficient // // Go reference: consumer.go — delivery delay calculated from deficit / refill rate. // ------------------------------------------------------------------------- [Fact] public void EstimateWait_returns_positive_when_insufficient() { // 100 bytes/sec = 0.1 bytes/ms; burst = 200 bytes var limiter = new TokenBucketRateLimiter(bytesPerSecond: 100); // Drain all tokens limiter.TryConsume(200).ShouldBeTrue(); // Requesting 50 more bytes — must wait var wait = limiter.EstimateWait(50); wait.ShouldBeGreaterThan(TimeSpan.Zero); } // ------------------------------------------------------------------------- // Test 8 — UpdateRate changes the effective rate dynamically // // Go reference: consumer.go — rate can be updated via config reload. // ------------------------------------------------------------------------- [Fact] public void UpdateRate_changes_rate_dynamically() { var limiter = new TokenBucketRateLimiter(bytesPerSecond: 1000); limiter.UpdateRate(500); limiter.BytesPerSecond.ShouldBe(500L); } // ------------------------------------------------------------------------- // Test 9 — UpdateRate caps existing tokens at new max // // Go reference: consumer.go — when burst is reduced, current tokens are // clamped to not exceed the new maximum. // ------------------------------------------------------------------------- [Fact] public void UpdateRate_caps_tokens_at_new_max() { // Start with rate=1000, burst=2000 var limiter = new TokenBucketRateLimiter(bytesPerSecond: 1000); // Reduce to rate=100, burst=200 — existing tokens (2000) must be capped limiter.UpdateRate(100); limiter.AvailableTokens.ShouldBeLessThanOrEqualTo(200.0 + 1.0); // +1 for refill epsilon } // ------------------------------------------------------------------------- // Test 10 — TryConsume partial consumption leaves correct remainder // // Go reference: consumer.go — each delivery subtracts exactly payload bytes // from the bucket. // ------------------------------------------------------------------------- [Fact] public void TryConsume_partial_consumption() { var limiter = new TokenBucketRateLimiter(bytesPerSecond: 1000, burstSize: 200); limiter.TryConsume(100).ShouldBeTrue(); // ~100 tokens should remain (minus any tiny refill drift during test) limiter.AvailableTokens.ShouldBeInRange(99.0, 101.0); } // ------------------------------------------------------------------------- // Test 11 — Default burst size is 2x the bytes-per-second rate // // Go reference: consumer.go — default burst allows two seconds worth of data. // ------------------------------------------------------------------------- [Fact] public void Default_burst_is_2x_rate() { var limiter = new TokenBucketRateLimiter(bytesPerSecond: 500); // Bucket starts full at burst = 2 * 500 = 1000 limiter.AvailableTokens.ShouldBe(1000.0, tolerance: 1.0); } // ------------------------------------------------------------------------- // Test 12 — Custom burst size overrides the default 2x calculation // // Go reference: consumer.go — explicit burst size gives precise control // over maximum allowed burst traffic. // ------------------------------------------------------------------------- [Fact] public void Custom_burst_size() { var limiter = new TokenBucketRateLimiter(bytesPerSecond: 500, burstSize: 750); limiter.AvailableTokens.ShouldBe(750.0, tolerance: 1.0); } }