From a1b28fe77e80c1e2b069300a3de8cbb1cb1fd371 Mon Sep 17 00:00:00 2001 From: David Pedersen Date: Tue, 26 Oct 2021 01:05:26 +0200 Subject: [PATCH] Fix inconsistent naming of WebSocket rejections --- CHANGELOG.md | 3 ++ examples/chat/chat.html | 98 ++++++++++++++++++++--------------------- src/extract/ws.rs | 18 ++++---- 3 files changed, 61 insertions(+), 58 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e314e93ac87..f816461fdf4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -144,6 +144,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 // ... } ``` +- Misc: + - `InvalidWebsocketVersionHeader` has been renamed to `InvalidWebSocketVersionHeader` + - `WebsocketKeyHeaderMissing` has been renamed to `WebSocketKeyHeaderMissing` [#339]: https://github.com/tokio-rs/axum/pull/339 [#286]: https://github.com/tokio-rs/axum/pull/286 diff --git a/examples/chat/chat.html b/examples/chat/chat.html index d1c665e0965..c062f3807d4 100644 --- a/examples/chat/chat.html +++ b/examples/chat/chat.html @@ -1,52 +1,52 @@ - - - Websocket Chat - - -

Websocket Chat Example

- - - - - - - - + + + WebSocket Chat + + +

WebSocket Chat Example

+ + + + + + + + diff --git a/src/extract/ws.rs b/src/extract/ws.rs index 4b76857cd0f..c5a06989934 100644 --- a/src/extract/ws.rs +++ b/src/extract/ws.rs @@ -209,7 +209,7 @@ where } if !header_eq(req, header::SEC_WEBSOCKET_VERSION, "13")? { - return Err(InvalidWebsocketVersionHeader.into()); + return Err(InvalidWebSocketVersionHeader.into()); } let sec_websocket_key = if let Some(key) = req @@ -219,7 +219,7 @@ where { key } else { - return Err(WebsocketKeyHeaderMissing.into()); + return Err(WebSocketKeyHeaderMissing.into()); }; let on_upgrade = req @@ -309,7 +309,7 @@ where } else { return ( StatusCode::BAD_REQUEST, - "`Sec-Websocket-Protocol` header is invalid", + "`Sec-WebSocket-Protocol` header is invalid", ) .into_response(); } @@ -578,16 +578,16 @@ pub mod rejection { define_rejection! { #[status = BAD_REQUEST] - #[body = "`Sec-Websocket-Version` header did not include '13'"] + #[body = "`Sec-WebSocket-Version` header did not include '13'"] /// Rejection type for [`WebSocketUpgrade`](super::WebSocketUpgrade). - pub struct InvalidWebsocketVersionHeader; + pub struct InvalidWebSocketVersionHeader; } define_rejection! { #[status = BAD_REQUEST] - #[body = "`Sec-Websocket-Key` header missing"] + #[body = "`Sec-WebSocket-Key` header missing"] /// Rejection type for [`WebSocketUpgrade`](super::WebSocketUpgrade). - pub struct WebsocketKeyHeaderMissing; + pub struct WebSocketKeyHeaderMissing; } composite_rejection! { @@ -599,8 +599,8 @@ pub mod rejection { MethodNotGet, InvalidConnectionHeader, InvalidUpgradeHeader, - InvalidWebsocketVersionHeader, - WebsocketKeyHeaderMissing, + InvalidWebSocketVersionHeader, + WebSocketKeyHeaderMissing, HeadersAlreadyExtracted, ExtensionsAlreadyExtracted, }