RateLimit class

Lets a client send at most max requests in each per window. One more request gets 429 Too Many Requests with a Retry-After header (seconds). Every answer has X-RateLimit-Limit and X-RateLimit-Remaining.

Route.post('/login', <dynamic>[
  RateLimit(max: 5, per: Duration(minutes: 1)),
  authController.login,
]);

Where the counts live:

  • the default cache store is Redis: in Redis. All isolates and all servers share them.
  • else: in the main isolate. All isolates of this server share them. The other isolates send each count to the main isolate (one message and its answer per limited request). Each server has its own counts.
  • store names a store: in that store (a memory store counts in the main isolate, like above).
  • cacheStore is given: in that store, as it is. A MemoryDriver store given here counts in each isolate on its own.

It is a fixed window: the counter starts again at each new window (eg. each new minute). So a client can send up to 2 x max requests around the end of one window and the start of the next.

Implemented types

Constructors

RateLimit({int max = 60, Duration per = const Duration(minutes: 1), RateLimitKey? key, String? name, String? store, CacheStore? cacheStore, DateTime now()?})

Properties

cacheStore → CacheStore?
a ready cache store to keep the counts, eg. in tests
final
hashCode → int
The hash code for this object.
no setterinherited
key → RateLimitKey
the client to count for. Default is the client ip.
final
max → int
the most requests in one window
final
name → String
Two limits with the same name (and the same key) share one counter. Default is made from max and per.
final
per → Duration
the length of one window
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
store → String?
the name of a cache store from AppConfig.cache to keep the counts. Default: the default store when it is Redis, else memory.
final

Methods

handle(IDoxRequest req) → Future
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited