feat: add grouping for new response notification (#37674)

Author: AhtishamShahid

lms/djangoapps/discussion/rest_api/discussions_notifications.py

@@ -122,6 +122,7 @@ def send_new_response_notification(self):
         if not self.parent_id and self.creator.id != int(self.thread.user_id):
             context = {
                 'email_content': clean_thread_html_body(self.comment.body),
+                'group_by_id': str(self.thread.id),
             }
             self._populate_context_with_ids_for_mobile(context, notification_type)
             self._send_notification([self.thread.user_id], notification_type, extra_context=context)
@@ -229,6 +230,7 @@ def send_response_on_followed_post_notification(self):
         if not self.parent_id:
             context = {
                 "email_content": clean_thread_html_body(self.comment.body),
+                "group_by_id": str(self.thread.id),
             }
             notification_type = "response_on_followed_post"
             self._populate_context_with_ids_for_mobile(context, notification_type)

lms/djangoapps/discussion/rest_api/tests/test_tasks_v2.py

@@ -148,6 +148,7 @@ def test_send_notification_to_thread_creator(self):
             'topic_id': None,
             'thread_id': 1,
             'comment_id': None,
+            'group_by_id': '1',
         }
         self.assertDictEqual(args.context, expected_context)
         self.assertEqual(
@@ -214,6 +215,8 @@ def test_send_notification_to_followers(self, parent_id, notification_type):
             'thread_id': 1,
             'comment_id': 4 if not notification_type == 'response_on_followed_post' else None,
         }
+        if notification_type == 'response_on_followed_post':
+            expected_context['group_by_id'] = '1'
         if parent_id:
             expected_context['author_name'] = 'dummy\'s'
             expected_context['author_pronoun'] = 'dummy\'s'

openedx/core/djangoapps/notifications/base_notification.py

@@ -95,6 +95,8 @@ class NotificationType(TypedDict):
         'is_core': True,
         'content_template': _('<{p}><{strong}>{replier_name}</{strong}> responded to your '
                               'post <{strong}>{post_title}</{strong}></{p}>'),
+        'grouped_content_template': _('<{p}><{strong}>{replier_name}</{strong}> and others have responded to your post '
+                                      '<{strong}>{post_title}</{strong}></{p}>'),
         'content_context': {
             'post_title': 'Post title',
             'replier_name': 'replier name',
@@ -148,6 +150,8 @@ class NotificationType(TypedDict):
         'non_editable': [],
         'content_template': _('<{p}><{strong}>{replier_name}</{strong}> responded to a post you’re following: '
                               '<{strong}>{post_title}</{strong}></{p}>'),
+        'grouped_content_template': _('<{p}><{strong}>{replier_name}</{strong}> and others responded to a post you’re '
+                                      'following: <{strong}>{post_title}</{strong}></{p}>'),
         'content_context': {
             'post_title': 'Post title',
             'replier_name': 'replier name',

openedx/core/djangoapps/notifications/grouping_notifications.py

@@ -106,6 +106,38 @@ def group(self, new_notification, old_notification):
         return content_context
 
 
+@NotificationRegistry.register('new_response')
+class NewResponseGrouper(BaseNotificationGrouper):
+    """
+    Grouper for new response on post.
+    """
+
+    def group(self, new_notification, old_notification):
+        """
+        Groups new ora staff notifications based on the xblock ID.
+        """
+        content_context = old_notification.content_context
+        content_context.setdefault("grouped", True)
+        content_context["replier_name"] = new_notification.content_context["replier_name"]
+        return content_context
+
+
+@NotificationRegistry.register('response_on_followed_post')
+class NewResponseOnFollowedPostGrouper(BaseNotificationGrouper):
+    """
+    Grouper for new response on post.
+    """
+
+    def group(self, new_notification, old_notification):
+        """
+        Groups new ora staff notifications based on the xblock ID.
+        """
+        content_context = old_notification.content_context
+        content_context.setdefault("grouped", True)
+        content_context["replier_name"] = new_notification.content_context["replier_name"]
+        return content_context
+
+
 def group_user_notifications(new_notification: Notification, old_notification: Notification):
     """
     Groups user notification based on notification type and group_id

openedx/core/djangoapps/notifications/tests/test_notification_grouping.py

@@ -13,7 +13,7 @@
     BaseNotificationGrouper,
     NotificationRegistry,
     group_user_notifications,
-    get_user_existing_notifications, NewPostGrouper
+    get_user_existing_notifications, NewPostGrouper, NewResponseGrouper, NewResponseOnFollowedPostGrouper
 )
 from openedx.core.djangoapps.notifications.models import Notification
 from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
@@ -98,12 +98,13 @@ class TestGroupUserNotifications(ModuleStoreTestCase):
     """
 
     @patch('openedx.core.djangoapps.notifications.grouping_notifications.NotificationRegistry.get_grouper')
-    def test_group_user_notifications(self, mock_get_grouper):
+    @ddt.data(NewPostGrouper, NewResponseGrouper, NewResponseOnFollowedPostGrouper)
+    def test_group_user_notifications(self, grouper_class, mock_get_grouper):
         """
-        Test that the function groups notifications using the appropriate grou
+        Test that the function groups notifications using the appropriate grouping class
         """
         # Mock the grouper
-        mock_grouper = MagicMock(spec=NewPostGrouper)
+        mock_grouper = MagicMock(spec=grouper_class)
         mock_get_grouper.return_value = mock_grouper
 
         new_notification = MagicMock(spec=Notification)