Fix graphql ws did not ignore parsing errors #3670
Open
+111
−38
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
Reviewer's Guide by SourceryThis pull request fixes a regression in the legacy GraphQL over WebSocket protocol implementation. The main change is to restore the behavior of ignoring client message parsing errors in the legacy protocol, which was accidentally changed in a recent refactor. The PR updates the WebSocket adapters, handlers, and related tests to properly handle and ignore parsing errors when required. Sequence diagram for WebSocket message handling with parsing errorssequenceDiagram
participant Client
participant Server
Client->>Server: Send text message
alt Valid JSON
Server->>Server: Process message
else Invalid JSON
Server->>Server: Ignore message
end
Client->>Server: Send non-text message
Server->>Client: Close connection with error "WebSocket message type must be text"
Updated class diagram for WebSocket adaptersclassDiagram
class AsyncWebSocketAdapter {
+iter_json(ignore_parsing_errors: bool) AsyncGenerator
+send_json(message: Mapping)
}
class LitestarWebSocketAdapter {
+iter_json(ignore_parsing_errors: bool) AsyncGenerator
}
class ASGIWebSocketAdapter {
+iter_json(ignore_parsing_errors: bool) AsyncGenerator
}
class ChannelsWebSocketAdapter {
+iter_json(ignore_parsing_errors: bool) AsyncGenerator
}
class AiohttpWebSocketAdapter {
+iter_json(ignore_parsing_errors: bool) AsyncGenerator
}
AsyncWebSocketAdapter <|-- LitestarWebSocketAdapter
AsyncWebSocketAdapter <|-- ASGIWebSocketAdapter
AsyncWebSocketAdapter <|-- ChannelsWebSocketAdapter
AsyncWebSocketAdapter <|-- AiohttpWebSocketAdapter
note for AsyncWebSocketAdapter "Added ignore_parsing_errors parameter to iter_json method"
Updated class diagram for WebSocket exceptionsclassDiagram
class NonTextMessageReceived {
}
class NonJsonMessageReceived {
}
class HTTPException {
-status_code: int
-reason: str
}
HTTPException <|-- NonTextMessageReceived
HTTPException <|-- NonJsonMessageReceived
note for NonTextMessageReceived "New exception for non-text messages"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
DoctorJohn
force-pushed
the
fix-graphql-ws-did-not-ignore-parsing-errors
branch
from
8d712d8
to
0ad7d1d
Compare
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @DoctorJohn - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
Thanks for adding the Here's a preview of the changelog: This release fixes a regression in the legacy GraphQL over WebSocket protocol. Here's the tweet text: |
CodSpeed Performance ReportMerging #3670 will not alter performanceComparing Summary
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3670 +/- ##
==========================================
+ Coverage 96.67% 96.70% +0.03%
==========================================
Files 503 503
Lines 33457 33486 +29
Branches 5602 5624 +22
==========================================
+ Hits 32344 32384 +40
Misses 880 880
+ Partials 233 222 -11 |
bellini666
approved these changes
Oct 19, 2024
| @@ -86,16 +90,19 @@ def __init__(self, request: web.Request, ws: web.WebSocketResponse) -> None: | |||
| self.request = request | |||
| self.ws = ws | |||
|
|
|||
| async def iter_json(self) -> AsyncGenerator[Dict[str, object], None]: | |||
| async def iter_json( | |||
| self, ignore_parsing_errors: bool | |||
There was a problem hiding this comment.
nit: ensure this needs to be passed as a keyword to avoid someone calling as iter_json(True) and the True there is hard to understand the meaning
Suggested change
| self, ignore_parsing_errors: bool | |
| self, | |
| *, | |
| ignore_parsing_errors: bool, |
There was a problem hiding this comment.
Also, should it have a default value? (not sure, just asking =P)
| @@ -31,20 +31,23 @@ class ChannelsWebSocketAdapter(AsyncWebSocketAdapter): | |||
| def __init__(self, request: GraphQLWSConsumer, response: GraphQLWSConsumer) -> None: | |||
| self.ws_consumer = response | |||
|
|
|||
| async def iter_json(self) -> AsyncGenerator[Dict[str, object], None]: | |||
| async def iter_json( | |||
| self, ignore_parsing_errors: bool | |||
| @@ -81,7 +81,9 @@ async def get_form_data(self) -> FormData: ... | |||
|
|
|||
| class AsyncWebSocketAdapter(abc.ABC): | |||
| @abc.abstractmethod | |||
| def iter_json(self) -> AsyncGenerator[Dict[str, object], None]: ... | |||
| def iter_json( | |||
| self, ignore_parsing_errors: bool | |||
| @@ -192,13 +196,22 @@ class LitestarWebSocketAdapter(AsyncWebSocketAdapter): | |||
| def __init__(self, request: WebSocket, response: WebSocket) -> None: | |||
| self.ws = response | |||
|
|
|||
| async def iter_json(self) -> AsyncGenerator[Dict[str, object], None]: | |||
| async def iter_json( | |||
| self, ignore_parsing_errors: bool | |||
| raise NonTextMessageReceived() | ||
|
|
||
| try: | ||
| yield json.loads(text) |
There was a problem hiding this comment.
Not related to this PR (so nothing to change here), but this got me thinking if we should allow for different json libs to be used in places like this, like orjson.
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.
Description
The legacy WS protocol dictates that servers should ignore text messages sent by clients that are not valid JSON. Here's the relevant section from the legacy protocol specification:
I accidentally changed this behavior in a recent refactor to match the newer protocol, which requires servers to close the WebSocket in this case.
This PR restores the intended behavior and updates the relevant tests.
Types of Changes
Summary by Sourcery
Fix the handling of non-JSON messages in the legacy GraphQL WebSocket protocol to ignore parsing errors instead of closing the connection, and update tests to reflect this behavior.
Bug Fixes:
Documentation:
Tests: