NotificationsYou must be signed in to change notification settings
Fork9.7k
Star30.8k

[RateLimiter] Fix wait duration for fixed window policy#42167

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Closed

jlekowski wants to merge1 commit intosymfony:5.4fromjlekowski:master

Closed

[RateLimiter] Fix wait duration for fixed window policy#42167

jlekowski wants to merge1 commit intosymfony:5.4fromjlekowski:master

Conversation

Copy link

Contributor

jlekowski commentedJul 17, 2021

Q	A
Branch?	5.4, 5.3, 5.2
Bug fix?	yes
New feature?	no
Deprecations?	no
Tickets	Fix #...
License	MIT
Doc PR	symfony/symfony-docs#...

When usingfixed_window policy and calling->wait() after overconsuming, there might be nosleep() called. Reproducer below:

<?phpuseSymfony\Component\RateLimiter\RateLimiterFactory;useSymfony\Component\RateLimiter\Storage\InMemoryStorage;require_once'./vendor/autoload.php';$factory =newRateLimiterFactory(['id' =>'some_id','policy' =>'fixed_window','limit' =>10,'interval' =>'2 seconds',],newInMemoryStorage());$limiter =$factory->create();$limit =$limiter->consume(8);$limit =$limiter->consume(4);$start =microtime(true);$limit->wait();echo'WAITED:' .1000 * (microtime(true) -$start);// WAITED: 0.0030994415283203 - instantaneous instead of WAITED: 2000.3020763397 after the fix

Fix wait duration for fixed window policy

4ccf374

carsonbot added Status: Needs Review Bug RateLimiter labels

Jul 17, 2021

Copy link

carsonbot commentedJul 17, 2021

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has acontribution guide which I suggest you to read.

In short:

Always add tests
Keep backward compatibility (seehttps://symfony.com/bc).
Bug fixes must be submitted against the lowest maintained branch where they apply (seehttps://symfony.com/releases)
Features and deprecations must be submitted against the 5.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot