feat: Add NOTIFICATIONS_MODEL setting (#74)

danidee10 · web-flow · commit 37b9339f4e41 · 2021-09-19T22:28:40.000+02:00
* feat: Change `obj` field to GenericForeignKey
* dep: Upgrade django-json-field backport to 1.0.4
* dep: Upgrade `Django` to &gt;= 2.2
* feat: Add NOTIFICATIONS_MODEL setting
* fix: tests
diff --git a/.travis.yml b/.travis.yml
@@ -18,27 +18,27 @@ matrix:
     # Python 3.6
     - python: 3.6
       if: branch != master
-      env: TOXENV=py36-django22,py36-django30,py36-django31
+      env: TOXENV=py36-django22,py36-django30,py36-django31,py36-django32
 
     # Python 3.7
     - python: 3.7
       if: branch != master
-      env: TOXENV=py37-django22,py37-django30,py37-django31
+      env: TOXENV=py37-django22,py37-django30,py37-django31,py37-django32
 
     # Python 3.8
     - python: 3.8
       if: branch != master
-      env: TOXENV=py38-django22,py38-django30,py38-django31
+      env: TOXENV=py38-django22,py38-django30,py38-django31,py38-django32
 
     # Python 3.9
     - python: 3.9
       if: branch != master
-      env: TOXENV=py39-django22,py39-django30,py39-django31
+      env: TOXENV=py39-django22,py39-django30,py39-django31,py39-django32
 
     # Python 3.9 Coverage
     - python: 3.9
       if: branch = master
-      env: TOXENV=py39-django31
+      env: TOXENV=py39-django31,py39-django32
       before_script:
         - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
         - chmod +x ./cc-test-reporter
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -2,6 +2,14 @@ Configuration
 *************
 
 
+``NOTIFICATIONS_MODEL``
+--------------------------
+
+``Default='notifications.models.Notification'``
+
+This setting is used override the default database Model for saving notifications. Most users wouldn't need to override this
+but it can be useful if you're trying to integrate django-notifs into an existing project that already has it's own Notificaiton model
+
 
 ``NOTIFICATIONS_CHANNELS``
 --------------------------
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -138,7 +138,6 @@ channel class::
 
 Delayed notification channel class::
 
-    from notifications.models import Notification
     from notifications.channels import BaseNotificationChannel
 
 
@@ -148,7 +147,7 @@ Delayed notification channel class::
             """Cancel the delivery if the notification has been read"""
             # notification_id is only available if the notification isn't silent
             if self.notification_id:
-                notification = Notification.objects.get(id=self.notification_id)
+                notification = self.NotificationModel.objects.get(id=self.notification_id)
 
                 if notification.read is True:
                     return
diff --git a/notifications/admin.py b/notifications/admin.py
@@ -2,7 +2,10 @@
 
 from django.contrib import admin
 
-from .models import Notification
+from .utils import get_notification_model
+
+
+Notification = get_notification_model()
 
 
 admin.site.register(Notification)
diff --git a/notifications/backends/utils.py b/notifications/backends/utils.py
@@ -9,9 +9,7 @@ def _send_notification(notification, channel_alias, logger):
     # Validate channel alias
     channel_path = _validate_channel_alias(channel_alias)
 
-    channel = _import_class_string(channel_path)(
-        **notification, alias=channel_alias
-    )
+    channel = _import_class_string(channel_path)(**notification, alias=channel_alias)
 
     message = channel.construct_message()
     channel.notify(message)
diff --git a/notifications/channels/base.py b/notifications/channels/base.py
@@ -1,5 +1,7 @@
 import abc
 
+from notifications.utils import get_notification_model
+
 
 class BaseNotificationChannel(metaclass=abc.ABCMeta):
     """Base channel for sending notifications."""
@@ -8,6 +10,8 @@ def __init__(self, **kwargs):
         self.notification_kwargs = kwargs
         self.notification_id = kwargs['notification_id']
 
+        self.NotificationModel = get_notification_model()
+
     @abc.abstractmethod
     def construct_message(self):
         """Constructs a message from notification details."""
diff --git a/notifications/channels/channels_websocket.py b/notifications/channels/channels_websocket.py
@@ -21,8 +21,7 @@ def _validate_notification_kwargs(self):
             notif_kwargs['extra_data'][self.destination_name]
         except KeyError:
             raise KeyError(
-                f'`extra_kwargs` must contain the `{self.destination_name}`'
-                'key'
+                f'`extra_kwargs` must contain the `{self.destination_name}`' 'key'
             )
 
     def construct_message(self):
@@ -35,9 +34,7 @@ def construct_message(self):
 
     def notify(self, message):
         channel_layer = get_channel_layer()
-        destination = self.notification_kwargs['extra_data'][
-            self.destination_name
-        ]
+        destination = self.notification_kwargs['extra_data'][self.destination_name]
 
         async_to_sync(channel_layer.group_send)(
             destination,
diff --git a/notifications/consumers.py b/notifications/consumers.py
@@ -38,17 +38,13 @@ async def connect(self):
         ]
 
         # Join room group
-        await self.channel_layer.group_add(
-            self.room_group_name, self.channel_name
-        )
+        await self.channel_layer.group_add(self.room_group_name, self.channel_name)
 
         await self.accept()
 
     async def disconnect(self, close_code):
         """Leave the group."""
-        await self.channel_layer.group_discard(
-            self.room_group_name, self.channel_name
-        )
+        await self.channel_layer.group_discard(self.room_group_name, self.channel_name)
 
     async def receive(self, text_data):
         """
diff --git a/notifications/default_settings.py b/notifications/default_settings.py
@@ -15,9 +15,7 @@
 
 NOTIFICATIONS_RETRY = getattr(settings, 'NOTIFICATIONS_RETRY', False)
 
-NOTIFICATIONS_RETRY_INTERVAL = getattr(
-    settings, 'NOTIFICATIONS_RETRY_INTERVAL', 5
-)
+NOTIFICATIONS_RETRY_INTERVAL = getattr(settings, 'NOTIFICATIONS_RETRY_INTERVAL', 5)
 
 NOTIFICATIONS_MAX_RETRIES = getattr(settings, 'NOTIFICATIONS_MAX_RETRIES', 5)
 
diff --git a/notifications/migrations/0010_notification_channels.py b/notifications/migrations/0010_notification_channels.py
@@ -14,9 +14,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='notification',
             name='channels',
-            field=notifications.fields.ListField(
-                default=('console',), max_length=200
-            ),  # noqa
+            field=notifications.fields.ListField(default=('console',), max_length=200),
             preserve_default=False,
         ),
     ]
diff --git a/notifications/models.py b/notifications/models.py
@@ -22,7 +22,7 @@ def all_read(self):
         return self.filter(is_read=True)
 
 
-class Notification(models.Model):
+class BaseNotificationModel(models.Model):
     """
     Model for notifications.
 
@@ -56,9 +56,8 @@ class Notification(models.Model):
     User = settings.AUTH_USER_MODEL
 
     class Meta:
-        """Specify ordering for notifications."""
-
         ordering = ('-id',)
+        abstract = True
 
     source = models.ForeignKey(User, null=True, on_delete=models.CASCADE)
     source_display_name = models.CharField(max_length=150, null=True)
@@ -122,3 +121,7 @@ def to_json(self):
             'extra_data': self.extra_data,
             'is_read': self.is_read,
         }
+
+
+class Notification(BaseNotificationModel):
+    pass
diff --git a/notifications/tests/test_backends.py b/notifications/tests/test_backends.py
@@ -3,12 +3,15 @@
 from django.test import TestCase
 from django.contrib.auth import get_user_model
 
-from ..models import Notification
+from ..utils import get_notification_model
 from ..tasks import send_notification
 from ..backends import Celery, Channels, RQ
 from ..consumers import DjangoNotifsConsumer
 
 
+Notification = get_notification_model()
+
+
 class BackendTests(TestCase):
     """
     Tests for the Delivery backends
@@ -59,9 +62,7 @@ def test_rq_backend(self):
 
     def test_celery_task(self):
         """This ensures that the Celery task runs without errors."""
-        self.assertIsNone(
-            send_notification(self.notification.to_json(), 'console')
-        )
+        self.assertIsNone(send_notification(self.notification.to_json(), 'console'))
 
     async def test_channels_consumer(self):
         """This ensures that the Channels consumer runs without errors."""
diff --git a/notifications/tests/test_general.py b/notifications/tests/test_general.py
diff --git a/notifications/tests/tests.py b/notifications/tests/tests.py
diff --git a/notifications/utils.py b/notifications/utils.py
diff --git a/tox.ini b/tox.ini
