More informative assert errors for WebsocketCommunicator. #2098
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hovi
commented
May 12, 2024
| assert response["type"] == "websocket.send" | ||
| assert ( | ||
| response["type"] == "websocket.send" | ||
| ), f"Expected type 'websocket.send', but was '{response['type']}'" |
There was a problem hiding this comment.
This is the useful and important one, the rest I added only for sake of completion.
There was a problem hiding this comment.
Hi @hovi — this looks reasonable, yes. Thanks!
Just one comment…
Co-authored-by: Carlton Gibson <[email protected]>
carltongibson
approved these changes
May 12, 2024
|
If you can fix the lint error, we're good to go. |
I believe I just did. Are you squashing or should I cleanup commits? |
|
Thanks @hovi 🎁 |
|
My pleasure, thanks for quick review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Already happened to me twice, that this AssertionError got me puzzled for a bit (being channels newbie and coming back after months), until I figured out, what was going on (socket closed unexpectedly while I wanted to read from it).
Having this kind of informative message would give me immediate hint and make my debugging much faster.