Fix WebSocket close reason to send valid JSON string - #1
Open
veeceey wants to merge 14 commits into
Open
Conversation
[skip ci]
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Motov Yurii <109919500+YuriiMotov@users.noreply.github.com> Co-authored-by: Yurii Motov <yurii.motov.monte@gmail.com>
[skip ci]
[skip ci]
…pi#14873) Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
[skip ci]
[skip ci]
The default `websocket_request_validation_exception_handler` was passing a Python list (from `jsonable_encoder`) as the `reason` parameter to `websocket.close()`, which expects a string. This caused the close reason to be sent as a Python repr (with single quotes and `None` instead of `null`), making it impossible for clients to parse as JSON. Wrap the result with `json.dumps()` so that the close reason is a proper JSON string that clients can reliably deserialize. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
veeceey
changed the title
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
This PR fixes a bug in the default
websocket_request_validation_exception_handlerand is intended for upstream fastapi/fastapi.list(fromjsonable_encoder(exc.errors())) as thereasonparameter towebsocket.close(), which expects astr. The close reason is sent as Python repr with single quotes andNoneinstead ofnull, making it unparseable as JSON by WebSocket clients.json.dumps()so the close reason is a valid JSON string.Before (on master)
After (this PR)
[{"loc": ["header", "x-token"], "msg": "Field required", "type": "missing", "input": null}]Test plan
test_websocket_validation_close_reason_is_valid_json- fails on master, passes with fix