fix_rate_limit_bc_after_51676_pr

ERuban · ERuban · commit 2d9fb06bf3fe · 2023-12-17T17:11:39.000+04:00
-
diff --git a/src/Symfony/Component/RateLimiter/Policy/FixedWindowLimiter.php b/src/Symfony/Component/RateLimiter/Policy/FixedWindowLimiter.php
@@ -59,21 +59,33 @@ 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 && $availableTokens > $tokens) {
                 $window->add($tokens, $now);
 
                 $reservation = new Reservation($now, new RateLimit($window->getAvailableTokens($now), \DateTimeImmutable::createFromFormat('U', floor($now)), true, $this->limit));
             } else {
+                if ($availableTokens === $tokens) {
+                    $window->add($tokens, $now);
+                }
+
                 $waitDuration = $window->calculateTimeForTokens(max(1, $tokens), $now);
 
-                if (null !== $maxTime && $waitDuration > $maxTime) {
+                if ($availableTokens !== $tokens && 0 !== $tokens && null !== $maxTime && $waitDuration > $maxTime) {
                     // process needs to wait longer than set interval
                     throw new MaxWaitDurationExceededException(sprintf('The rate limiter wait time ("%d" seconds) is longer than the provided maximum time ("%d" seconds).', $waitDuration, $maxTime), new RateLimit($window->getAvailableTokens($now), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), false, $this->limit));
                 }
 
-                $window->add($tokens, $now);
+                if ($availableTokens !== $tokens) {
+                    $window->add($tokens, $now);
+                }
+
+                if ($availableTokens === $tokens || 0 === $tokens) {
+                    $accepted = true;
+                } else {
+                    $accepted = false;
+                }
 
-                $reservation = new Reservation($now + $waitDuration, new RateLimit($window->getAvailableTokens($now), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), false, $this->limit));
+                $reservation = new Reservation($now + $waitDuration, new RateLimit($window->getAvailableTokens($now), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), $accepted, $this->limit));
             }
 
             if (0 < $tokens) {
diff --git a/src/Symfony/Component/RateLimiter/Policy/SlidingWindowLimiter.php b/src/Symfony/Component/RateLimiter/Policy/SlidingWindowLimiter.php
@@ -65,21 +65,33 @@ public function reserve(int $tokens = 1, float $maxTime = null): Reservation
             $now = microtime(true);
             $hitCount = $window->getHitCount();
             $availableTokens = $this->getAvailableTokens($hitCount);
-            if ((0 !== $tokens || 0 !== $availableTokens) && $availableTokens >= $tokens) {
+            if (0 !== $tokens && $availableTokens > $tokens) {
                 $window->add($tokens);
 
                 $reservation = new Reservation($now, new RateLimit($this->getAvailableTokens($window->getHitCount()), \DateTimeImmutable::createFromFormat('U', floor($now)), true, $this->limit));
             } else {
+                if ($availableTokens === $tokens) {
+                    $window->add($tokens);
+                }
+
                 $waitDuration = $window->calculateTimeForTokens($this->limit, max(1, $tokens));
 
-                if (null !== $maxTime && $waitDuration > $maxTime) {
+                if ($availableTokens !== $tokens && 0 !== $tokens && null !== $maxTime && $waitDuration > $maxTime) {
                     // process needs to wait longer than set interval
                     throw new MaxWaitDurationExceededException(sprintf('The rate limiter wait time ("%d" seconds) is longer than the provided maximum time ("%d" seconds).', $waitDuration, $maxTime), new RateLimit($this->getAvailableTokens($window->getHitCount()), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), false, $this->limit));
                 }
 
-                $window->add($tokens);
+                if ($availableTokens !== $tokens) {
+                    $window->add($tokens);
+                }
+
+                if ($availableTokens === $tokens || 0 === $tokens) {
+                    $accepted = true;
+                } else {
+                    $accepted = false;
+                }
 
-                $reservation = new Reservation($now + $waitDuration, new RateLimit($this->getAvailableTokens($window->getHitCount()), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), false, $this->limit));
+                $reservation = new Reservation($now + $waitDuration, new RateLimit($this->getAvailableTokens($window->getHitCount()), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), $accepted, $this->limit));
             }
 
             if (0 < $tokens) {
diff --git a/src/Symfony/Component/RateLimiter/Tests/Policy/FixedWindowLimiterTest.php b/src/Symfony/Component/RateLimiter/Tests/Policy/FixedWindowLimiterTest.php
@@ -57,6 +57,21 @@ public function testConsume()
         $this->assertEquals($retryAfter, $rateLimit->getRetryAfter());
     }
 
+    public function testConsumeLastToken()
+    {
+        $now = time();
+        $limiter = $this->createLimiter();
+        $limiter->consume(9);
+
+        $rateLimit = $limiter->consume(1);
+        $this->assertSame(0, $rateLimit->getRemainingTokens());
+        $this->assertTrue($rateLimit->isAccepted());
+        $this->assertEquals(
+            \DateTimeImmutable::createFromFormat('U', $now + 60),
+            $rateLimit->getRetryAfter()
+        );
+    }
+
     /**
      * @dataProvider provideConsumeOutsideInterval
      */
diff --git a/src/Symfony/Component/RateLimiter/Tests/Policy/SlidingWindowLimiterTest.php b/src/Symfony/Component/RateLimiter/Tests/Policy/SlidingWindowLimiterTest.php
@@ -54,6 +54,21 @@ public function testConsume()
         $this->assertSame(10, $rateLimit->getLimit());
     }
 
+    public function testConsumeLastToken()
+    {
+        $limiter = $this->createLimiter();
+        $limiter->reset();
+        $limiter->consume(9);
+
+        $rateLimit = $limiter->consume(1);
+        $this->assertSame(0, $rateLimit->getRemainingTokens());
+        $this->assertTrue($rateLimit->isAccepted());
+        $this->assertEquals(
+            \DateTimeImmutable::createFromFormat('U', (string) floor(microtime(true) + 12 / 10)),
+            $rateLimit->getRetryAfter()
+        );
+    }
+
     public function testConsumeZeroTokens()
     {
         $limiter = $this->createLimiter();
@@ -70,7 +85,7 @@ public function testConsumeZeroTokens()
         $limiter->consume(10);
 
         $rateLimit = $limiter->consume(0);
-        $this->assertFalse($rateLimit->isAccepted());
+        $this->assertTrue($rateLimit->isAccepted());
         $this->assertEquals(
             \DateTimeImmutable::createFromFormat('U', (string) floor(microtime(true) + 12 / 10)),
             $rateLimit->getRetryAfter()
