Open source video conferencing app powered by LiveKit. Built with Django and React.
⚡️(backend) send recording notification emails from a Celery task
lebaudantoine0194f7f3f344
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 6ce55224..16bf673e 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -12,6 +12,7 @@ and this project adheres to- ✨(frontend) let users pick the recording encoding- ✨(backend) introduce a token exchange endpoint for iframe embeds+- ⚡️(backend) send recording notification emails from a Celery task### Changeddiff --git a/docs/installation/compose.md b/docs/installation/compose.mdindex 75f11c81..411ed1f9 100644--- a/docs/installation/compose.md+++ b/docs/installation/compose.md@@ -113,6 +113,7 @@ DJANGO_EMAIL_FROM=<your email address>#DJANGO_EMAIL_USE_TLS=true # A flag to enable or disable TLS for email sending.#DJANGO_EMAIL_USE_SSL=true # A flag to enable or disable SSL for email sending.+#DJANGO_EMAIL_TIMEOUT=30 # Seconds before a stalled SMTP connection times out.DJANGO_EMAIL_BRAND_NAME=<brand name used in email templates> # e.g. "La Suite Numérique"diff --git a/docs/installation/kubernetes.md b/docs/installation/kubernetes.mdindex 414f3c32..008cac6d 100644--- a/docs/installation/kubernetes.md+++ b/docs/installation/kubernetes.md@@ -357,6 +357,7 @@ These are the environmental options available on meet backend.| DJANGO_EMAIL_PORT | Port to connect to the email server | || DJANGO_EMAIL_USE_TLS | Enable TLS on email connection | false || DJANGO_EMAIL_USE_SSL | Enable SSL on email connection | false |+| DJANGO_EMAIL_TIMEOUT | Seconds before a stalled SMTP connection times out | 30 || DJANGO_EMAIL_FROM | Email from account | [email protected] || EMAIL_BRAND_NAME | Email branding name | || EMAIL_SUPPORT_EMAIL | Support email address | |diff --git a/src/backend/core/recording/event/notification.py b/src/backend/core/recording/event/notification.pyindex 81624b1a..9d0c7602 100644--- a/src/backend/core/recording/event/notification.py+++ b/src/backend/core/recording/event/notification.py@@ -7,18 +7,18 @@ from datetime import datetime, timezonefrom zoneinfo import ZoneInfo, ZoneInfoNotFoundErrorfrom django.conf import settings-from django.core.mail import send_mail-from django.template.loader import render_to_string-from django.utils.translation import get_language, gettext, override+from django.utils.translation import get_language, gettext, gettext_noop, overridefrom django.utils.translation import gettext_lazy as _import aiohttpimport requestsfrom asgiref.sync import async_to_sync+from celery.exceptions import OperationalError as CeleryOperationalErrorfrom livekit import api as livekit_apifrom core import models, utilsfrom core.analytics import UserFeatureFlag, is_user_feature_flag_enabled+from core.tasks.mail import send_emailfrom core.utils import generate_download_s3_urllogger = logging.getLogger(__name__)@@ -68,10 +68,14 @@ class NotificationService:@staticmethoddef _notify_user_by_email(recording) -> bool:"""- Send an email notification to recording owners when their recording is ready.+ Queue an email notification to recording owners when their recording is ready.The email includes a direct link that redirects owners to a dedicated downloadpage in the frontend where they can access their specific recording.++ Rendering and SMTP delivery happen in a Celery worker (``send_email``), so+ this only does one DB query and enqueues one message per owner.+ Returns True when every email was queued (or sent, if Celery is disabled)."""owner_accesses = (@@ -88,10 +92,6 @@ class NotificationService:return Falsecontext = {- "brandname": settings.EMAIL_BRAND_NAME,- "support_email": settings.EMAIL_SUPPORT_EMAIL,- "logo_img": settings.EMAIL_LOGO_IMG,- "domain": settings.EMAIL_DOMAIN,"room_name": recording.room.name,"recording_expiration_days": settings.RECORDING_EXPIRATION_DAYS,"link": f"{get_recording_download_base_url()}/{recording.id}",@@ -104,37 +104,22 @@ class NotificationService:# 2. The number of recipients per recording is typically small (not thousands)for access in owner_accesses:user = access.user- language = user.language or get_language()- with override(language):- personalized_context = {- "recording_date": recording.created_at.astimezone(- user.timezone- ).strftime("%Y-%m-%d"),- "recording_time": recording.created_at.astimezone(- user.timezone- ).strftime("%H:%M"),- **context,- }- msg_html = render_to_string(- "mail/html/screen_recording.html", personalized_context- )- msg_plain = render_to_string(- "mail/text/screen_recording.txt", personalized_context+ local_created_at = recording.created_at.astimezone(user.timezone)+ try:+ send_email.delay(+ template="screen_recording",+ subject=gettext_noop("Your recording is ready"),+ recipients=[user.email],+ language=user.language or get_language(),+ context={+ **context,+ "recording_date": local_created_at.strftime("%Y-%m-%d"),+ "recording_time": local_created_at.strftime("%H:%M"),+ },)- subject = gettext("Your recording is ready") # Force translation-- try:- send_mail(- subject.capitalize(),- msg_plain,- settings.EMAIL_FROM,- [user.email],- html_message=msg_html,- fail_silently=False,- )- except smtplib.SMTPException as exception:- logger.error("notification could not be sent: %s", exception)- has_failures = True+ except (smtplib.SMTPException, CeleryOperationalError) as exception:+ logger.error("notification could not be sent: %s", exception)+ has_failures = Truereturn not has_failuresdiff --git a/src/backend/core/tasks/__init__.py b/src/backend/core/tasks/__init__.pyindex b433db5f..9c6e2913 100644--- a/src/backend/core/tasks/__init__.py+++ b/src/backend/core/tasks/__init__.py@@ -2,8 +2,10 @@from core.tasks.connection_test import delete_connection_test_roomfrom core.tasks.file import process_file_deletion+from core.tasks.mail import send_email__all__ = ("delete_connection_test_room","process_file_deletion",+ "send_email",)diff --git a/src/backend/core/tasks/mail.py b/src/backend/core/tasks/mail.pynew file mode 100644index 00000000..ecec4c27--- /dev/null+++ b/src/backend/core/tasks/mail.py@@ -0,0 +1,74 @@+"""Send mail using celery task."""++import logging+import smtplib++from django.conf import settings+from django.core.mail import send_mail+from django.template.loader import render_to_string+from django.utils.translation import get_language, gettext, override++from core.tasks._task import task++logger = logging.getLogger(__name__)+++def get_base_email_context() -> dict:+ """Context shared by every email template (branding, support, domain)."""+ return {+ "brandname": settings.EMAIL_BRAND_NAME,+ "support_email": settings.EMAIL_SUPPORT_EMAIL,+ "logo_img": settings.EMAIL_LOGO_IMG,+ "domain": settings.EMAIL_DOMAIN,+ }+++@task(+ autoretry_for=(smtplib.SMTPException, ConnectionError, TimeoutError),+ retry_backoff=True,+ retry_backoff_max=600,+ retry_jitter=True,+ max_retries=5,+)+def send_email(+ *,+ template: str,+ subject: str,+ recipients: list[str],+ context: dict | None = None,+ language: str | None = None,+):+ """Render a mail template and send it.++ Generic on purpose: any feature can reuse it with its own template and context.++ Args:+ template: Template base name, e.g. "screen_recording". Both+ "mail/html/<template>.html" and "mail/text/<template>.txt" must exist.+ subject: Untranslated subject msgid. Mark it with ``gettext_noop`` at the+ call site; it is translated here, in ``language``.+ recipients: Email addresses, all receiving the same rendered message.+ context: Template context. Must be JSON-serializable (str, int, list, dict…):+ pre-format dates, cast UUIDs to str. Merged over the base branding context.+ language: Language to render the email in. Defaults to the active language.++ Raises:+ OSError: SMTP or network failure, after retries are exhausted (or+ immediately when Celery is disabled and the call runs synchronously).+ """+ full_context = {**get_base_email_context(), **(context or {})}++ with override(language or get_language()):+ msg_html = render_to_string(f"mail/html/{template}.html", full_context)+ msg_plain = render_to_string(f"mail/text/{template}.txt", full_context)+ translated_subject = gettext(subject)++ send_mail(+ translated_subject,+ msg_plain,+ settings.EMAIL_FROM,+ recipients,+ html_message=msg_html,+ fail_silently=False,+ )+ logger.info("Email '%s' sent to %d recipient(s)", template, len(recipients))diff --git a/src/backend/core/tests/recording/event/test_notification.py b/src/backend/core/tests/recording/event/test_notification.pyindex f40bb840..79433829 100644--- a/src/backend/core/tests/recording/event/test_notification.py+++ b/src/backend/core/tests/recording/event/test_notification.py@@ -12,6 +12,7 @@ from unittest import mockfrom django.contrib.sites.models import Siteimport pytest+from celery.exceptions import OperationalError as CeleryOperationalErrorfrom core import factories, modelsfrom core.analytics import UserFeatureFlag@@ -142,7 +143,7 @@ def test_notify_user_by_email_success(mocked_current_site, settings):notification_service = NotificationService()- with mock.patch("core.recording.event.notification.send_mail") as mock_send_mail:+ with mock.patch("core.tasks.mail.send_mail") as mock_send_mail:result = notification_service._notify_user_by_email(recording)assert result is True@@ -237,7 +238,7 @@ def test_notify_user_by_email_smtp_exception(mocked_current_site, caplog):notification_service = NotificationService()with mock.patch(- "core.recording.event.notification.send_mail",+ "core.tasks.mail.send_mail",side_effect=smtplib.SMTPException("SMTP Error"),) as mock_send_mail:result = notification_service._notify_user_by_email(recording)@@ -247,6 +248,60 @@ def test_notify_user_by_email_smtp_exception(mocked_current_site, caplog):assert "notification could not be sent:" in caplog.text+def test_notify_user_by_email_queues_generic_task(settings):+ """One generic send_email task is queued per owner, with serializable args."""+ settings.RECORDING_DOWNLOAD_BASE_URL = "https://acme.com/recordings"+ settings.RECORDING_EXPIRATION_DAYS = 7++ recording = factories.RecordingFactory(room__name="Conference Room A")+ recording.created_at = datetime.datetime(+ 2023, 5, 15, 14, 30, 0, tzinfo=datetime.timezone.utc+ )+ user = factories.UserFactory(+ email="[email protected]", language="fr-fr", timezone="Europe/Paris"+ )+ factories.UserRecordingAccessFactory(+ recording=recording, role=models.RoleChoices.OWNER, user=user+ )++ with mock.patch("core.recording.event.notification.send_email.delay") as mock_delay:+ result = notification_service._notify_user_by_email(recording)++ assert result is True+ mock_delay.assert_called_once_with(+ template="screen_recording",+ subject="Your recording is ready",+ recipients=["[email protected]"],+ language="fr-fr",+ context={+ "room_name": "Conference Room A",+ "recording_expiration_days": 7,+ "link": f"https://acme.com/recordings/{recording.id}",+ "recording_date": "2023-05-15",+ "recording_time": "16:30",+ },+ )+ # Celery's JSON serializer must accept every argument+ json.dumps(mock_delay.call_args.kwargs)+++def test_notify_user_by_email_broker_unavailable(caplog):+ """A broker outage is reported as a failure without crashing the caller."""+ recording = factories.RecordingFactory()+ factories.UserRecordingAccessFactory(+ recording=recording, role=models.RoleChoices.OWNER+ )++ with mock.patch(+ "core.recording.event.notification.send_email.delay",+ side_effect=CeleryOperationalError("broker down"),+ ):+ result = notification_service._notify_user_by_email(recording)++ assert result is False+ assert "notification could not be sent: broker down" in caplog.text++@mock.patch("core.recording.event.notification.requests.post")@mock.patch("core.recording.event.notification.generate_download_s3_url")@mock.patch.object(diff --git a/src/backend/core/tests/tasks/test_mail.py b/src/backend/core/tests/tasks/test_mail.pynew file mode 100644index 00000000..f0b0dc8a--- /dev/null+++ b/src/backend/core/tests/tasks/test_mail.py@@ -0,0 +1,98 @@+"""Tests for the generic send_email task."""++# pylint: disable=unused-argument,redefined-outer-name++import smtplib+from unittest import mock++from django.core.mail import get_connection+from django.utils.translation import gettext_noop++import pytest++from core.tasks.mail import send_email+++def email_settings(settings):+ """Branding settings shared by every email."""+ settings.EMAIL_BRAND_NAME = "ACME"+ settings.EMAIL_SUPPORT_EMAIL = "[email protected]"+ settings.EMAIL_LOGO_IMG = "https://acme.com/logo"+ settings.EMAIL_DOMAIN = "acme.com"+ settings.EMAIL_FROM = "[email protected]"+ return settings++[email protected]("core.tasks.mail.send_mail")[email protected]("core.tasks.mail.render_to_string", side_effect=["<p>html</p>", "text"])+def test_send_email_renders_template_and_sends(+ mock_render, mock_send_mail, email_settings+):+ """Both template variants are rendered with base + caller context, then sent."""+ send_email(+ template="some_template",+ subject="Any subject",+ recipients=["[email protected]", "[email protected]"],+ context={"foo": "bar", "brandname": "Overridden"},+ )++ expected_context = {+ "brandname": "Overridden",+ "support_email": "[email protected]",+ "logo_img": "https://acme.com/logo",+ "domain": "acme.com",+ "foo": "bar",+ }+ assert mock_render.call_args_list == [+ mock.call("mail/html/some_template.html", expected_context),+ mock.call("mail/text/some_template.txt", expected_context),+ ]+ mock_send_mail.assert_called_once_with(+ "Any subject",+ "text",+ "[email protected]",+ ["[email protected]", "[email protected]"],+ html_message="<p>html</p>",+ fail_silently=False,+ )++[email protected]("core.tasks.mail.send_mail")+def test_send_email_translates_subject_in_requested_language(+ mock_send_mail, email_settings+):+ """The subject msgid is translated in the worker, in the recipient language."""+ send_email(+ template="screen_recording",+ subject=gettext_noop("Your recording is ready"),+ recipients=["[email protected]"],+ context={"room_name": "Room", "link": "https://acme.com/r/1"},+ language="fr-fr",+ )++ subject, body, *_ = mock_send_mail.call_args[0]+ assert subject == "Votre enregistrement est prêt"+ assert "Votre enregistrement est prêt !" in body+++ "core.tasks.mail.send_mail", side_effect=smtplib.SMTPException("SMTP Error")+)[email protected]("core.tasks.mail.render_to_string", return_value="content")+def test_send_email_raises_on_smtp_error(mock_render, mock_send_mail, email_settings):+ """SMTP errors propagate so Celery can retry the task."""+ with pytest.raises(smtplib.SMTPException):+ send_email(+ template="some_template",+ subject="Any subject",+ recipients=["[email protected]"],+ )+++def test_smtp_backend_uses_email_timeout(settings):+ """A stalled SMTP server cannot hold the worker forever."""+ settings.EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"+ settings.EMAIL_TIMEOUT = 12++ assert get_connection().timeout == 12diff --git a/src/backend/meet/settings.py b/src/backend/meet/settings.pyindex ea285c5d..b1cfd404 100755--- a/src/backend/meet/settings.py+++ b/src/backend/meet/settings.py@@ -508,6 +508,7 @@ class Base(Configuration):EMAIL_PORT = values.PositiveIntegerValue(None)EMAIL_USE_TLS = values.BooleanValue(False)EMAIL_USE_SSL = values.BooleanValue(False)+ EMAIL_TIMEOUT = values.PositiveIntegerValue(30)EMAIL_FROM = values.Value("[email protected]")EMAIL_BRAND_NAME = values.Value(None)EMAIL_SUPPORT_EMAIL = values.Value(None)