edx-ace 1.10.1__tar.gz → 1.11.1__tar.gz

{edx-ace-1.10.1/edx_ace.egg-info → edx-ace-1.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-ace
-Version: 1.10.1
+Version: 1.11.1
 Summary: Framework for Messaging
 Home-page: https://github.com/openedx/edx-ace
 Author: edX

{edx-ace-1.10.1 → edx-ace-1.11.1}/edx_ace/__init__.py

@@ -13,7 +13,7 @@ from .policy import Policy, PolicyResult
 from .recipient import Recipient
 from .recipient_resolver import RecipientResolver
 
-__version__ = '1.10.1'
+__version__ = '1.11.1'
 
 
 __all__ = [

{edx-ace-1.10.1 → edx-ace-1.11.1}/edx_ace/delivery.py

@@ -10,6 +10,7 @@ import time
 from django.conf import settings
 
 from edx_ace.errors import RecoverableChannelDeliveryError
+from edx_ace.signals import ACE_MESSAGE_SENT
 from edx_ace.utils.date import get_current_time
 
 LOG = logging.getLogger(__name__)
@@ -60,6 +61,7 @@ def deliver(channel, rendered_message, message):
             message.report(f'{channel_type}_delivery_retried', num_seconds)
         else:
             message.report(f'{channel_type}_delivery_succeeded', True)
+            ACE_MESSAGE_SENT.send(sender=channel, message=message)
             return
 
     delivery_expired_report = f'{channel_type}_delivery_expired'

edx-ace-1.11.1/edx_ace/signals.py

@@ -0,0 +1,7 @@
+"""
+Signals for the edx_ace app
+"""
+from django.dispatch import Signal
+
+# signal to indicate that a message has been sent using ace
+ACE_MESSAGE_SENT = Signal()

{edx-ace-1.10.1 → edx-ace-1.11.1}/edx_ace/tests/test_delivery.py

@@ -34,21 +34,26 @@ class TestDelivery(TestCase):  # pylint: disable=missing-class-docstring
         )
         self.current_time = datetime.datetime.utcnow().replace(tzinfo=tzutc())
 
-    def test_happy_path(self):
+    @patch('edx_ace.delivery.ACE_MESSAGE_SENT.send')
+    def test_happy_path(self, mock_ace_message_sent):
         deliver(self.mock_channel, sentinel.rendered_email, self.message)
         self.mock_channel.deliver.assert_called_once_with(self.message, sentinel.rendered_email)
+        # check if ACE_MESSAGE_SENT is raised
+        mock_ace_message_sent.assert_called_once_with(sender=self.mock_channel, message=self.message)
 
     def test_fatal_error(self):
         self.mock_channel.deliver.side_effect = FatalChannelDeliveryError('testing')
         with self.assertRaises(FatalChannelDeliveryError):
             deliver(self.mock_channel, sentinel.rendered_email, self.message)
 
+    @patch('edx_ace.delivery.ACE_MESSAGE_SENT.send')
     @patch('edx_ace.delivery.get_current_time')
-    def test_custom_message_expiration(self, mock_get_current_time):
+    def test_custom_message_expiration(self, mock_get_current_time, mock_ace_message_sent):
         self.message.expiration_time = self.current_time - datetime.timedelta(seconds=10)
         mock_get_current_time.return_value = self.current_time
         deliver(self.mock_channel, sentinel.rendered_email, self.message)
         assert not self.mock_channel.deliver.called
+        mock_ace_message_sent.assert_not_called()
 
     @patch('edx_ace.delivery.time')
     @patch('edx_ace.delivery.get_current_time')
@@ -100,3 +105,16 @@ class TestDelivery(TestCase):  # pylint: disable=missing-class-docstring
         deliver(self.mock_channel, sentinel.rendered_email, self.message)
         assert mock_time.sleep.call_args_list == [call(1), call(1)]
         assert self.mock_channel.deliver.call_count == 3
+
+    @patch('edx_ace.delivery.ACE_MESSAGE_SENT.send')
+    def test_message_sent_signal_for_push_channel(self, mock_ace_message_sent):
+        """
+        Test that ACE_MESSAGE_SENT signal is sent when a message is delivered to a push channel.
+        """
+        mock_push_channel = Mock(
+            name='push_channel',
+            channel_type=ChannelType.PUSH
+        )
+        deliver(mock_push_channel, sentinel.rendered_email, self.message)
+        # check if ACE_MESSAGE_SENT is raised
+        mock_ace_message_sent.assert_called_once_with(sender=mock_push_channel, message=self.message)

{edx-ace-1.10.1 → edx-ace-1.11.1/edx_ace.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edx-ace
-Version: 1.10.1
+Version: 1.11.1
 Summary: Framework for Messaging
 Home-page: https://github.com/openedx/edx-ace
 Author: edX

{edx-ace-1.10.1 → edx-ace-1.11.1}/edx_ace.egg-info/SOURCES.txt

@@ -17,6 +17,7 @@ edx_ace/recipient.py
 edx_ace/recipient_resolver.py
 edx_ace/renderers.py
 edx_ace/serialization.py
+edx_ace/signals.py
 edx_ace.egg-info/PKG-INFO
 edx_ace.egg-info/SOURCES.txt
 edx_ace.egg-info/dependency_links.txt