[8.x] Adds attempt method to Rate Limiter (#38313)

* Adds an attempt method w/tests.

* Modified to return callback result.

* Style fixes.

* formatting

Co-authored-by: Taylor Otwell <[email protected]>

Author: DarkGhostHunter

src/Illuminate/Cache/RateLimiter.php

@@ -60,6 +60,26 @@ public function limiter(string $name)
         return $this->limiters[$name] ?? null;
     }
 
+    /**
+     * Attempts to execute a callback if it's not limited.
+     *
+     * @param  string  $key
+     * @param  int  $maxAttempts
+     * @param  \Closure  $callback
+     * @param  int  $decaySeconds
+     * @return mixed
+     */
+    public function attempt($key, $maxAttempts, Closure $callback, $decaySeconds = 60)
+    {
+        if ($this->tooManyAttempts($key, $maxAttempts)) {
+            return false;
+        }
+
+        return tap($callback() ?: true, function () use ($key, $decaySeconds) {
+            $this->hit($key, $decaySeconds);
+        });
+    }
+
     /**
      * Determine if the given key has been "accessed" too many times.
      *

src/Illuminate/Support/Facades/RateLimiter.php

@@ -12,6 +12,7 @@
  * @method static int retriesLeft($key, $maxAttempts)
  * @method static void clear($key)
  * @method static int availableIn($key)
+ * @method static bool attempt($key, $maxAttempts, \Closure $callback, $decaySeconds = 60)
  *
  * @see \Illuminate\Cache\RateLimiter
  */

tests/Cache/CacheRateLimiterTest.php

@@ -76,4 +76,53 @@ public function testAvailableInReturnsPositiveValues()
         $this->assertTrue($rateLimiter->availableIn('key:timer') >= 0);
         $this->assertTrue($rateLimiter->availableIn('key:timer') >= 0);
     }
+
+    public function testAttemptsCallbackReturnsTrue()
+    {
+        $cache = m::mock(Cache::class);
+        $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);
+
+        $executed = false;
+
+        $rateLimiter = new RateLimiter($cache);
+
+        $this->assertTrue($rateLimiter->attempt('key', 1, function() use (&$executed) {
+            $executed = true;
+        }, 1));
+        $this->assertTrue($executed);
+    }
+
+    public function testAttemptsCallbackReturnsCallbackReturn()
+    {
+        $cache = m::mock(Cache::class);
+        $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);
+
+        $rateLimiter = new RateLimiter($cache);
+
+        $this->assertEquals('foo', $rateLimiter->attempt('key', 1, function() {
+            return 'foo';
+        }, 1));
+    }
+
+    public function testAttemptsCallbackReturnsFalse()
+    {
+        $cache = m::mock(Cache::class);
+        $cache->shouldReceive('get')->once()->with('key', 0)->andReturn(2);
+        $cache->shouldReceive('has')->once()->with('key:timer')->andReturn(true);
+
+        $executed = false;
+
+        $rateLimiter = new RateLimiter($cache);
+
+        $this->assertFalse($rateLimiter->attempt('key', 1, function() use (&$executed) {
+            $executed = true;
+        }, 1));
+        $this->assertFalse($executed);
+    }
 }