allow for optional re-rendering on login/logout methods

Author: Archmonger

src/reactpy_django/auth/components.py

@@ -19,25 +19,40 @@
 
 
 @component
-def session_manager(child: Any):
+def root_manager(child: Any):
+    scope = hooks.use_connection().scope
+    _, set_rerender = hooks.use_state(uuid4)
+
+    @hooks.use_effect(dependencies=[])
+    def setup_asgi_scope():
+        """Store trigger functions in the websocket scope so that ReactPy-Django's hooks can command
+        any relevant actions."""
+        scope["reactpy"]["rerender"] = rerender
+
+    async def rerender():
+        """Event that can force a rerender of the entire component tree."""
+        set_rerender(uuid4())
+
+    return child
+
+
+@component
+def session_manager():
     """This component can force the client (browser) to switch HTTP sessions,
     making it match the websocket session.
 
     Used to force persistent authentication between Django's websocket and HTTP stack."""
     from reactpy_django import config
 
     synchronize_requested, set_synchronize_requested = hooks.use_state(False)
-    _, set_rerender = hooks.use_state(uuid4)
     uuid = hooks.use_ref("")
     scope = hooks.use_connection().scope
 
     @hooks.use_effect(dependencies=[])
     def setup_asgi_scope():
         """Store trigger functions in the websocket scope so that ReactPy-Django's hooks can command
         any relevant actions."""
-        scope.setdefault("reactpy", {})
         scope["reactpy"]["synchronize_session"] = synchronize_session
-        scope["reactpy"]["rerender"] = rerender
 
     @hooks.use_effect(dependencies=[synchronize_requested])
     async def synchronize_session_watchdog():
@@ -86,15 +101,10 @@ async def synchronize_session_callback(status_code: int, response: str):
                 f"Client returned unexpected HTTP status code ({status_code}) while trying to sychronize sessions.",
             )
 
-    async def rerender():
-        """Event that can force a rerender of the entire component tree."""
-        set_rerender(uuid4())
-
     # If needed, synchronize sessions by configuring all relevant session cookies.
     # This is achieved by commanding the client to perform a HTTP request to our session manager endpoint.
-    http_request = None
     if synchronize_requested:
-        http_request = HttpRequest(
+        return HttpRequest(
             {
                 "method": "GET",
                 "url": reverse("reactpy:session_manager", args=[uuid.current]),
@@ -103,4 +113,4 @@ async def rerender():
             },
         )
 
-    return html._(child, http_request)
+    return None

src/reactpy_django/hooks.py

@@ -423,14 +423,27 @@ def use_auth():
 
     scope = use_scope()
 
-    async def login(user: AbstractUser):
+    async def login(user: AbstractUser, rerender: bool = True):
+        """Login a user.
+
+        Args:
+            user: The user to login.
+            rerender: If True, the root component will be re-rendered after the user is logged in."""
         await channels_auth.login(scope, user, backend=config.REACTPY_AUTH_BACKEND)
         session_save_method = getattr(scope["session"], "asave", scope["session"].save)
         await ensure_async(session_save_method)()
         await scope["reactpy"]["synchronize_session"]()
 
+        if rerender:
+            await scope["reactpy"]["rerender"]()
+
     async def logout(rerender: bool = True):
+        """Logout the current user.
+
+        Args:
+            rerender: If True, the root component will be re-rendered after the user is logged out."""
         await channels_auth.logout(scope)
+
         if rerender:
             await scope["reactpy"]["rerender"]()
 

src/reactpy_django/websocket/consumer.py

@@ -142,8 +142,9 @@ async def encode_json(cls, content):
 
     async def run_dispatcher(self):
         """Runs the main loop that performs component rendering tasks."""
+        # TODO: Figure out why exceptions raised in this method are not being printed to the console.
         from reactpy_django import models
-        from reactpy_django.auth.components import session_manager
+        from reactpy_django.auth.components import root_manager, session_manager
         from reactpy_django.config import (
             REACTPY_REGISTERED_COMPONENTS,
             REACTPY_SESSION_MAX_AGE,
@@ -212,7 +213,11 @@ async def run_dispatcher(self):
         with contextlib.suppress(Exception):
             await serve_layout(
                 Layout(  # type: ignore
-                    ConnectionContext(session_manager(root_component), value=connection)
+                    ConnectionContext(
+                        session_manager(),
+                        root_manager(root_component),
+                        value=connection,
+                    )
                 ),
                 self.send_json,
                 self.recv_queue.get,