Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve user feedback if no ws library installed #926

Merged
merged 6 commits into from
Feb 25, 2021
Merged

Improve user feedback if no ws library installed #926

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c0e7268
Note about ws not by default
euri10 Dec 29, 2020
af15cae
Add a warning message
euri10 Dec 29, 2020
3ee2cb1
Removed index prose
euri10 Feb 24, 2021
194dd77
Add warning in h11 which is where you'll be with uvicorn installed wi…
euri10 Feb 25, 2021
b49b29e
Better warning message
euri10 Feb 25, 2021
6be7919
Seperate upgrade warning from libraries warning
euri10 Feb 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions uvicorn/protocols/http/h11_impl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,13 @@ def handle_upgrade(self, event):
if upgrade_value != b"websocket" or self.ws_protocol_class is None:
msg = "Unsupported upgrade request."
self.logger.warning(msg)

from uvicorn.protocols.websockets.auto import AutoWebSocketsProtocol
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Nit) Let's add empty lines around this block so it's clearer that it's related but separate from the rest of the error handling code?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems like we're gtg :)


if AutoWebSocketsProtocol is None:
msg = "No supported WebSocket library detected. Please use 'pip install uvicorn[standard]', or install 'websockets' or 'wsproto' manually." # noqa: E501
self.logger.warning(msg)

reason = STATUS_PHRASES[400]
headers = [
(b"content-type", b"text/plain; charset=utf-8"),
Expand Down