REACTPY_AUTO_RELOGIN

Author: Archmonger

CHANGELOG.md

@@ -36,20 +36,17 @@ Using the following categories, list your changes in this order:
 
 ### Added
 
--   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" %}`
--   New components!
+-   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" %}`.
+-   New `view_to_iframe` feature!
     -   `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!
+-   New Django `User` related features!
     -   `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.
+    -   `reactpy_django.decorators.user_passes_test` is inspired by Django's [`user_passes_test`](http://docs.djangoproject.com/en/dev/topics/auth/default/#django.contrib.auth.decorators.user_passes_test) decorator, but works with ReactPy components.
+    -   `settings.py:REACTPY_AUTO_RELOGIN` will cause component WebSocket connections to automatically perform a re-login on authenticated users. This is useful to continuously update `last_login` timestamps and refresh the [Django login session](https://docs.djangoproject.com/en/dev/topics/http/sessions/).
 
 ### Changed
 

docs/src/reference/settings.md

@@ -62,6 +62,18 @@ Dotted path to the Django authentication backend to use for ReactPy components.
 
 ---
 
+### `#!python REACTPY_AUTO_RELOGIN`
+
+**Default:** `#!python False`
+
+**Example Value(s):** `#!python True`
+
+Enabling this will cause component WebSocket connections to automatically perform a [re-login](https://channels.readthedocs.io/en/latest/topics/authentication.html#how-to-log-a-user-in-out) on users that are already authenticated.
+
+This is useful to continuously update `#!python last_login` timestamps and refresh the [Django login session](https://docs.djangoproject.com/en/dev/topics/http/sessions/).
+
+---
+
 ## Performance Settings
 
 ---
@@ -128,7 +140,7 @@ You can use the `#!python host` argument in your [template tag](../reference/tem
 
 **Example Value(s):** `#!python True`
 
-Configures whether to pre-render your components, which enables SEO compatibility and reduces perceived latency.
+Configures whether to HTTP pre-render your components, which enables SEO compatibility and reduces perceived latency.
 
 During pre-rendering, there are some key differences in behavior:
 

src/reactpy_django/checks.py

@@ -482,4 +482,13 @@ def reactpy_errors(app_configs, **kwargs):
             )
         )
 
+    if not isinstance(config.REACTPY_AUTO_RELOGIN, bool):
+        errors.append(
+            Error(
+                "Invalid type for REACTPY_AUTO_RELOGIN.",
+                hint="REACTPY_AUTO_RELOGIN should be a boolean.",
+                id="reactpy_django.E022",
+            )
+        )
+
     return errors

src/reactpy_django/config.py

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

src/reactpy_django/websocket/consumer.py

@@ -48,14 +48,15 @@ async def connect(self) -> None:
         from reactpy_django import models
         from reactpy_django.config import (
             REACTPY_AUTH_BACKEND,
-            REACTPY_AUTO_LOGIN,
+            REACTPY_AUTO_RELOGIN,
             REACTPY_BACKHAUL_THREAD,
         )
 
         await super().connect()
 
-        user: AbstractUser = self.scope.get("user")
-        if REACTPY_AUTO_LOGIN and user and user.is_authenticated:
+        # Automatically re-login the user, if needed
+        user: AbstractUser | None = self.scope.get("user")
+        if REACTPY_AUTO_RELOGIN and user and user.is_authenticated and user.is_active:
             try:
                 await login(self.scope, user, backend=REACTPY_AUTH_BACKEND)
             except Exception: