mrpastewart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add endpoint cost

Browse source
This commit is contained in:
Tobe O 2019-08-14 15:19:37 -04:00
parent 40656a2b7d
commit 0f6011d693
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
lib/src/rate_limiter.dart
View file

@ -30,8 +30,19 @@ abstract class RateLimiter<User> {
/// Updates the underlying store with information about the new /// Updates the underlying store with information about the new
/// [window] that the user is operating in. /// [window] that the user is operating in.
FutureOr<void> updateCurrentWindow(RequestContext req, ResponseContext res, FutureOr<void> updateCurrentWindow(
RateLimitingWindow<User> window); RequestContext req, ResponseContext res, RateLimitingWindow<User> window);
/// Computes the amount of points that a given request will cost. This amount
/// is then added to the amount of points that the user has already consumed
/// in the current [window].
///
/// The default behavior is to return `1`, which signifies that all requests
/// carry the same weight.
FutureOr<int> getEndpointCost(RequestContext req, ResponseContext res,
RateLimitingWindow<User> window) {
return Future<int>.value(1);
}
FutureOr<Object> denyRequest(RequestContext req, ResponseContext res, FutureOr<Object> denyRequest(RequestContext req, ResponseContext res,
RateLimitingWindow<User> window) {} RateLimitingWindow<User> window) {}