[10.x] Custom RateLimiter increase (#50197)

* Allow ratelimiter custom increments

* add test

* formatting

* formatting

* Revert formatting

* Formatting

* formatting

---------

Co-authored-by: Tim MacDonald <hello@timacdonald.me>
Co-authored-by: Taylor Otwell <taylor@laravel.com>

Author: 3 people

src/Illuminate/Cache/RateLimiter.php

@@ -105,13 +105,26 @@ public function tooManyAttempts($key, $maxAttempts)
     }
 
     /**
-     * Increment the counter for a given key for a given decay time.
+     * Increment (by 1) the counter for a given key for a given decay time.
      *
      * @param  string  $key
      * @param  int  $decaySeconds
      * @return int
      */
     public function hit($key, $decaySeconds = 60)
+    {
+        return $this->increment($key, $decaySeconds);
+    }
+
+    /**
+     * Increment the counter for a given key for a given decay time by a given amount.
+     *
+     * @param  string  $key
+     * @param  int  $decaySeconds
+     * @param  int  $amount
+     * @return int
+     */
+    public function increment($key, $decaySeconds = 60, $amount = 1)
     {
         $key = $this->cleanRateLimiterKey($key);
 
@@ -121,7 +134,7 @@ public function hit($key, $decaySeconds = 60)
 
         $added = $this->cache->add($key, 0, $decaySeconds);
 
-        $hits = (int) $this->cache->increment($key);
+        $hits = (int) $this->cache->increment($key, $amount);
 
         if (! $added && $hits == 1) {
             $this->cache->put($key, 1, $decaySeconds);

tests/Cache/CacheRateLimiterTest.php

@@ -30,18 +30,29 @@ public function testHitProperlyIncrementsAttemptCount()
         $cache = m::mock(Cache::class);
         $cache->shouldReceive('add')->once()->with('key:timer', m::type('int'), 1)->andReturn(true);
         $cache->shouldReceive('add')->once()->with('key', 0, 1)->andReturn(true);
-        $cache->shouldReceive('increment')->once()->with('key')->andReturn(1);
+        $cache->shouldReceive('increment')->once()->with('key', 1)->andReturn(1);
         $rateLimiter = new RateLimiter($cache);
 
         $rateLimiter->hit('key', 1);
     }
 
+    public function testIncrementProperlyIncrementsAttemptCount()
+    {
+        $cache = m::mock(Cache::class);
+        $cache->shouldReceive('add')->once()->with('key:timer', m::type('int'), 1)->andReturn(true);
+        $cache->shouldReceive('add')->once()->with('key', 0, 1)->andReturn(true);
+        $cache->shouldReceive('increment')->once()->with('key', 5)->andReturn(5);
+        $rateLimiter = new RateLimiter($cache);
+
+        $rateLimiter->increment('key', 1, 5);
+    }
+
     public function testHitHasNoMemoryLeak()
     {
         $cache = m::mock(Cache::class);
         $cache->shouldReceive('add')->once()->with('key:timer', m::type('int'), 1)->andReturn(true);
         $cache->shouldReceive('add')->once()->with('key', 0, 1)->andReturn(false);
-        $cache->shouldReceive('increment')->once()->with('key')->andReturn(1);
+        $cache->shouldReceive('increment')->once()->with('key', 1)->andReturn(1);
         $cache->shouldReceive('put')->once()->with('key', 1, 1);
         $rateLimiter = new RateLimiter($cache);
 
@@ -83,7 +94,7 @@ public function testAttemptsCallbackReturnsTrue()
         $cache->shouldReceive('get')->once()->with('key', 0)->andReturn(0);
         $cache->shouldReceive('add')->once()->with('key:timer', m::type('int'), 1);
         $cache->shouldReceive('add')->once()->with('key', 0, 1)->andReturns(1);
-        $cache->shouldReceive('increment')->once()->with('key')->andReturn(1);
+        $cache->shouldReceive('increment')->once()->with('key', 1)->andReturn(1);
 
         $executed = false;
 
@@ -101,7 +112,7 @@ public function testAttemptsCallbackReturnsCallbackReturn()
         $cache->shouldReceive('get')->times(6)->with('key', 0)->andReturn(0);
         $cache->shouldReceive('add')->times(6)->with('key:timer', m::type('int'), 1);
         $cache->shouldReceive('add')->times(6)->with('key', 0, 1)->andReturns(1);
-        $cache->shouldReceive('increment')->times(6)->with('key')->andReturn(1);
+        $cache->shouldReceive('increment')->times(6)->with('key', 1)->andReturn(1);
 
         $rateLimiter = new RateLimiter($cache);