Best of JS • node-rate-limiter-flexible

node-rate-limiter-flexible

rate-limiter-flexible counts and limits the number of actions by key and protects from DDoS and brute force attacks at any scale.

It works with Redis, Prisma, DynamoDB, process Memory, Cluster or PM2, Memcached, MongoDB, MySQL, and PostgreSQL.

Memory limiter also works in the browser.

Atomic increments. All operations in memory or distributed environment use atomic increments against race conditions.

Fast. Average request takes 0.7ms in Cluster and 2.5ms in Distributed application. See benchmarks.

Flexible. Combine limiters, block key for some duration, delay actions, manage failover with insurance options, configure smart key blocking in memory and many others.

Ready for growth. It provides a unified API for all limiters. Whenever your application grows, it is ready. Prepare your limiters in minutes.

Friendly. No matter which node package you prefer: redis or ioredis, sequelize/typeorm or knex, memcached, native driver or mongoose. It works with all of them.

In-memory blocks. Avoid extra requests to store with inMemoryBlockOnConsumed.

Allow traffic bursts with BurstyRateLimiter.

Deno compatible See this example

It uses a fixed window, as it is much faster than a rolling window. See comparative benchmarks with other libraries here

Installation

npm i --save rate-limiter-flexible

yarn add rate-limiter-flexible

Import

// CommonJS
const { RateLimiterMemory } = require("rate-limiter-flexible");

// or

// ECMAScript 
import { RateLimiterMemory } from "rate-limiter-flexible";
// or
import RateLimiterMemory from "rate-limiter-flexible/lib/RateLimiterMemory.js";

Basic Example

Points can be consumed by IP address, user ID, authorisation token, API route or any other string.

const opts = {
  points: 6, // 6 points
  duration: 1, // Per second
};

const rateLimiter = new RateLimiterMemory(opts);

rateLimiter.consume(remoteAddress, 2) // consume 2 points
    .then((rateLimiterRes) => {
      // 2 points consumed
    })
    .catch((rateLimiterRes) => {
      // Not enough points to consume
    });

RateLimiterRes object

The Promise's resolve and reject callbacks both return an instance of the RateLimiterRes class if there is no error. Object attributes:

RateLimiterRes = {
    msBeforeNext: 250, // Number of milliseconds before next action can be done
    remainingPoints: 0, // Number of remaining points in current duration 
    consumedPoints: 5, // Number of consumed points in current duration 
    isFirstInDuration: false, // action is first in current duration 
}

You may want to set HTTP headers for the response:

const headers = {
  "Retry-After": rateLimiterRes.msBeforeNext / 1000,
  "X-RateLimit-Limit": opts.points,
  "X-RateLimit-Remaining": rateLimiterRes.remainingPoints,
  "X-RateLimit-Reset": new Date(Date.now() + rateLimiterRes.msBeforeNext)
}

Advantages:

no race conditions
no production dependencies
TypeScript declaration bundled
Block Strategy against really powerful DDoS attacks (like 100k requests per sec) Read about it and benchmarking here
Insurance Strategy as emergency solution if database/store is down Read about Insurance Strategy here
works in Cluster or PM2 without additional software See RateLimiterCluster benchmark and detailed description here
useful get, set, block, delete, penalty and reward methods

Full documentation is on Wiki

Middlewares, plugins and other packages

Express middleware
Koa middleware
Hapi plugin
GraphQL graphql-rate-limit-directive
NestJS try nestjs-rate-limiter
Fastify based NestJS app try nestjs-fastify-rate-limiter

Some copy/paste examples on Wiki:

Migration from other packages

express-brute Bonus: race conditions fixed, prod deps removed
limiter Bonus: multi-server support, respects queue order, native promises

Docs and Examples

Options
API methods
Redis
Memory
DynamoDb
Prisma
BurstyRateLimiter Traffic burst support
Mongo (with sharding support)
MySQL (support Sequelize and Knex)
Postgres (support Sequelize, TypeORM and Knex)
RateLimiterCluster (PM2 cluster docs read here)
Memcache
RateLimiterUnion Combine 2 or more limiters to act as single
RLWrapperBlackAndWhite Black and White lists
RateLimiterQueue Rate limiter with FIFO queue

Changelog

See releases for detailed changelog.

Basic Options

points

Default: 4

Maximum number of points that can be consumed over duration
duration

Default: 1

Number of seconds before consumed points are reset.

Points are never reset if duration is set to 0.
storeClient

Required for store limiters

Must be redis, ioredis, memcached, mongodb, pg, mysql2, mysql or any other related pool or connection.

Other options on Wiki:

keyPrefix Make keys unique among different limiters.
blockDuration Block for N seconds, if consumed more than points.
inMemoryBlockOnConsumed Avoid extra requests to store.
inMemoryBlockDuration
insuranceLimiter Make it more stable with less efforts.
storeType Have to be set to knex, if you use it.
dbName Where to store points.
tableName Table/collection.
tableCreated Is table already created in MySQL or PostgreSQL.
clearExpiredByTimeout For MySQL and PostgreSQL.

Smooth out traffic peaks:

Specific:

indexKeyPrefix Combined indexes of MongoDB.
timeoutMs For Cluster.
rejectIfRedisNotReady
useRedisPackage
useRedis3AndLowerPackage
customIncrTtlLuaScript

API

Read detailed description on Wiki.

consume(key, points = 1) Consume points by key.
get(key) Get RateLimiterRes or null.
set(key, points, secDuration) Set points by key.
block(key, secDuration) Block key for secDuration seconds.
delete(key) Reset consumed points.
deleteInMemoryBlockedAll
penalty(key, points = 1) Increase number of consumed points in current duration.
reward(key, points = 1) Decrease number of consumed points in current duration.
getKey(key) Get internal prefixed key.

Benchmark

Average latency during test of pure NodeJS endpoint in cluster of 4 workers with everything set up on one server.

1000 concurrent clients with maximum 2000 requests per sec during 30 seconds.

1. Memory     0.34 ms
2. Cluster    0.69 ms
3. Redis      2.45 ms
4. Memcached  3.89 ms
5. Mongo      4.75 ms

500 concurrent clients with maximum 1000 req per sec during 30 seconds

6. PostgreSQL 7.48 ms (with connection pool max 100)
7. MySQL     14.59 ms (with connection pool 100)

Note, you can speed up limiters with inMemoryBlockOnConsumed option.

Contributions

Appreciated, feel free!

Make sure you've launched npm run eslint before creating PR, all errors have to be fixed.

You can try to run npm run eslint-fix to fix some issues.

Any new limiter with storage must be extended from RateLimiterStoreAbstract. It has to implement 4 methods:

_getRateLimiterRes parses raw data from store to RateLimiterRes object.
_upsert may be atomic or non-atomic upsert (increment). It inserts or updates the value by key and returns raw data. If it doesn't make an atomic upsert (increment), the class should be suffixed with NonAtomic, e.g. RateLimiterRedisNonAtomic.

It must support forceExpire mode to overwrite key expiration time.
_get returns raw data by key or null if there is no key.
_delete deletes all key-related data and returns true on deleted, false if key is not found.

All other methods depends on the store. See RateLimiterRedis or RateLimiterPostgres for examples.

Note: all changes should be covered by tests.

// CommonJS const { RateLimiterMemory } = require("rate-limiter-flexible"); // or // ECMAScript import { RateLimiterMemory } from "rate-limiter-flexible"; // or import RateLimiterMemory from "rate-limiter-flexible/lib/RateLimiterMemory.js";

RateLimiterRes = { msBeforeNext: 250, // Number of milliseconds before next action can be done remainingPoints: 0, // Number of remaining points in current duration consumedPoints: 5, // Number of consumed points in current duration isFirstInDuration: false, // action is first in current duration }

const headers = { "Retry-After": rateLimiterRes.msBeforeNext / 1000, "X-RateLimit-Limit": opts.points, "X-RateLimit-Remaining": rateLimiterRes.remainingPoints, "X-RateLimit-Reset": new Date(Date.now() + rateLimiterRes.msBeforeNext) }