Skip to content

Do not swallow non-JSON http error responses #1250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sanders41 merged 2 commits into from
Jun 23, 2026
Merged

Do not swallow non-JSON http error responses #1250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e2f14e
Do not swallow non-JSON http error responses
Strift Jun 23, 2026
ef693f6
Handle non-dict valid JSON
Strift Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions meilisearch/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,17 @@ def __init__(self, error: str, request: Response) -> None:
self.type = None

if request.text:
json_data = json.loads(request.text)
self.message = json_data.get("message")
self.code = json_data.get("code")
self.link = json_data.get("link")
self.type = json_data.get("type")
try:
json_data = json.loads(request.text)
if isinstance(json_data, dict):
self.message = json_data.get("message") or request.text
self.code = json_data.get("code")
self.link = json_data.get("link")
self.type = json_data.get("type")
else:
self.message = request.text
except json.JSONDecodeError:
self.message = request.text
else:
self.message = error
super().__init__(self.message)
Expand Down
40 changes: 40 additions & 0 deletions tests/errors/test_api_error_meilisearch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,46 @@ def test_meilisearch_api_error_no_code(mock_post):
client.create_index("some_index")


@patch("requests.post")
def test_meilisearch_api_error_falls_back_to_raw_message_for_non_json_response(mock_post):
"""Uses raw response text when an API error body is not valid JSON."""
mock_post.configure_mock(__name__="post")
mock_response = requests.models.Response()
mock_response.status_code = 502
mock_response._content = b"<html>Bad Gateway</html>" # pylint: disable=protected-access
mock_post.return_value = mock_response

with pytest.raises(MeilisearchApiError) as exc:
client = meilisearch.Client(BASE_URL, MASTER_KEY + "123")
client.create_index("some_index")

assert exc.value.status_code == 502
assert exc.value.message == "<html>Bad Gateway</html>"
assert exc.value.code is None
assert exc.value.link is None
assert exc.value.type is None


@patch("requests.post")
def test_meilisearch_api_error_falls_back_to_raw_message_for_non_object_json_response(mock_post):
"""Uses raw response text when parsed JSON is not an object."""
mock_post.configure_mock(__name__="post")
mock_response = requests.models.Response()
mock_response.status_code = 502
mock_response._content = b'["Bad Gateway"]' # pylint: disable=protected-access
mock_post.return_value = mock_response

with pytest.raises(MeilisearchApiError) as exc:
client = meilisearch.Client(BASE_URL, MASTER_KEY + "123")
client.create_index("some_index")

assert exc.value.status_code == 502
assert exc.value.message == '["Bad Gateway"]'
assert exc.value.code is None
assert exc.value.link is None
assert exc.value.type is None


def test_version_error_hint_message():
mock_response = requests.models.Response()
mock_response.status_code = 408
Expand Down