Preview moderation emails on the admin pages

Author: marcospri

h/routes.py

@@ -58,6 +58,10 @@ def includeme(config):  # noqa: PLR0915
         "admin.email.preview.mention_notification",
         "/admin/email/preview/mention-notification",
     )
+    config.add_route(
+        "admin.email.preview.moderated_annotation_notification",
+        "/admin/email/preview/moderated-annotation-notification",
+    )
     config.add_route("admin.nipsa", "/admin/nipsa")
     config.add_route("admin.oauthclients", "/admin/oauthclients")
     config.add_route("admin.oauthclients_create", "/admin/oauthclients/new")

h/services/annotation_moderation.py

@@ -1,10 +1,30 @@
+from dataclasses import asdict
+
+from h_pyramid_sentry import report_exception
+from kombu.exceptions import OperationalError
+from pyramid.renderers import render
+
+from h import links
 from h.events import AnnotationAction
-from h.models import Annotation, ModerationLog, ModerationStatus, User
+from h.models import Annotation, ModerationLog, ModerationStatus, Subscriptions, User
+from h.services.email import EmailData, EmailTag, TaskData
+from h.services.subscription import SubscriptionService
+from h.services.user import UserService
+from h.tasks import email
 
 
 class AnnotationModerationService:
-    def __init__(self, session):
+    def __init__(
+        self,
+        session,
+        user_service: UserService,
+        subscription_service: SubscriptionService,
+        email_subaccount: str | None = None,
+    ):
         self._session = session
+        self._user_service = user_service
+        self._subscription_service = subscription_service
+        self._email_subaccount = email_subaccount
 
     def all_hidden(self, annotation_ids: str) -> set[str]:
         """
@@ -45,6 +65,8 @@ def set_status(
 
             return moderation_log
 
+        return None
+
     def update_status(self, action: AnnotationAction, annotation: Annotation) -> None:
         """Change the moderation status of an annotation based on the action taken."""
         new_status = None
@@ -80,6 +102,133 @@ def update_status(self, action: AnnotationAction, annotation: Annotation) -> Non
 
         self.set_status(annotation, new_status)
 
+    def queue_moderation_change_email(
+        self, request, moderation_log: ModerationLog
+    ) -> None:
+        """Queue an email to be sent to the user about moderation changes on their annotations."""
+
+        annotation = moderation_log.annotation
+        group = annotation.group
+        author = self._user_service.fetch(annotation.userid)
+
+        if not group.pre_moderated:
+            # We'll start only sending these emails for pre-moderated groups
+            # For now this ties these emails to the FF for moderation emails
+            return
+
+        if not author or not author.email:
+            return
+
+        # If there is no active 'moderated' subscription for the user being mentioned.
+        if not self._subscription_service.get_subscription(
+            user_id=author.userid, type_=Subscriptions.Type.MODERATED
+        ).active:
+            return
+
+        old_status = moderation_log.old_moderation_status
+        new_status = moderation_log.new_moderation_status
+
+        # These are the transitions that will trigger an email to be sent
+        email_sending_status_changes = {
+            (ModerationStatus.PENDING, ModerationStatus.APPROVED),
+            (ModerationStatus.PENDING, ModerationStatus.DENIED),
+            (ModerationStatus.APPROVED, ModerationStatus.PENDING),
+            (ModerationStatus.APPROVED, ModerationStatus.DENIED),
+            (ModerationStatus.DENIED, ModerationStatus.APPROVED),
+            (ModerationStatus.SPAM, ModerationStatus.APPROVED),
+        }
+        if (old_status, new_status) not in email_sending_status_changes:
+            return
+
+        unsubscribe_token = self._subscription_service.get_unsubscribe_token(
+            user_id=author.userid, type_=Subscriptions.Type.MODERATED
+        )
+        subject = self._email_subject(group, new_status)
+        status_change_description = self.email_status_change_description(
+            group, new_status
+        )
+        context = {
+            "user_display_name": author.display_name or f"@{author.username}",
+            "annotation_url": links.incontext_link(request, annotation)
+            or request.route_url("annotation", id=annotation.id),
+            "annotation": annotation,
+            "annotation_quote": annotation.quote,
+            "app_url": request.registry.settings.get("h.app_url"),
+            "unsubscribe_url": request.route_url(
+                "unsubscribe",
+                token=unsubscribe_token,
+            ),
+            "preferences_url": request.route_url("account_notifications"),
+            "status_change_description": status_change_description,
+        }
+
+        text = render(
+            "h:templates/emails/mention_notification.txt.jinja2",
+            context,
+            request=request,
+        )
+        html = render(
+            "h:templates/emails/mention_notification.html.jinja2",
+            context,
+            request=request,
+        )
+
+        email_data = EmailData(
+            recipients=[author.email],
+            subject=subject,
+            body=text,
+            tag=EmailTag.MODERATED,
+            html=html,
+            subaccount=self._email_subaccount,
+        )
+        task_data = TaskData(
+            tag=email_data.tag,
+            sender_id=author.id,
+            recipient_ids=[author.id],
+            extra={"annotation_id": annotation.id},
+        )
+        try:
+            email.send.delay(asdict(email_data), asdict(task_data))
+        except OperationalError as err:  # pragma: no cover
+            report_exception(err)
+
+    @staticmethod
+    def email_subject(group_name: str, new_status: ModerationStatus) -> str:
+        """Generate the email subject based on the moderation status change."""
+        if new_status == ModerationStatus.DENIED:
+            return f"Your comment  in {group_name} has been declined"
+
+        if new_status == ModerationStatus.APPROVED:
+            return f"Your comment in {group_name} has been approved"
+
+        msg = f"Unexpected moderation status change to {new_status}"
+        raise ValueError(msg)
+
+    @staticmethod
+    def email_status_change_description(
+        group_name: str, new_status: ModerationStatus
+    ) -> str:
+        if new_status == ModerationStatus.DENIED:
+            return f"""The following comment has been declined by the moderation team for {group_name}.
+            You can edit this comment and it will be reevaluated by that group's moderators."""
+
+        if new_status == ModerationStatus.PENDING:
+            return f"""The following comment has been hidden by the moderation team for {group_name} and is only visible to that group's moderators and yourself.
+            You'll receive another email when your comment's moderation status changes."""
+        if new_status == ModerationStatus.APPROVED:
+            return f"""The following comment has been approved by the moderation team for {group_name}.
+            It's now visible to everyone viewing that group."""
+
+        msg = f"Unexpected moderation status change description for {new_status}"
+        raise ValueError(msg)
+
 
 def annotation_moderation_service_factory(_context, request):
-    return AnnotationModerationService(request.db)
+    return AnnotationModerationService(
+        request.db,
+        user_service=request.find_service(name="user"),
+        subscription_service=request.find_service(name="subscription_service"),
+        email_subaccount=request.registry.settings.get(
+            "mailchimp_user_actions_subaccount"
+        ),
+    )

h/subscribers.py

@@ -6,7 +6,7 @@
 from pyramid.events import BeforeRender, subscriber
 
 from h import __version__, emails
-from h.events import AnnotationEvent
+from h.events import AnnotationEvent, ModeratedAnnotationEvent
 from h.exceptions import RealtimeMessageQueueError
 from h.models.notification import NotificationType
 from h.notification import mention, reply
@@ -178,3 +178,10 @@ def publish_annotation_event_for_authority(event):
     annotations.publish_annotation_event_for_authority.delay(
         event.action, event.annotation_id
     )
+
+
+@subscriber(ModeratedAnnotationEvent)
+def send_moderation_notification(event: ModeratedAnnotationEvent) -> None:
+    event.request.find_service(
+        name="annotation_moderation"
+    ).queue_moderation_change_email(event.moderation_log)

h/views/admin/email.py

@@ -4,7 +4,9 @@
 from pyramid.view import view_config
 
 from h.emails import test
+from h.models.annotation import ModerationStatus
 from h.security import Permission
+from h.services.annotation_moderation import AnnotationModerationService
 from h.services.email import TaskData
 from h.tasks import email
 
@@ -57,3 +59,22 @@ def preview_mention_notification(_request):
         },
         "annotation_quote": "This is a very important text",
     }
+
+
+@view_config(
+    route_name="admin.email.preview.moderated_annotation_notification",
+    request_method="GET",
+    permission=Permission.AdminPage.LOW_RISK,
+    renderer="h:templates/emails/moderated_annotation_notification.html.jinja2",
+)
+def preview_moderated_annotation_notification(_request):
+    return {
+        "user_display_name": "Jane Doe",
+        "status_change_description": AnnotationModerationService.email_status_change_description(
+            "GROUP NAME", ModerationStatus.APPROVED
+        ),
+        "annotation_url": "https://example.com/bouncer",  # Bouncer link (AKA: annotation deeplink)
+        "annotation": {
+            "text_rendered": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla tincidunt malesuada ex, id dictum risus posuere sed. Curabitur risus lectus, aliquam vel tempus ut, tempus non risus. Duis ac nibh lacinia, lacinia leo sit amet, lacinia tortor. Vestibulum dictum maximus lorem, nec lobortis augue ullamcorper nec. Ut ac viverra nisi. Nam congue neque eu mi viverra ultricies. Integer pretium odio nulla, at semper dolor tincidunt quis. Pellentesque suscipit magna nec nunc mollis, a interdum purus aliquam.",
+        },
+    }

tests/unit/h/services/annotation_moderation_test.py

@@ -1,3 +1,4 @@
+from unittest.mock import sentinel
 import pytest
 
 from h.models.annotation import ModerationStatus
@@ -202,11 +203,17 @@ def user(self, factories, db_session):
 
 
 @pytest.fixture
-def svc(db_session):
-    return AnnotationModerationService(db_session)
+def svc(db_session, user_service, subscription_service):
+    return AnnotationModerationService(
+        db_session,
+        user_service=user_service,
+        subscription_service=subscription_service,
+        email_subaccount=sentinel.email_subaccount,
+    )
 
 
 class TestAnnotationModerationServiceFactory:
+    @pytest.mark.usefixtures("user_service", "subscription_service")
     def test_it_returns_service(self, pyramid_request):
         svc = annotation_moderation_service_factory(None, pyramid_request)
         assert isinstance(svc, AnnotationModerationService)