Spec: Added reason to WebSocket Disconnect
#462
Conversation
| @@ -189,6 +189,7 @@ class WebSocketResponseBodyEvent(TypedDict): | |||
| class WebSocketDisconnectEvent(TypedDict): | |||
| type: Literal["websocket.disconnect"] | |||
| code: int | |||
| reason: Optional[str] | |||
There was a problem hiding this comment.
@andrewgodwin Can we start using NotRequired on those?
There was a problem hiding this comment.
Unfortunately that only appears in 3.11...
There was a problem hiding this comment.
asgiref depends on typing_extensions, so it's already possible.
| @@ -22,6 +22,7 @@ This spec has had the following versions: | |||
| * ``2.2``: Allow ``None`` in the second item of ``server`` scope value. | |||
| * ``2.3``: Added the ``reason`` key to the WebSocket close event. | |||
| * ``2.4``: Calling ``send()`` on a closed connection should raise an error | |||
| * ``2.5``: Added the ``reason`` key to the WebSocket disconnect event. | |||
There was a problem hiding this comment.
Does this need a bump on the spec?
There was a problem hiding this comment.
Not for me to say, but I saw it was done similarly for 2.3. Can remove it if not needed :)
There was a problem hiding this comment.
Yes, any spec change should minor bump if it's backwards-compatible (like this) and a major bump if it is not.
There was a problem hiding this comment.
You did miss out updating the main version number though - we'll need that bumped too.
There was a problem hiding this comment.
You did miss out updating the main version number though - we'll need that bumped too.
Done 👍
|
Anything I can do so we can go forward with this? 🙂 |
| @@ -22,6 +22,7 @@ This spec has had the following versions: | |||
| * ``2.2``: Allow ``None`` in the second item of ``server`` scope value. | |||
| * ``2.3``: Added the ``reason`` key to the WebSocket close event. | |||
| * ``2.4``: Calling ``send()`` on a closed connection should raise an error | |||
| * ``2.5``: Added the ``reason`` key to the WebSocket disconnect event. | |||
There was a problem hiding this comment.
You did miss out updating the main version number though - we'll need that bumped too.
Clients can send this reason field when disconnecting. This is allowed as per RFC 6455 and supported in browsers JS API, but previously not supported in ASGI. Fix django#459
|
Thanks for your help on this! |
|
@andrewgodwin can you push an update to the docs, please? |
|
It was meant to auto-build but it seems the webhook became unhappy - just initiated a manual build, so it should be good soon. |
Thanks! |
This is a proposal to fix the discussion in #459
Clients can send this reason field when disconnecting. This is allowed as per RFC 6455 and supported in browsers JS API, but previously not supported in ASGI.
I took the liberty to bump the spec version, but I can remove it if you prefer 🙂