bug #58601 [RateLimiter] Fix bucket size reduced when previously created with bigger size (Orkin)

fabpot · fabpot · commit c15a195ddadb · 2024-11-09T08:19:24.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [RateLimiter] Fix bucket size reduced when previously created with bigger size | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix # | License | MIT ```yaml foo: policy: 'token_bucket' limit: 1000 rate: { interval: '15 minutes', amount: 5 } cache_pool: rate_limiter.cache_pool lock_factory: 'lock.rate_limiter.factory' ``` `rate_limiter.cache_pool` => it's a persistent cache pool like redis When using previously this configuration and consume the token bucket with 1 token it was save on the storage with 999 tokens available. If you update the configuration with a lower token limit ```yaml foo: policy: 'token_bucket' limit: 10 rate: { interval: '15 minutes', amount: 5 } cache_pool: rate_limiter.cache_pool lock_factory: 'lock.rate_limiter.factory' ``` You can consume 999 tokens before triggering the bucket limit without flushing the cache. The purpose of this PR is to update and use the new configuration limit. Commits ------- 6c34c58 Fix bucket size reduce when previously created with bigger size
diff --git a/src/Symfony/Component/RateLimiter/Policy/TokenBucketLimiter.php b/src/Symfony/Component/RateLimiter/Policy/TokenBucketLimiter.php
@@ -67,6 +67,10 @@ public function reserve(int $tokens = 1, ?float $maxTime = null): Reservation
             $now = microtime(true);
             $availableTokens = $bucket->getAvailableTokens($now);
 
+            if ($availableTokens > $this->maxBurst) {
+                $availableTokens = $this->maxBurst;
+            }
+
             if ($availableTokens >= $tokens) {
                 // tokens are now available, update bucket
                 $bucket->setTokens($availableTokens - $tokens);
diff --git a/src/Symfony/Component/RateLimiter/Tests/Policy/TokenBucketLimiterTest.php b/src/Symfony/Component/RateLimiter/Tests/Policy/TokenBucketLimiterTest.php
@@ -56,6 +56,18 @@ public function testReserveMoreTokensThanBucketSize()
         $limiter->reserve(15);
     }
 
+    public function testReduceBucketSizeWhenAlreadyExistInStorageWithBiggerBucketSize()
+    {
+        $limiter = $this->createLimiter(100);
+
+        $limiter->consume();
+
+        $limiter2 = $this->createLimiter(1);
+        $limiter2->consume();
+
+        $this->assertFalse($limiter2->consume()->isAccepted());
+    }
+
     public function testReserveMaxWaitingTime()
     {
         $this->expectException(MaxWaitDurationExceededException::class);
