File size: 8,509 Bytes
7a1ad33 | 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 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, beforeEach, vi } from 'vitest';
import { RateLimiter } from './rate-limiter.js';
describe('RateLimiter', () => {
let rateLimiter: RateLimiter;
beforeEach(() => {
rateLimiter = new RateLimiter(1000); // 1 second interval for testing
});
describe('constructor', () => {
it('should initialize with default interval', () => {
const defaultLimiter = new RateLimiter();
expect(defaultLimiter).toBeInstanceOf(RateLimiter);
});
it('should initialize with custom interval', () => {
const customLimiter = new RateLimiter(5000);
expect(customLimiter).toBeInstanceOf(RateLimiter);
});
it('should throw on negative interval', () => {
expect(() => new RateLimiter(-1)).toThrow(
'minIntervalMs must be non-negative.',
);
});
});
describe('shouldRecord', () => {
it('should allow first recording', () => {
const result = rateLimiter.shouldRecord('test_metric');
expect(result).toBe(true);
});
it('should block immediate subsequent recordings', () => {
rateLimiter.shouldRecord('test_metric'); // First call
const result = rateLimiter.shouldRecord('test_metric'); // Immediate second call
expect(result).toBe(false);
});
it('should allow recording after interval', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('test_metric'); // First call
// Advance time past interval
vi.advanceTimersByTime(1500);
const result = rateLimiter.shouldRecord('test_metric');
expect(result).toBe(true);
vi.useRealTimers();
});
it('should handle different metric keys independently', () => {
rateLimiter.shouldRecord('metric_a'); // First call for metric_a
const resultA = rateLimiter.shouldRecord('metric_a'); // Second call for metric_a
const resultB = rateLimiter.shouldRecord('metric_b'); // First call for metric_b
expect(resultA).toBe(false); // Should be blocked
expect(resultB).toBe(true); // Should be allowed
});
it('should use shorter interval for high priority events', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('test_metric', true); // High priority
// Advance time by half the normal interval
vi.advanceTimersByTime(500);
const result = rateLimiter.shouldRecord('test_metric', true);
expect(result).toBe(true); // Should be allowed due to high priority
vi.useRealTimers();
});
it('should still block high priority events if interval not met', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('test_metric', true); // High priority
// Advance time by less than half interval
vi.advanceTimersByTime(300);
const result = rateLimiter.shouldRecord('test_metric', true);
expect(result).toBe(false); // Should still be blocked
vi.useRealTimers();
});
});
describe('forceRecord', () => {
it('should update last record time', () => {
const before = rateLimiter.getTimeUntilNextAllowed('test_metric');
rateLimiter.forceRecord('test_metric');
const after = rateLimiter.getTimeUntilNextAllowed('test_metric');
expect(after).toBeGreaterThan(before);
});
it('should block subsequent recordings after force record', () => {
rateLimiter.forceRecord('test_metric');
const result = rateLimiter.shouldRecord('test_metric');
expect(result).toBe(false);
});
});
describe('getTimeUntilNextAllowed', () => {
it('should return 0 for new metric', () => {
const time = rateLimiter.getTimeUntilNextAllowed('new_metric');
expect(time).toBe(0);
});
it('should return correct time after recording', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('test_metric');
// Advance time partially
vi.advanceTimersByTime(300);
const timeRemaining = rateLimiter.getTimeUntilNextAllowed('test_metric');
expect(timeRemaining).toBeCloseTo(700, -1); // Approximately 700ms remaining
vi.useRealTimers();
});
it('should return 0 after interval has passed', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('test_metric');
// Advance time past interval
vi.advanceTimersByTime(1500);
const timeRemaining = rateLimiter.getTimeUntilNextAllowed('test_metric');
expect(timeRemaining).toBe(0);
vi.useRealTimers();
});
it('should account for high priority interval', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('hp_metric', true);
// After 300ms, with 1000ms base interval, half rounded is 500ms
vi.advanceTimersByTime(300);
const timeRemaining = rateLimiter.getTimeUntilNextAllowed(
'hp_metric',
true,
);
expect(timeRemaining).toBeCloseTo(200, -1);
vi.useRealTimers();
});
});
describe('getStats', () => {
it('should return empty stats initially', () => {
const stats = rateLimiter.getStats();
expect(stats).toEqual({
totalMetrics: 0,
oldestRecord: 0,
newestRecord: 0,
averageInterval: 0,
});
});
it('should return correct stats after recordings', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('metric_a');
vi.advanceTimersByTime(500);
rateLimiter.shouldRecord('metric_b');
vi.advanceTimersByTime(500);
rateLimiter.shouldRecord('metric_c');
const stats = rateLimiter.getStats();
expect(stats.totalMetrics).toBe(3);
expect(stats.averageInterval).toBeCloseTo(500, -1);
vi.useRealTimers();
});
it('should handle single recording correctly', () => {
rateLimiter.shouldRecord('test_metric');
const stats = rateLimiter.getStats();
expect(stats.totalMetrics).toBe(1);
expect(stats.averageInterval).toBe(0);
});
});
describe('reset', () => {
it('should clear all rate limiting state', () => {
rateLimiter.shouldRecord('metric_a');
rateLimiter.shouldRecord('metric_b');
rateLimiter.reset();
const stats = rateLimiter.getStats();
expect(stats.totalMetrics).toBe(0);
// Should allow immediate recording after reset
const result = rateLimiter.shouldRecord('metric_a');
expect(result).toBe(true);
});
});
describe('cleanup', () => {
it('should remove old entries', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('old_metric');
// Advance time beyond cleanup threshold
vi.advanceTimersByTime(4000000); // More than 1 hour
rateLimiter.cleanup(3600000); // 1 hour cleanup
// Should allow immediate recording of old metric after cleanup
const result = rateLimiter.shouldRecord('old_metric');
expect(result).toBe(true);
vi.useRealTimers();
});
it('should preserve recent entries', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('recent_metric');
// Advance time but not beyond cleanup threshold
vi.advanceTimersByTime(1800000); // 30 minutes
rateLimiter.cleanup(3600000); // 1 hour cleanup
// Should no longer be rate limited after 30 minutes (way past 1 minute default interval)
const result = rateLimiter.shouldRecord('recent_metric');
expect(result).toBe(true);
vi.useRealTimers();
});
it('should use default cleanup age', () => {
vi.useFakeTimers();
rateLimiter.shouldRecord('test_metric');
// Advance time beyond default cleanup (1 hour)
vi.advanceTimersByTime(4000000);
rateLimiter.cleanup(); // Use default age
const result = rateLimiter.shouldRecord('test_metric');
expect(result).toBe(true);
vi.useRealTimers();
});
});
describe('edge cases', () => {
it('should handle zero interval', () => {
const zeroLimiter = new RateLimiter(0);
zeroLimiter.shouldRecord('test_metric');
const result = zeroLimiter.shouldRecord('test_metric');
expect(result).toBe(true); // Should allow with zero interval
});
it('should handle very large intervals', () => {
const longLimiter = new RateLimiter(Number.MAX_SAFE_INTEGER);
longLimiter.shouldRecord('test_metric');
const timeRemaining = longLimiter.getTimeUntilNextAllowed('test_metric');
expect(timeRemaining).toBeGreaterThan(1000000);
});
});
});
|