REACTPY_AUTO_LOGIN setting

Author: Archmonger

CHANGELOG.md

@@ -39,20 +39,29 @@ Using the following categories, list your changes in this order:
 -   ReactPy components can now use SEO compatible rendering!
     -   `settings.py:REACTPY_PRERENDER` can be set to `True` to enable this behavior by default
     -   Or, you can enable it on individual components via the template tag: `{% component "..." prerender="True" %}`
--   `reactpy_django.components.view_to_iframe` component has been added, which uses an `<iframe>` to render a Django view.
--   `reactpy_django.utils.register_iframe` function has been added, which is mandatory to use alongside `reactpy_django.components.view_to_iframe`.
+-   New components!
+    -   `reactpy_django.components.view_to_iframe` uses an `<iframe>` to render a Django view.
+-   New utilies!
+    -   `reactpy_django.utils.register_iframe` notifies ReactPy which views are allowed to be used with `view_to_iframe`.
+-   New decorators!
+    -   `reactpy_django.decorators.user_passes_test` is a similar equivalent to Django's `user_passes_test` decorator, but ours works with ReactPy components.
+-   New hooks!
+    -   `reactpy_django.hooks.use_user` can be used to access the current user.
+    -   `reactpy_django.hooks.use_user_data` provides a simplified interface for storing user key-value data.
+-   New settings!
+    -   `REACTPY_AUTO_LOGIN` automatically logs in **pre-authenticated** users that during the initial component WebSocket connection. This is useful to continuously update `last_login` timestamps.
 
 ### Changed
 
--   Renamed undocumented utility function `reactpy_django.utils.ComponentPreloader` to `reactpy_django.utils.RootComponentFinder`.
+-   Renamed undocumented utility function `ComponentPreloader` to `RootComponentFinder`.
 -   It is now recommended to call `as_view()` when using `view_to_component` or `view_to_iframe` with Class Based Views.
 -   Thread sensitivity has been enabled in all locations where ORM queries are possible.
 
 ### Deprecated
 
--   The `compatibility` argument on `reactpy_django.components.view_to_component` is deprecated. Use `reactpy_django.components.view_to_iframe` instead.
+-   The `compatibility` argument on `reactpy_django.components.view_to_component` is deprecated. Use `view_to_iframe` instead.
 -   Using `reactpy_django.components.view_to_component` as a decorator is deprecated. Check the docs on the new suggested usage.
--   `reactpy_django.decorators.auth_required` is deprecated. An equivalent to this decorator's default is `@reactpy_django.decorators.user_passes_test(lambda user: user.is_active)`.
+-   `reactpy_django.decorators.auth_required` is deprecated. An equivalent to this decorator's default is `@user_passes_test(lambda user: user.is_active)`.
 
 ## [3.5.1] - 2023-09-07
 

src/reactpy_django/config.py

@@ -113,3 +113,8 @@
     "REACTPY_PRERENDER",
     False,
 )
+REACTPY_AUTO_LOGIN: bool = getattr(
+    settings,
+    "REACTPY_AUTO_LOGIN",
+    True,
+)

src/reactpy_django/websocket/consumer.py

@@ -8,10 +8,11 @@
 from concurrent.futures import Future
 from datetime import timedelta
 from threading import Thread
-from typing import Any, MutableMapping, Sequence
+from typing import TYPE_CHECKING, Any, MutableMapping, Sequence
 
 import dill as pickle
 import orjson
+from channels.auth import login
 from channels.db import database_sync_to_async
 from channels.generic.websocket import AsyncJsonWebsocketConsumer
 from django.utils import timezone
@@ -23,6 +24,9 @@
 from reactpy_django.types import ComponentParams
 from reactpy_django.utils import delete_expired_sessions
 
+if TYPE_CHECKING:
+    from django.contrib.auth.models import AbstractUser
+
 _logger = logging.getLogger(__name__)
 backhaul_loop = asyncio.new_event_loop()
 
@@ -42,23 +46,28 @@ class ReactpyAsyncWebsocketConsumer(AsyncJsonWebsocketConsumer):
     async def connect(self) -> None:
         """The browser has connected."""
         from reactpy_django import models
-        from reactpy_django.config import REACTPY_BACKHAUL_THREAD
+        from reactpy_django.config import (
+            REACTPY_AUTH_BACKEND,
+            REACTPY_AUTO_LOGIN,
+            REACTPY_BACKHAUL_THREAD,
+        )
 
         await super().connect()
 
-        # Warn for missing features
-        if self.scope.get("user") is None:
-            await asyncio.to_thread(
-                _logger.debug,
-                "ReactPy websocket is missing Auth Middleware! "
-                "User will not be accessible within hooks!",
-            )
-        if not self.scope.get("session"):
-            await asyncio.to_thread(
-                _logger.debug,
-                "ReactPy websocket is missing Session Middleware! "
-                "Sessions will not be accessible within hooks!",
-            )
+        user: AbstractUser = self.scope.get("user")
+        if REACTPY_AUTO_LOGIN and user and user.is_authenticated:
+            try:
+                await login(self.scope, user, backend=REACTPY_AUTH_BACKEND)
+            except Exception:
+                await asyncio.to_thread(
+                    _logger.exception, "ReactPy websocket authentication has failed!"
+                )
+            try:
+                await database_sync_to_async(self.scope["session"].save)()
+            except Exception:
+                await asyncio.to_thread(
+                    _logger.exception, "ReactPy has failed to save scope['session']!"
+                )
 
         # Start the component dispatcher
         self.dispatcher: Future | asyncio.Task