Skip to content

Improve Informativeness of Network Errors #4822

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
merged 4 commits into from
Jun 29, 2025
Merged

Improve Informativeness of Network Errors #4822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0098d7b
Improve Informativeness of Network Errors
Bibo-Joshi Jun 9, 2025
1498e04
Add Chango Fragment
Bibo-Joshi Jun 9, 2025
6b1f4f4
try fixing tests
Bibo-Joshi Jun 9, 2025
43db65d
try again
Bibo-Joshi Jun 9, 2025
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
5 changes: 5 additions & 0 deletions changes/unreleased/4822.DrW3tJ3KoB8kTmHtNnNEpQ.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
other = "Improve Informativeness of Network Errors Raised by ``BaseRequest.post/retrieve``"

[[pull_requests]]
uid = "4822"
author_uid = "Bibo-Joshi"
72 changes: 44 additions & 28 deletions src/telegram/request/_baserequest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,45 +317,61 @@ async def _request_wrapper(

if HTTPStatus.OK <= code <= 299:
# 200-299 range are HTTP success statuses
# starting with Py 3.12 we can use `HTTPStatus.is_success`
return payload

response_data = self.parse_json_payload(payload)

description = response_data.get("description")
message = description if description else "Unknown HTTPError"
try:
message = f"{HTTPStatus(code).phrase} ({code})"
except ValueError:
message = f"Unknown HTTPError ({code})"

# In some special cases, we can raise more informative exceptions:
# see https://core.telegram.org/bots/api#responseparameters and
# https://core.telegram.org/bots/api#making-requests
# TGs response also has the fields 'ok' and 'error_code'.
# However, we rather rely on the HTTP status code for now.
parameters = response_data.get("parameters")
if parameters:
migrate_to_chat_id = parameters.get("migrate_to_chat_id")
if migrate_to_chat_id:
raise ChatMigrated(migrate_to_chat_id)
retry_after = parameters.get("retry_after")
if retry_after:
raise RetryAfter(retry_after)
parsing_exception: Optional[TelegramError] = None

message += f"\nThe server response contained unknown parameters: {parameters}"
try:
response_data = self.parse_json_payload(payload)
except TelegramError as exc:
message += f". Parsing the server response {payload!r} failed"
parsing_exception = exc
else:
message = response_data.get("description") or message

# In some special cases, we can raise more informative exceptions:
# see https://core.telegram.org/bots/api#responseparameters and
# https://core.telegram.org/bots/api#making-requests
# TGs response also has the fields 'ok' and 'error_code'.
# However, we rather rely on the HTTP status code for now.
parameters = response_data.get("parameters")
if parameters:
migrate_to_chat_id = parameters.get("migrate_to_chat_id")
if migrate_to_chat_id:
raise ChatMigrated(migrate_to_chat_id)
retry_after = parameters.get("retry_after")
if retry_after:
raise RetryAfter(retry_after)

message += f". The server response contained unknown parameters: {parameters}"

if code == HTTPStatus.FORBIDDEN: # 403
raise Forbidden(message)
if code in (HTTPStatus.NOT_FOUND, HTTPStatus.UNAUTHORIZED): # 404 and 401
exception: TelegramError = Forbidden(message)
elif code in (HTTPStatus.NOT_FOUND, HTTPStatus.UNAUTHORIZED): # 404 and 401
# TG returns 404 Not found for
# 1) malformed tokens
# 2) correct tokens but non-existing method, e.g. api.tg.org/botTOKEN/unkonwnMethod
# 2) is relevant only for Bot.do_api_request, where we have special handing for it.
# TG returns 401 Unauthorized for correctly formatted tokens that are not valid
raise InvalidToken(message)
if code == HTTPStatus.BAD_REQUEST: # 400
raise BadRequest(message)
if code == HTTPStatus.CONFLICT: # 409
raise Conflict(message)
if code == HTTPStatus.BAD_GATEWAY: # 502
raise NetworkError(description or "Bad Gateway")
raise NetworkError(f"{message} ({code})")
exception = InvalidToken(message)
elif code == HTTPStatus.BAD_REQUEST: # 400
exception = BadRequest(message)
elif code == HTTPStatus.CONFLICT: # 409
exception = Conflict(message)
elif code == HTTPStatus.BAD_GATEWAY: # 502
exception = NetworkError(message)
else:
exception = NetworkError(message)

if parsing_exception:
raise exception from parsing_exception
raise exception

@staticmethod
def parse_json_payload(payload: bytes) -> JSONDict:
Expand Down
28 changes: 25 additions & 3 deletions tests/request/test_request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,18 +316,40 @@ async def test_error_description(self, monkeypatch, httpx_request: HTTPXRequest,
(-1, NetworkError),
],
)
@pytest.mark.parametrize("description", ["Test Message", None])
async def test_special_errors(
self, monkeypatch, httpx_request: HTTPXRequest, code, exception_class
self, monkeypatch, httpx_request: HTTPXRequest, code, exception_class, description
):
server_response = b'{"ok": "False", "description": "Test Message"}'
server_response_json = {"ok": False}
if description:
server_response_json["description"] = description
server_response = json.dumps(server_response_json).encode(TextEncoding.UTF_8)

monkeypatch.setattr(
httpx_request,
"do_request",
mocker_factory(response=server_response, return_code=code),
)

with pytest.raises(exception_class, match="Test Message"):
if not description and code not in list(HTTPStatus):
match = f"Unknown HTTPError.*{code}"
else:
match = description or str(code.value)

with pytest.raises(exception_class, match=match):
await httpx_request.post("", None, None)

async def test_error_parsing_payload(self, monkeypatch, httpx_request: HTTPXRequest):
"""Test that we raise an error if the payload is not a valid JSON."""
server_response = b"invalid_json"

monkeypatch.setattr(
httpx_request,
"do_request",
mocker_factory(response=server_response, return_code=HTTPStatus.BAD_GATEWAY),
)

with pytest.raises(TelegramError, match=r"502.*\. Parsing.*b'invalid_json' failed"):
await httpx_request.post("", None, None)

@pytest.mark.parametrize(
Expand Down
Loading