Open source video conferencing app powered by LiveKit. Built with Django and React.
✨(backend) personalize recording notification emails by user preferences
lebaudantoine986b75ba394b
diff --git a/src/backend/core/recording/event/notification.py b/src/backend/core/recording/event/notification.pyindex 9c01c270..ca6ff480 100644--- a/src/backend/core/recording/event/notification.py+++ b/src/backend/core/recording/event/notification.py@@ -44,49 +44,68 @@ class NotificationService:page in the frontend where they can access their specific recording."""- owner_accesses = models.RecordingAccess.objects.select_related("user").filter(- role=models.RoleChoices.OWNER,- recording_id=recording.id,+ owner_accesses = (+ models.RecordingAccess.objects.select_related("user")+ .filter(+ role=models.RoleChoices.OWNER,+ recording_id=recording.id,+ )+ .order_by("created_at"))if not owner_accesses:logger.error("No owner found for recording %s", recording.id)return False- language = get_language()-context = {"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_date": recording.created_at.strftime("%A %d %B %Y"),- "recording_time": recording.created_at.strftime("%H:%M"),"link": f"{settings.SCREEN_RECORDING_BASE_URL}/{recording.id}",}- emails = [access.user.email for access in owner_accesses]-- with override(language):- msg_html = render_to_string("mail/html/screen_recording.html", context)- msg_plain = render_to_string("mail/text/screen_recording.txt", context)- subject = str(_("Your recording is ready")) # Force translation-- try:- send_mail(- subject.capitalize(),- msg_plain,- settings.EMAIL_FROM,- emails,- html_message=msg_html,- fail_silently=False,+ has_failures = False++ # We process emails individually rather than in batch because:+ # 1. Each email requires personalization (timezone, language)+ # 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)- except smtplib.SMTPException as exception:- logger.error("notification could not be sent: %s", exception)- return False-- return True+ msg_plain = render_to_string(+ "mail/text/screen_recording.txt", personalized_context+ )+ subject = str(_("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++ return not has_failures@staticmethoddef _notify_summary_service(recording):diff --git a/src/backend/core/tests/recording/event/test_notification.py b/src/backend/core/tests/recording/event/test_notification.pyindex 7c56af53..641e081e 100644--- a/src/backend/core/tests/recording/event/test_notification.py+++ b/src/backend/core/tests/recording/event/test_notification.py@@ -4,6 +4,7 @@ Test event notification.# pylint: disable=E1128,W0621,W0613,W0212+import datetimeimport smtplibfrom unittest import mock@@ -74,6 +75,7 @@ def test_notify_external_services_unknown_mode(caplog):assert f"Unknown recording mode unknown for recording {recording.id}" in caplog.text+# pylint: disable=too-many-localsdef test_notify_user_by_email_success(mocked_current_site, settings):"""Test successful email notification to recording owners."""settings.EMAIL_BRAND_NAME = "ACME"@@ -84,15 +86,28 @@ def test_notify_user_by_email_success(mocked_current_site, settings):recording = factories.RecordingFactory(room__name="Conference Room A")- owners = [- factories.UserRecordingAccessFactory(- recording=recording, role=models.RoleChoices.OWNER- ).user,- factories.UserRecordingAccessFactory(- recording=recording, role=models.RoleChoices.OWNER- ).user,- ]- owner_emails = [owner.email for owner in owners]+ # Fix recording test to avoid flaky tests+ recording.created_at = datetime.datetime(2023, 5, 15, 14, 30, 0)++ french_user = factories.UserFactory(+ email="[email protected]", language="fr-fr", timezone="Europe/Paris"+ )+ dutch_user = factories.UserFactory(+ email="[email protected]", language="nl-nl", timezone="Europe/Amsterdam"+ )+ english_user = factories.UserFactory(+ email="[email protected]", language="en-us", timezone="America/Phoenix"+ )++ factories.UserRecordingAccessFactory(+ recording=recording, role=models.RoleChoices.OWNER, user=french_user+ )+ factories.UserRecordingAccessFactory(+ recording=recording, role=models.RoleChoices.OWNER, user=dutch_user+ )+ factories.UserRecordingAccessFactory(+ recording=recording, role=models.RoleChoices.OWNER, user=english_user+ )# Create non-owner users to verify they don't receive emailsfactories.UserRecordingAccessFactory(@@ -108,30 +123,69 @@ def test_notify_user_by_email_success(mocked_current_site, settings):result = notification_service._notify_user_by_email(recording)assert result is True- mock_send_mail.assert_called_once()-- subject, body, sender, recipients = mock_send_mail.call_args[0]+ assert mock_send_mail.call_count == 3- assert subject == "Your recording is ready"+ call_args_list = mock_send_mail.call_args_list- # Verify email contains expected content- required_content = [+ base_content = ["ACME", # Brand name"[email protected]", # Support email"https://acme.com/logo", # Logo URLf"https://acme.com/recordings/{recording.id}", # Recording link"Conference Room A", # Room name- recording.created_at.strftime("%A %d %B %Y"), # Formatted date- recording.created_at.strftime("%H:%M"), # Formatted time]- for content in required_content:- assert content in body+ # First call verification+ subject1, body1, sender1, recipients1 = call_args_list[0][0]+ assert subject1 == "Votre enregistrement est prêt"++ # Verify email contains expected content+ personalized_content1 = [+ *base_content,+ "2023-05-15", # Formatted date+ "16:30", # Formatted time+ "Votre enregistrement est prêt !", # Intro+ ]+ for content in personalized_content1:+ assert content in body1++ assert recipients1 == ["[email protected]"]+ assert sender1 == "[email protected]"++ # Second call verification+ subject2, body2, sender2, recipients2 = call_args_list[1][0]+ assert subject2 == "Je opname is klaar"++ # Verify second email content (if needed)+ personalized_content2 = [+ *base_content,+ "2023-05-15", # Formatted date+ "16:30", # Formatted time+ "Je opname is klaar!", # Intro+ ]+ for content in personalized_content2:+ assert content in body2++ assert recipients2 == ["[email protected]"]+ assert sender2 == "[email protected]"- assert sender == "[email protected]"+ # Third call verification+ subject3, body3, sender3, recipients3 = call_args_list[2][0]+ assert subject3 == "Your recording is ready"- # Verify all owners received the email (order-independent comparison)- assert sorted(recipients) == sorted(owner_emails)+ # Verify second email content (if needed)+ personalized_content3 = [+ *base_content,+ "Conference Room A", # Room name+ "2023-05-15", # Formatted date+ "07:30", # Formatted time+ "Your recording is ready!", # Intro+ ]+ for content in personalized_content3:+ assert content in body3++ assert recipients3 == ["[email protected]"]+ assert sender3 == "[email protected]"def test_notify_user_by_email_no_owners(mocked_current_site, caplog):@@ -153,6 +207,9 @@ def test_notify_user_by_email_smtp_exception(mocked_current_site, caplog):factories.UserRecordingAccessFactory(recording=recording, role=models.RoleChoices.OWNER)+ factories.UserRecordingAccessFactory(+ recording=recording, role=models.RoleChoices.OWNER+ )notification_service = NotificationService()@@ -163,5 +220,5 @@ def test_notify_user_by_email_smtp_exception(mocked_current_site, caplog):result = notification_service._notify_user_by_email(recording)assert result is False- mock_send_mail.assert_called_once()+ assert mock_send_mail.call_count == 2assert "notification could not be sent:" in caplog.text