feat(http): add max retry error handling in http client

Author: jentyk

mpt_api_client/exceptions.py

@@ -17,6 +17,13 @@ def __init__(self, status_code: int, message: str, body: str):
         super().__init__(f"HTTP {status_code}: {message}")
 
 
+class MPTMaxRetryError(MPTError):
+    """Represents an error when maximum retry attempts are exceeded."""
+
+    def __init__(self, message: str, attempts: int):
+        super().__init__(f"{message} error after {attempts} retry attempts.")
+
+
 class MPTAPIError(MPTHttpError):
     """Represents an API error."""
 

mpt_api_client/http/async_client.py

@@ -1,11 +1,11 @@
 import os
 from typing import Any
 
-from httpx import AsyncClient, HTTPError, HTTPStatusError
+from httpx import AsyncClient, HTTPError, HTTPStatusError, RequestError
 from httpx_retries import Retry, RetryTransport
 
 from mpt_api_client.constants import APPLICATION_JSON
-from mpt_api_client.exceptions import MPTError, transform_http_status_exception
+from mpt_api_client.exceptions import MPTError, MPTMaxRetryError, transform_http_status_exception
 from mpt_api_client.http.client import json_to_file_payload
 from mpt_api_client.http.client_utils import get_query_params, validate_base_url
 from mpt_api_client.http.query_options import QueryOptions
@@ -23,6 +23,7 @@ def __init__(
         timeout: float = 20.0,
         retries: int = 5,
     ):
+        self._retries = retries
         retry = Retry(total=retries)
         transport = RetryTransport(retry=retry)
 
@@ -47,7 +48,7 @@ def __init__(
             follow_redirects=True,
         )
 
-    async def request(  # noqa: WPS211
+    async def request(  # noqa: WPS211  # NOSONAR
         self,
         method: str,
         url: str,
@@ -80,6 +81,7 @@ async def request(  # noqa: WPS211
             MPTError: If the request fails.
             MPTApiError: If the response contains an error.
             MPTHttpError: If the response contains an HTTP error.
+            MPTMaxRetryError: If the request fails after maximum retry attempts.
         """
         files = dict(files or {})
         if force_multipart or (files and json):
@@ -95,6 +97,8 @@ async def request(  # noqa: WPS211
                 params=params_str or None,
                 headers=headers,
             )
+        except RequestError as err:
+            raise MPTMaxRetryError(str(err), self._retries + 1) from err
         except HTTPError as err:
             raise MPTError(f"HTTP Error: {err}") from err
 

mpt_api_client/http/client.py

@@ -2,11 +2,11 @@
 import os
 from typing import Any
 
-from httpx import Client, HTTPError, HTTPStatusError
+from httpx import Client, HTTPError, HTTPStatusError, RequestError
 from httpx_retries import Retry, RetryTransport
 
 from mpt_api_client.constants import APPLICATION_JSON
-from mpt_api_client.exceptions import MPTError, transform_http_status_exception
+from mpt_api_client.exceptions import MPTError, MPTMaxRetryError, transform_http_status_exception
 from mpt_api_client.http.client_utils import get_query_params, validate_base_url
 from mpt_api_client.http.query_options import QueryOptions
 from mpt_api_client.http.types import HeaderTypes, QueryParam, RequestFiles, Response
@@ -33,7 +33,8 @@ def __init__(
         timeout: float = 20.0,
         retries: int = 5,
     ):
-        retry = Retry(total=retries)
+        self._retries = retries
+        retry = Retry(total=self._retries)
         transport = RetryTransport(retry=retry)
 
         api_token = api_token or os.getenv("MPT_API_TOKEN")
@@ -105,6 +106,8 @@ def request(  # noqa: WPS211
                 params=params_str or None,
                 headers=headers,
             )
+        except RequestError as err:
+            raise MPTMaxRetryError(str(err), self._retries + 1) from err
         except HTTPError as err:
             raise MPTError(f"HTTP Error: {err}") from err
 

tests/unit/http/test_async_client.py

@@ -79,7 +79,7 @@ async def test_async_http_call_success(async_http_client, mock_response):
 async def test_async_http_call_failure(async_http_client):
     timeout_route = respx.get(f"{API_URL}/timeout").mock(side_effect=ConnectTimeout("Mock Timeout"))
 
-    with pytest.raises(MPTError, match="HTTP Error: Mock Timeout"):
+    with pytest.raises(MPTError, match=r"Mock Timeout error after 6 retry attempts."):
         await async_http_client.request("GET", "/timeout")
 
     assert timeout_route.called

tests/unit/http/test_client.py

@@ -5,7 +5,7 @@
 import respx
 from httpx import ConnectTimeout, Response, codes
 
-from mpt_api_client.exceptions import MPTError
+from mpt_api_client.exceptions import MPTMaxRetryError
 from mpt_api_client.http.client import HTTPClient
 from mpt_api_client.http.query_options import QueryOptions
 from tests.unit.conftest import API_TOKEN, API_URL
@@ -71,7 +71,7 @@ def test_http_call_success(http_client):
 def test_http_call_failure(http_client):
     timeout_route = respx.get(f"{API_URL}/timeout").mock(side_effect=ConnectTimeout("Mock Timeout"))
 
-    with pytest.raises(MPTError, match="HTTP Error: Mock Timeout"):
+    with pytest.raises(MPTMaxRetryError, match=r"Mock Timeout error after 6 retry attempts."):
         http_client.request("GET", "/timeout")
 
     assert timeout_route.called