v3.3.1 (#169)

Archmonger · web-flow · commit 36da02e2749f · 2023-08-08T17:49:55.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,6 +36,16 @@ Using the following categories, list your changes in this order:
 
 -   Nothing (yet)!
 
+## [3.3.1] - 2023-08-08
+
+### Added
+
+-   Additional system checks for ReactPy misconfigurations.
+
+### Changed
+
+-   `REACTPY_BACKHAUL_THREAD` now defaults to `False`.
+
 ## [3.3.0] - 2023-08-05
 
 ### Added
@@ -313,7 +323,8 @@ Using the following categories, list your changes in this order:
 
 -   Support for IDOM within the Django
 
-[unreleased]: https://github.com/reactive-python/reactpy-django/compare/3.3.0...HEAD
+[unreleased]: https://github.com/reactive-python/reactpy-django/compare/3.3.1...HEAD
+[3.3.1]: https://github.com/reactive-python/reactpy-django/compare/3.3.0...3.3.1
 [3.3.0]: https://github.com/reactive-python/reactpy-django/compare/3.2.1...3.3.0
 [3.2.1]: https://github.com/reactive-python/reactpy-django/compare/3.2.0...3.2.1
 [3.2.0]: https://github.com/reactive-python/reactpy-django/compare/3.1.0...3.2.0
diff --git a/docs/python/auth-required-attribute.py b/docs/python/auth-required-attribute.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.decorators import auth_required
 
 
diff --git a/docs/python/auth-required-component-fallback.py b/docs/python/auth-required-component-fallback.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.decorators import auth_required
 
 
diff --git a/docs/python/auth-required-custom-attribute.py b/docs/python/auth-required-custom-attribute.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.decorators import auth_required
 
 
diff --git a/docs/python/auth-required-vdom-fallback.py b/docs/python/auth-required-vdom-fallback.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.decorators import auth_required
 
 
diff --git a/docs/python/auth-required.py b/docs/python/auth-required.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.decorators import auth_required
 
 
diff --git a/docs/python/configure-asgi-middleware.py b/docs/python/configure-asgi-middleware.py
@@ -1,17 +1,14 @@
 # Broken load order, only used for linting
 from channels.routing import ProtocolTypeRouter, URLRouter
-
 from reactpy_django import REACTPY_WEBSOCKET_PATH
 
-
 django_asgi_app = ""
 
 
 # start
 from channels.auth import AuthMiddlewareStack  # noqa: E402
 from channels.sessions import SessionMiddlewareStack  # noqa: E402
 
-
 application = ProtocolTypeRouter(
     {
         "http": django_asgi_app,
diff --git a/docs/python/configure-asgi.py b/docs/python/configure-asgi.py
@@ -2,7 +2,6 @@
 
 from django.core.asgi import get_asgi_application
 
-
 # Ensure DJANGO_SETTINGS_MODULE is set properly based on your project name!
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example_project.settings")
 
@@ -11,10 +10,8 @@
 
 
 from channels.routing import ProtocolTypeRouter, URLRouter  # noqa: E402
-
 from reactpy_django import REACTPY_WEBSOCKET_PATH  # noqa: E402
 
-
 application = ProtocolTypeRouter(
     {
         "http": django_asgi_app,
diff --git a/docs/python/configure-urls.py b/docs/python/configure-urls.py
@@ -1,6 +1,5 @@
 from django.urls import include, path
 
-
 urlpatterns = [
     ...,
     path("reactpy/", include("reactpy_django.http.urls")),
diff --git a/docs/python/django-css.py b/docs/python/django-css.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.components import django_css
 
 
diff --git a/docs/python/django-js.py b/docs/python/django-js.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.components import django_js
 
 
diff --git a/docs/python/django-query-postprocessor.py b/docs/python/django-query-postprocessor.py
@@ -1,6 +1,5 @@
 from example.models import TodoItem
 from reactpy import component
-
 from reactpy_django.hooks import use_query
 from reactpy_django.types import QueryOptions
 from reactpy_django.utils import django_query_postprocessor
diff --git a/docs/python/example/urls.py b/docs/python/example/urls.py
@@ -1,7 +1,6 @@
 from django.urls import path
 from example import views
 
-
 urlpatterns = [
     path("example/", views.index),
 ]
diff --git a/docs/python/settings.py b/docs/python/settings.py
@@ -29,4 +29,4 @@
 
 # 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
+REACTPY_BACKHAUL_THREAD = False
diff --git a/docs/python/use-connection.py b/docs/python/use-connection.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.hooks import use_connection
 
 
diff --git a/docs/python/use-location.py b/docs/python/use-location.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.hooks import use_location
 
 
diff --git a/docs/python/use-mutation-args-kwargs.py b/docs/python/use-mutation-args-kwargs.py
@@ -1,5 +1,4 @@
 from reactpy import component
-
 from reactpy_django.hooks import use_mutation
 
 
diff --git a/docs/python/use-mutation-query-refetch.py b/docs/python/use-mutation-query-refetch.py
@@ -1,6 +1,5 @@
 from example.models import TodoItem
 from reactpy import component, html
-
 from reactpy_django.hooks import use_mutation, use_query
 
 
diff --git a/docs/python/use-mutation-reset.py b/docs/python/use-mutation-reset.py
@@ -1,6 +1,5 @@
 from example.models import TodoItem
 from reactpy import component, html
-
 from reactpy_django.hooks import use_mutation
 
 
diff --git a/docs/python/use-mutation.py b/docs/python/use-mutation.py
@@ -1,6 +1,5 @@
 from example.models import TodoItem
 from reactpy import component, html
-
 from reactpy_django.hooks import use_mutation
 
 
@@ -10,11 +9,12 @@ def add_item(text: str):
 
 @component
 def todo_list():
+    item_mutation = use_mutation(add_item)
+
     def submit_event(event):
         if event["key"] == "Enter":
             item_mutation.execute(text=event["target"]["value"])
 
-    item_mutation = use_mutation(add_item)
     if item_mutation.loading:
         mutation_status = html.h2("Adding...")
     elif item_mutation.error:
diff --git a/docs/python/use-origin.py b/docs/python/use-origin.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.hooks import use_origin
 
 
diff --git a/docs/python/use-query-args.py b/docs/python/use-query-args.py
@@ -1,5 +1,4 @@
 from reactpy import component
-
 from reactpy_django.hooks import use_query
 
 
diff --git a/docs/python/use-query-async.py b/docs/python/use-query-async.py
@@ -1,7 +1,6 @@
 from channels.db import database_sync_to_async
 from example.models import TodoItem
 from reactpy import component, html
-
 from reactpy_django.hooks import use_query
 
 
diff --git a/docs/python/use-query-postprocessor-change.py b/docs/python/use-query-postprocessor-change.py
@@ -1,5 +1,4 @@
 from reactpy import component
-
 from reactpy_django.hooks import use_query
 from reactpy_django.types import QueryOptions
 
diff --git a/docs/python/use-query-postprocessor-disable.py b/docs/python/use-query-postprocessor-disable.py
@@ -1,5 +1,4 @@
 from reactpy import component
-
 from reactpy_django.hooks import use_query
 from reactpy_django.types import QueryOptions
 
diff --git a/docs/python/use-query-postprocessor-kwargs.py b/docs/python/use-query-postprocessor-kwargs.py
@@ -1,6 +1,5 @@
 from example.models import TodoItem
 from reactpy import component
-
 from reactpy_django.hooks import use_query
 from reactpy_django.types import QueryOptions
 
diff --git a/docs/python/use-query-thread-sensitive.py b/docs/python/use-query-thread-sensitive.py
@@ -1,5 +1,4 @@
 from reactpy import component
-
 from reactpy_django.hooks import use_query
 from reactpy_django.types import QueryOptions
 
diff --git a/docs/python/use-query.py b/docs/python/use-query.py
@@ -1,6 +1,5 @@
 from example.models import TodoItem
 from reactpy import component, html
-
 from reactpy_django.hooks import use_query
 
 
diff --git a/docs/python/use-scope.py b/docs/python/use-scope.py
@@ -1,5 +1,4 @@
 from reactpy import component, html
-
 from reactpy_django.hooks import use_scope
 
 
diff --git a/docs/python/vtc-args-kwargs.py b/docs/python/vtc-args-kwargs.py
@@ -1,6 +1,5 @@
 from django.http import HttpResponse
 from reactpy import component, html
-
 from reactpy_django.components import view_to_component
 
 
diff --git a/docs/python/vtc-cbv-compatibility.py b/docs/python/vtc-cbv-compatibility.py
@@ -1,7 +1,6 @@
 from django.contrib.auth.decorators import user_passes_test
 from django.utils.decorators import method_decorator
 from django.views.generic import TemplateView
-
 from reactpy_django.components import view_to_component
 
 
diff --git a/docs/python/vtc-cbv.py b/docs/python/vtc-cbv.py
@@ -1,7 +1,6 @@
 from django.http import HttpResponse
 from django.views import View
 from reactpy import component, html
-
 from reactpy_django.components import view_to_component
 
 
diff --git a/docs/python/vtc-compatibility.py b/docs/python/vtc-compatibility.py
@@ -1,6 +1,5 @@
 from django.http import HttpResponse
 from reactpy import component, html
-
 from reactpy_django.components import view_to_component
 
 
diff --git a/docs/python/vtc-fbv-compat.py b/docs/python/vtc-fbv-compat.py
@@ -1,5 +1,4 @@
 from django.contrib.auth.decorators import user_passes_test
-
 from reactpy_django.components import view_to_component
 
 
diff --git a/docs/python/vtc-func.py b/docs/python/vtc-func.py
@@ -1,9 +1,7 @@
 from example.views import example_view
 from reactpy import component, html
-
 from reactpy_django.components import view_to_component
 
-
 example_vtc = view_to_component(example_view)
 
 
diff --git a/docs/python/vtc-request.py b/docs/python/vtc-request.py
@@ -1,9 +1,7 @@
 from django.http import HttpRequest, HttpResponse
 from reactpy import component, html
-
 from reactpy_django.components import view_to_component
 
-
 example_request = HttpRequest()
 example_request.method = "PUT"
 
diff --git a/docs/python/vtc-strict-parsing.py b/docs/python/vtc-strict-parsing.py
@@ -1,6 +1,5 @@
 from django.http import HttpResponse
 from reactpy import component, html
-
 from reactpy_django.components import view_to_component
 
 
diff --git a/docs/python/vtc-transforms.py b/docs/python/vtc-transforms.py
@@ -1,6 +1,5 @@
 from django.http import HttpResponse
 from reactpy import component, html
-
 from reactpy_django.components import view_to_component
 
 
diff --git a/docs/python/vtc.py b/docs/python/vtc.py
@@ -1,6 +1,5 @@
 from django.http import HttpResponse
 from reactpy import component, html
-
 from reactpy_django.components import view_to_component
 
 
diff --git a/src/reactpy_django/__init__.py b/src/reactpy_django/__init__.py
@@ -1,7 +1,7 @@
 from reactpy_django import checks, components, decorators, hooks, types, utils
 from reactpy_django.websocket.paths import REACTPY_WEBSOCKET_PATH
 
-__version__ = "3.3.0"
+__version__ = "3.3.1"
 __all__ = [
     "REACTPY_WEBSOCKET_PATH",
     "hooks",
diff --git a/src/reactpy_django/checks.py b/src/reactpy_django/checks.py
@@ -2,6 +2,7 @@
 
 from django.contrib.staticfiles.finders import find
 from django.core.checks import Error, Tags, Warning, register
+from django.template import loader
 
 
 @register(Tags.compatibility)
@@ -48,7 +49,7 @@ def reactpy_warnings(app_configs, **kwargs):
     if (
         sys.argv
         and sys.argv[0].endswith("daphne")
-        and getattr(settings, "REACTPY_BACKHAUL_THREAD", True)
+        and getattr(settings, "REACTPY_BACKHAUL_THREAD", False)
         and sys.platform == "linux"
     ):
         warnings.append(
@@ -76,11 +77,47 @@ def reactpy_warnings(app_configs, **kwargs):
             Warning(
                 "ReactPy failed to register the following components:\n\t+ "
                 + "\n\t+ ".join(REACTPY_FAILED_COMPONENTS),
-                hint="Check if these paths are valid, or if an exception is being raised during import.",
+                hint="Check if these paths are valid, or if an exception is being "
+                "raised during import.",
                 id="reactpy_django.W005",
             )
         )
 
+    # Check if the reactpy/component.html template exists
+    try:
+        loader.get_template("reactpy/component.html")
+    except Exception:
+        warnings.append(
+            Warning(
+                "ReactPy HTML templates could not be found!",
+                hint="Check your settings.py:TEMPLATES configuration and make sure "
+                "ReactPy-Django is installed properly.",
+                id="reactpy_django.W006",
+            )
+        )
+
+    # Check if REACTPY_WEBSOCKET_URL doesn't end with a slash
+    REACTPY_WEBSOCKET_URL = getattr(settings, "REACTPY_WEBSOCKET_URL", "")
+    if isinstance(REACTPY_WEBSOCKET_URL, str):
+        if not REACTPY_WEBSOCKET_URL or not REACTPY_WEBSOCKET_URL.endswith("/"):
+            warnings.append(
+                Warning(
+                    "REACTPY_WEBSOCKET_URL did not end with a forward slash.",
+                    hint="Change your URL to be written in the following format: 'example_url/'",
+                    id="reactpy_django.W007",
+                )
+            )
+
+        # Check if REACTPY_WEBSOCKET_URL doesn't start with an alphanumeric character
+        if not REACTPY_WEBSOCKET_URL or not REACTPY_WEBSOCKET_URL[0].isalnum():
+            warnings.append(
+                Warning(
+                    "REACTPY_WEBSOCKET_URL did not start with an alphanumeric character.",
+                    hint="Change your URL to be written in the following format: 'example_url/'",
+                    id="reactpy_django.W008",
+                )
+            )
+
     return warnings
 
 
diff --git a/src/reactpy_django/config.py b/src/reactpy_django/config.py
diff --git a/src/reactpy_django/hooks.py b/src/reactpy_django/hooks.py
diff --git a/src/reactpy_django/http/urls.py b/src/reactpy_django/http/urls.py
diff --git a/src/reactpy_django/templatetags/reactpy.py b/src/reactpy_django/templatetags/reactpy.py
diff --git a/src/reactpy_django/types.py b/src/reactpy_django/types.py
diff --git a/src/reactpy_django/websocket/paths.py b/src/reactpy_django/websocket/paths.py

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`from reactpy import component, html`
`2`		`-`
`3`	`2`	`from reactpy_django.decorators import auth_required`
`4`	`3`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`from reactpy import component, html`
`2`		`-`
`3`	`2`	`from reactpy_django.components import django_css`
`4`	`3`
`5`	`4`