add X-Ratelimit-Strategy header to responses

Author: IAmTomahawkx

README.md

@@ -34,7 +34,8 @@ To get an API token, log in with any oauth provider and enter the dashboard. Cop
 The way ratelimits work differs based on whether redis is being used or not.
 If redis is in use, the window method is used, where you have X requests available in a certain timeframe.
 If redis is NOT in use, the leaky bucket method is used, where you gain requests after every X seconds.
-The ratelimit headers will differ a slight bit depending on the method in use (ex x-ratelimit-reset is not applicable to the leaky bucket, and will always be 0)
+The ratelimit headers will differ a slight bit depending on the method in use (ex x-ratelimit-reset is not applicable to the leaky bucket, and will always be 0).
+You can always tell what method is being used via the `X-Ratelimit-Strategy` header. If this header returns `ignore`, ratelimits are not applicable to the request (ex if using an admin account).
 
 All API responses have ratelimit information associated with them:
 - `x-ratelimit-available`: How many API calls you have left before being ratelimited.

mystbin/backend/utils/ratelimits.py

@@ -32,6 +32,8 @@ class NoRedisConnection(Exception):
 }
 
 class BaseLimitBucket:
+    strategy: str
+
     def __init__(self, app: MystbinApp, key: str, count: int, per: int) -> None:
         self.count = count
         self.per = per
@@ -57,6 +59,8 @@ class InMemoryLimitBucket(BaseLimitBucket):
 
     __slots__ = ("count", "per", "hits")
 
+    strategy: str = "leakybucket"
+
     def __init__(self, app: MystbinApp, key: str, count: int, per: int) -> None:
         self.count = count
         self.per = per
@@ -87,6 +91,8 @@ class RedisLimitBucket(BaseLimitBucket):
 
     __slots__ = ("key", "count", "per", "app", "reset")
 
+    strategy: str = "window"
+
     def __init__(self, app: MystbinApp, key: str, count: int, per: int) -> None:
         self.app = app
         self.key = key
@@ -179,7 +185,8 @@ async def middleware(self, request: Request, call_next: _CT) -> Response:
                 "X-Ratelimit-Used": "0",
                 "X-Ratelimit-Reset": "0",
                 "X-Ratelimit-Max": "1",
-                "X-Ratelimit-Available": "1"
+                "X-Ratelimit-Available": "1",
+                "X-Ratelimit-Strategy": self.bucket_cls.strategy
             }
 
             if is_limited:
@@ -213,7 +220,8 @@ async def middleware(self, request: Request, call_next: _CT) -> Response:
                 "X-Ratelimit-Used": "0",
                 "X-Ratelimit-Reset": "0",
                 "X-Ratelimit-Max": "1",
-                "X-Ratelimit-Available": "1"
+                "X-Ratelimit-Available": "1",
+                "X-Ratelimit-Strategy": "ignore"
             }
             resp = await call_next(request)
             resp.headers.update(headers)