Auto-clean command for auth sync stuff

Author: Archmonger

pyproject.toml

@@ -148,6 +148,8 @@ extra-dependencies = [
   "twisted",
   "servestatic",
   "django-bootstrap5",
+  "decorator",
+  "playwright",
 ]
 
 [tool.hatch.envs.django.scripts]
@@ -156,6 +158,14 @@ runserver = [
   "cd tests && python manage.py runserver",
 ]
 makemigrations = ["cd tests && python manage.py makemigrations"]
+clean = ["cd tests && python manage.py clean_reactpy -v 3"]
+clean_sessions = ["cd tests && python manage.py clean_reactpy --sessions -v 3"]
+clean_auth_sync = [
+  "cd tests && python manage.py clean_reactpy --auth-sync -v 3",
+]
+clean_user_data = [
+  "cd tests && python manage.py clean_reactpy --user-data -v 3",
+]
 
 #######################################
 # >>> Hatch Documentation Scripts <<< #

src/reactpy_django/auth/components.py

@@ -41,13 +41,15 @@ def setup_asgi_scope():
 
     @hooks.use_effect(dependencies=[synchronize_requested])
     async def synchronize_session_watchdog():
-        """This effect will automatically be cancelled if the session is successfully
+        """Detected if the client has taken too long to request a session synchronization.
+
+        This effect will automatically be cancelled if the session is successfully
         switched (via effect dependencies)."""
         if synchronize_requested:
-            await asyncio.sleep(config.REACTPY_AUTH_TIMEOUT + 0.1)
+            await asyncio.sleep(config.REACTPY_AUTH_SYNC_TIMEOUT + 0.1)
             await asyncio.to_thread(
                 _logger.warning,
-                f"Client did not switch sessions within {config.REACTPY_AUTH_TIMEOUT} (REACTPY_AUTH_TIMEOUT) seconds.",
+                f"Client did not switch sessions within {config.REACTPY_AUTH_SYNC_TIMEOUT} (REACTPY_AUTH_SYNC_TIMEOUT) seconds.",
             )
             set_synchronize_requested(False)
 

src/reactpy_django/config.py

@@ -39,9 +39,9 @@
     "REACTPY_SESSION_MAX_AGE",
     259200,  # Default to 3 days
 )
-REACTPY_AUTH_TIMEOUT: int = getattr(
+REACTPY_AUTH_SYNC_TIMEOUT: int = getattr(
     settings,
-    "REACTPY_AUTH_TIMEOUT",
+    "REACTPY_AUTH_SYNC_TIMEOUT",
     30,  # Default to 30 seconds
 )
 REACTPY_CACHE: str = getattr(
@@ -126,6 +126,11 @@
     "REACTPY_CLEAN_SESSIONS",
     True,
 )
+REACTPY_CLEAN_AUTH_SYNC: bool = getattr(
+    settings,
+    "REACTPY_CLEAN_AUTH_SYNC",
+    True,
+)
 REACTPY_CLEAN_USER_DATA: bool = getattr(
     settings,
     "REACTPY_CLEAN_USER_DATA",

src/reactpy_django/management/commands/clean_reactpy.py

@@ -1,5 +1,4 @@
 from logging import getLogger
-from typing import Literal
 
 from django.core.management.base import BaseCommand
 
@@ -9,18 +8,12 @@
 class Command(BaseCommand):
     help = "Manually clean ReactPy data. When using this command without args, it will perform all cleaning operations."
 
-    def handle(self, **options):
-        from reactpy_django.tasks import clean
+    def handle(self, *_args, **options):
+        from reactpy_django.tasks import CleaningArgs, clean
 
-        verbosity = options.get("verbosity", 1)
-
-        cleaning_args: set[Literal["all", "sessions", "user_data"]] = set()
-        if options.get("sessions"):
-            cleaning_args.add("sessions")
-        if options.get("user_data"):
-            cleaning_args.add("user_data")
-        if not cleaning_args:
-            cleaning_args = {"all"}
+        verbosity = options.pop("verbosity", 1)
+        valid_args: set[CleaningArgs] = {"all", "sessions", "auth_sync", "user_data"}
+        cleaning_args: set[CleaningArgs] = {arg for arg in options if arg in valid_args and options[arg]} or {"all"}
 
         clean(*cleaning_args, immediate=True, verbosity=verbosity)
 
@@ -31,10 +24,15 @@ def add_arguments(self, parser):
         parser.add_argument(
             "--sessions",
             action="store_true",
-            help="Clean session data. This value can be combined with other cleaning options.",
+            help="Clean component session data. This value can be combined with other cleaning options.",
         )
         parser.add_argument(
             "--user-data",
             action="store_true",
             help="Clean user data. This value can be combined with other cleaning options.",
         )
+        parser.add_argument(
+            "--auth-sync",
+            action="store_true",
+            help="Clean authentication synchronizer data. This value can be combined with other cleaning options.",
+        )

src/reactpy_django/models.py

@@ -28,17 +28,16 @@ class SynchronizeSession(models.Model):
 
     Source code must be written to respect the expiration property of this model."""
 
-    # TODO: Add cleanup task for this.
     uuid = models.UUIDField(primary_key=True, editable=False, unique=True)
     session_key = models.CharField(max_length=40, editable=False)
     created_at = models.DateTimeField(auto_now_add=True, editable=False)
 
     @property
     def expired(self) -> bool:
-        """Check if the login UUID has expired."""
-        from reactpy_django.config import REACTPY_AUTH_TIMEOUT
+        """Check the client has exceeded the max timeout."""
+        from reactpy_django.config import REACTPY_AUTH_SYNC_TIMEOUT
 
-        return self.created_at < (timezone.now() - timedelta(seconds=REACTPY_AUTH_TIMEOUT))
+        return self.created_at < (timezone.now() - timedelta(seconds=REACTPY_AUTH_SYNC_TIMEOUT))
 
 
 class Config(models.Model):

src/reactpy_django/tasks.py

@@ -2,7 +2,7 @@
 
 import logging
 from datetime import datetime, timedelta
-from typing import TYPE_CHECKING, Literal
+from typing import TYPE_CHECKING, Literal, TypeAlias
 
 from django.contrib.auth import get_user_model
 from django.utils import timezone
@@ -13,37 +13,39 @@
     from reactpy_django.models import Config
 
 CLEAN_NEEDED_BY: datetime = datetime(year=1, month=1, day=1, tzinfo=timezone.now().tzinfo)
+CleaningArgs: TypeAlias = Literal["all", "sessions", "auth_sync", "user_data"]
 
 
-def clean(
-    *args: Literal["all", "sessions", "user_data"],
-    immediate: bool = False,
-    verbosity: int = 1,
-):
+def clean(*args: CleaningArgs, immediate: bool = False, verbosity: int = 1):
     from reactpy_django.config import (
+        REACTPY_CLEAN_AUTH_SYNC,
         REACTPY_CLEAN_SESSIONS,
         REACTPY_CLEAN_USER_DATA,
     )
     from reactpy_django.models import Config
 
     config = Config.load()
-    if immediate or is_clean_needed(config):
+    if immediate or clean_is_needed(config):
         config.cleaned_at = timezone.now()
         config.save()
         sessions = REACTPY_CLEAN_SESSIONS
+        auth_sync = REACTPY_CLEAN_AUTH_SYNC
         user_data = REACTPY_CLEAN_USER_DATA
 
         if args:
             sessions = any(value in args for value in ("sessions", "all"))
+            auth_sync = any(value in args for value in ("auth_sync", "all"))
             user_data = any(value in args for value in ("user_data", "all"))
 
         if sessions:
-            clean_sessions(verbosity)
+            clean_component_sessions(verbosity)
+        if auth_sync:
+            clean_auth_synchronizer(verbosity)
         if user_data:
             clean_user_data(verbosity)
 
 
-def clean_sessions(verbosity: int = 1):
+def clean_component_sessions(verbosity: int = 1):
     """Deletes expired component sessions from the database.
     As a performance optimization, this is only run once every REACTPY_SESSION_MAX_AGE seconds.
     """
@@ -67,6 +69,25 @@ def clean_sessions(verbosity: int = 1):
         inspect_clean_duration(start_time, "component sessions", verbosity)
 
 
+def clean_auth_synchronizer(verbosity: int = 1):
+    from reactpy_django.config import DJANGO_DEBUG, REACTPY_AUTH_SYNC_TIMEOUT
+    from reactpy_django.models import SynchronizeSession
+
+    if verbosity >= 2:
+        _logger.info("Cleaning ReactPy auth sync data...")
+    start_time = timezone.now()
+    expiration_date = timezone.now() - timedelta(seconds=REACTPY_AUTH_SYNC_TIMEOUT)
+    synchronizer_objects = SynchronizeSession.objects.filter(created_at__lte=expiration_date)
+
+    if verbosity >= 2:
+        _logger.info("Deleting %d expired auth sync objects...", synchronizer_objects.count())
+
+    synchronizer_objects.delete()
+
+    if DJANGO_DEBUG or verbosity >= 2:
+        inspect_clean_duration(start_time, "auth sync", verbosity)
+
+
 def clean_user_data(verbosity: int = 1):
     """Delete any user data that is not associated with an existing `User`.
     This is a safety measure to ensure that we don't have any orphaned data in the database.
@@ -101,7 +122,7 @@ def clean_user_data(verbosity: int = 1):
         inspect_clean_duration(start_time, "user data", verbosity)
 
 
-def is_clean_needed(config: Config | None = None) -> bool:
+def clean_is_needed(config: Config | None = None) -> bool:
     """Check if a clean is needed. This function avoids unnecessary database reads by caching the
     CLEAN_NEEDED_BY date."""
     from reactpy_django.config import REACTPY_CLEAN_INTERVAL