kiba-core 0.5.3.dev68__tar.gz → 0.5.3.dev69__tar.gz

{kiba_core-0.5.3.dev68 → kiba_core-0.5.3.dev69}/CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 
 ### Added
+- [MAJOR] Updated `Requester` to raise `RequesterTimeoutException` (a `GatewayTimeoutException`, 504) instead of `httpx` timeout exceptions; it carries the method, the URL without credentials or query string, the timeout, how long the request ran and the `httpx` timeout type, and keeps the original exception as its cause. Code catching `httpx.TimeoutException` (or `ReadTimeout`, `ConnectTimeout`, …) around `Requester` calls must catch `RequesterTimeoutException` instead
 - [PATCH] Updated `MessageQueueProcessor` failure notifications to show the exception type before its message, so failures from exceptions without text (e.g. `httpx` timeouts) are still identifiable
 - [MINOR] Added `authorize_bearer_jwt_request` for validating bearer JWTs in `RouteAuthResolver` implementations; it and `authorize_bearer_jwt` now only strip the leading `Bearer ` prefix, let cancellation propagate, and log why a JWT was rejected
 - [MINOR] Made the `route` `authResolver` optional for routes without `auth`; setting `auth` without an `authResolver` raises `ValueError` at registration

{kiba_core-0.5.3.dev68 → kiba_core-0.5.3.dev69}/PKG-INFO

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

{kiba_core-0.5.3.dev68 → kiba_core-0.5.3.dev69}/core/requester/requester.py

@@ -1,4 +1,5 @@
 import os
+import time
 import typing
 import urllib.parse as urlparse
 from collections.abc import Mapping
@@ -13,6 +14,7 @@ import httpx2 as httpx
 
 from core import logging
 from core.exceptions import HTTP_EXCEPTIONS_MAP
+from core.exceptions import GatewayTimeoutException
 from core.exceptions import KibaException
 from core.util import dict_util
 from core.util import file_util
@@ -42,6 +44,18 @@ class ResponseException(KibaException):
         self.headers = headers
 
 
+class RequesterTimeoutException(GatewayTimeoutException):
+    def __init__(self, method: str, url: str, timeoutSeconds: float | None, durationSeconds: float, timeoutType: str) -> None:
+        urlParts = urlparse.urlsplit(url)
+        # NOTE(krishan711): drop credentials and the query string (where api keys usually live) since this message ends up in logs and notifications
+        self.url = urlparse.urlunsplit((urlParts.scheme, urlParts.netloc.rpartition('@')[2], urlParts.path, '', ''))
+        self.method = method
+        self.timeoutSeconds = timeoutSeconds
+        self.durationSeconds = durationSeconds
+        self.timeoutType = timeoutType
+        super().__init__(message=f'{method} {self.url} timed out after {durationSeconds:.1f}s ({timeoutType}, timeout {timeoutSeconds}s)')
+
+
 class Requester:
     def __init__(self, headers: Mapping[str, str] | None = None, shouldFollowRedirects: bool = True) -> None:
         self.headers = headers or {}
@@ -136,7 +150,11 @@ class Requester:
             else:
                 logging.error('Error: formFiles should only be passed into POST requests.')
         request = self.client.build_request(method=method, url=url, content=content, data=innerData, files=files, timeout=timeout, headers=requestHeaders)
-        httpxResponse = await self.client.send(request=request)
+        startTime = time.monotonic()
+        try:
+            httpxResponse = await self.client.send(request=request)
+        except httpx.TimeoutException as exception:
+            raise RequesterTimeoutException(method=method, url=str(request.url), timeoutSeconds=timeout, durationSeconds=time.monotonic() - startTime, timeoutType=exception.__class__.__name__) from exception
         if 400 <= httpxResponse.status_code < 600:  # noqa: PLR2004
             message = httpxResponse.text
             if not message and httpxResponse.status_code == 401 and httpxResponse.headers.get('www-authenticate'):  # noqa: PLR2004

{kiba_core-0.5.3.dev68 → kiba_core-0.5.3.dev69}/kiba_core.egg-info/PKG-INFO

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

{kiba_core-0.5.3.dev68 → kiba_core-0.5.3.dev69}/pyproject.toml

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

{kiba_core-0.5.3.dev68 → kiba_core-0.5.3.dev69}/tests/requester/test_requester.py

@@ -4,6 +4,7 @@ import pytest
 from core.exceptions import NotFoundException
 from core.exceptions import TooManyRequestsException
 from core.requester.requester import Requester
+from core.requester.requester import RequesterTimeoutException
 
 
 class TestRequesterExceptionHeaders:
@@ -39,3 +40,21 @@ class TestRequesterExceptionHeaders:
         requester.client = httpx.AsyncClient(transport=httpx.MockTransport(handler))
         with pytest.raises(NotFoundException):
             await requester.get(url='https://example.com/resource')
+
+
+class TestRequesterTimeouts:
+
+    @pytest.mark.asyncio
+    async def test_timeout_raises_requester_timeout_with_request_details(self):
+        def handler(request: httpx.Request) -> httpx.Response:
+            raise httpx.ReadTimeout('', request=request)
+
+        requester = Requester()
+        requester.client = httpx.AsyncClient(transport=httpx.MockTransport(handler))
+        with pytest.raises(RequesterTimeoutException) as excInfo:
+            await requester.post(url='https://user:secret@example.com/v1/rpc?apiKey=secret', timeout=5)
+        exception = excInfo.value
+        assert (exception.method, exception.url, exception.timeoutSeconds, exception.timeoutType, exception.statusCode) == ('POST', 'https://example.com/v1/rpc', 5, 'ReadTimeout', 504)
+        assert exception.message.startswith('POST https://example.com/v1/rpc timed out after ')
+        assert 'secret' not in exception.message
+        assert isinstance(exception.__cause__, httpx.ReadTimeout)