-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: rate limit peer exchange protocol, enhanced response status in…
… RPC (#3035) * Enhanced peer-ex protocol - added rate limiting, added response status and desc to the rpc * Better error result handling for PeerEx request, adjusted tests * Refactored RateLimit configuration option for better CLI UX - now possible to set separate limits per protocol. Adjusted mountings. Added and adjusted tests * Fix libwaku due to changes of error return type of fetchPeerExchangePeers * Fix rate limit setting tests due to changed defaults * Introduce new gauge to help dasboard effectively show current rate limit applied for protocol * Adjust timeing in filter rate limit test to let macos CI test run ok. * Address review findings, namings, error logs, removed left-overs * Changes to reflect latest spec agreement and changes. PeerExchange RPC is changed the now respond structure will contain status_code and status_desc.
- Loading branch information
1 parent
83f25c3
commit 0a7f16a
Showing
23 changed files
with
656 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| # 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, libp2p/stream/connection | ||
| import std/[sequtils, options, tables] | ||
|
|
||
| import ../../waku/common/rate_limit/request_limiter | ||
| import ../../waku/common/rate_limit/timed_map | ||
|
|
||
| let proto = "ProtocolDescriptor" | ||
|
|
||
| let conn1 = Connection(peerId: PeerId.random().tryGet()) | ||
| let conn2 = Connection(peerId: PeerId.random().tryGet()) | ||
| let conn3 = Connection(peerId: PeerId.random().tryGet()) | ||
|
|
||
| suite "RateLimitSetting": | ||
| test "Parse rate limit setting - ok": | ||
| let test1 = "10/2m" | ||
| let test2 = " store : 10 /1h" | ||
| let test2a = "storev2 : 10 /1h" | ||
| let test2b = "storeV3: 12 /1s" | ||
| let test3 = "LIGHTPUSH: 10/ 1m" | ||
| let test4 = "px:10/2 s " | ||
| let test5 = "filter:42/66ms" | ||
|
|
||
| let expU = UnlimitedRateLimit | ||
| let exp1: RateLimitSetting = (10, 2.minutes) | ||
| let exp2: RateLimitSetting = (10, 1.hours) | ||
| let exp2a: RateLimitSetting = (10, 1.hours) | ||
| let exp2b: RateLimitSetting = (12, 1.seconds) | ||
| let exp3: RateLimitSetting = (10, 1.minutes) | ||
| let exp4: RateLimitSetting = (10, 2.seconds) | ||
| let exp5: RateLimitSetting = (42, 66.milliseconds) | ||
|
|
||
| let res1 = ProtocolRateLimitSettings.parse(@[test1]) | ||
| let res2 = ProtocolRateLimitSettings.parse(@[test2]) | ||
| let res2a = ProtocolRateLimitSettings.parse(@[test2a]) | ||
| let res2b = ProtocolRateLimitSettings.parse(@[test2b]) | ||
| let res3 = ProtocolRateLimitSettings.parse(@[test3]) | ||
| let res4 = ProtocolRateLimitSettings.parse(@[test4]) | ||
| let res5 = ProtocolRateLimitSettings.parse(@[test5]) | ||
|
|
||
| check: | ||
| res1.isOk() | ||
| res1.get() == {GLOBAL: exp1, FILTER: FilterDefaultPerPeerRateLimit}.toTable() | ||
| res2.isOk() | ||
| res2.get() == | ||
| { | ||
| GLOBAL: expU, | ||
| FILTER: FilterDefaultPerPeerRateLimit, | ||
| STOREV2: exp2, | ||
| STOREV3: exp2, | ||
| }.toTable() | ||
| res2a.isOk() | ||
| res2a.get() == | ||
| {GLOBAL: expU, FILTER: FilterDefaultPerPeerRateLimit, STOREV2: exp2a}.toTable() | ||
| res2b.isOk() | ||
| res2b.get() == | ||
| {GLOBAL: expU, FILTER: FilterDefaultPerPeerRateLimit, STOREV3: exp2b}.toTable() | ||
| res3.isOk() | ||
| res3.get() == | ||
| {GLOBAL: expU, FILTER: FilterDefaultPerPeerRateLimit, LIGHTPUSH: exp3}.toTable() | ||
| res4.isOk() | ||
| res4.get() == | ||
| {GLOBAL: expU, FILTER: FilterDefaultPerPeerRateLimit, PEEREXCHG: exp4}.toTable() | ||
| res5.isOk() | ||
| res5.get() == {GLOBAL: expU, FILTER: exp5}.toTable() | ||
|
|
||
| test "Parse rate limit setting - err": | ||
| let test1 = "10/2d" | ||
| let test2 = " stre : 10 /1h" | ||
| let test2a = "storev2 10 /1h" | ||
| let test2b = "storev3: 12 1s" | ||
| let test3 = "somethingelse: 10/ 1m" | ||
| let test4 = ":px:10/2 s " | ||
| let test5 = "filter:p42/66ms" | ||
|
|
||
| let res1 = ProtocolRateLimitSettings.parse(@[test1]) | ||
| let res2 = ProtocolRateLimitSettings.parse(@[test2]) | ||
| let res2a = ProtocolRateLimitSettings.parse(@[test2a]) | ||
| let res2b = ProtocolRateLimitSettings.parse(@[test2b]) | ||
| let res3 = ProtocolRateLimitSettings.parse(@[test3]) | ||
| let res4 = ProtocolRateLimitSettings.parse(@[test4]) | ||
| let res5 = ProtocolRateLimitSettings.parse(@[test5]) | ||
|
|
||
| check: | ||
| res1.isErr() | ||
| res2.isErr() | ||
| res2a.isErr() | ||
| res2b.isErr() | ||
| res3.isErr() | ||
| res4.isErr() | ||
| res5.isErr() | ||
|
|
||
| test "Parse rate limit setting - complex": | ||
| let expU = UnlimitedRateLimit | ||
|
|
||
| let test1 = @["lightpush:2/2ms", "10/2m", " store: 3/3s", " storev2:12/12s"] | ||
| let exp1 = { | ||
| GLOBAL: (10, 2.minutes), | ||
| FILTER: FilterDefaultPerPeerRateLimit, | ||
| LIGHTPUSH: (2, 2.milliseconds), | ||
| STOREV3: (3, 3.seconds), | ||
| STOREV2: (12, 12.seconds), | ||
| }.toTable() | ||
|
|
||
| let res1 = ProtocolRateLimitSettings.parse(test1) | ||
|
|
||
| check: | ||
| res1.isOk() | ||
| res1.get() == exp1 | ||
| res1.get().getSetting(PEEREXCHG) == (10, 2.minutes) | ||
| res1.get().getSetting(STOREV2) == (12, 12.seconds) | ||
| res1.get().getSetting(STOREV3) == (3, 3.seconds) | ||
| res1.get().getSetting(LIGHTPUSH) == (2, 2.milliseconds) | ||
|
|
||
| let test2 = @["lightpush:2/2ms", " store: 3/3s", "px:10/10h", "filter:4/42ms"] | ||
| let exp2 = { | ||
| GLOBAL: expU, | ||
| LIGHTPUSH: (2, 2.milliseconds), | ||
| STOREV3: (3, 3.seconds), | ||
| STOREV2: (3, 3.seconds), | ||
| FILTER: (4, 42.milliseconds), | ||
| PEEREXCHG: (10, 10.hours), | ||
| }.toTable() | ||
|
|
||
| let res2 = ProtocolRateLimitSettings.parse(test2) | ||
|
|
||
| check: | ||
| res2.isOk() | ||
| res2.get() == exp2 | ||
|
|
||
| let test3 = | ||
| @["storev2:1/1s", "store:3/3s", "storev3:4/42ms", "storev3:5/5s", "storev3:6/6s"] | ||
| let exp3 = { | ||
| GLOBAL: expU, | ||
| FILTER: FilterDefaultPerPeerRateLimit, | ||
| STOREV3: (6, 6.seconds), | ||
| STOREV2: (1, 1.seconds), | ||
| }.toTable() | ||
|
|
||
| let res3 = ProtocolRateLimitSettings.parse(test3) | ||
|
|
||
| check: | ||
| res3.isOk() | ||
| res3.get() == exp3 | ||
| res3.get().getSetting(LIGHTPUSH) == expU | ||
|
|
||
| let test4 = newSeq[string](0) | ||
| let exp4 = {GLOBAL: expU, FILTER: FilterDefaultPerPeerRateLimit}.toTable() | ||
|
|
||
| let res4 = ProtocolRateLimitSettings.parse(test4) | ||
|
|
||
| check: | ||
| res4.isOk() | ||
| res4.get() == exp4 | ||
| res3.get().getSetting(LIGHTPUSH) == expU |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.