Merge pull request #2648 from IFRCGo/project/alert-system-workflow

Project:Alert system workflow

Author: szabozoltan69

alert_system/__init__.py

@@ -0,0 +1,87 @@
+from django.contrib import admin
+
+from .models import AlertEmailLog, AlertEmailThread, Connector, ExtractionItem, LoadItem
+
+
+@admin.register(Connector)
+class ConnectorAdmin(admin.ModelAdmin):
+    list_display = ("id", "type", "last_success_run", "status")
+    readonly_fields = ("last_success_run",)
+
+
+@admin.register(ExtractionItem)
+class EventAdmin(admin.ModelAdmin):
+    list_display = (
+        "stac_id",
+        "created_at",
+        "collection",
+    )
+    list_filter = ("connector", "collection")
+    readonly_fields = ("connector",)
+    search_fields = ("stac_id",)
+
+
+@admin.register(LoadItem)
+class LoadItemAdmin(admin.ModelAdmin):
+    list_display = (
+        "id",
+        "event_title",
+        "created_at",
+        "event_id",
+        "item_eligible",
+        "is_past_event",
+    )
+    list_filter = (
+        "connector",
+        "item_eligible",
+        "is_past_event",
+    )
+    readonly_fields = (
+        "connector",
+        "item_eligible",
+        "related_montandon_events",
+        "related_go_events",
+    )
+    search_fields = ("id",)
+
+
+@admin.register(AlertEmailThread)
+class AlertEmailThreadAdmin(admin.ModelAdmin):
+    list_display = (
+        "user",
+        "parent_event_id",
+        "root_email_message_id",
+    )
+    search_fields = (
+        "parent_event_id",
+        "root_email_message_id",
+        "user__username",
+    )
+    list_select_related = ("user",)
+    autocomplete_fields = ("user",)
+
+
+@admin.register(AlertEmailLog)
+class AlertEmailLogAdmin(admin.ModelAdmin):
+    list_display = (
+        "id",
+        "message_id",
+        "status",
+    )
+    list_select_related = (
+        "user",
+        "subscription",
+        "item",
+        "thread",
+    )
+    search_fields = (
+        "user__username",
+        "message_id",
+    )
+    autocomplete_fields = (
+        "user",
+        "subscription",
+        "item",
+        "thread",
+    )
+    list_filter = ("status",)

alert_system/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AlertSystemConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "alert_system"

alert_system/apps.py

@@ -0,0 +1,75 @@
+from django.http import HttpResponse
+from django.template import loader
+from rest_framework import permissions
+from rest_framework.views import APIView
+
+
+class AlertEmailPreview(APIView):
+    permission_classes = [permissions.IsAuthenticated]
+
+    def get(self, request):
+        type_param = request.GET.get("type")
+
+        template_map = {
+            "alert": "email/alert_system/alert_notification.html",
+            "alert_reply": "email/alert_system/alert_notification_reply.html",
+        }
+
+        if type_param not in template_map:
+            valid_values = ", ".join(template_map.keys())
+            return HttpResponse(
+                f"Invalid 'type' parameter. Please use one of the following values: {valid_values}.",
+            )
+        context_map = {
+            "alert": {
+                "user_name": "Test User",
+                "event_title": "Test Title",
+                "event_description": "This is a test description for the alert email.",
+                "start_datetime": "2025-11-28 01:00:00",
+                "end_datetime": "2025-11-28 01:00:00",
+                "country_name": [
+                    "Nepal",
+                ],
+                "total_people_exposed": 1200,
+                "total_buildings_exposed": 150,
+                "hazard_types": "Flood",
+                "related_montandon_events": [
+                    {
+                        "event_title": "Related Event 1",
+                        "total_people_exposed": 100,
+                        "total_buildings_exposed": 300,
+                        "start_datetime": "2025-11-28 01:00:00",
+                        "end_datetime": "2025-11-28 01:00:00",
+                    },
+                    {
+                        "event_title": "Related Event 2",
+                        "total_people_exposed": 200,
+                        "total_buildings_exposed": 500,
+                        "start_datetime": "2025-11-28 01:00:00",
+                        "end_datetime": "2025-11-28 01:00:00",
+                    },
+                ],
+                "related_go_events": [
+                    "go-event-uuid-1",
+                    "go-event-uuid-2",
+                ],
+            },
+            "alert_reply": {
+                "event_title": "Test Title",
+                "event_description": "This is a test description for the alert email.",
+                "start_datetime": "2025-11-28 01:00:00",
+                "end_datetime": "2025-11-28 01:00:00",
+                "country_name": [
+                    "Nepal",
+                ],
+                "total_people_exposed": 1200,
+                "total_buildings_exposed": 150,
+            },
+        }
+
+        context = context_map.get(type_param)
+        if context is None:
+            return HttpResponse("No context found for the email preview.")
+        template_file = template_map[type_param]
+        template = loader.get_template(template_file)
+        return HttpResponse(template.render(context, request))

alert_system/dev_views.py

@@ -0,0 +1,165 @@
+import logging
+import uuid
+from typing import Optional
+
+from django.contrib.auth.models import User
+from django.db.models import Count
+from django.template.loader import render_to_string
+from django.utils import timezone
+
+from alert_system.models import AlertEmailLog, AlertEmailThread, LoadItem
+from alert_system.utils import get_alert_email_context, get_alert_subscriptions
+from notifications.models import AlertSubscription
+from notifications.notification import send_notification
+
+logger = logging.getLogger(__name__)
+
+DEFAULT_ALERT_PER_DAY = 100
+
+
+def send_alert_email_notification(
+    load_item: LoadItem,
+    user: User,
+    subscription: AlertSubscription,
+    thread: Optional[AlertEmailThread],
+    is_reply: bool = False,
+) -> None:
+    """Helper function to send email and create log entry"""
+    message_id: str = str(uuid.uuid4())
+
+    email_log = AlertEmailLog.objects.create(
+        user=user,
+        subscription=subscription,
+        item=load_item,
+        status=AlertEmailLog.Status.PROCESSING,
+        message_id=message_id,
+        thread=thread,
+    )
+
+    try:
+        if is_reply:
+            subject = f"Re: Hazard Alert: {load_item.event_title}"
+            template = "email/alert_system/alert_notification_reply.html"
+            email_type = "Alert Email Notification Reply"
+            in_reply_to = thread.root_email_message_id
+        else:
+            subject = f"New Hazard Alert: {load_item.event_title}"
+            template = "email/alert_system/alert_notification.html"
+            email_type = "Alert Email Notification"
+            in_reply_to = None
+
+        email_context = get_alert_email_context(load_item, user)
+        email_body = render_to_string(template, email_context)
+        send_notification(
+            subject=subject,
+            recipients=[user.email],
+            message_id=message_id,
+            in_reply_to=in_reply_to,
+            html=email_body,
+            mailtype=email_type,
+        )
+        # Create thread for initial emails
+        email_log.status = AlertEmailLog.Status.SENT
+        email_log.email_sent_at = timezone.now()
+
+        if not is_reply:
+            thread, created = AlertEmailThread.objects.get_or_create(
+                user=user,
+                parent_event_id=load_item.parent_event_id,
+                defaults={
+                    "root_email_message_id": message_id,
+                    "root_message_sent_at": timezone.now(),
+                },
+            )
+            email_log.thread = thread
+            email_log.save(update_fields=["status", "email_sent_at", "thread"])
+
+            if created:
+                logger.info(
+                    f"Alert Email thread created for user [{user.get_full_name()}] "
+                    f"with parent event [{load_item.parent_event_id}]"
+                )
+            else:
+                logger.info(
+                    f"Existing thread found for user [{user.get_full_name()}] " f"with parent event [{load_item.parent_event_id}]"
+                )
+        else:
+            email_log.save(update_fields=["status", "email_sent_at"])
+        logger.info(f"Alert email sent to [{user.get_full_name()}] for LoadItem ID [{load_item.id}]")
+
+    except Exception:
+        email_log.status = AlertEmailLog.Status.FAILED
+        email_log.save(update_fields=["status"])
+        logger.warning(f"Alert email failed for [{user.get_full_name()}] LoadItem ID [{load_item.id}]", exc_info=True)
+
+
+def process_email_alert(load_item_id: int) -> None:
+    load_item = LoadItem.objects.select_related("connector", "connector__dtype").filter(id=load_item_id).first()
+
+    if not load_item:
+        logger.warning(f"LoadItem with ID [{load_item_id}] not found")
+        return
+
+    subscriptions = list(get_alert_subscriptions(load_item))
+    if not subscriptions:
+        logger.info(f"No alert subscriptions matched for LoadItem ID [{load_item_id}]")
+        return
+
+    today = timezone.now().date()
+    user_ids = [sub.user_id for sub in subscriptions]
+    subscription_ids = [sub.id for sub in subscriptions]
+
+    # Daily email counts per user
+    daily_counts = (
+        AlertEmailLog.objects.filter(
+            user_id__in=user_ids,
+            subscription_id__in=subscription_ids,
+            status=AlertEmailLog.Status.SENT,
+            email_sent_at__date=today,
+        )
+        .values("user_id", "subscription_id")
+        .annotate(sent_count=Count("id"))
+    )
+    daily_count_map = {(item["user_id"], item["subscription_id"]): item["sent_count"] for item in daily_counts}
+
+    # Emails already sent for this item (per user)
+    already_sent = set(
+        AlertEmailLog.objects.filter(
+            user_id__in=user_ids,
+            subscription_id__in=subscription_ids,
+            item_id=load_item_id,
+            status=AlertEmailLog.Status.SENT,
+        ).values_list("user_id", "subscription_id")
+    )
+
+    # Existing threads for this correlation_id
+    existing_threads = {
+        thread.user_id: thread
+        for thread in AlertEmailThread.objects.filter(
+            parent_event_id=load_item.parent_event_id,
+            user_id__in=user_ids,
+        )
+    }
+
+    for subscription in subscriptions:
+        user = subscription.user
+        user_id: int = user.id
+        subscription_id: int = subscription.id
+
+        # Reply if this specific user has an existing thread
+        thread = existing_threads.get(user_id)
+        is_reply: bool = thread is not None
+
+        # Skip duplicate emails for same item
+        if (user_id, subscription_id) in already_sent:
+            logger.info(f"Duplicate alert skipped for user [{user.get_full_name()}] " f"with LoadItem ID [{load_item_id}]")
+            continue
+
+        # Skip if daily alert limit reached
+        sent_today: int = daily_count_map.get((user_id, subscription_id), 0)
+        effective_limit = subscription.alert_per_day or DEFAULT_ALERT_PER_DAY
+        if sent_today >= effective_limit:
+            logger.info(f"Daily alert limit reached for user [{user.get_full_name()}]")
+            continue
+
+        send_alert_email_notification(load_item=load_item, user=user, subscription=subscription, thread=thread, is_reply=is_reply)

alert_system/email_processing.py

@@ -0,0 +1,13 @@
+from typing import Dict, TypedDict
+
+
+class ExtractionConfig(TypedDict):
+    event_collection_type: str
+    hazard_collection_type: str | None
+    impact_collection_type: str | None
+
+    filter_event: Dict | None
+    filter_hazard: Dict | None
+    filter_impact: Dict | None
+
+    people_exposed_threshold: int