kiba-core 0.5.3.dev53__tar.gz → 0.5.3.dev55__tar.gz

{kiba_core-0.5.3.dev53 → kiba_core-0.5.3.dev55}/CHANGELOG.md

@@ -34,6 +34,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - [MINOR] Added `blockNumber` to `EthClient.multicall` function
 - [MINOR] Added `SqlMessageQueue` and `CosmosMessageQueue` to support database backed queues
 - [MINOR] Added `shouldAllowFailures` to `EthClient.multicall` to allow individual calls to fail without reverting the whole batch
+- [MINOR] Added `KibaException.from_headers`/`outgoing_headers` hooks so exceptions can be built from and emit response headers; used by `TooManyRequestsException` (`Retry-After`, now also parsed automatically by `Requester` from 429 responses) and `RedirectException` (`Location`/`Cache-Control`), and applied generically by `ExceptionHandlingMiddleware`
 
 ### Changed
 

{kiba_core-0.5.3.dev53 → kiba_core-0.5.3.dev55}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiba-core
-Version: 0.5.3.dev53
+Version: 0.5.3.dev55
 Summary: Kiba Labs' python utilities
 Project-URL: repository, https://github.com/kibalabs/core-py
 Requires-Python: <4,>=3.12

{kiba_core-0.5.3.dev53 → kiba_core-0.5.3.dev55}/core/api/authorizer.py

@@ -1,4 +1,5 @@
 import functools
+import hmac
 import typing
 from collections.abc import AsyncIterator
 
@@ -101,7 +102,7 @@ class StaticTokenAuthorizer(TokenAuthorizer):
         self._token = token
 
     async def validate_token(self, token: str) -> None:
-        if token != self._token:
+        if not hmac.compare_digest(token, self._token):
             raise ForbiddenException(message='AUTH_INVALID')
 
 

{kiba_core-0.5.3.dev53 → kiba_core-0.5.3.dev55}/core/api/middleware/exception_handling_middleware.py

@@ -20,6 +20,7 @@ class ExceptionHandlingMiddleware(BaseHTTPMiddleware):
     @staticmethod
     def _convert_exception(exception: KibaException) -> Response:
         response = JSONResponse(status_code=exception.statusCode, content=exception.to_dict())
+        response.headers.update(exception.outgoing_headers())
         return response
 
     async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -> Response:
@@ -27,10 +28,7 @@ class ExceptionHandlingMiddleware(BaseHTTPMiddleware):
             response = await call_next(request)
         except RedirectException as exception:
             response = Response(status_code=exception.statusCode)
-            response.headers['Location'] = exception.location
-            # TODO(krishan711): clean this up after major version bump (since shouldAddCacheHeader field will always exist)
-            if not hasattr(exception, 'shouldAddCacheHeader') or exception.shouldAddCacheHeader:
-                response.headers['Cache-Control'] = f'max-age={60 * 60 * 24 * 365}'
+            response.headers.update(exception.outgoing_headers())
         except ClientException as exception:
             if self.shouldSquashClientExceptions:
                 logging.error(f'{exception.exceptionType} occurred: {exception.message}')

{kiba_core-0.5.3.dev53 → kiba_core-0.5.3.dev55}/core/exceptions.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import datetime
+import email.utils
 from collections.abc import Mapping
 
 from core.util.typing_util import JsonObject
@@ -18,6 +20,15 @@ class KibaException(Exception):  # noqa: N818
             return exception
         return KibaException(message=str(exception), statusCode=statusCode, exceptionType=exception.__class__.__name__)
 
+    @classmethod
+    def from_headers(cls, message: str | None, statusCode: int, headers: Mapping[str, str]) -> KibaException:  # noqa: ARG003
+        # NOTE(krishan711): default ignores headers; subclasses that need response headers (e.g. Retry-After, Location) should override
+        return cls(message=message)
+
+    def outgoing_headers(self) -> Mapping[str, str]:
+        # NOTE(krishan711): default has no extra headers; subclasses that need to set response headers (e.g. Retry-After, Location) should override
+        return {}
+
     def to_dict(self) -> JsonObject:
         return {
             'exceptionType': self.exceptionType,
@@ -194,9 +205,34 @@ class PreconditionRequiredException(ClientException):
 
 
 class TooManyRequestsException(ClientException):
-    def __init__(self, message: str | None = None) -> None:
+    def __init__(self, message: str | None = None, retryAfterSeconds: int | None = None) -> None:
         message = message or 'Too Many Requests'
         super().__init__(message=message, statusCode=429)
+        self.retryAfterSeconds = retryAfterSeconds
+
+    @staticmethod
+    def _parse_retry_after_header(value: str | None) -> int | None:
+        if not value:
+            return None
+        if value.strip().isdigit():
+            return int(value.strip())
+        try:
+            retryDate = email.utils.parsedate_to_datetime(value)
+        except (TypeError, ValueError):
+            return None
+        if retryDate.tzinfo is None:
+            retryDate = retryDate.replace(tzinfo=datetime.UTC)
+        remainingSeconds = int((retryDate - datetime.datetime.now(datetime.UTC)).total_seconds())
+        return max(0, remainingSeconds)
+
+    @classmethod
+    def from_headers(cls, message: str | None, statusCode: int, headers: Mapping[str, str]) -> TooManyRequestsException:  # noqa: ARG003
+        return cls(message=message, retryAfterSeconds=cls._parse_retry_after_header(headers.get('Retry-After')))
+
+    def outgoing_headers(self) -> Mapping[str, str]:
+        if self.retryAfterSeconds is None:
+            return {}
+        return {'Retry-After': str(self.retryAfterSeconds)}
 
 
 class RequestHeaderFieldsTooLargeException(ClientException):
@@ -394,6 +430,12 @@ class RedirectException(KibaException):
         self.location = location
         self.shouldAddCacheHeader = shouldAddCacheHeader
 
+    def outgoing_headers(self) -> Mapping[str, str]:
+        headers = {'Location': self.location}
+        if self.shouldAddCacheHeader:
+            headers['Cache-Control'] = f'max-age={60 * 60 * 24 * 365}'
+        return headers
+
 
 class MovedPermanentlyRedirectException(RedirectException):
     def __init__(self, location: str, message: str | None = None, shouldAddCacheHeader: bool | None = True) -> None:

{kiba_core-0.5.3.dev53 → kiba_core-0.5.3.dev55}/core/requester/requester.py

@@ -143,7 +143,7 @@ class Requester:
                 message = httpxResponse.headers['www-authenticate']
             if HTTP_EXCEPTIONS_MAP.get(httpxResponse.status_code) is not None:
                 exceptionCls = HTTP_EXCEPTIONS_MAP[httpxResponse.status_code]
-                exception: KibaException = exceptionCls(message=message)
+                exception: KibaException = exceptionCls.from_headers(message=message, statusCode=httpxResponse.status_code, headers=httpxResponse.headers)
             else:
                 exception = ResponseException(message=message, statusCode=httpxResponse.status_code, headers=httpxResponse.headers)
             raise exception

{kiba_core-0.5.3.dev53 → kiba_core-0.5.3.dev55}/kiba_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiba-core
-Version: 0.5.3.dev53
+Version: 0.5.3.dev55
 Summary: Kiba Labs' python utilities
 Project-URL: repository, https://github.com/kibalabs/core-py
 Requires-Python: <4,>=3.12

{kiba_core-0.5.3.dev53 → kiba_core-0.5.3.dev55}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kiba-core"
-version = "0.5.3.dev53"
+version = "0.5.3.dev55"
 description = "Kiba Labs' python utilities"
 readme = "README.md"
 requires-python = ">=3.12, <4"