improve JSON decode error handling to include response content in client.request_ws() (#111)

cldif · web-flow · commit 25cd23833814 · 2025-09-05T15:08:29.000+02:00
* improve JSON decode error handling to include response content in client.request_ws()

* fix formatting and linting issues
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### CHANGED
+
+- #[110](https://github.com/braincube-io/python-connector/issues/110): Improved JSON decode error messages in client.request_ws() to include response content when the server returns non-JSON responses.
+
 ## [2.7.0 - 2025-01-09](https://github.com/braincube-io/python-connector/compare/2.6.1...2.7.0)
 
 ### CHANGED
diff --git a/braincube_connector/client.py b/braincube_connector/client.py
@@ -100,7 +100,15 @@ def request_ws(
         )
         request_result.raise_for_status()
         if response_as_json:
-            return request_result.json()
+            try:
+                return request_result.json()
+            except requests.exceptions.JSONDecodeError as json_error:
+                error_msg = "Invalid JSON response: {0}. Response content: {1}".format(
+                    json_error, request_result.text
+                )
+                raise requests.exceptions.JSONDecodeError(
+                    error_msg, request_result.text, 0
+                ) from json_error
         return request_result
 
     def get_braincube_infos(self) -> Dict[str, Any]:
diff --git a/tests/test_client.py b/tests/test_client.py
@@ -63,6 +63,27 @@ def test_request_ws_succes_no_json(mock_client):
     assert type(result) == requests.models.Response
 
 
+@responses.activate
+def test_request_ws_json_decode_error_with_content(mock_client):
+    """Test whether request_ws includes response content in JSON decode error messages."""
+    # Mock a response that returns non-JSON content
+    responses.add(
+        responses.GET,
+        LOAD_URL,
+        body="<html><body>Response content not JSON</body></html>",
+        status=200,
+    )
+
+    with pytest.raises(requests.exceptions.JSONDecodeError) as excinfo:
+        mock_client.request_ws("path", response_as_json=True)
+
+    # Check that the error message contains the response content
+    error_message = str(excinfo.value)
+    assert "Invalid JSON response" in error_message
+    assert "Response content:" in error_message
+    assert "<html><body>Response content not JSON</body></html>" in error_message
+
+
 @responses.activate
 def test_request_braincubes(mock_client):
     """Test the _request_braincubes method"""
