chore: better error messages on http client errors (#1017)

Author: eikek

components/renku_data_services/base_api/error_handler.py

@@ -8,6 +8,7 @@
 from sqlite3 import Error as SqliteError
 from typing import Any, Optional, Protocol, TypeVar, Union
 
+import httpx
 import jwt
 from asyncpg import exceptions as postgres_exceptions
 from pydantic import ValidationError as PydanticValidationError
@@ -67,9 +68,9 @@ def __init__(self, api_spec: ApiSpec, base: type[BaseRenderer] = TextRenderer) -
         self.api_spec = api_spec
         super().__init__(base)
 
-    def default(self, request: Request, exception: Exception) -> HTTPResponse:
-        """Overrides the default error handler."""
-        formatted_exception = errors.BaseError()
+    @classmethod
+    def _get_formatted_exception(cls, request: Request, exception: Exception) -> errors.BaseError | None:
+        formatted_exception: errors.BaseError | None = None
         match exception:
             case errors.BaseError():
                 formatted_exception = exception
@@ -136,6 +137,24 @@ def default(self, request: Request, exception: Exception) -> HTTPResponse:
             case CancelledError():
                 quiet = request.transport.is_closing()
                 formatted_exception = errors.RequestCancelledError(quiet=quiet)
+
+            case httpx.RequestError():
+                req_uri = "<unknown-uri>"
+                req_method = "<unknown-method>"
+                if exception._request:
+                    req_uri = str(exception.request.url)
+                    req_method = exception.request.method
+
+                formatted_exception = errors.BaseError(
+                    message=f"Error on remote connection {req_method} {req_uri}: {exception}"
+                )
+
+        return formatted_exception
+
+    def default(self, request: Request, exception: Exception) -> HTTPResponse:
+        """Overrides the default error handler."""
+        formatted_exception = self._get_formatted_exception(request, exception) or errors.BaseError()
+
         self.log(request, formatted_exception)
         if formatted_exception.status_code == 500 and "PYTEST_CURRENT_TEST" in os.environ:
             # TODO: Figure out how to do logging properly in here, I could not get the sanic logs to show up from here

test/components/renku_data_services/base_api/test_error_handler.py

@@ -0,0 +1,50 @@
+"""Test functions for the error_handler module."""
+
+from sqlite3 import Error as SqliteError
+
+import httpx
+import jwt
+from asyncpg.exceptions import PostgresError
+from pydantic import ValidationError as PydanticValidationError
+from sanic import SanicException
+from sanic_ext.exceptions import ValidationError as SanicValidationError
+from sqlalchemy.exc import SQLAlchemyError
+
+from renku_data_services.base_api.error_handler import CustomErrorHandler
+from renku_data_services.errors import errors
+
+
+def make_sqlite_error() -> SqliteError:
+    err = SqliteError()
+    err.sqlite_errorcode = 1
+    err.sqlite_errorname = "name"
+    return err
+
+
+def make_pg_error() -> PostgresError:
+    err = PostgresError()
+    err.msg = "not supported"
+    err.pgcode = "A0110"
+    return err
+
+
+def test_match_exception() -> None:
+    expect_to_match = [
+        errors.BaseError(),
+        SanicValidationError(extra={"exception": PydanticValidationError("oops", [])}),
+        SanicValidationError(extra={"exception": TypeError("oops")}),
+        PydanticValidationError("oops", []),
+        SanicException(),
+        make_sqlite_error(),
+        make_pg_error(),
+        SQLAlchemyError(),
+        OverflowError(),
+        jwt.exceptions.InvalidTokenError(),
+        httpx.ConnectError("oops"),
+        httpx.UnsupportedProtocol("ftp"),
+    ]
+
+    req = httpx.Request("GET", "")
+    for exc in expect_to_match:
+        result = CustomErrorHandler._get_formatted_exception(req, exc)
+        assert result is not None