asiadevmedia / guzzle-rate-limiter

src/RateLimiter.php

<?php

namespace Asiadevmedia\GuzzleRateLimiter;

class RateLimiter
{
    const TIME_FRAME_MINUTE = 'minute';
    const TIME_FRAME_SECOND = 'second';

    /** @var int */
    protected $limit;

    /** @var string */
    protected $timeFrame;

    /** @var \Asiadevmedia\RateLimiter\Store */

The type Asiadevmedia\RateLimiter\Store was not found. Maybe you did not declare it correctly or list all dependencies?

    protected $store;

    /** @var \Asiadevmedia\GuzzleRateLimiter\Deferrer */
    protected $deferrer;

    public function __construct(
        int $limit,
        string $timeFrame,
        Store $store,
        Deferrer $deferrer
    ) {
        $this->limit = $limit;
        $this->timeFrame = $timeFrame;
        $this->store = $store;

It seems like $store of type Asiadevmedia\GuzzleRateLimiter\Store is incompatible with the declared type Asiadevmedia\RateLimiter\Store of property $store.

        $this->deferrer = $deferrer;
    }

    public function handle(callable $callback)
    {
        $delayUntilNextRequest = $this->delayUntilNextRequest();

        if ($delayUntilNextRequest > 0) {
            $this->deferrer->sleep($delayUntilNextRequest);
        }

        $this->store->push(
            $this->deferrer->getCurrentTime(),
            $this->limit
        );

        return $callback();
    }

    protected function delayUntilNextRequest(): int
    {
        $currentTimeFrameStart = $this->deferrer->getCurrentTime() - $this->timeFrameLengthInMilliseconds();

        $requestsInCurrentTimeFrame = array_values(array_filter(
            $this->store->get(),
            function (int $timestamp) use ($currentTimeFrameStart) {
                return $timestamp >= $currentTimeFrameStart;
            }
        ));

        if (count($requestsInCurrentTimeFrame) < $this->limit) {
            return 0;
        }

        $oldestRequestStartTimeRelativeToCurrentTimeFrame =
            $this->deferrer->getCurrentTime() - $requestsInCurrentTimeFrame[0];

        return $this->timeFrameLengthInMilliseconds() - $oldestRequestStartTimeRelativeToCurrentTimeFrame;
    }

    protected function timeFrameLengthInMilliseconds(): int
    {
        if ($this->timeFrame === self::TIME_FRAME_MINUTE) {
            return 60 * 1000;
        }

        return 1000;
    }
}