avaibook/symfony-rate-limiter

Sf4.4 compatibility patch of Symfony RateLimiter component, that provides a Token Bucket implementation to rate limit input and output in your application

4.4 2021-10-06 12:43 UTC

Requires

• php: >=7.2.5
• symfony/lock: ^4.4
• symfony/options-resolver: ^4.4

Requires (Dev)

• psr/cache: ^1.0|^2.0|^3.0

MIT

• Wouter de Jong
• Symfony Community

• limiter
• rate-limiter

README

The Rate Limiter component provides a Token Bucket implementation to rate limit input and output in your application.

This is a fork of the original bundle that makes it compatible with Symfony <= 4.4.

This Component is experimental. Experimental features are not covered by Symfony's Backward Compatibility Promise.

Getting Started

$ composer require avaibook/symfony-rate-limiter

use Symfony\Component\RateLimiter\Storage\InMemoryStorage;
use Symfony\Component\RateLimiter\RateLimiterFactory;

$factory = new RateLimiterFactory([
    'id' => 'login',
    'policy' => 'token_bucket',
    'limit' => 10,
    'rate' => ['interval' => '15 minutes'],
], new InMemoryStorage());

$limiter = $factory->create();

// blocks until 1 token is free to use for this process
$limiter->reserve(1)->wait();
// ... execute the code

// only claims 1 token if it's free at this moment (useful if you plan to skip this process)
if ($limiter->consume(1)->isAccepted()) {
   // ... execute the code
}

Resources

• Contributing
• Report issues and send Pull Requests in the main Symfony repository