websockify: additional comments on async, rewrite

Author: dylex

jupyter_server_proxy/config.py

@@ -291,7 +291,7 @@ def cats_only(response, path):
             Proxy websocket requests as a TCP (or unix socket) stream.
             In this mode, only websockets are handled, and messages are sent to the backend,
             equivalent to running a websockify layer (https://github.com/novnc/websockify).
-            All other HTTP requests return 405.
+            All other HTTP requests return 405 (and thus this will also bypass rewrite_response).
         """,
         config=True,
     )

jupyter_server_proxy/websockify.py

@@ -22,7 +22,8 @@ def __init__(self, handler):
     def data_received(self, data):
         "Send the buffer as a websocket message."
         self.handler._record_activity()
-        self.handler.write_message(data, binary=True) # async, no wait
+        # async "semi-synchronous", waiting is only needed for control flow and errors:
+        self.handler.write_message(data, binary=True)
 
     def connection_lost(self, exc):
         "Close the websocket connection."