feat: Add bulk notifications (#76)

* feat: Add bulk notifications

Author: danidee10

docs/usage.rst

@@ -64,8 +64,34 @@ and decide how each individual notification should be sent
     You must inherit from the base class and specify the ``name`` property for the channel to be properly registered
 
 
+Bulk sending
+------------
+
+You can send bulk notifications by setting the ``bulk`` property to ``True`` in the context dictionary::
+
+    console_notification = ConsoleNotificationChannel(
+        notification: Notification, context={'bulk': True, 'arbitrary_data': 'data'}
+    )
+    console_notification.notify()
+
+or::
+
+    notify(
+        ...,
+        extra_data={
+            'context': {
+                'bulk': True,
+            }
+        }
+    )
+
+.. note::
+    The provider takes care of sending the payload in the most efficient way.
+    (Some providers like ``pusher`` have a bulk api for delivering multiple notifications in a single batch).
+
+
 Notification Model
--------------------
+-----------------
 
 Django notifs includes an inbuilt notification model with the following fields:
 

notifications/backends/base.py

@@ -22,9 +22,16 @@ def get_notification_provider(provider_path, context):
     @classmethod
     def consume(cls, provider, provider_class, payload, context):
         notification_channel = cls.get_notification_provider(provider_class, context)
-        notification_channel.send(payload)
+
+        bulk = context.get('bulk', False)
+        if bulk is True:
+            notification_channel.send_bulk(payload)
+        else:
+            notification_channel.send(payload)
+
         cls.logger.info(
-            'Sent notification with the %s channel. context: %s\n' % (provider, context)
+            'Sent notification with the %s provider with context: %s\n'
+            % (provider, context)
         )
 
     @abc.abstractclassmethod

notifications/tests/test_general.py

@@ -1,6 +1,7 @@
 """General Tests."""
 
 import time
+from unittest import mock
 
 from django.db import models
 from django.contrib.auth import get_user_model
@@ -10,6 +11,7 @@
 from .. import NotificationError
 from ..models import BaseNotificationModel
 from ..backends.base import BaseBackend
+from ..channels import ConsoleNotificationChannel
 
 
 Notification = get_notification_model()
@@ -123,6 +125,51 @@ def test_silent_notification(self):
 
         self.assertEqual(notifications.count(), 0)
 
+    @mock.patch('notifications.providers.ConsoleNotificationProvider.send_bulk')
+    def test_bulk_notification_notify(self, send_bulk):
+        notify(
+            source=self.user2,
+            source_display_name='User 2',
+            recipient=self.user1,
+            action='Notified',
+            category='Silent notification',
+            obj=self.user2,
+            url='http://example.com',
+            short_description='Short Description',
+            is_read=False,
+            channels=('console',),
+            extra_data={
+                'context': {
+                    'bulk': True,
+                }
+            },
+        )
+
+        send_bulk.assert_called_once_with(
+            {'context': {'bulk': True}, 'payload': 'console'}
+        )
+
+    @mock.patch('notifications.providers.ConsoleNotificationProvider.send_bulk')
+    def test_bulk_notification_direct(self, send_bulk):
+        notification = Notification.objects.create(
+            source=self.user2,
+            source_display_name='User 2',
+            recipient=self.user1,
+            action='Notified',
+            category='Silent notification',
+            obj=self.user2,
+            url='http://example.com',
+            short_description='Short Description',
+            is_read=False,
+        )
+        console_notification = ConsoleNotificationChannel(
+            notification, context={'bulk': True}
+        )
+        payload = console_notification.build_payload('console')
+        console_notification.notify()
+
+        send_bulk.assert_called_once_with(payload)
+
     def test_notify_invalid_channel(self):
         """An invalid channel should raise a AttributeError."""
         notification_kwargs = dict(