mirror of
https://github.com/waku-org/nwaku.git
synced 2025-01-13 16:25:00 +00:00
ba418ab5ba
* DOS protection of non relay protocols - rate limit phase3: - Enhanced TokenBucket to be able to add compensation tokens based on previous usage percentage, - per peer rate limiter 'PeerRateLimier' applied on waku_filter_v2 with opinionated default of acceptable request rate - Add traffic metrics to filter message push - RequestRateLimiter added to combine simple token bucket limiting of request numbers but consider per peer usage over time and prevent some peers to over use the service (although currently rule violating peers will not be disconnected by this time only their requests will get not served) - TimedMap utility created (inspired and taken from libp2p TimedCache) which serves as forgiving feature for peers had been overusing the service. - Added more tests - Fix rebase issues - Applied new RequestRateLimiter for store and legacy_store and lightpush * Incorporate review comments, typos, file/class naming and placement changes. * Add issue link reference of the original issue with nim-chronos TokenBucket * Make TimedEntry of TimedMap private and not mixable with similar named in libp2p * Fix review comments, renamings, const instead of values and more comments.
70 lines
2.3 KiB
Nim
70 lines
2.3 KiB
Nim
# Chronos Test Suite
|
|
# (c) Copyright 2022-Present
|
|
# Status Research & Development GmbH
|
|
#
|
|
# Licensed under either of
|
|
# Apache License, version 2.0, (LICENSE-APACHEv2)
|
|
# MIT license (LICENSE-MIT)
|
|
|
|
{.used.}
|
|
|
|
import testutils/unittests
|
|
import chronos
|
|
import ../../waku/common/rate_limit/token_bucket
|
|
|
|
suite "Token Bucket":
|
|
test "TokenBucket Sync test - strict":
|
|
var bucket = TokenBucket.newStrict(1000, 1.milliseconds)
|
|
let
|
|
start = Moment.now()
|
|
fullTime = start + 1.milliseconds
|
|
check:
|
|
bucket.tryConsume(800, start) == true
|
|
bucket.tryConsume(200, start) == true
|
|
# Out of budget
|
|
bucket.tryConsume(100, start) == false
|
|
bucket.tryConsume(800, fullTime) == true
|
|
bucket.tryConsume(200, fullTime) == true
|
|
# Out of budget
|
|
bucket.tryConsume(100, fullTime) == false
|
|
|
|
test "TokenBucket Sync test - compensating":
|
|
var bucket = TokenBucket.new(1000, 1.milliseconds)
|
|
let
|
|
start = Moment.now()
|
|
fullTime = start + 1.milliseconds
|
|
check:
|
|
bucket.tryConsume(800, start) == true
|
|
bucket.tryConsume(200, start) == true
|
|
# Out of budget
|
|
bucket.tryConsume(100, start) == false
|
|
bucket.tryConsume(800, fullTime) == true
|
|
bucket.tryConsume(200, fullTime) == true
|
|
# Due not using the bucket for a full period the compensation will satisfy this request
|
|
bucket.tryConsume(100, fullTime) == true
|
|
|
|
test "TokenBucket Max compensation":
|
|
var bucket = TokenBucket.new(1000, 1.minutes)
|
|
var reqTime = Moment.now()
|
|
|
|
check bucket.tryConsume(1000, reqTime)
|
|
check bucket.tryConsume(1, reqTime) == false
|
|
reqTime += 1.minutes
|
|
check bucket.tryConsume(500, reqTime) == true
|
|
reqTime += 1.minutes
|
|
check bucket.tryConsume(1000, reqTime) == true
|
|
reqTime += 10.seconds
|
|
# max compensation is 25% so try to consume 250 more
|
|
check bucket.tryConsume(250, reqTime) == true
|
|
reqTime += 49.seconds
|
|
# out of budget within the same period
|
|
check bucket.tryConsume(1, reqTime) == false
|
|
|
|
test "TokenBucket Short replenish":
|
|
var bucket = TokenBucket.new(15000, 1.milliseconds)
|
|
let start = Moment.now()
|
|
check bucket.tryConsume(15000, start)
|
|
check bucket.tryConsume(1, start) == false
|
|
|
|
check bucket.tryConsume(15000, start + 1.milliseconds) == true
|