The asyncio-redis-rate-limit's discuss from wemake-services

wemake-services / asyncio-redis-rate-limit Goto Github PK

View Code? Open in Web Editor NEW

Rate limiter for async functions using Redis as a backend.

License: MIT License

Makefile 1.30% Python 98.70%

asyncio-redis-rate-limit's Issues

Enable `wps` in actions

Right now for some reason poetry install with wps fails.
I think that it is pip / poetry problem. We need to add this later.

Add python3.10 support

For some reason, it is failing

Document semantics of rate limit window

From reading the code, the following comment indicates that Redis Pattern: Rate Limiter 1 is being used which is confusing as the cache key does not contain the timestamp.

    async def _run_pipeline(
        self,
        cache_key: str,
        pipeline: AnyPipeline,
    ) -> int:
        # https://redis.io/commands/incr/#pattern-rate-limiter-1
        current_rate, _ = await pipeline_expire(
            pipeline.incr(cache_key),
            cache_key,
            self._rate_spec.seconds,
        ).execute()
        return current_rate

My understanding is that in-fact a variation of Redis Pattern: Rate Limiter 2 is being used as a by-product of the NX command.

Is this understanding correct? If so - would be useful to update the comment.

Attaching the reference patterns

Pattern 1

FUNCTION LIMIT_API_CALL(ip)
ts = CURRENT_UNIX_TIME()
keyname = ip+":"+ts
MULTI
    INCR(keyname)
    EXPIRE(keyname,10)
EXEC
current = RESPONSE_OF_INCR_WITHIN_MULTI
IF current > 10 THEN
    ERROR "too many requests per second"
ELSE
    PERFORM_API_CALL()
END

Pattern 2

FUNCTION LIMIT_API_CALL(ip):
current = GET(ip)
IF current != NULL AND current > 10 THEN
    ERROR "too many requests per second"
ELSE
    value = INCR(ip)
    IF value == 1 THEN
        EXPIRE(ip,1)
    END
    PERFORM_API_CALL()
END