[deps] Add support for Django 5.x and update channels #340

- Dropped support for Python < 3.9
- Dropped support for Django < 4.2

Closes #340

Author: pandafy

.github/workflows/build.yml

@@ -26,13 +26,29 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.8"
           - "3.9"
           - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
         django-version:
-          - django~=3.2.0
-          - django~=4.1.0
           - django~=4.2.0
+          - django~=5.0.0
+          - django~=5.1.0
+          - django~=5.2.0
+        exclude:
+          # Django 5.0+ requires Python >=3.10
+          - python-version: "3.9"
+            django-version: django~=5.0.0
+          - python-version: "3.9"
+            django-version: django~=5.1.0
+          - python-version: "3.9"
+            django-version: django~=5.2.0
+          # Python 3.13 supported only in Django >=5.1.3
+          - python-version: "3.13"
+            django-version: django~=4.2.0
+          - python-version: "3.13"
+            django-version: django~=5.0.0
 
     steps:
     - uses: actions/checkout@v4

openwisp_notifications/base/models.py

@@ -1,11 +1,13 @@
 import logging
 from contextlib import contextmanager
 
+import django
 from django.conf import settings
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
 from django.contrib.sites.models import Site
 from django.core.cache import cache
+from django.core.exceptions import ObjectDoesNotExist
 from django.db import models
 from django.db.models.constraints import UniqueConstraint
 from django.template.loader import render_to_string
@@ -22,6 +24,7 @@
 from openwisp_notifications.exceptions import NotificationRenderException
 from openwisp_notifications.types import (
     NOTIFICATION_CHOICES,
+    get_notification_choices,
     get_notification_configuration,
 )
 from openwisp_notifications.utils import _get_absolute_url, _get_object_link
@@ -53,6 +56,15 @@ def notification_render_attributes(obj, **attrs):
     for target_attr, source_attr in defaults.items():
         setattr(obj, target_attr, getattr(obj, source_attr))
 
+    # In Django 5.1+, GenericForeignKey fields defined in parent models can no longer
+    # be overridden in child models (https://code.djangoproject.com/ticket/36295).
+    # To avoid multiple database queries, we explicitly set these attributes here
+    # using our cached _related_object method instead of relying on the default
+    # GenericForeignKey accessor which would bypass our caching mechanism.
+    setattr(obj, 'actor', obj._related_object('actor'))
+    setattr(obj, 'action_object', obj._related_object('action_object'))
+    setattr(obj, 'target', obj._related_object('target'))
+
     yield obj
 
     for attr in defaults.keys():
@@ -61,7 +73,21 @@ def notification_render_attributes(obj, **attrs):
 
 class AbstractNotification(UUIDModel, BaseNotification):
     CACHE_KEY_PREFIX = 'ow-notifications-'
-    type = models.CharField(max_length=30, null=True, choices=NOTIFICATION_CHOICES)
+    type = models.CharField(
+        max_length=30,
+        null=True,
+        # TODO: Remove when dropping support for Django 4.2
+        choices=(
+            NOTIFICATION_CHOICES
+            if django.VERSION < (5, 0)
+            # In Django 5.0+, choices are normalized at model definition,
+            # creating a static list of tuples that doesn't update when notification
+            # types are dynamically registered or unregistered. Using a callable
+            # ensures we always get the current choices from the registry.
+            else get_notification_choices
+        ),
+        verbose_name=_('Notification Type'),
+    )
     _actor = BaseNotification.actor
     _action_object = BaseNotification.action_object
     _target = BaseNotification.target
@@ -117,7 +143,7 @@ def _get_related_object_url(self, field):
                     return url_callable(self, field=field, absolute_url=True)
                 except ImportError:
                     return url
-        return _get_object_link(self, field=field, absolute_url=True)
+        return _get_object_link(obj=self._related_object(field), absolute_url=True)
 
     @property
     def actor_url(self):
@@ -200,7 +226,19 @@ def _related_object(self, field):
         cache_key = self._cache_key(obj_content_type_id, obj_id)
         obj = cache.get(cache_key)
         if not obj:
-            obj = getattr(self, f'_{field}')
+            try:
+                obj = getattr(self, f'_{field}')
+            except AttributeError:
+                # Django 5.1+ no longer respects overridden GenericForeignKey fields in model definitions.
+                # Using `_actor = BaseNotification.actor` doesn't work as expected.
+                # We must manually fetch the related object using content type and object ID.
+                # See: https://code.djangoproject.com/ticket/36295
+                try:
+                    obj = ContentType.objects.get_for_id(
+                        obj_content_type_id
+                    ).get_object_for_this_type(pk=obj_id)
+                except ObjectDoesNotExist:
+                    obj = None
             cache.set(
                 cache_key,
                 obj,
@@ -246,8 +284,17 @@ class AbstractNotificationSetting(UUIDModel):
     type = models.CharField(
         max_length=30,
         null=True,
-        choices=NOTIFICATION_CHOICES,
-        verbose_name='Notification Type',
+        # TODO: Remove when dropping support for Django 4.2
+        choices=(
+            NOTIFICATION_CHOICES
+            if django.VERSION < (5, 0)
+            # In Django 5.0+, choices are normalized at model definition,
+            # creating a static list of tuples that doesn't update when notification
+            # types are dynamically registered or unregistered. Using a callable
+            # ensures we always get the current choices from the registry.
+            else get_notification_choices
+        ),
+        verbose_name=_('Notification Type'),
     )
     organization = models.ForeignKey(
         get_model_name('openwisp_users', 'Organization'),

openwisp_notifications/migrations/0003_notification_notification_type.py

@@ -1,6 +1,7 @@
+import django
 from django.db import migrations, models
 
-from openwisp_notifications.types import NOTIFICATION_CHOICES
+from openwisp_notifications.types import NOTIFICATION_CHOICES, get_notification_choices
 
 
 class Migration(migrations.Migration):
@@ -13,9 +14,12 @@ class Migration(migrations.Migration):
             model_name='notification',
             name='type',
             field=models.CharField(
-                choices=NOTIFICATION_CHOICES,
+                choices=NOTIFICATION_CHOICES
+                if django.VERSION < (5, 0)
+                else get_notification_choices,
                 max_length=30,
                 null=True,
+                verbose_name="Notification Type",
             ),
         ),
     ]

openwisp_notifications/migrations/0004_notificationsetting.py

@@ -2,14 +2,15 @@
 
 import uuid
 
+import django
 import django.db.models.deletion
 import swapper
 from django.conf import settings
 from django.contrib.auth.management import create_permissions
 from django.db import migrations, models
 
 from openwisp_notifications.migrations import get_swapped_model
-from openwisp_notifications.types import NOTIFICATION_CHOICES
+from openwisp_notifications.types import NOTIFICATION_CHOICES, get_notification_choices
 
 
 def create_notification_setting_groups_permissions(apps, schema_editor):
@@ -89,7 +90,9 @@ class Migration(migrations.Migration):
                 (
                     'type',
                     models.CharField(
-                        choices=NOTIFICATION_CHOICES,
+                        choices=NOTIFICATION_CHOICES
+                        if django.VERSION < (5, 0)
+                        else get_notification_choices,
                         max_length=30,
                         null=True,
                         verbose_name='Notification Type',

openwisp_notifications/migrations/0008_rename_notification_recipient_unread_openwisp_no_recipie_b7c4ef_idx.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.2 on 2025-04-02 19:22
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("openwisp_notifications", "0007_notificationsetting_deleted"),
+    ]
+
+    operations = [
+        migrations.RenameIndex(
+            model_name="notification",
+            new_name="openwisp_no_recipie_b7c4ef_idx",
+            old_fields=("recipient", "unread"),
+        ),
+    ]

openwisp_notifications/tests/test_helpers.py

@@ -6,9 +6,10 @@
 from django.http import HttpRequest
 from django.utils import timezone
 
+from openwisp_notifications.base.models import NOTIFICATION_CHOICES
 from openwisp_notifications.swapper import load_model
 from openwisp_notifications.tasks import ns_register_unregister_notification_type
-from openwisp_notifications.types import NOTIFICATION_CHOICES, NOTIFICATION_TYPES
+from openwisp_notifications.types import NOTIFICATION_TYPES
 from openwisp_notifications.types import (
     register_notification_type as base_register_notification_type,
 )
@@ -41,6 +42,15 @@ def register_notification_type(type_name, type_config, models=[]):
     ns_register_unregister_notification_type.delay(
         notification_type=type_name, delete_unregistered=False
     )
+    # Update choices for model fields directly
+    # Django loads field choices during model initialization, but our mocked
+    # NOTIFICATION_CHOICES don't automatically update field choices.
+    # We need to explicitly update the field choices to ensure the models
+    # use our test environment's notification types.
+    from openwisp_notifications.types import NOTIFICATION_CHOICES
+
+    Notification._meta.get_field('type').choices = NOTIFICATION_CHOICES
+    NotificationSetting._meta.get_field('type').choices = NOTIFICATION_CHOICES
 
 
 def unregister_notification_type(type_name):
@@ -66,24 +76,6 @@ def wrapper(*args, **kwargs):
             NOTIFICATION_CHOICES=deepcopy(NOTIFICATION_CHOICES),
             NOTIFICATION_TYPES=deepcopy(NOTIFICATION_TYPES),
         ):
-            from openwisp_notifications import types
-
-            # Here we mock the choices for model fields directly. This is
-            # because the choices for model fields are defined during the
-            # model loading phase, and any changes to the mocked
-            # NOTIFICATION_CHOICES don't affect the model field choices.
-            # So, we mock the choices directly here to ensure that any
-            # changes to the mocked NOTIFICATION_CHOICES reflect in the
-            # model field choices.
-            with patch.object(
-                Notification._meta.get_field('type'),
-                'choices',
-                types.NOTIFICATION_CHOICES,
-            ), patch.object(
-                NotificationSetting._meta.get_field('type'),
-                'choices',
-                types.NOTIFICATION_CHOICES,
-            ):
-                return func(*args, **kwargs)
+            return func(*args, **kwargs)
 
     return wrapper

openwisp_notifications/tests/test_notifications.py

@@ -397,7 +397,7 @@ def test_notification_type_message_template(self):
             'level': 'info',
             'verb': 'message template verb',
             'verbose_name': 'Message Template Type',
-            'email_subject': '[{site.name}] Messsage Template Subject',
+            'email_subject': '[{site.name}] Message Template Subject',
         }
 
         with self.subTest('Register type with non existent message template'):
@@ -414,7 +414,7 @@ def test_notification_type_message_template(self):
             self._create_notification()
             n = notification_queryset.first()
             self.assertEqual(n.type, 'message_template')
-            self.assertEqual(n.email_subject, '[example.com] Messsage Template Subject')
+            self.assertEqual(n.email_subject, '[example.com] Message Template Subject')
 
         with self.subTest('Links in notification message'):
             url = _get_absolute_url(
@@ -633,16 +633,16 @@ def test_notification_invalid_message_attribute(self, mocked_task):
     def test_related_objects_database_query(self):
         operator = self._get_operator()
         self.notification_options.update(
-            {'action_object': operator, 'target': operator}
+            {'action_object': operator, 'target': operator, 'type': 'default'}
         )
-        self._create_notification()
+        n = self._create_notification().pop()[1][0]
         with self.assertNumQueries(1):
-            # 1 query since all related objects are cached
-            # when rendering the notification
+            # Accessing email_message should access all related objects
+            # (actor, action_object, target) but only execute a single
+            # query since these objects are cached when rendering
+            # the notification, rather than executing separate queries for each one.
             n = notification_queryset.first()
-            self.assertEqual(n.actor, self.admin)
-            self.assertEqual(n.action_object, operator)
-            self.assertEqual(n.target, operator)
+            n.message
 
     @patch.object(app_settings, 'CACHE_TIMEOUT', 0)
     def test_notification_cache_timeout(self):

openwisp_notifications/tests/test_selenium.py

@@ -41,7 +41,7 @@ def test_notification_relative_link(self):
         notification_elem = self.find_element(By.CLASS_NAME, 'ow-notification-elem')
         data_location_value = notification_elem.get_attribute('data-location')
         self.assertEqual(
-            data_location_value, _get_object_link(notification, 'target', False)
+            data_location_value, _get_object_link(notification.target, False)
         )
 
     def test_notification_dialog(self):

openwisp_notifications/tests/test_websockets.py

@@ -1,4 +1,3 @@
-import sys
 import uuid
 from datetime import timedelta
 from unittest.mock import patch
@@ -215,10 +214,6 @@ async def test_short_term_notification_storm_prevention(
     async def test_long_term_notification_storm_prevention(
         self, admin_user, admin_client
     ):
-        if sys.version_info[:2] == (3, 7):
-            NotificationConsumer._backoff_increment = 60
-            NotificationConsumer._max_allowed_backoff = 5
-
         datetime_now = now()
         freezer = freeze_time(datetime_now).start()
         await bulk_create_notification(admin_user, count=30)
@@ -232,12 +227,8 @@ async def test_long_term_notification_storm_prevention(
         # _initial_backoff is mocked since the time is frozen in this test
         # which was leading to initialization case getting skipped.
         with patch.object(NotificationConsumer, '_initial_backoff', 0):
-            if sys.version_info[:2] == (3, 7):
-                NotificationConsumer._initial_backoff = 0
             await create_notification(admin_user)
             response = await communicator.receive_json_from()
-            if sys.version_info[:2] == (3, 7):
-                NotificationConsumer._initial_backoff = 1
 
         # These notifications will increment the backoff time beyond allowed limit.
         for _ in range(2):
@@ -263,7 +254,3 @@ async def test_long_term_notification_storm_prevention(
         assert response['reload_widget'] is True
 
         await communicator.disconnect()
-
-        if sys.version_info[:1] == (3, 7):
-            NotificationConsumer._backoff_increment = 1
-            NotificationConsumer._max_allowed_backoff = 15

openwisp_notifications/types.py

@@ -111,3 +111,12 @@ def _unregister_notification_choice(notification_type):
             NOTIFICATION_CHOICES.pop(index)
             return
     raise ImproperlyConfigured(f'No such Notification Choice {notification_type}')
+
+
+def get_notification_choices():
+    """
+    Returns the list of notification choices, which may
+    be dyanmically changed at runtime by other openwisp
+    modules which register new notification types.
+    """
+    return NOTIFICATION_CHOICES

openwisp_notifications/utils.py

@@ -3,12 +3,11 @@
 from django.urls import NoReverseMatch, reverse
 
 
-def _get_object_link(obj, field, absolute_url=False, *args, **kwargs):
-    related_obj = getattr(obj, field)
+def _get_object_link(obj, absolute_url=False, *args, **kwargs):
     try:
         url = reverse(
-            f'admin:{related_obj._meta.app_label}_{related_obj._meta.model_name}_change',
-            args=[related_obj.id],
+            f'admin:{obj._meta.app_label}_{obj._meta.model_name}_change',
+            args=[obj.id],
         )
         if absolute_url:
             url = _get_absolute_url(url)

requirements-test.txt

@@ -1,7 +1,4 @@
-openwisp-utils[qa,selenium] @ https://github.com/openwisp/openwisp-utils/tarball/1.2
+openwisp-utils[qa,selenium,channels,channels-test] @ https://github.com/openwisp/openwisp-utils/tarball/1.2
 django-cors-headers~=4.4.0
 django-redis~=5.4.0
-channels_redis~=4.2.1
-pytest-asyncio~=0.24.0
-pytest-django~=4.10.0
 freezegun~=1.5.1