Skip to content

Add socket to environ to allow user sending websocket messages #470

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

Open
smeng9 wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −0
Open

Add socket to environ to allow user sending websocket messages #470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
acafff5
Allow user to manipulate socket to add support for websocket
smeng9 May 12, 2025
cc572a2
update tests for added socket object
smeng9 May 13, 2025
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
4 changes: 4 additions & 0 deletions src/waitress/task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,10 @@ def get_environment(self):
# channel_request_lookahead larger than 0.
environ["waitress.client_disconnected"] = self.channel.check_client_disconnected

# Insert the raw socket object into the environment that allows the
# application to upgrade to WebSocket communication.
environ["waitress.socket"] = self.channel.socket

# cache the environ for this request
self.environ = environ
return environ
3 changes: 3 additions & 0 deletions tests/test_task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import io
import socket
import unittest


Expand Down Expand Up @@ -804,6 +805,7 @@ def test_get_environment_values(self):
"SERVER_PROTOCOL",
"SERVER_SOFTWARE",
"waitress.client_disconnected",
"waitress.socket",
"wsgi.errors",
"wsgi.file_wrapper",
"wsgi.input",
Expand Down Expand Up @@ -960,6 +962,7 @@ class DummyChannel:
adj = DummyAdj()
creation_time = 0
addr = ("127.0.0.1", 39830)
socket = socket.socket()

def check_client_disconnected(self):
# For now, until we have tests handling this feature
Expand Down