Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[RateLimiter] Fix DateInterval normalization #58757

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
Nov 5, 2024
Merged

[RateLimiter] Fix DateInterval normalization #58757

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
6 changes: 5 additions & 1 deletion src/Symfony/Component/RateLimiter/RateLimiterFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,11 @@ protected static function configureOptions(OptionsResolver $options): void
{
$intervalNormalizer = static function (Options $options, string $interval): \DateInterval {
try {
return (new \DateTimeImmutable())->diff(new \DateTimeImmutable('+'.$interval));
// Create DateTimeImmutable from unix timesatmp, so the default timezone is ignored and we don't need to
// deal with quirks happening when modifying dates using a timezone with DST.
$now = \DateTimeImmutable::createFromFormat('U', time());

return $now->diff($now->modify('+'.$interval));
} catch (\Exception $e) {
if (!preg_match('/Failed to parse time string \(\+([^)]+)\)/', $e->getMessage(), $m)) {
throw $e;
Expand Down
34 changes: 34 additions & 0 deletions src/Symfony/Component/RateLimiter/Tests/RateLimiterFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
namespace Symfony\Component\RateLimiter\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Bridge\PhpUnit\ClockMock;
use Symfony\Component\OptionsResolver\Exception\MissingOptionsException;
use Symfony\Component\RateLimiter\Policy\FixedWindowLimiter;
use Symfony\Component\RateLimiter\Policy\NoLimiter;
Expand Down Expand Up @@ -76,4 +77,37 @@ public static function invalidConfigProvider()
'policy' => 'token_bucket',
]];
}

/**
* @group time-sensitive
*/
public function testExpirationTimeCalculationWhenUsingDefaultTimezoneRomeWithIntervalAfterCETChange()
{
$originalTimezone = date_default_timezone_get();
try {
// Timestamp for 'Sun 27 Oct 2024 12:59:40 AM UTC' that's just 20 seconds before switch CEST->CET
ClockMock::withClockMock(1729990780);

// This is a prerequisite for the bug to happen
date_default_timezone_set('Europe/Rome');

$storage = new InMemoryStorage();
$factory = new RateLimiterFactory(
[
'id' => 'id_1',
'policy' => 'fixed_window',
'limit' => 30,
'interval' => '21 seconds',
],
$storage
);
$rateLimiter = $factory->create('key');
$rateLimiter->consume(1);
$limiterState = $storage->fetch('id_1-key');
// As expected the expiration is equal to the interval we defined
$this->assertSame(21, $limiterState->getExpirationTime());
} finally {
date_default_timezone_set($originalTimezone);
}
}
}
2 changes: 1 addition & 1 deletion src/Symfony/Component/RateLimiter/Util/TimeUtil.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ final class TimeUtil
{
public static function dateIntervalToSeconds(\DateInterval $interval): int
{
$now = new \DateTimeImmutable();
$now = \DateTimeImmutable::createFromFormat('U', time());

return $now->add($interval)->getTimestamp() - $now->getTimestamp();
}
Expand Down