michaelesmith / throttle

A basic throttling implementation to limit requests

What is it?

A basic throttling implementation

Versions

If you are looking for the old version compatible with PHP 5.3 try the v0.1 branch and update your composer requirement to "michaelesmith/throttle": "^0.1"

Installation

composer require "michaelesmith/throttle"

You will also need a PSR-6 compatible cache library such as "cache/cache" or "symfony/cache".

Examples

$throttle = new Throttle(new \Cache\Adapter\PHPArray\ArrayCachePool());
$throttle->add(new Condition(60, 2)); // adds an interval where 2 increments are allowed in 60 seconds
$throttle->add(new Condition(600, 5)); // adds an interval where 5 increments are allowed in 10 minutes

// in each action you want to limit
try {
    $throttle->increment($_SERVER['REMOTE_ADDR']); // some client identifier like an ip or session id
    // NOTE: $_SERVER['REMOTE_ADDR'] may not gove you the actual client IP if you are behind a reverse proxy
    // Here is how Symfony finds the client IP
    // @link: https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpFoundation/Request.php#L786-L805
} catch(RateException $e) {
    $condition = $e->getCondition(); // the condition that hit the rate limit
    printf('You can only make %d requests in %d seconds', $condition->getLimit(), $condition->getTtl());
}

You can use any PSR-6 compatible cache pool, but you need to use one that is persistent across requests for most cases unlike this example.

throttle's Issues

Symfony filesystem cache item expiration when isHit

I'm using Symfony filesystem cache (https://symfony.com/doc/current/components/cache.html#basic-usage-psr-6) and I detected that expiration time is modify to default adapter value after second usage.

Throttle/src/Throttle.php

Line 68 in 1a37a7c

$interval = $item->get();

I think putting $item->expiresAfter($condition->getTtl()); outside the "if is hit" sentence this unwanted behavior will be changed

PHP Cache and Increment Issue

I am using cache/cache library, and I keep getting the following error.

[01-Jun-2020 16:33:50 America/New_York] PHP Fatal error: Uncaught Cache\Adapter\Common\Exception\InvalidArgumentException: Invalid key "282822929-60". Valid filenames must match [a-zA-Z0-9.! ]. in /opt/lampp/htdocs/qubus/vendor/cache/cache/src/Adapter/Filesystem/FilesystemCachePool.php:145_

Here is a bit of my code:

use TriTan\Common\Container;
use MS\Throttle\Condition;
use MS\Throttle\Interval;
use MS\Throttle\RateException;
use MS\Throttle\Throttle;
use League\Flysystem\Adapter\Local;
use League\Flysystem\Filesystem;
use Cache\Adapter\Filesystem\FilesystemCachePool;

$filesystemAdapter = new Local(Container::getInstance()->get('cache_path'));
$filesystem        = new Filesystem($filesystemAdapter);
$throttle = new Throttle(new FilesystemCachePool($filesystem));

$throttle->add(new Condition(60, 2));

try {
    $throttle->increment('282822929');
} catch (RateException $e) {
    $condition = $e->getCondition(); // the condition that hit the rate limit
    printf(
        'You can only make %d requests in %d seconds',
        $condition->getLimit(),
        $condition->getTtl()
    );
}

Any help with figuring this out is greatly appreciated.