From 87771e76ce92e12ae7500657e178a659cccf7701 Mon Sep 17 00:00:00 2001
From: Muhammad Adeel Tajamul
 <77053848+muhammadadeeltajamul@users.noreply.github.com>
Date: Mon, 23 Sep 2024 01:37:54 -0700
Subject: [PATCH] feat: replaced button and heading tags in email digest
 content (#35518)

---
 .../rest_api/discussions_notifications.py     | 14 ++++++++++
 .../tests/test_discussions_notifications.py   | 26 +++++++++++++++++++
 2 files changed, 40 insertions(+)

diff --git a/lms/djangoapps/discussion/rest_api/discussions_notifications.py b/lms/djangoapps/discussion/rest_api/discussions_notifications.py
index 25abcf80d4..f65faf7f2a 100644
--- a/lms/djangoapps/discussion/rest_api/discussions_notifications.py
+++ b/lms/djangoapps/discussion/rest_api/discussions_notifications.py
@@ -399,4 +399,18 @@ def clean_thread_html_body(html_body):
         for match in html_body.find_all(tag):
             match.unwrap()
 
+    # Replace tags that are not allowed in email
+    tags_to_update = [
+        {"source": "button", "target": "span"},
+        {"source": "h1", "target": "h4"},
+        {"source": "h2", "target": "h4"},
+        {"source": "h3", "target": "h4"},
+    ]
+    for tag_dict in tags_to_update:
+        for source_tag in html_body.find_all(tag_dict['source']):
+            target_tag = html_body.new_tag(tag_dict['target'], **source_tag.attrs)
+            if source_tag.string:
+                target_tag.string = source_tag.string
+            source_tag.replace_with(target_tag)
+
     return str(html_body)
diff --git a/lms/djangoapps/discussion/rest_api/tests/test_discussions_notifications.py b/lms/djangoapps/discussion/rest_api/tests/test_discussions_notifications.py
index f1a71fd123..d92e1000fe 100644
--- a/lms/djangoapps/discussion/rest_api/tests/test_discussions_notifications.py
+++ b/lms/djangoapps/discussion/rest_api/tests/test_discussions_notifications.py
@@ -168,3 +168,29 @@ class TestCleanThreadHtmlBody(unittest.TestCase):
 
         result = clean_thread_html_body(html_body)
         self.assertEqual(result.strip(), expected_output)
+
+    def test_button_tag_replace(self):
+        """
+        Tests that the clean_thread_html_body function replaces the button tag with span tag
+        """
+        # Tests for button replacement tag with text
+        html_body = '<button class="abc">Button</button>'
+        expected_output = '<span class="abc">Button</span>'
+        result = clean_thread_html_body(html_body)
+        self.assertEqual(result, expected_output)
+
+        # Tests button tag replacement without text
+        html_body = '<button class="abc"></button>'
+        expected_output = '<span class="abc"></span>'
+        result = clean_thread_html_body(html_body)
+        self.assertEqual(result, expected_output)
+
+    def test_heading_tag_replace(self):
+        """
+        Tests that the clean_thread_html_body function replaces the h1, h2 and h3 tags with h4 tag
+        """
+        for tag in ['h1', 'h2', 'h3']:
+            html_body = f'<{tag}>Heading</{tag}>'
+            expected_output = '<h4>Heading</h4>'
+            result = clean_thread_html_body(html_body)
+            self.assertEqual(result, expected_output)