v3.3.2

Author: Archmonger

CHANGELOG.md

@@ -36,6 +36,12 @@ Using the following categories, list your changes in this order:
 
 -   Nothing (yet)!
 
+## [3.3.2] - 2023-08-09
+
+### Changed
+
+-   Changed implementation of `REACTPY_BACKHAUL_THREAD` to attempt increased performance compatibility.
+
 ## [3.3.1] - 2023-08-08
 
 ### Added

docs/python/settings.py

@@ -27,6 +27,6 @@
 #   3. Your Django user model does not define a `backend` attribute
 REACTPY_AUTH_BACKEND = "django.contrib.auth.backends.ModelBackend"
 
-# Whether to enable rendering ReactPy via a dedicated backhaul thread
-# This allows the webserver to process traffic while during ReactPy rendering
+# Whether to enable rendering ReactPy via a dedicated backhaul thread.
+# This allows the webserver to process traffic while during ReactPy rendering.
 REACTPY_BACKHAUL_THREAD = False

src/reactpy_django/checks.py

@@ -97,7 +97,7 @@ def reactpy_warnings(app_configs, **kwargs):
         )
 
     # Check if REACTPY_WEBSOCKET_URL doesn't end with a slash
-    REACTPY_WEBSOCKET_URL = getattr(settings, "REACTPY_WEBSOCKET_URL", "")
+    REACTPY_WEBSOCKET_URL = getattr(settings, "REACTPY_WEBSOCKET_URL", "reactpy/")
     if isinstance(REACTPY_WEBSOCKET_URL, str):
         if not REACTPY_WEBSOCKET_URL or not REACTPY_WEBSOCKET_URL.endswith("/"):
             warnings.append(

src/reactpy_django/websocket/consumer.py

@@ -5,7 +5,6 @@
 import asyncio
 import contextlib
 import logging
-from concurrent.futures import Future
 from datetime import timedelta
 from threading import Thread
 from typing import Any, MutableMapping, Sequence
@@ -41,12 +40,12 @@ class ReactpyAsyncWebsocketConsumer(AsyncJsonWebsocketConsumer):
 
     async def connect(self) -> None:
         """The browser has connected."""
-        from reactpy_django.config import REACTPY_AUTH_BACKEND, REACTPY_BACKHAUL_THREAD
+        from reactpy_django.config import REACTPY_AUTH_BACKEND
 
         await super().connect()
 
         # Authenticate the user, if possible
-        user: Any = self.scope.get("user")
+        user = self.scope.get("user")
         if user and user.is_authenticated:
             try:
                 await login(self.scope, user, backend=REACTPY_AUTH_BACKEND)
@@ -77,33 +76,36 @@ async def connect(self) -> None:
             )
 
         # Start the component dispatcher
-        self.dispatcher: Future | asyncio.Task
-        self.threaded = REACTPY_BACKHAUL_THREAD
-        if self.threaded:
-            if not backhaul_thread.is_alive():
-                await asyncio.to_thread(
-                    _logger.debug, "Starting ReactPy backhaul thread."
-                )
-                backhaul_thread.start()
-            self.dispatcher = asyncio.run_coroutine_threadsafe(
-                self.run_dispatcher(), backhaul_loop
-            )
-        else:
-            self.dispatcher = asyncio.create_task(self.run_dispatcher())
+        self.recv_queue: asyncio.Queue = asyncio.Queue()
+        self.dispatcher = asyncio.create_task(self.run_dispatcher())
 
     async def disconnect(self, code: int) -> None:
         """The browser has disconnected."""
         self.dispatcher.cancel()
+        await self.dispatcher
         await super().disconnect(code)
 
     async def receive_json(self, content: Any, **_) -> None:
         """Receive a message from the browser. Typically, messages are event signals."""
-        if self.threaded:
-            asyncio.run_coroutine_threadsafe(
-                self.recv_queue.put(content), backhaul_loop
-            )
-        else:
-            await self.recv_queue.put(content)
+        await self.recv_queue.put(content)
+
+    async def dispatch(self, message):
+        """Override the Django Channels dispatch method to allow running the ASGI
+        dispatcher in a thread."""
+        from reactpy_django.config import REACTPY_BACKHAUL_THREAD
+
+        if REACTPY_BACKHAUL_THREAD:
+            if not backhaul_thread.is_alive():
+                await asyncio.to_thread(
+                    _logger.debug, "Starting ReactPy backhaul thread."
+                )
+                backhaul_thread.start()
+
+            return asyncio.run_coroutine_threadsafe(
+                super().dispatch(message), backhaul_loop
+            ).result()
+
+        return await super().dispatch(message)
 
     async def run_dispatcher(self):
         """Runs the main loop that performs component rendering tasks."""
@@ -117,7 +119,6 @@ async def run_dispatcher(self):
         dotted_path = scope["url_route"]["kwargs"]["dotted_path"]
         uuid = scope["url_route"]["kwargs"]["uuid"]
         search = scope["query_string"].decode()
-        self.recv_queue: asyncio.Queue = asyncio.Queue()
         connection = Connection(  # For `use_connection`
             scope=scope,
             location=Location(