Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add human readable error messages for WebSocket PING/PONG timeouts #10422

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

Jump to bottom
Merged
bdraco merged 3 commits into from
Feb 6, 2025
Merged

Add human readable error messages for WebSocket PING/PONG timeouts #10422

bdraco merged 3 commits into from
Feb 6, 2025

Conversation

@bdraco
Copy link
Member

@bdraco bdraco commented Feb 6, 2025

What do these changes do?

Currently the exception would stringify to an empty string which left the caller with no information about why the WebSocket disconnected in the log

Are there changes in behavior for the user?

Human readable errors

Is it a substantial burden for the maintainers to support this?

no

@bdraco
Add human readable error messages for WebSocket PING/PONG timeouts
a721b5c 
Currently the exception would stringify to an empty string which
left the caller with no information about why the WebSocket
disconnected in the log
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Feb 6, 2025
bdraco
bdraco commented Feb 6, 2025
View reviewed changes
bdraco
bdraco commented Feb 6, 2025
View reviewed changes
@codspeed-hq
Copy link

codspeed-hq bot commented Feb 6, 2025

CodSpeed Performance Report

Merging #10422 will not alter performance

Comparing ws_error (8f2216b) with master (e6ed541)

Summary

✅ 47 untouched benchmarks

@codecov
Copy link

codecov bot commented Feb 6, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.76%. Comparing base (e6ed541) to head (8f2216b).
Report is 318 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #10422      +/-   ##
==========================================
- Coverage   98.77%   98.76%   -0.01%     
==========================================
  Files         122      122              
  Lines       37125    37127       +2     
  Branches     2044     2044              
==========================================
- Hits        36669    36668       -1     
- Misses        316      319       +3     
  Partials      140      140
Flag Coverage Δ
CI-GHA 98.65% <100.00%> (-0.01%) ⬇️
OS-Linux 98.33% <100.00%> (-0.01%) ⬇️
OS-Windows 96.26% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.46% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.34% <100.00%> (-0.01%) ⬇️
Py-3.10.16 97.91% <100.00%> (+<0.01%) ⬆️
Py-3.11.11 97.99% <100.00%> (-0.02%) ⬇️
Py-3.11.9 97.43% <100.00%> (+<0.01%) ⬆️
Py-3.12.8 98.43% <100.00%> (+<0.01%) ⬆️
Py-3.13.1 98.42% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.23% <100.00%> (+<0.01%) ⬆️
Py-3.9.21 97.79% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.38% <100.00%> (-0.01%) ⬇️
VM-macos 97.46% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 98.33% <100.00%> (-0.01%) ⬇️
VM-windows 96.26% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bdraco bdraco marked this pull request as ready for review February 6, 2025 14:28
@bdraco bdraco mentioned this pull request Feb 6, 2025
Open
@bdraco bdraco merged commit 289259d into master Feb 6, 2025
40 checks passed
@bdraco bdraco deleted the ws_error branch February 6, 2025 16:27
@patchback
Copy link
Contributor

patchback bot commented Feb 6, 2025 •
edited
Loading

Backport to 3.11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.11/289259d123763911c8f408e2979d820fd10dc053/pr-10422

Backported as #10431

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Feb 6, 2025
@bdraco @patchback
Add human readable error messages for WebSocket PING/PONG timeouts (#…
d8caa16 
…10422)

(cherry picked from commit 289259d)
@patchback patchback bot mentioned this pull request Feb 6, 2025
Merged
@patchback
Copy link
Contributor

patchback bot commented Feb 6, 2025 •
edited
Loading

Backport to 3.12: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.12/289259d123763911c8f408e2979d820fd10dc053/pr-10422

Backported as #10432

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Feb 6, 2025
@bdraco @patchback
Add human readable error messages for WebSocket PING/PONG timeouts (#…
abe7f0f 
…10422)

(cherry picked from commit 289259d)
@patchback patchback bot mentioned this pull request Feb 6, 2025
Merged
bdraco added a commit that referenced this pull request Feb 6, 2025
@patchback @bdraco
[PR #10422/289259d1 backport][3.12] Add human readable error messages…
a3d8bd3 
… for WebSocket PING/PONG timeouts (#10432)

Co-authored-by: J. Nick Koston <[email protected]>
bdraco added a commit that referenced this pull request Feb 6, 2025
@patchback @bdraco
[PR #10422/289259d1 backport][3.11] Add human readable error messages…
5942b0b 
… for WebSocket PING/PONG timeouts (#10431)

Co-authored-by: J. Nick Koston <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@webknjaz webknjaz Awaiting requested review from webknjaz webknjaz is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

Assignees

No one assigned

Labels

bot:chronographer:provided There is a change note present in this PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bdraco