[RateLimiter] Allow to get RateLimit without consuming again.

ERuban · ERuban · commit c15d76d41d08 · 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,33 +59,21 @@ public function reserve(int $tokens = 1, float $maxTime = null): Reservation
             $now = microtime(true);
             $availableTokens = $window->getAvailableTokens($now);
 
-            if (0 !== $tokens && $availableTokens > $tokens) {
+            if ($availableTokens >= max(1, $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 ($availableTokens !== $tokens && 0 !== $tokens && null !== $maxTime && $waitDuration > $maxTime) {
+                if (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));
                 }
 
-                if ($availableTokens !== $tokens) {
-                    $window->add($tokens, $now);
-                }
-
-                if ($availableTokens === $tokens || 0 === $tokens) {
-                    $accepted = true;
-                } else {
-                    $accepted = false;
-                }
+                $window->add($tokens, $now);
 
-                $reservation = new Reservation($now + $waitDuration, new RateLimit($window->getAvailableTokens($now), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), $accepted, $this->limit));
+                $reservation = new Reservation($now + $waitDuration, new RateLimit($window->getAvailableTokens($now), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), false, $this->limit));
             }
 
             if (0 < $tokens) {
diff --git a/src/Symfony/Component/RateLimiter/Policy/SlidingWindowLimiter.php b/src/Symfony/Component/RateLimiter/Policy/SlidingWindowLimiter.php
@@ -87,11 +87,13 @@ public function reserve(int $tokens = 1, float $maxTime = null): Reservation
 
                 if ($availableTokens === $tokens || 0 === $tokens) {
                     $accepted = true;
+                    $timeToAct = $now;
                 } else {
                     $accepted = false;
+                    $timeToAct = $now + $waitDuration;
                 }
 
-                $reservation = new Reservation($now + $waitDuration, new RateLimit($this->getAvailableTokens($window->getHitCount()), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), $accepted, $this->limit));
+                $reservation = new Reservation($timeToAct, 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,21 +57,6 @@ 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
@@ -114,6 +114,9 @@ public function testReserve()
 
         // 2 over the limit, causing the WaitDuration to become 2/10th of the 12s interval
         $this->assertEqualsWithDelta(12 / 5, $limiter->reserve(4)->getWaitDuration(), 1);
+
+        $limiter->reset();
+        $this->assertEquals(0, $limiter->reserve(10)->getWaitDuration());
     }
 
     private function createLimiter(): SlidingWindowLimiter

Original file line number	Diff line number	Diff line change
`@@ -87,11 +87,13 @@ public function reserve(int $tokens = 1, float $maxTime = null): Reservation`
`87`	`87`
`88`	`88`	`if ($availableTokens === $tokens \|\| 0 === $tokens) {`
`89`	`89`	`$accepted = true;`
	`90`	`+ $timeToAct = $now;`
`90`	`91`	`} else {`
`91`	`92`	`$accepted = false;`
	`93`	`+ $timeToAct = $now + $waitDuration;`
`92`	`94`	`}`
`93`	`95`
`94`		`- $reservation = new Reservation($now + $waitDuration, new RateLimit($this->getAvailableTokens($window->getHitCount()), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), $accepted, $this->limit));`
	`96`	`+ $reservation = new Reservation($timeToAct, new RateLimit($this->getAvailableTokens($window->getHitCount()), \DateTimeImmutable::createFromFormat('U', floor($now + $waitDuration)), $accepted, $this->limit));`
`95`	`97`	`}`
`96`	`98`
`97`	`99`	`if (0 < $tokens) {`
Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,9 @@ public function testReserve()`
`114`	`114`
`115`	`115`	`// 2 over the limit, causing the WaitDuration to become 2/10th of the 12s interval`
`116`	`116`	`$this->assertEqualsWithDelta(12 / 5, $limiter->reserve(4)->getWaitDuration(), 1);`
	`117`	`+`
	`118`	`+ $limiter->reset();`
	`119`	`+ $this->assertEquals(0, $limiter->reserve(10)->getWaitDuration());`
`117`	`120`	`}`
`118`	`121`
`119`	`122`	`private function createLimiter(): SlidingWindowLimiter`