sanic-org · ahopkins · Sep 29, 2021 · Jun 8, 2021 · Jun 9, 2021 · Jun 16, 2021
diff --git a/examples/websocket_bench.html b/examples/websocket_bench.html
@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>WebSocket benchmark</title>
+    </head>
+    <body>
+        <script>
+            function make_msg(length) {
+                var result = '';
+                var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+                var clen = characters.length;
+                for ( var i = 0; i < length; i++ ) {
+                  result += characters.charAt(Math.floor(Math.random() * clen));
+               }
+               return result;
+            }
+            var ws = new WebSocket('ws://' + document.domain + ':' + location.port + '/bench');
+            var msg = make_msg(16384);
+            var started = false;
+            function send_msg() {
+                if (ws.readyState === ws.OPEN) {
+                    ws.send(msg);
+                    window.setTimeout(send_msg, 1);
+                }
+            }
+            function run_bench() {
+                console.log("first msg seen, starting bench...");
+                window.setTimeout(send_msg, 0);
+            }
+            function stop_bench() {
+                ws.close(1000);
+            }
+            ws.onmessage = function(event) {
+                console.log("Received "+ event.data);
+                if (started === false) {
+                    started = true;
+                    window.setTimeout(run_bench, 0);
+                    window.setTimeout(stop_bench, 40000);
+                }
+            };
+            ws.onclose = function(event) {
+                console.log("Websocket connection closed.");
+            }
+
+        </script>
+    </body>
+</html>
diff --git a/examples/websocket_bench.py b/examples/websocket_bench.py
@@ -0,0 +1,70 @@
+import asyncio
+import logging
+from sanic import Sanic
+from sanic.response import file
+from sanic.log import error_logger
+import time
+error_logger.setLevel(logging.INFO)
+app = Sanic(__name__)
+
+@app.route('/')
+async def index(request):
+    return await file('websocket_bench.html')
+
+
+@app.websocket('/bench')
+async def bench_p_time(request, ws):
+    i = 0
+    bytes_total = 0
+    start = 0
+    end_time = 0
+    started = False
+    await ws.send("1")
+    while started is False or (end_time > time.time()):
+        i += 1
+        in_data = await ws.recv()
+        if started is False:
+            del in_data
+            error_logger.info("received first data: starting benchmark now..")
+            started = True
+            start = time.time()
+            end_time = start + 30.0
+            continue
+        bytes_total += len(in_data)
+        del in_data
+    end = time.time()
+    elapsed = end - start
+    error_logger.info("Done. Took {} seconds".format(elapsed))
+    error_logger.info("{} bytes in 30 seconds = {}".format(bytes_total, (bytes_total/30.0)))
+
+@app.websocket('/benchp')
+async def bench_p_time(request, ws):
+    i = 0
+    bytes_total = 0
+    real_start = 0
+    start_ptime = 0
+    end_ptime = 0
+    started = False
+    await ws.send("1")
+    while started is False or (end_ptime > time.process_time()):
+        i += 1
+        in_data = await ws.recv()
+        if started is False:
+            del in_data
+            error_logger.info("received first data: starting benchmark now..")
+            started = True
+            real_start = time.time()
+            start_ptime = time.process_time()
+            end_ptime = start_ptime + 30.0
+            continue
+        bytes_total += len(in_data)
+        del in_data
+    real_end = time.time()
+    elapsed = real_end - real_start
+    error_logger.info("Done. Took {} seconds".format(elapsed))
+    error_logger.info("{} bytes in 30 seconds = {}".format(bytes_total, (bytes_total/30.0)))
+
+
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000, debug=False, auto_reload=False)
+
@@ -74,9 +74,10 @@
 from sanic.server import AsyncioServer, HttpProtocol
 from sanic.server import Signal as ServerSignal
 from sanic.server import serve, serve_multiple, serve_single
+from sanic.server.protocols.websocket_protocol import WebSocketProtocol
+from sanic.server.websockets.impl import ConnectionClosed
 from sanic.signals import Signal, SignalRouter
 from sanic.touchup import TouchUp, TouchUpMeta
-from sanic.websocket import ConnectionClosed, WebSocketProtocol
 
 
 class Sanic(BaseSanic, metaclass=TouchUpMeta):
@@ -871,39 +872,31 @@ async def handle_request(self, request: Request):  # no cov
     async def _websocket_handler(
         self, handler, request, *args, subprotocols=None, **kwargs
     ):
-        request.app = self
-        if not getattr(handler, "__blueprintname__", False):
-            request._name = handler.__name__
-        else:
-            request._name = (
-                getattr(handler, "__blueprintname__", "") + handler.__name__
-            )
-
-            pass
-
         if self.asgi:
             ws = request.transport.get_websocket_connection()
             await ws.accept(subprotocols)
         else:
             protocol = request.transport.get_protocol()
-            protocol.app = self
-
             ws = await protocol.websocket_handshake(request, subprotocols)
 
         # schedule the application handler
         # its future is kept in self.websocket_tasks in case it
         # needs to be cancelled due to the server being stopped
         fut = ensure_future(handler(request, ws, *args, **kwargs))
         self.websocket_tasks.add(fut)
+        cancelled = False
         try:
             await fut
         except Exception as e:
             self.error_handler.log(request, e)
         except (CancelledError, ConnectionClosed):
-            pass
+            cancelled = True
         finally:
             self.websocket_tasks.remove(fut)
-            await ws.close()
+            if cancelled:
+                ws.end_connection(1000)
+            else:
+                await ws.close()
 
     # -------------------------------------------------------------------- #
     # Testing

@@ -10,7 +10,7 @@
 from sanic.models.asgi import ASGIReceive, ASGIScope, ASGISend, MockTransport
 from sanic.request import Request
 from sanic.server import ConnInfo
-from sanic.websocket import WebSocketConnection
+from sanic.server.websockets.connection import WebSocketConnection
 
 
 class Lifespan:

@@ -35,12 +35,9 @@
     "REQUEST_MAX_SIZE": 100000000,  # 100 megabytes
     "REQUEST_TIMEOUT": 60,  # 60 seconds
     "RESPONSE_TIMEOUT": 60,  # 60 seconds
-    "WEBSOCKET_MAX_QUEUE": 32,
     "WEBSOCKET_MAX_SIZE": 2 ** 20,  # 1 megabyte
     "WEBSOCKET_PING_INTERVAL": 20,
     "WEBSOCKET_PING_TIMEOUT": 20,
-    "WEBSOCKET_READ_LIMIT": 2 ** 16,
-    "WEBSOCKET_WRITE_LIMIT": 2 ** 16,
 }
 
 
@@ -62,12 +59,9 @@ class Config(dict):
     REQUEST_MAX_SIZE: int
     REQUEST_TIMEOUT: int
     RESPONSE_TIMEOUT: int
-    WEBSOCKET_MAX_QUEUE: int
     WEBSOCKET_MAX_SIZE: int
     WEBSOCKET_PING_INTERVAL: int
     WEBSOCKET_PING_TIMEOUT: int
-    WEBSOCKET_READ_LIMIT: int
-    WEBSOCKET_WRITE_LIMIT: int
 
     def __init__(
         self,

@@ -121,8 +121,11 @@ def decorator(handler):
                         "Expected either string or Iterable of host strings, "
                         "not %s" % host
                     )
-
-            if isinstance(subprotocols, (list, tuple, set)):
+            if isinstance(subprotocols, list):
+                # Ordered subprotocols, maintain order
+                subprotocols = tuple(subprotocols)
+            elif isinstance(subprotocols, set):
+                # subprotocol is unordered, keep it unordered
                 subprotocols = frozenset(subprotocols)
 
             route = FutureRoute(

@@ -3,7 +3,7 @@
 from typing import Any, Awaitable, Callable, MutableMapping, Optional, Union
 
 from sanic.exceptions import InvalidUsage
-from sanic.websocket import WebSocketConnection
+from sanic.server.websockets.connection import WebSocketConnection
 
 
 ASGIScope = MutableMapping[str, Any]