This is an automated email from the ASF dual-hosted git repository.
elizabeth pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new 6575cacc5d feat(reports): allowing the email mutator to update
recipients (#27851)
6575cacc5d is described below
commit 6575cacc5d1cc59c7cacd9e186a1d05e76259183
Author: SkinnyPigeon <[email protected]>
AuthorDate: Wed May 29 03:03:42 2024 +0200
feat(reports): allowing the email mutator to update recipients (#27851)
---
superset/utils/core.py | 6 ++++++
tests/integration_tests/email_tests.py | 30 ++++++++++++++++++++++++++++++
2 files changed, 36 insertions(+)
diff --git a/superset/utils/core.py b/superset/utils/core.py
index 37a11ea7ff..0e485d749c 100644
--- a/superset/utils/core.py
+++ b/superset/utils/core.py
@@ -714,6 +714,7 @@ def send_email_smtp( # pylint:
disable=invalid-name,too-many-arguments,too-many
msg["CC"] = ", ".join(smtp_mail_cc)
recipients = recipients + smtp_mail_cc
+ smtp_mail_bcc = []
if bcc:
# don't add bcc in header
smtp_mail_bcc = get_email_address_list(bcc)
@@ -764,6 +765,11 @@ def send_email_smtp( # pylint:
disable=invalid-name,too-many-arguments,too-many
msg_mutator = config["EMAIL_HEADER_MUTATOR"]
# the base notification returns the message without any editing.
new_msg = msg_mutator(msg, **(header_data or {}))
+ new_to = new_msg["To"].split(", ") if "To" in new_msg else []
+ new_cc = new_msg["Cc"].split(", ") if "Cc" in new_msg else []
+ new_recipients = new_to + new_cc + smtp_mail_bcc
+ if set(new_recipients) != set(recipients):
+ recipients = new_recipients
send_mime_email(smtp_mail_from, recipients, new_msg, config, dryrun=dryrun)
diff --git a/tests/integration_tests/email_tests.py
b/tests/integration_tests/email_tests.py
index c8bc137062..12c2fc676b 100644
--- a/tests/integration_tests/email_tests.py
+++ b/tests/integration_tests/email_tests.py
@@ -90,6 +90,36 @@ class TestEmailSmtp(SupersetTestCase):
assert msg.get_payload()[-1].get_payload() == mimeapp.get_payload()
app.config["EMAIL_HEADER_MUTATOR"] = base_email_mutator
+ @mock.patch("superset.utils.core.send_mime_email")
+ def test_send_smtp_with_email_mutator_changing_recipients(self,
mock_send_mime):
+ attachment = tempfile.NamedTemporaryFile()
+ attachment.write(b"attachment")
+ attachment.seek(0)
+
+ # putting this into a variable so that we can reset after the test
+ base_email_mutator = app.config["EMAIL_HEADER_MUTATOR"]
+
+ def mutator(msg, **kwargs):
+ msg.replace_header("To", "mutated")
+ return msg
+
+ app.config["EMAIL_HEADER_MUTATOR"] = mutator
+ utils.send_email_smtp(
+ "to", "subject", "content", app.config, files=[attachment.name]
+ )
+ assert mock_send_mime.called
+ call_args = mock_send_mime.call_args[0]
+ logger.debug(call_args)
+ assert call_args[0] == app.config["SMTP_MAIL_FROM"]
+ assert call_args[1] == ["mutated"]
+ msg = call_args[2]
+ assert msg["Subject"] == "subject"
+ assert msg["From"] == app.config["SMTP_MAIL_FROM"]
+ assert len(msg.get_payload()) == 2
+ mimeapp = MIMEApplication("attachment")
+ assert msg.get_payload()[-1].get_payload() == mimeapp.get_payload()
+ app.config["EMAIL_HEADER_MUTATOR"] = base_email_mutator
+
@mock.patch("superset.utils.core.send_mime_email")
def test_send_smtp_data(self, mock_send_mime):
utils.send_email_smtp(
