[ST-1553] apps/notifications: Fix email template rendering (#3033)

Author: shn-liqd

CHANGELOG.md

@@ -16,7 +16,7 @@ This project (not yet) adheres to [Semantic Versioning](https://semver.org/spec/
 ### Fixed
 
 - Fix duplicate notifications bug
-- Fix translation of ProjectCompleted email subject
+- Fix email variable interpolation
 
 ### Fixed
 

apps/notifications/services.py

@@ -44,7 +44,26 @@ def render(self, template_name, context):
                         site_name=(
                             context.get("site", "").name if context.get("site") else ""
                         ),
-                        project_name=context.get("project"),
+                        event_name=context.get("event_name"),
+                        project_name=context.get("project_name"),
+                        project_type=context.get("project_type"),
+                        article=context.get("article", ""),
+                        content_type_display=context.get("content_type_display", ""),
+                        commenter_name=context.get("commenter_name", ""),
+                        post_name=context.get("post_name", ""),
+                    )
+                if "headline" in context:
+                    context["headline"] = context["headline"].format(
+                        project_name=context.get(
+                            "project_name", context.get("project_name", "")
+                        ),
+                        project_type=context.get("project_type", ""),
+                        organisation_name=context.get("organisation_name", ""),
+                        article=context.get("article", ""),
+                        article_lower=context.get("article_lower", ""),
+                        content_type=context.get("content_type", ""),
+                        content_type_display=context.get("content_type_display", ""),
+                        creator_name=context.get("creator_name", ""),
                     )
                 if "greeting" in context:
                     context["greeting"] = context["greeting"].format(

apps/notifications/strategies/comment_strategies.py

@@ -30,9 +30,7 @@ def create_notification_data(self, comment) -> dict:
 
         email_context = {
             "subject": _("A moderator highlighted your comment"),
-            "headline": _("Project {project_name}").format(
-                project_name=comment.project.name
-            ),
+            "headline": _("Project {project_name}"),
             "cta_url": cta_url,
             "cta_label": cta_label,
             "reason": _(
@@ -42,6 +40,7 @@ def create_notification_data(self, comment) -> dict:
             "content_template": "a4_candy_notifications/emails/content/moderator_highlighted_comment.en.email",
             # Template variables
             "project": comment.project.name,
+            "project_name": comment.project.name,
             "project_url": comment.project.get_absolute_url(),
             "post_url": post_url,
         }
@@ -84,9 +83,7 @@ def create_notification_data(self, comment) -> dict:
         post_name = getattr(comment.content_object, "name", _("post"))
 
         email_context = {
-            "subject": _("{commenter} commented on your post {post}").format(
-                commenter=comment.creator.username, post=post_name
-            ),
+            "subject": _("{commenter_name} commented on your post {post_name}"),
             "headline": _("New comment on your post"),
             "subheadline": comment.project.name,
             "cta_url": comment.content_object.get_absolute_url(),
@@ -144,9 +141,7 @@ def create_notification_data(self, comment) -> dict:
         parent_comment = self._get_parent_comment(comment)
 
         email_context = {
-            "subject": _("{commenter} replied to your comment").format(
-                commenter=comment.creator.username
-            ),
+            "subject": _("{commenter_name} replied to your comment"),
             "headline": _("New reply to your comment"),
             "subheadline": comment.project.name,
             "cta_url": comment.get_absolute_url(),

apps/notifications/strategies/event_strategies.py

@@ -19,9 +19,7 @@ def get_recipients(self, event) -> list[User]:
 
     def create_notification_data(self, offline_event):
         email_context = {
-            "subject": _("Event added to project {project}").format(
-                project=offline_event.project.name
-            ),
+            "subject": _("Event added to project {project_name}"),
             "headline": _("Event"),
             "subheadline": offline_event.name,
             "cta_url": offline_event.get_absolute_url(),
@@ -33,6 +31,7 @@ def create_notification_data(self, offline_event):
             "content_template": "a4_candy_notifications/emails/content/event_added.en.email",
             # Template variables
             "project": offline_event.project.name,
+            "project_name": offline_event.project.name,
             "event": offline_event.name,
             "event_date": format_event_date(offline_event.date),
             "organisation": offline_event.project.organisation.name,
@@ -67,9 +66,7 @@ def get_recipients(self, event) -> list[User]:
 
     def create_notification_data(self, offline_event):
         email_context = {
-            "subject": _("Event {event} in project {project} cancelled").format(
-                event=offline_event.name, project=offline_event.project.name
-            ),
+            "subject": _("Event {event_name} in project {project_name} cancelled"),
             "headline": _("Event"),
             "subheadline": offline_event.name,
             "reason": _(
@@ -79,7 +76,9 @@ def create_notification_data(self, offline_event):
             "content_template": "a4_candy_notifications/emails/content/event_deleted.en.email",
             # Template variables
             "project": offline_event.project.name,
+            "project_name": offline_event.project.name,
             "event": offline_event.name,
+            "event_name": offline_event.name,
             "event_date": format_event_date(offline_event.date),
             "organisation": offline_event.project.organisation.name,
         }
@@ -112,9 +111,7 @@ def get_recipients(self, event) -> list[User]:
 
     def create_notification_data(self, offline_event):
         email_context = {
-            "subject": _("Event in project {project}").format(
-                project=offline_event.project.name
-            ),
+            "subject": _("Event in project {project_name}"),
             "headline": _("Event"),
             "subheadline": offline_event.name,
             "cta_url": offline_event.get_absolute_url(),
@@ -126,6 +123,7 @@ def create_notification_data(self, offline_event):
             "content_template": "a4_candy_notifications/emails/content/event_soon.en.email",
             # Template variables
             "project": offline_event.project.name,
+            "project_name": offline_event.project.name,
             "event": offline_event.name,
             "event_date": format_event_date(offline_event.date),
             "organisation": offline_event.project.organisation.name,
@@ -158,9 +156,7 @@ def get_recipients(self, event) -> list[User]:
 
     def create_notification_data(self, offline_event):
         email_context = {
-            "subject": _("Event {event} in project {project} updated").format(
-                event=offline_event.name, project=offline_event.project.name
-            ),
+            "subject": _("Event {event_name} in project {project_name} updated"),
             "headline": _("Event"),
             "subheadline": offline_event.name,
             "reason": _(
@@ -172,7 +168,9 @@ def create_notification_data(self, offline_event):
             "content_template": "a4_candy_notifications/emails/content/event_updated.en.email",
             # Template variables
             "project": offline_event.project.name,
+            "project_name": offline_event.project.name,
             "event": offline_event.name,
+            "event_name": offline_event.name,
             "event_date": format_event_date(offline_event.date),
             "organisation": offline_event.project.organisation.name,
         }

apps/notifications/strategies/moderation_strategies.py

@@ -27,9 +27,7 @@ def create_notification_data(self, feedback) -> dict:
             site_name = ""
 
         email_context = {
-            "subject": _("Feedback for your contribution on {site_name}").format(
-                site_name=site_name
-            ),
+            "subject": _("Feedback for your contribution on {site_name}"),
             "headline": _("Feedback for your contribution"),
             "subheadline": project.name,
             "cta_url": user_comment.get_absolute_url(),
@@ -40,6 +38,7 @@ def create_notification_data(self, feedback) -> dict:
             "content_template": "a4_candy_notifications/emails/content/moderator_feedback_on_comment.en.email",
             # Template variables
             "project": project,
+            "site_name": site_name,
             "organisation": project.organisation.name,
             "organisation_name": project.organisation.name,
             "moderator_feedback": feedback.feedback_text,

apps/notifications/strategies/project_strategies.py

@@ -67,9 +67,7 @@ def create_notification_data(self, project) -> dict:
         )
 
         email_context = {
-            "subject": _("Here we go: {project_name} starts now!").format(
-                project_name=project.name
-            ),
+            "subject": _("Here we go: {project_name} starts now!"),
             "headline": _("Here we go!"),
             "subheadline": project.name,
             "cta_url": project.get_absolute_url(),
@@ -101,17 +99,15 @@ def get_recipients(self, project) -> List[User]:
 
     def create_notification_data(self, project) -> dict:
         email_context = {
-            "subject": _("{project_name} has completed.").format(
-                project_name=project.name
-            ),
+            "subject": _("{project_name} has completed."),
             "subheadline": project.name,
             "cta_url": project.get_absolute_url(),
             "cta_label": _("View now"),
             "reason": _(
                 "This email was sent to {receiver_email}. You have received the e-mail because you are following the above project."
             ),
             "content_template": "a4_candy_notifications/emails/content/project_ended.en.email",
-            "project": project.name,
+            "project_name": project.name,
         }
 
         return {
@@ -146,12 +142,8 @@ def create_notification_data(self, invitation) -> dict:
         project_type = "semi-public" if is_semipublic else "private"
 
         email_context = {
-            "subject": _(
-                "Invitation to the {project_type} project: {project_name}"
-            ).format(project_type=project_type, project_name=project.name),
-            "headline": _(
-                'Invitation to the {project_type} project: "{project_name}"'
-            ).format(project_type=project_type, project_name=project.name),
+            "subject": _("Invitation to the {project_type} project: {project_name}"),
+            "headline": _('Invitation to the {project_type} project: "{project_name}"'),
             "cta_url": f"{invitation.get_absolute_url()}",
             "cta_label": _("Accept invitation"),
             "reason": _("This email was sent to {receiver_email}."),
@@ -194,19 +186,14 @@ def get_recipients(self, invitation) -> List[User]:
     def create_notification_data(self, invitation) -> dict:
         project = invitation.project
         email_context = {
-            "subject": _("Moderator invitation for project {project_name}").format(
-                project_name=project.name
-            ),
+            "subject": _("Moderator invitation for project {project_name}"),
             "headline": _("Moderator Invitation"),
             "cta_url": invitation.get_absolute_url(),
             "cta_label": _("View Invitation"),
             "reason": _("This email was sent to {receiver_email}."),
             "content_template": "a4_candy_notifications/emails/content/project_moderation_invitation.en.email",
             "project_name": project.name,
         }
-        translated = _(
-            "You have been invited to be a moderator of project {project_name}. View {invitation}"
-        )
         return {
             "notification_type": NotificationType.PROJECT_MODERATION_INVITATION,
             "message_template": "You have been invited to be a moderator of project {project_name}. View {invitation}",
@@ -218,7 +205,6 @@ def create_notification_data(self, invitation) -> dict:
                 "invitation": "invitation",
                 "invitation_url": invitation.get_absolute_url(),
                 "project_url": None,  # Explicitly no project link
-                "irrelevant": translated,  # translation hack, to remove
             },
             "email_context": email_context,
         }
@@ -233,8 +219,6 @@ def create_notification_data(self, project) -> dict:
             "subject": _("New project {project_name} on {site_name}"),
             "headline": _(
                 "The new project {project_name} was created for {organisation_name}"
-            ).format(
-                project_name=project.name, organisation_name=project.organisation.name
             ),
             "cta_url": project.get_absolute_url(),
             "cta_label": _("Show project"),
@@ -270,16 +254,15 @@ def get_recipients(self, project) -> List[User]:
     def create_notification_data(self, project) -> dict:
         email_context = {
             "subject": _("Deletion of project"),
-            "headline": _("The project {project} was deleted.").format(
-                project=project.name
-            ),
+            "headline": _("The project {project_name} was deleted."),
             "reason": _(
                 "This email was sent to {receiver_email}. This email was sent to you because you are an initiator of the organisation '{organisation_name}', in which a project was deleted."
             ),
             # Content template
             "content_template": "a4_candy_notifications/emails/content/project_deleted.en.email",
             # Template variables
             "project": project.name,
+            "project_name": project.name,
             "organisation": project.organisation.name,
             "site": project.organisation.site,
         }
@@ -318,30 +301,22 @@ def create_notification_data(self, obj) -> dict:
             content_type_article = "An"
         email_context = {
             "subject": _(
-                "{article} {content_type} was added to the project {project}"
-            ).format(
-                article=content_type_article,
-                content_type=content_type_display,
-                project=obj.project.name,
+                "{article} {content_type_display} was added to the project {project_name}"
             ),
             "headline": _(
-                "{creator_name} created {article} {content_type} on the project {project}"
-            ).format(
-                article=content_type_article.lower(),
-                creator_name=obj.creator.username,
-                content_type=content_type_display,
-                project=obj.project.name,
+                "{creator_name} created {article_lower} {content_type_display} on the project {project_name}"
             ),
             "cta_url": obj.get_absolute_url(),
-            "cta_label": _("Check the {content_type}").format(
-                content_type=content_type_display
-            ),
+            "cta_label": _("Check the {content_type_display}"),
             "reason": _(
                 "This email was sent to {receiver_email}. This email was sent to you because you are a moderator in the project."
             ),
             # Content template
             "content_template": "a4_candy_notifications/emails/content/user_content_created.en.email",
             # Template variables
+            "article": content_type_article,
+            "article_lower": content_type_article.lower(),
+            "project_name": obj.project.name,
             "project": obj.project.name,
             "creator_name": obj.creator.username,
             "content_type": content_type.lower(),

apps/users/emails.py

@@ -26,8 +26,18 @@ class EmailAplus(Email):
     def get_languages(self, receiver):
         languages = super().get_languages(receiver)
         organisation = self.get_organisation()
-        if User.objects.filter(email=receiver).exists():
-            languages.insert(0, User.objects.get(email=receiver).language)
+
+        # Handle User object
+        if isinstance(receiver, User):
+            user_lang = receiver.language
+        # Handle email string
+        elif isinstance(receiver, str) and User.objects.filter(email=receiver).exists():
+            user_lang = User.objects.get(email=receiver).language
+        else:
+            user_lang = None
+
+        if user_lang:
+            languages.insert(0, user_lang)
         elif organisation is not None:
             languages.insert(0, organisation.language)
         elif hasattr(settings, "DEFAULT_USER_LANGUAGE_CODE"):