Fix review findings, added limit to debug logs

waku-org · May 9, 2024 · 8855227 · 8855227
1 parent 5ffa3fe
commit 8855227
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 4 deletions.
diff --git a/waku/common/ratelimit.nim b/waku/common/ratelimit.nim
@@ -26,7 +26,7 @@ proc newTokenBucket*(setting: Option[RateLimitSetting]): Option[TokenBucket] =
 
 proc checkUsage(
     t: var Option[TokenBucket], proto: string, conn: Connection
-): bool {.raises: [Defect].} =
+): bool {.raises: [].} =
   if t.isNone():
     return true
 
@@ -48,3 +48,9 @@ template checkUsageLimit*(
   else:
     waku_service_requests_rejected.inc(labelValues = [proto])
     bodyRejected
+
+func `$`*(ob: Option[TokenBucket]): string {.inline.} =
+  if ob.isNone():
+    return "no-limit"
+
+  return $ob.get()
diff --git a/waku/common/tokenbucket.nim b/waku/common/tokenbucket.nim
@@ -62,3 +62,6 @@ proc new*(T: type[TokenBucket], budgetCap: int, fillDuration: Duration = 1.secon
     fillDuration: fillDuration,
     lastTimeFull: Moment.now(),
   )
+
+func `$`*(b: TokenBucket): string {.inline.} =
+  return $b.budgetCap & "/" & $b.fillDuration
diff --git a/waku/waku_lightpush/protocol.nim b/waku/waku_lightpush/protocol.nim
@@ -79,7 +79,8 @@ proc initProtocolHandler(wl: WakuLightPush) =
 
       rpc = await handleRequest(wl, conn.peerId, buffer)
     do:
-      debug "lightpush request rejected due rate limit exceeded", peerId = conn.peerId
+      debug "lightpush request rejected due rate limit exceeded",
+        peerId = conn.peerId, limit = $wl.requestRateLimiter
 
       rpc = static(
         PushRPC(

diff --git a/waku/waku_store/protocol.nim b/waku/waku_store/protocol.nim
@@ -109,7 +109,8 @@ proc initProtocolHandler(self: WakuStore) =
 
       resBuf = await self.handleQueryRequest(conn.peerId, reqBuf)
     do:
-      debug "store query request rejected due rate limit exceeded", peerId = conn.peerId
+      debug "store query request rejected due rate limit exceeded",
+        peerId = conn.peerId, limit = $self.requestRateLimiter
       resBuf = rejectReposnseBuffer
 
     let writeRes = catch:

diff --git a/waku/waku_store_legacy/protocol.nim b/waku/waku_store_legacy/protocol.nim
@@ -125,7 +125,7 @@ proc initProtocolHandler(ws: WakuStore) =
       resBuf = await ws.handleLegacyQueryRequest(conn.peerId, reqBuf)
     do:
       debug "Legacy store query request rejected due rate limit exceeded",
-        peerId = conn.peerId
+        peerId = conn.peerId, limit = $ws.requestRateLimiter
       resBuf = rejectResponseBuf
 
     let writeRes = catch: