Fix import issues with swappable SentNotifications model

Author: peterfarrell

.coveragerc

@@ -5,3 +5,5 @@ source = herald
 branch = True
 omit =
     */migrations/*
+    */tests/*
+    runtests.py

.gitignore

@@ -44,6 +44,7 @@ nosetests.xml
 coverage.xml
 *,cover
 .hypothesis/
+htmlcov
 
 # Translations
 *.mo
@@ -66,4 +67,7 @@ target/
 
 # Herald Specific
 *.sqlite3
-.venv
+.venv
+
+# MacOS Specific
+.DS_store

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contrinbuting
+
+## Running Tests
+
+This will run with a SQLite3 in-memory database:
+
+```bash
+python runtests.py -v 2
+```
+
+## Running Server to See Views
+
+You will need to run migrations:
+
+```bash
+python manage.py migrate
+```
+
+Run server:
+
+```bash
+python manage.py runserver 0.0.0.0:8000
+```

README.md

@@ -452,28 +452,4 @@ You can also attach any MIMEBase objects as regular attachments, but you must ad
 my_image.add_header('Content-Disposition', 'attachment; filename="python.jpg"')
 ```
 
-Attachments can cause your database to become quite large, so you should be sure to run the management commands to purge the database of old messages.
-
-# Development
-
-## Running Tests
-
-This will run with a SQLite3 in-memory database:
-
-```bash
-python runtests.py -v 2
-```
-
-## Running Server to See Views
-
-You will need to run migrations:
-
-```bash
-python manage.py migrate
-```
-
-Run server:
-
-```bash
-python manage.py runserver 0.0.0.0:8000
-```
+Attachments can cause your database to become quite large, so you should be sure to run the management commands to purge the database of old messages.

herald/admin.py

@@ -3,25 +3,14 @@
 """
 
 from functools import update_wrapper
-
-try:
-    from django.urls import re_path as url
-except ImportError:
-    from django.conf.urls import url
-
 from django.contrib import admin, messages
 from django.contrib.admin.options import csrf_protect_m
 from django.contrib.admin.utils import unquote
-from django.urls import reverse
+from django.urls import re_path, reverse
 from django.utils.safestring import mark_safe
 
-from herald.utils import get_sent_notification_model
 from .models import Notification
 
-SentNotification = get_sent_notification_model()
-
-
-@admin.register(SentNotification)
 class SentNotificationAdmin(admin.ModelAdmin):
     """
     Admin for viewing historical notifications sent
@@ -80,7 +69,7 @@ def wrapper(*args, **kwargs):
         info = opts.app_label, opts.model_name
 
         return [
-            url(r"^(.+)/resend/$", wrap(self.resend_view), name="%s_%s_resend" % info),
+            re_path(r"^(.+)/resend/$", wrap(self.resend_view), name="%s_%s_resend" % info),
         ] + urls
 
     @csrf_protect_m
@@ -110,7 +99,6 @@ def resend_view(
         return self.response_post_save_change(request, obj)
 
 
-@admin.register(Notification)
 class NotificationAdmin(admin.ModelAdmin):
     """
     Admin for viewing/managing notifications in the system

herald/apps.py

@@ -19,6 +19,8 @@ def ready(self):
 
         self.module.autodiscover()
 
+        self.register_admins()
+
         Notification = self.get_model("Notification")
 
         try:
@@ -43,3 +45,21 @@ def ready(self):
         except ProgrammingError:
             # if the database is not created yet, keep going (ie: during testing)
             pass
+
+    def register_admins(self):
+        """
+        Register admin classes if they are not already registered.
+        This is the correct way to handle admin registration for swappable models.
+        """
+        from django.contrib import admin
+
+        from herald.admin import NotificationAdmin, SentNotificationAdmin
+        from herald.models import Notification
+        from herald.utils import get_sent_notification_model
+
+        SentNotification = get_sent_notification_model()
+
+        admin.site.register(Notification, NotificationAdmin)
+
+        if not admin.site.is_registered(SentNotification):
+            admin.site.register(SentNotification, SentNotificationAdmin)

herald/base.py

@@ -1,7 +1,3 @@
-"""
-Base notification classes
-"""
-
 import json
 import re
 from email.mime.base import MIMEBase
@@ -18,8 +14,6 @@
 
 from herald.utils import get_sent_notification_model
 
-SentNotification = get_sent_notification_model()
-
 
 class NotificationBase:
     """
@@ -97,6 +91,8 @@ def send(self, raise_exception=False, user=None):
         subject = self.get_subject()
         extra_data = self.get_extra_data()
 
+        SentNotification = get_sent_notification_model()
+
         sent_notification = SentNotification(
             recipients=",".join(recipients),
             text_content=text_content,
@@ -138,6 +134,8 @@ def _delete_expired_notifications():
 
         if not retention_time:
             return
+        
+        SentNotification = get_sent_notification_model()
 
         cutoff_date = timezone.now() - retention_time
 

herald/contrib/auth/notifications.py

@@ -9,9 +9,10 @@
 from django.utils.encoding import force_bytes
 
 try:
-    from django.utils.encoding import force_str as force_text
+    from django.utils.encoding import force_str
 except ImportError:
-    from django.utils.encoding import force_text
+    # Django 3.2 compatibility: force_text was renamed to force_str in Django 4.0
+    from django.utils.encoding import force_text as force_str
 
 from django.urls import reverse
 from django.utils.http import urlsafe_base64_encode
@@ -60,7 +61,7 @@ def get_context_data(self):
             self.domain = current_site.domain
 
         protocol = "https" if self.use_https else "http"
-        uid = force_text(urlsafe_base64_encode(force_bytes(self.user.pk)))
+        uid = force_str(urlsafe_base64_encode(force_bytes(self.user.pk)))
         token = self.token_generator.make_token(self.user)
 
         context.update(

herald/management/commands/delnotifs.py

@@ -3,7 +3,7 @@
 from django.core.management.base import BaseCommand
 from django.utils import timezone
 
-from ...models import SentNotification
+from ...utils import get_sent_notification_model
 
 
 def valid_date(s):
@@ -22,6 +22,7 @@ def add_arguments(self, parser):
         )
 
     def handle(self, *args, **options):
+        SentNotification = get_sent_notification_model()
         start_date = options.get("start")
         end_date = options.get("end")
 

herald/urls.py

@@ -1,17 +1,13 @@
 """
 Urls for herald app
 """
-
-try:
-    from django.urls import re_path as url
-except ImportError:
-    from django.conf.urls import url
+from django.urls import re_path
 
 from .views import TestNotification, TestNotificationList
 
 urlpatterns = [
-    url(r"^$", TestNotificationList.as_view(), name="herald_preview_list"),
-    url(
+    re_path(r"^$", TestNotificationList.as_view(), name="herald_preview_list"),
+    re_path(
         r"^(?P<index>\d+)/(?P<type>[\w\-]+)/$",
         TestNotification.as_view(),
         name="herald_preview",