Skip to content

[RateLimit] Test and fix peeking behavior on rate limit policies #53259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 29, 2023
Merged

[RateLimit] Test and fix peeking behavior on rate limit policies #53259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/Symfony/Component/RateLimiter/Policy/FixedWindowLimiter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,15 @@ public function reserve(int $tokens = 1, float $maxTime = null): Reservation
$now = microtime(true);
$availableTokens = $window->getAvailableTokens($now);

if ($availableTokens >= max(1, $tokens)) {
if (0 === $tokens) {
$waitDuration = $window->calculateTimeForTokens(1, $now);
$reservation = new Reservation($now + $waitDuration, new RateLimit($window->getAvailableTokens($now), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), true, $this->limit));
} elseif ($availableTokens >= $tokens) {
$window->add($tokens, $now);

$reservation = new Reservation($now, new RateLimit($window->getAvailableTokens($now), \DateTimeImmutable::createFromFormat('U', floor($now)), true, $this->limit));
} else {
$waitDuration = $window->calculateTimeForTokens(max(1, $tokens), $now);
$waitDuration = $window->calculateTimeForTokens($tokens, $now);

if (null !== $maxTime && $waitDuration > $maxTime) {
// process needs to wait longer than set interval
Expand Down
9 changes: 5 additions & 4 deletions src/Symfony/Component/RateLimiter/Policy/SlidingWindowLimiter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,13 @@ public function consume(int $tokens = 1): RateLimit
return new RateLimit($availableTokens, $window->getRetryAfter(), false, $this->limit);
}

$window->add($tokens);

if (0 < $tokens) {
$this->storage->save($window);
if (0 === $tokens) {
return new RateLimit($availableTokens, $availableTokens ? \DateTimeImmutable::createFromFormat('U.u', sprintf('%.6F', microtime(true))) : $window->getRetryAfter(), true, $this->limit);
}

$window->add($tokens);
$this->storage->save($window);

return new RateLimit($this->getAvailableTokens($window->getHitCount()), $window->getRetryAfter(), true, $this->limit);
} finally {
$this->lock?->release();
Expand Down
13 changes: 11 additions & 2 deletions src/Symfony/Component/RateLimiter/Policy/TokenBucketLimiter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,20 @@ public function reserve(int $tokens = 1, float $maxTime = null): Reservation
$now = microtime(true);
$availableTokens = $bucket->getAvailableTokens($now);

if ($availableTokens >= max(1, $tokens)) {
if ($availableTokens >= $tokens) {
// tokens are now available, update bucket
$bucket->setTokens($availableTokens - $tokens);

$reservation = new Reservation($now, new RateLimit($bucket->getAvailableTokens($now), \DateTimeImmutable::createFromFormat('U', floor($now)), true, $this->maxBurst));
if (0 === $availableTokens) {
// This means 0 tokens where consumed (discouraged in most cases).
// Return the first time a new token is available
$waitDuration = $this->rate->calculateTimeForTokens(1);
$waitTime = \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration));
} else {
$waitTime = \DateTimeImmutable::createFromFormat('U', floor($now));
}

$reservation = new Reservation($now, new RateLimit($bucket->getAvailableTokens($now), $waitTime, true, $this->maxBurst));
} else {
$remainingTokens = $tokens - $availableTokens;
$waitDuration = $this->rate->calculateTimeForTokens($remainingTokens);
Expand Down
14 changes: 14 additions & 0 deletions src/Symfony/Component/RateLimiter/Tests/Policy/FixedWindowLimiterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,21 @@ public function testPeekConsume()
$rateLimit = $limiter->consume(0);
$this->assertSame(10, $rateLimit->getLimit());
$this->assertTrue($rateLimit->isAccepted());
$this->assertEquals(
\DateTimeImmutable::createFromFormat('U', (string) floor(microtime(true))),
$rateLimit->getRetryAfter()
);
}

$limiter->consume();

$rateLimit = $limiter->consume(0);
$this->assertEquals(0, $rateLimit->getRemainingTokens());
$this->assertTrue($rateLimit->isAccepted());
$this->assertEquals(
\DateTimeImmutable::createFromFormat('U', (string) floor(microtime(true) + 60)),
$rateLimit->getRetryAfter()
);
}

public static function provideConsumeOutsideInterval(): \Generator
Expand Down
16 changes: 16 additions & 0 deletions src/Symfony/Component/RateLimiter/Tests/Policy/SlidingWindowLimiterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ protected function setUp(): void

ClockMock::register(InMemoryStorage::class);
ClockMock::register(RateLimit::class);
ClockMock::register(SlidingWindowLimiter::class);
}

public function testConsume()
Expand Down Expand Up @@ -82,11 +83,26 @@ public function testPeekConsume()

$limiter->consume(9);

// peek by consuming 0 tokens twice (making sure peeking doesn't claim a token)
for ($i = 0; $i < 2; ++$i) {
$rateLimit = $limiter->consume(0);
$this->assertTrue($rateLimit->isAccepted());
$this->assertSame(10, $rateLimit->getLimit());
$this->assertEquals(
\DateTimeImmutable::createFromFormat('U.u', sprintf('%.6F', microtime(true))),
$rateLimit->getRetryAfter()
);
}

$limiter->consume();

$rateLimit = $limiter->consume(0);
$this->assertEquals(0, $rateLimit->getRemainingTokens());
$this->assertTrue($rateLimit->isAccepted());
$this->assertEquals(
\DateTimeImmutable::createFromFormat('U.u', sprintf('%.6F', microtime(true) + 12)),
$rateLimit->getRetryAfter()
);
}

private function createLimiter(): SlidingWindowLimiter
Expand Down
15 changes: 15 additions & 0 deletions src/Symfony/Component/RateLimiter/Tests/Policy/TokenBucketLimiterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,26 @@ public function testPeekConsume()

$limiter->consume(9);

// peek by consuming 0 tokens twice (making sure peeking doesn't claim a token)
for ($i = 0; $i < 2; ++$i) {
$rateLimit = $limiter->consume(0);
$this->assertTrue($rateLimit->isAccepted());
$this->assertSame(10, $rateLimit->getLimit());
$this->assertEquals(
\DateTimeImmutable::createFromFormat('U', (string) floor(microtime(true))),
$rateLimit->getRetryAfter()
);
}

$limiter->consume();

$rateLimit = $limiter->consume(0);
$this->assertEquals(0, $rateLimit->getRemainingTokens());
$this->assertTrue($rateLimit->isAccepted());
$this->assertEquals(
\DateTimeImmutable::createFromFormat('U', (string) floor(microtime(true) + 1)),
$rateLimit->getRetryAfter()
);
}

public function testBucketRefilledWithStrictFrequency()
Expand Down