8000 [HttpFoundation] Prevent accepted rate limits with no remaining token to be preferred over denied ones by MatTheCat · Pull Request #47283 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[HttpFoundation] Prevent accepted rate limits with no remaining token to be preferred over denied ones #47283

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
Aug 19, 2022
Merged

[HttpFoundation] Prevent accepted rate limits with no remaining token to be preferred over denied ones #47283

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
20 changes: 17 additions & 3 deletions src/Symfony/Component/HttpFoundation/RateLimiter/AbstractRequestRateLimiter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ public function consume(Request $request): RateLimit
foreach ($limiters as $limiter) {
$rateLimit = $limiter->consume(1);

if (null === $minimalRateLimit || $rateLimit->getRemainingTokens() < $minimalRateLimit->getRemainingTokens()) {
$minimalRateLimit = $rateLimit;
}
$minimalRateLimit = $minimalRateLimit ? self::getMinimalRateLimit($minimalRateLimit, $rateLimit) : $rateLimit;
}

return $minimalRateLimit;
Expand All @@ -54,4 +52,20 @@ public function reset(Request $request): void
* @return LimiterInterface[] a set of limiters using keys extracted from the request
*/
abstract protected function getLimiters(Request $request): array;

private static function getMinimalRateLimit(RateLimit $first, RateLimit $second): RateLimit
{
if ($first->isAccepted() !== $second->isAccepted()) {
return $first->isAccepted() ? $second : $first;
}

$firstRemainingTokens = $first->getRemainingTokens();
$secondRemainingTokens = $second->getRemainingTokens();

if ($firstRemainingTokens === $secondRemainingTokens) {
return $first->getRetryAfter() < $second->getRetryAfter() ? $second : $first;
}

return $firstRemainingTokens > $secondRemainingTokens ? $second : $first;
}
}
64 changes: 64 additions & 0 deletions src/Symfony/Component/HttpFoundation/Tests/RateLimiter/AbstractRequestRateLimiterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\HttpFoundation\Tests\RateLimiter;

use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\RateLimiter\LimiterInterface;
use Symfony\Component\RateLimiter\RateLimit;

class AbstractRequestRateLimiterTest extends TestCase
{
/**
* @dataProvider provideRateLimits
*/
public function testConsume(array $rateLimits, ?RateLimit $expected)
{
$rateLimiter = new MockAbstractRequestRateLimiter(array_map(function (RateLimit $rateLimit) {
$limiter = $this->createStub(LimiterInterface::class);
$limiter->method('consume')->willReturn($rateLimit);

return $limiter;
}, $rateLimits));

$this->assertSame($expected, $rateLimiter->consume(new Request()));
}

public function provideRateLimits()
{
$now = new \DateTimeImmutable();

yield 'Both accepted with different count of remaining tokens' => [
[
$expected = new RateLimit(0, $now, true, 1), // less remaining tokens
new RateLimit(1, $now, true, 1),
],
$expected,
];

yield 'Both accepted with same count of remaining tokens' => [
[
$expected = new RateLimit(0, $now->add(new \DateInterval('P1D')), true, 1), // longest wait time
new RateLimit(0, $now, true, 1),
],
$expected,
];

yield 'Accepted and denied' => [
[
new RateLimit(0, $now, true, 1),
$expected = new RateLimit(0, $now, false, 1), // denied
],
$expected,
];
}
}
34 changes: 34 additions & 0 deletions src/Symfony/Component/HttpFoundation/Tests/RateLimiter/MockAbstractRequestRateLimiter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\HttpFoundation\Tests\RateLimiter;

use Symfony\Component\HttpFoundation\RateLimiter\AbstractRequestRateLimiter;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\RateLimiter\LimiterInterface;

class MockAbstractRequestRateLimiter extends AbstractRequestRateLimiter
{
/**
* @var LimiterInterface[]
*/
private $limiters;

public function __construct(array $limiters)
{
$this->limiters = $limiters;
}

protected function getLimiters(Request $request): array
{
return $this->limiters;
}
}
3 changes: 2 additions & 1 deletion src/Symfony/Component/HttpFoundation/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
"symfony/dependency-injection": "^5.4|^6.0",
"symfony/http-kernel": "^5.4.12|^6.0.12|^6.1.4",
"symfony/mime": "^4.4|^5.0|^6.0",
"symfony/expression-language": "^4.4|^5.0|^6.0"
"symfony/expression-language": "^4.4|^5.0|^6.0",
"symfony/rate-limiter": "^5.2|^6.0"
},
"suggest" : {
"symfony/mime": "To use the file extension guesser"
Expand Down
0