feat: add payload to ClientError and structure message

src/posit/connect/errors.py

@@ -1,15 +1,29 @@
+import json
+from typing import Any
+
+
 class ClientError(Exception):
     def __init__(
         self,
         error_code: int,
         error_message: str,
         http_status: int,
         http_message: str,
+        payload: Any = None,
     ):
         self.error_code = error_code
         self.error_message = error_message
         self.http_status = http_status
         self.http_message = http_message
+        self.payload = payload
         super().__init__(
-            f"{error_message} (Error Code: {error_code}, HTTP Status: {http_status} {http_message})"
+            json.dumps(
+                {
+                    "error_code": error_code,
+                    "error_message": error_message,
+                    "http_status": http_status,
+                    "http_message": http_message,
+                    "payload": payload,
+                }
+            )
         )

src/posit/connect/hooks.py

@@ -12,10 +12,11 @@ def handle_errors(response: Response, *args, **kwargs) -> Response:
             data = response.json()
             error_code = data["code"]
             message = data["error"]
+            payload = data.get("payload")
             http_status = response.status_code
             http_status_message = responses[http_status]
             raise ClientError(
-                error_code, message, http_status, http_status_message
+                error_code, message, http_status, http_status_message, payload
             )
         except JSONDecodeError:
             # No JSON error message from Connect, so just raise

tests/posit/connect/test_errors.py

@@ -3,19 +3,56 @@
 from posit.connect.errors import ClientError
 
 
-class TestClientError:
-    def test(self):
-        error_code = 0
-        error_message = "foo"
-        http_status = 404
-        http_message = "Foo Bar"
-        with pytest.raises(
-            ClientError,
-            match=r"foo \(Error Code: 0, HTTP Status: 404 Foo Bar\)",
-        ):
-            raise ClientError(
-                error_code=error_code,
-                error_message=error_message,
-                http_status=http_status,
-                http_message=http_message,
-            )
+def test():
+    error_code = 0
+    error_message = "error"
+    http_status = 404
+    http_message = "Error"
+    with pytest.raises(
+        ClientError,
+        match='{"error_code": 0, "error_message": "error", "http_status": 404, "http_message": "Error", "payload": null}',
+    ):
+        raise ClientError(
+            error_code=error_code,
+            error_message=error_message,
+            http_status=http_status,
+            http_message=http_message,
+        )
+
+
+def test_payload_is_str():
+    error_code = 0
+    error_message = "error"
+    http_status = 404
+    http_message = "Error"
+    payload = "This is an error payload"
+    with pytest.raises(
+        ClientError,
+        match='{"error_code": 0, "error_message": "error", "http_status": 404, "http_message": "Error", "payload": "This is an error payload"}',
+    ):
+        raise ClientError(
+            error_code=error_code,
+            error_message=error_message,
+            http_status=http_status,
+            http_message=http_message,
+            payload=payload,
+        )
+
+
+def test_payload_is_dict():
+    error_code = 0
+    error_message = "error"
+    http_status = 404
+    http_message = "Error"
+    payload = {"message": "This is an error payload"}
+    with pytest.raises(
+        ClientError,
+        match='{"error_code": 0, "error_message": "error", "http_status": 404, "http_message": "Error", "payload": {"message": "This is an error payload"}}',
+    ):
+        raise ClientError(
+            error_code=error_code,
+            error_message=error_message,
+            http_status=http_status,
+            http_message=http_message,
+            payload=payload,
+        )

tests/posit/connect/test_hooks.py

@@ -55,7 +55,7 @@ def test_response_client_error_with_json_payload():
     response.raw = io.BytesIO(b'{"code":0,"error":"foobar"}')
     with pytest.raises(
         ClientError,
-        match=r"foobar \(Error Code: 0, HTTP Status: 400 Bad Request\)",
+        match='{"error_code": 0, "error_message": "foobar", "http_status": 400, "http_message": "Bad Request", "payload": null}',
     ):
         handle_errors(response)