Bump ReactPy, refactor template tag, and pretty WS URLs. (#174)

-   Bumped the minimum ReactPy version to `1.0.2`.
-   Prettier websocket URLs for components that do not have sessions.
-   Template tag will now only validate `args`/`kwargs` if `settings.py:DEBUG` is enabled.

Author: Archmonger

CHANGELOG.md

@@ -34,7 +34,11 @@ Using the following categories, list your changes in this order:
 
 ## [Unreleased]
 
--   Nothing (yet)!
+### Changed
+
+-   Bumped the minimum ReactPy version to `1.0.2`.
+-   Prettier websocket URLs for components that do not have sessions.
+-   Template tag will now only validate `args`/`kwargs` if `settings.py:DEBUG` is enabled.
 
 ## [3.4.0] - 2023-08-18
 

requirements/pkg-deps.txt

@@ -1,6 +1,6 @@
 channels >=4.0.0
 django >=4.1.0
-reactpy >=1.0.0, <1.1.0
+reactpy >=1.0.2, <1.1.0
 aiofile >=3.0
 dill >=0.3.5
 orjson >=3.6.0

src/reactpy_django/templatetags/reactpy.py

@@ -7,6 +7,7 @@
 from django import template
 from django.http import HttpRequest
 from django.urls import NoReverseMatch, reverse
+from reactpy.core.types import ComponentConstructor
 
 from reactpy_django import config, models
 from reactpy_django.exceptions import (
@@ -15,7 +16,7 @@
     InvalidHostError,
 )
 from reactpy_django.types import ComponentParamData
-from reactpy_django.utils import check_component_args, func_has_args
+from reactpy_django.utils import validate_component_args
 
 try:
     RESOLVED_WEB_MODULES_PATH = reverse("reactpy:web_modules", args=["/"]).strip("/")
@@ -55,60 +56,52 @@ def component(
         </body>
         </html>
     """
-
-    # Determine the host
     request: HttpRequest | None = context.get("request")
     perceived_host = (request.get_host() if request else "").strip("/")
     host = (
         host
         or (next(config.REACTPY_DEFAULT_HOSTS) if config.REACTPY_DEFAULT_HOSTS else "")
     ).strip("/")
-
-    # Check if this this component needs to rendered by the current ASGI app
-    use_current_app = not host or host.startswith(perceived_host)
-
-    # Create context variables
+    is_local = not host or host.startswith(perceived_host)
     uuid = uuid4().hex
     class_ = kwargs.pop("class", "")
-    kwargs.pop("key", "")  # `key` is effectively useless for the root node
-
-    # Fail if user has a method in their host
-    if host.find("://") != -1:
-        protocol = host.split("://")[0]
-        msg = (
-            f"Invalid host provided to component. Contains a protocol '{protocol}://'."
-        )
-        _logger.error(msg)
-        return failure_context(dotted_path, InvalidHostError(msg))
-
-    # Fetch the component if needed
-    if use_current_app:
+    kwargs.pop("key", "")  # `key` is useless for the root node
+    component_has_args = args or kwargs
+    user_component: ComponentConstructor | None = None
+
+    # Validate the host
+    if host and config.REACTPY_DEBUG_MODE:
+        try:
+            validate_host(host)
+        except InvalidHostError as e:
+            return failure_context(dotted_path, e)
+
+    # Fetch the component
+    if is_local:
         user_component = config.REACTPY_REGISTERED_COMPONENTS.get(dotted_path)
         if not user_component:
             msg = f"Component '{dotted_path}' is not registered as a root component. "
             _logger.error(msg)
             return failure_context(dotted_path, ComponentDoesNotExistError(msg))
 
-    # Store the component's args/kwargs in the database, if needed
-    # These will be fetched by the websocket consumer later
-    try:
-        if use_current_app:
-            check_component_args(user_component, *args, **kwargs)
-            if func_has_args(user_component):
-                save_component_params(args, kwargs, uuid)
-        # Can't guarantee args will match up if the component is rendered by a different app.
-        # So, we just store any provided args/kwargs in the database.
-        elif args or kwargs:
-            save_component_params(args, kwargs, uuid)
-    except Exception as e:
-        if isinstance(e, ComponentParamError):
+    # Validate the component
+    if is_local and config.REACTPY_DEBUG_MODE:
+        try:
+            validate_component_args(user_component, *args, **kwargs)
+        except ComponentParamError as e:
             _logger.error(str(e))
-        else:
+            return failure_context(dotted_path, e)
+
+    # Store args & kwargs in the database (fetched by our websocket later)
+    if component_has_args:
+        try:
+            save_component_params(args, kwargs, uuid)
+        except Exception as e:
             _logger.exception(
                 "An unknown error has occurred while saving component params for '%s'.",
                 dotted_path,
             )
-        return failure_context(dotted_path, e)
+            return failure_context(dotted_path, e)
 
     # Return the template rendering context
     return {
@@ -117,7 +110,9 @@ def component(
         "reactpy_host": host or perceived_host,
         "reactpy_url_prefix": config.REACTPY_URL_PREFIX,
         "reactpy_reconnect_max": config.REACTPY_RECONNECT_MAX,
-        "reactpy_component_path": f"{dotted_path}/{uuid}/",
+        "reactpy_component_path": f"{dotted_path}/{uuid}/"
+        if component_has_args
+        else f"{dotted_path}/",
         "reactpy_resolved_web_modules_path": RESOLVED_WEB_MODULES_PATH,
     }
 
@@ -136,3 +131,13 @@ def save_component_params(args, kwargs, uuid):
     model = models.ComponentSession(uuid=uuid, params=pickle.dumps(params))
     model.full_clean()
     model.save()
+
+
+def validate_host(host: str):
+    if "://" in host:
+        protocol = host.split("://")[0]
+        msg = (
+            f"Invalid host provided to component. Contains a protocol '{protocol}://'."
+        )
+        _logger.error(msg)
+        raise InvalidHostError(msg)

src/reactpy_django/utils.py

@@ -297,12 +297,7 @@ def django_query_postprocessor(
     return data
 
 
-def func_has_args(func) -> bool:
-    """Checks if a function has any args or kwargs."""
-    return bool(inspect.signature(func).parameters)
-
-
-def check_component_args(func, *args, **kwargs):
+def validate_component_args(func, *args, **kwargs):
     """
     Validate whether a set of args/kwargs would work on the given function.
 

src/reactpy_django/websocket/consumer.py

@@ -22,7 +22,7 @@
 from reactpy.core.serve import serve_layout
 
 from reactpy_django.types import ComponentParamData, ComponentWebsocket
-from reactpy_django.utils import db_cleanup, func_has_args
+from reactpy_django.utils import db_cleanup
 
 _logger = logging.getLogger(__name__)
 backhaul_loop = asyncio.new_event_loop()
@@ -124,7 +124,7 @@ async def run_dispatcher(self):
 
         scope = self.scope
         dotted_path = scope["url_route"]["kwargs"]["dotted_path"]
-        uuid = scope["url_route"]["kwargs"]["uuid"]
+        uuid = scope["url_route"]["kwargs"].get("uuid")
         search = scope["query_string"].decode()
         self.recv_queue: asyncio.Queue = asyncio.Queue()
         connection = Connection(  # For `use_connection`
@@ -151,7 +151,7 @@ async def run_dispatcher(self):
 
         # Fetch the component's args/kwargs from the database, if needed
         try:
-            if func_has_args(component_constructor):
+            if uuid:
                 # Always clean up expired entries first
                 await database_sync_to_async(db_cleanup, thread_sensitive=False)()
 

src/reactpy_django/websocket/paths.py

@@ -1,12 +1,18 @@
+from channels.routing import URLRouter  # noqa: E402
 from django.urls import path
 
 from reactpy_django.config import REACTPY_URL_PREFIX
 
 from .consumer import ReactpyAsyncWebsocketConsumer
 
 REACTPY_WEBSOCKET_ROUTE = path(
-    f"{REACTPY_URL_PREFIX}/<dotted_path>/<uuid>/",
-    ReactpyAsyncWebsocketConsumer.as_asgi(),
+    f"{REACTPY_URL_PREFIX}/<dotted_path>/",
+    URLRouter(
+        [
+            path("<uuid>/", ReactpyAsyncWebsocketConsumer.as_asgi()),
+            path("", ReactpyAsyncWebsocketConsumer.as_asgi()),
+        ]
+    ),
 )
 """A URL path for :class:`ReactpyAsyncWebsocketConsumer`.