Running ReactPy in a backhaul thread (#163)

- The entirety of the ReactPy rendering stack is encapsulated within a single backhaul thread.
- Backhaul thread can be disabled via settings.py:REACTPY_BACKHAUL_THREAD
- Implementation is "thread-safe" since all ReactPy code runs on the exact same thread.

Author: Archmonger

.github/workflows/test-docs.yml

@@ -33,5 +33,4 @@ jobs:
                   pip install -r requirements/check-style.txt
                   mypy --show-error-codes docs/python/
                   black docs/python/ --check
-                  isort docs/python/ --check-only
-                  flake8 docs/python/
+                  ruff check docs/python/

.github/workflows/test-src.yml

@@ -1,35 +1,35 @@
 name: Test
 
 on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-  schedule:
-    - cron: "0 0 * * *"
+    push:
+        branches:
+            - main
+    pull_request:
+        branches:
+            - main
+    schedule:
+        - cron: "0 0 * * *"
 
 jobs:
-  source:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.8", "3.9", "3.10"]
-    steps:
-      - uses: actions/checkout@v3
-      - uses: nanasess/setup-chromedriver@master
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "14"
-      - name: Use Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install Python Dependencies
-        run: pip install -r requirements/test-run.txt
-      - name: Run Tests
-        run: |
-          npm install -g npm@latest
-          npm --version
-          nox -s test
+    source:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: ["3.9", "3.10", "3.11"]
+        steps:
+            - uses: actions/checkout@v3
+            - uses: nanasess/setup-chromedriver@master
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: "14"
+            - name: Use Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v4
+              with:
+                  python-version: ${{ matrix.python-version }}
+            - name: Install Python Dependencies
+              run: pip install -r requirements/test-run.txt
+            - name: Run Tests
+              run: |
+                  npm install -g npm@latest
+                  npm --version
+                  nox -s test

CHANGELOG.md

@@ -34,7 +34,14 @@ Using the following categories, list your changes in this order:
 
 ## [Unreleased]
 
--   Nothing yet!
+### Added
+
+-   `REACTPY_BACKHAUL_THREAD` setting to enable/disable threading behavior.
+
+### Changed
+
+-   By default, ReactPy will now use a backhaul thread to increase performance.
+-   Minimum Python version required is now `3.9`
 
 ## [3.2.1] - 2023-06-29
 

docs/python/settings.py

@@ -20,3 +20,7 @@
 #   2. You are using Django's `AUTHENTICATION_BACKENDS` setting and...
 #   3. Your Django user model does not define a `backend` attribute
 REACTPY_AUTH_BACKEND = None
+
+# Whether to enable rendering ReactPy via a dedicated backhaul thread
+# This allows the webserver to process traffic while during ReactPy rendering
+REACTPY_BACKHAUL_THREAD = True

docs/src/contribute/code.md

@@ -12,7 +12,7 @@
 
 If you plan to make code changes to this repository, you will need to install the following dependencies first:
 
--   [Python 3.8+](https://www.python.org/downloads/)
+-   [Python 3.9+](https://www.python.org/downloads/)
 -   [Git](https://git-scm.com/downloads)
 -   [NPM](https://docs.npmjs.com/try-the-latest-stable-version-of-npm) for installing and managing Javascript
 

docs/src/contribute/docs.md

@@ -8,7 +8,7 @@
 
 If you plan to make changes to this documentation, you will need to install the following dependencies first:
 
--   [Python 3.8+](https://www.python.org/downloads/)
+-   [Python 3.9+](https://www.python.org/downloads/)
 -   [Git](https://git-scm.com/downloads)
 
 Once done, you should clone this repository:

docs/src/contribute/running-tests.md

@@ -10,7 +10,7 @@ This repository uses [Nox](https://nox.thea.codes/en/stable/) to run tests. For
 
 If you plan to run tests, you will need to install the following dependencies first:
 
--   [Python 3.8+](https://www.python.org/downloads/)
+-   [Python 3.9+](https://www.python.org/downloads/)
 -   [Git](https://git-scm.com/downloads)
 
 Once done, you should clone this repository:

docs/src/dictionary.txt

@@ -35,3 +35,4 @@ backends
 backend
 frontend
 frontends
+backhaul

noxfile.py

@@ -6,7 +6,6 @@
 import nox
 from nox.sessions import Session
 
-
 HERE = Path(__file__).parent
 POSARGS_PATTERN = re.compile(r"^(\w+)\[(.+)\]$")
 
@@ -21,14 +20,6 @@ def manage(session: Session) -> None:
     session.run("python", "manage.py", *session.posargs)
 
 
-@nox.session(reuse_venv=True)
-def format(session: Session) -> None:
-    """Run automatic code formatters"""
-    install_requirements_file(session, "check-style")
-    session.run("black", ".")
-    session.run("isort", ".")
-
-
 @nox.session
 def test(session: Session) -> None:
     """Run the complete test suite"""
@@ -70,15 +61,14 @@ def test_types(session: Session) -> None:
 def test_style(session: Session) -> None:
     """Check that style guidelines are being followed"""
     install_requirements_file(session, "check-style")
-    session.run("flake8", "src/reactpy_django", "tests")
     session.run(
         "black",
         ".",
         "--check",
         "--extend-exclude",
         "/migrations/",
     )
-    session.run("isort", ".", "--check-only")
+    session.run("ruff", "check", ".")
 
 
 def install_requirements_file(session: Session, name: str) -> None:

pyproject.toml

@@ -2,16 +2,6 @@
 requires = ["setuptools>=42", "wheel"]
 build-backend = "setuptools.build_meta"
 
-[tool.isort]
-multi_line_output = 3
-force_grid_wrap = 0
-use_parentheses = "True"
-ensure_newline_before_comments = "True"
-include_trailing_comma = "True"
-line_length = 88
-lines_after_imports = 2
-extend_skip_glob = ["*/migrations/*", '.nox/*', '.venv/*', 'build/*']
-
 [tool.mypy]
 exclude = [
     'migrations/.*',
@@ -22,3 +12,11 @@ warn_redundant_casts = true
 warn_unused_ignores = true
 check_untyped_defs = true
 incremental = false
+
+[tool.ruff.isort]
+known-first-party = ["src", "tests"]
+
+[tool.ruff]
+ignore = ["E501"]
+extend-exclude = ["*/migrations/*", ".venv/*", ".eggs/*", ".nox/*", "build/*"]
+line-length = 120

requirements/check-style.txt

@@ -1,3 +1,2 @@
 black
-flake8
-isort
+ruff

requirements/test-env.txt

@@ -2,3 +2,4 @@ playwright
 twisted
 channels[daphne]>=4.0.0
 tblib
+whitenoise

setup.cfg

@@ -1,11 +1,2 @@
 [bdist_wheel]
 universal=1
-
-[flake8]
-ignore = E203, E266, E501, W503, F811, N802
-max-line-length = 88
-max-complexity = 18
-select = B,C,E,F,W,T4,B9,N,ROH
-exclude =
-    .eggs/*
-    .nox/*

setup.py

@@ -13,7 +13,6 @@
 from setuptools.command.develop import develop
 from setuptools.command.sdist import sdist
 
-
 if sys.platform == "win32":
     from subprocess import list2cmdline
 else:
@@ -22,7 +21,7 @@ def list2cmdline(cmd_list):
         return " ".join(map(pipes.quote, cmd_list))
 
 
-log = getLogger()
+log = getLogger()  # noqa: F811
 log.addHandler(StreamHandler(sys.stdout))
 
 
@@ -47,7 +46,7 @@ def list2cmdline(cmd_list):
 
 package = {
     "name": name,
-    "python_requires": ">=3.8",
+    "python_requires": ">=3.9",
     "packages": find_packages(str(src_dir)),
     "package_dir": {"": "src"},
     "description": "Control the web with Python",
@@ -66,9 +65,9 @@ def list2cmdline(cmd_list):
         "Intended Audience :: Developers",
         "Intended Audience :: Science/Research",
         "Topic :: Multimedia :: Graphics",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Environment :: Web Environment",
     ],
 }

src/reactpy_django/config.py

@@ -1,5 +1,8 @@
 from __future__ import annotations
 
+import logging
+import sys
+
 from django.conf import settings
 from django.core.cache import DEFAULT_CACHE_ALIAS
 from django.db import DEFAULT_DB_ALIAS
@@ -14,6 +17,9 @@
 from reactpy_django.utils import import_dotted_path
 
 
+_logger = logging.getLogger(__name__)
+
+
 # Not user configurable settings
 REACTPY_DEBUG_MODE.set_current(getattr(settings, "DEBUG"))
 REACTPY_REGISTERED_COMPONENTS: dict[str, ComponentConstructor] = {}
@@ -55,3 +61,21 @@
     "REACTPY_AUTH_BACKEND",
     None,
 )
+REACTPY_BACKHAUL_THREAD: bool = getattr(
+    settings,
+    "REACTPY_BACKHAUL_THREAD",
+    True,
+)
+
+# Settings checks (separate from Django checks)
+if (
+    sys.platform == "linux"
+    and sys.argv
+    and sys.argv[0].endswith("daphne")
+    and REACTPY_BACKHAUL_THREAD
+):
+    _logger.warning(
+        "ReactPy is running on Linux with Daphne, but REACTPY_BACKHAUL_THREAD is set "
+        "to True. This configuration is known to be unstable. Either set "
+        "REACTPY_BACKHAUL_THREAD to False, or run ReactPy with a different ASGI server."
+    )