Email Implementation on local units (#2357)

* Email setup for editing local unit

* Add email template for create and update local unit

* Add email backend

* Ad changes for the email template

* Email for deprecate and changes on template

* Changes in template and commenting out tls service

* Add changes for email and create command for notifying regional and global validators

* Add tags for regional and global validator

* Add notify validators to values file

* fix issue on deprecate api

* Add api for template preview

* Add USE_EMAIL_SMPT flag and last_sent_validator_type in model, Refactor email sending logic

* add a comment in email_context

* Add minor changes on email smtp

* Add email preview api for local units

* Add new views for email preview and changes on utils and email task

* Changes in email preview api

* Update localunit mail template

* Fix issue on email preview

---------

Co-authored-by: Shreeyash Shrestha <[email protected]>

Author: susilnem

deploy/helm/ifrcgo-helm/values.yaml

@@ -155,6 +155,8 @@ cronjobs:
     schedule: '0 0 * * 0'
   - command: 'ingest_icrc'
     schedule: '0 3 * * 0'
+  - command: 'notify_validators'
+    schedule: '0 0 * * *'
 
 
 elasticsearch:

local_units/dev_views.py

@@ -0,0 +1,32 @@
+from django.http import HttpResponse
+from django.template import loader
+from rest_framework import permissions
+from rest_framework.views import APIView
+
+
+class LocalUnitsEmailPreview(APIView):
+    permission_classes = [permissions.IsAuthenticated]
+
+    def get(self, request):
+        type_param = request.GET.get("type")
+        param_types = {"new", "update", "validate", "revert", "deprecate", "regional_validator", "global_validator"}
+
+        if type_param not in param_types:
+            return HttpResponse(f"Invalid type parameter. Please use one of the following values:  {', '.join(param_types)}.")
+
+        context_mapping = {
+            "new": {"new_local_unit": True, "validator_email": "Test Validator", "full_name": "Test User"},
+            "update": {"update_local_unit": True, "validator_email": "Test Validator", "full_name": "Test User"},
+            "validate": {"validate_success": True, "full_name": "Test User"},
+            "revert": {"revert_reason": "Test Reason", "full_name": "Test User"},
+            "deprecate": {"deprecate_local_unit": True, "deprecate_reason": "Test Deprecate Reason", "full_name": "Test User"},
+            "regional_validator": {"is_validator_regional_admin": True, "full_name": "Regional User"},
+            "global_validator": {"is_validator_global_admin": True, "full_name": "Global User"},
+        }
+
+        context = context_mapping.get(type_param)
+        if context is None:
+            return HttpResponse("No context found for the email preview.")
+
+        template = loader.get_template("email/local_units/local_unit.html")
+        return HttpResponse(template.render(context, request))

local_units/enums.py

@@ -3,5 +3,5 @@
 enum_register = {
     "deprecate_reason": models.LocalUnit.DeprecateReason,
     "validation_status": models.LocalUnitChangeRequest.Status,
-    "validators": models.LocalUnitChangeRequest.Validator,
+    "validators": models.Validator,
 }

local_units/management/commands/notify_validators.py

@@ -0,0 +1,85 @@
+from datetime import timedelta
+
+from django.core.management.base import BaseCommand
+from django.template.loader import render_to_string
+from django.utils import timezone
+from sentry_sdk.crons import monitor
+
+from local_units.models import LocalUnit, Validator
+from local_units.utils import (
+    get_email_context,
+    get_global_validators,
+    get_region_admins,
+)
+from main.sentry import SentryMonitor
+from notifications.notification import send_notification
+
+
+class Command(BaseCommand):
+    help = "Notify validators for the pending local units in different period of time"
+
+    @monitor(monitor_slug=SentryMonitor.NOTIFY_VALIDATORS)
+    def handle(self, *args, **options):
+        self.stdout.write(self.style.NOTICE("Notifying the validators..."))
+
+        # Regional Validators: 14 days
+        queryset_for_regional_validators = LocalUnit.objects.filter(
+            validated=False,
+            is_deprecated=False,
+            last_sent_validator_type=Validator.LOCAL,
+            created_at__lte=timezone.now() - timedelta(days=14),
+        )
+
+        # Global Validators: 28 days
+        queryset_for_global_validators = LocalUnit.objects.filter(
+            validated=False,
+            is_deprecated=False,
+            last_sent_validator_type=Validator.REGIONAL,
+            created_at__lte=timezone.now() - timedelta(days=28),
+        )
+
+        for local_unit in queryset_for_regional_validators:
+            self.stdout.write(self.style.NOTICE(f"Notifying regional validators for local unit pk:({local_unit.id})"))
+            email_context = get_email_context(local_unit)
+            email_context["is_validator_regional_admin"] = True
+            email_subject = "Action Required: Local Unit Pending Validation"
+            email_type = "Local Unit"
+
+            for region_admin_validator in get_region_admins(local_unit):
+                try:
+                    email_context["full_name"] = region_admin_validator.get_full_name()
+                    email_body = render_to_string("email/local_units/local_unit.html", email_context)
+                    send_notification(email_subject, region_admin_validator.email, email_body, email_type)
+                    local_unit.last_sent_validator_type = Validator.REGIONAL
+                    local_unit.save(update_fields=["last_sent_validator_type"])
+                except Exception as e:
+                    self.stdout.write(
+                        self.style.WARNING(
+                            f"Failed to notify regional validator {region_admin_validator.get_full_name()} for local unit pk:({local_unit.id}): {e}"  # noqa
+                        )
+                    )
+                    continue
+
+        for local_unit in queryset_for_global_validators:
+            self.stdout.write(self.style.NOTICE(f"Notifying global validators for local unit pk:({local_unit.id})"))
+            email_context = get_email_context(local_unit)
+            email_context["is_validator_global_admin"] = True
+            email_subject = "Action Required: Local Unit Pending Validation"
+            email_type = "Local Unit"
+
+            for global_validator in get_global_validators():
+                try:
+                    email_context["full_name"] = global_validator.get_full_name()
+                    email_body = render_to_string("email/local_units/local_unit.html", email_context)
+                    send_notification(email_subject, global_validator.email, email_body, email_type)
+                    local_unit.last_sent_validator_type = Validator.GLOBAL
+                    local_unit.save(update_fields=["last_sent_validator_type"])
+                except Exception as e:
+                    self.stdout.write(
+                        self.style.WARNING(
+                            f"Failed to notify global validator {global_validator.get_full_name()} for local unit pk:({local_unit.id}): {e}"  # noqa
+                        )
+                    )
+                    continue
+
+        self.stdout.write(self.style.SUCCESS("Successfully sent the notifications to the validators"))

local_units/migrations/0019_localunit_last_sent_validator_type.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.17 on 2024-12-27 14:32
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("local_units", "0018_localunit_deprecated_reason_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="localunit",
+            name="last_sent_validator_type",
+            field=models.IntegerField(
+                choices=[(1, "Local"), (2, "Regional"), (3, "Global")], default=1, verbose_name="Last email sent validator type"
+            ),
+        ),
+    ]

local_units/models.py

@@ -275,6 +275,12 @@ def __str__(self):
         return f"{self.name} ({self.level})"
 
 
+class Validator(models.IntegerChoices):
+    LOCAL = 1, _("Local")
+    REGIONAL = 2, _("Regional")
+    GLOBAL = 3, _("Global")
+
+
 @reversion.register(follow=("health",))
 class LocalUnit(models.Model):
 
@@ -356,6 +362,12 @@ class DeprecateReason(models.IntegerChoices):
         verbose_name=_("Explain the reason why the local unit is being deleted"), blank=True, null=True
     )
 
+    last_sent_validator_type = models.IntegerField(
+        choices=Validator.choices,
+        verbose_name=_("Last email sent validator type"),
+        default=Validator.LOCAL,
+    )
+
     def __str__(self):
         branch_name = self.local_branch_name or self.english_branch_name
         return f"{branch_name} ({self.country.name})"
@@ -377,11 +389,6 @@ class Status(models.IntegerChoices):
         APPROVED = 2, _("Approved")
         REVERT = 3, _("Revert")
 
-    class Validator(models.IntegerChoices):
-        LOCAL = 1, _("Local")
-        REGIONAL = 2, _("Regional")
-        GLOBAL = 3, _("Global")
-
     local_unit = models.ForeignKey(
         LocalUnit, on_delete=models.CASCADE, verbose_name=_("Local Unit"), related_name="local_unit_change_request"
     )

local_units/tasks.py

@@ -0,0 +1,90 @@
+from celery import shared_task
+from django.template.loader import render_to_string
+
+from local_units.models import LocalUnit, LocalUnitChangeRequest
+from notifications.notification import send_notification
+
+from .utils import get_email_context, get_local_admins
+
+
+@shared_task
+def send_local_unit_email(local_unit_id: int, new: bool = True):
+    if not local_unit_id:
+        return None
+
+    instance = LocalUnit.objects.get(id=local_unit_id)
+    users = get_local_admins(instance)
+    email_context = get_email_context(instance)
+    email_context["new_local_unit"] = True
+    email_subject = "Action Required: New Local Unit Pending Validation"
+    email_type = "New Local Unit"
+    # NOTE: Update case for the local unit
+    if not new:
+        email_context.pop("new_local_unit")
+        email_context["update_local_unit"] = True
+        email_subject = "Action Required: Local Unit Pending Validation"
+        email_type = "Update Local Unit"
+
+    for user in users:
+        # NOTE: Adding the validator email to the context
+        email_context["validator_email"] = user.email
+        email_context["full_name"] = user.get_full_name()
+        email_body = render_to_string("email/local_units/local_unit.html", email_context)
+        send_notification(email_subject, user.email, email_body, email_type)
+    return email_context
+
+
+@shared_task
+def send_validate_success_email(local_unit_id: int, message: str = ""):
+    if not local_unit_id:
+        return None
+
+    instance = LocalUnit.objects.get(id=local_unit_id)
+    user = instance.created_by
+    email_context = get_email_context(instance)
+    email_context["full_name"] = user.get_full_name()
+    email_context["validate_success"] = True
+    email_subject = "Your Local Unit Addition Request: Approved"
+    email_body = render_to_string("email/local_units/local_unit.html", email_context)
+    email_type = f"{message} Local Unit"
+
+    send_notification(email_subject, user.email, email_body, email_type)
+    return email_context
+
+
+@shared_task
+def send_revert_email(local_unit_id: int, change_request_id: int):
+    if not local_unit_id:
+        return None
+
+    instance = LocalUnit.objects.get(id=local_unit_id)
+    change_request_instance = LocalUnitChangeRequest.objects.get(id=change_request_id)
+    user = instance.created_by
+    email_context = get_email_context(instance)
+    email_context["full_name"] = user.get_full_name()
+    email_context["revert_reason"] = change_request_instance.rejected_reason
+    email_subject = "Your Local Unit Addition Request: Reverted"
+    email_body = render_to_string("email/local_units/local_unit.html", email_context)
+    email_type = "Revert Local Unit"
+
+    send_notification(email_subject, user.email, email_body, email_type)
+    return email_context
+
+
+@shared_task
+def send_deprecate_email(local_unit_id: int):
+    if not local_unit_id:
+        return None
+
+    instance = LocalUnit.objects.get(id=local_unit_id)
+    user = instance.created_by
+    email_context = get_email_context(instance)
+    email_context["full_name"] = user.get_full_name()
+    email_context["deprecate_local_unit"] = True
+    email_context["deprecate_reason"] = instance.deprecated_reason_overview
+    email_subject = "Your Local Unit Addition Request: Deprecated"
+    email_body = render_to_string("email/local_units/local_unit.html", email_context)
+    email_type = "Deprecate Local Unit"
+
+    send_notification(email_subject, user.email, email_body, email_type)
+    return email_context

local_units/test_views.py

@@ -22,6 +22,7 @@
     LocalUnitLevel,
     LocalUnitType,
     PrimaryHCC,
+    Validator,
     VisibilityChoices,
 )
 
@@ -677,7 +678,7 @@ def test_validate_local_unit(self):
         local_unit_request = LocalUnitChangeRequest.objects.filter(
             local_unit=local_unit_id, status=LocalUnitChangeRequest.Status.APPROVED
         ).last()
-        self.assertEqual(local_unit_request.current_validator, LocalUnitChangeRequest.Validator.GLOBAL)
+        self.assertEqual(local_unit_request.current_validator, Validator.GLOBAL)
 
         # Testing For the local unit admin/Local validator
         self.authenticate(self.local_unit_admin_user)
@@ -688,7 +689,7 @@ def test_validate_local_unit(self):
         local_unit_request = LocalUnitChangeRequest.objects.filter(
             local_unit=local_unit_id, status=LocalUnitChangeRequest.Status.APPROVED
         ).last()
-        self.assertEqual(local_unit_request.current_validator, LocalUnitChangeRequest.Validator.LOCAL)
+        self.assertEqual(local_unit_request.current_validator, Validator.LOCAL)
 
         # Testing For the regional validator
         self.authenticate(self.regional_validator_user)
@@ -699,7 +700,7 @@ def test_validate_local_unit(self):
         local_unit_request = LocalUnitChangeRequest.objects.filter(
             local_unit=local_unit_id, status=LocalUnitChangeRequest.Status.APPROVED
         ).last()
-        self.assertEqual(local_unit_request.current_validator, LocalUnitChangeRequest.Validator.REGIONAL)
+        self.assertEqual(local_unit_request.current_validator, Validator.REGIONAL)
 
         # Testing for Root User/Global validator
         self.authenticate(self.root_user)
@@ -710,4 +711,4 @@ def test_validate_local_unit(self):
         local_unit_request = LocalUnitChangeRequest.objects.filter(
             local_unit=local_unit_id, status=LocalUnitChangeRequest.Status.APPROVED
         ).last()
-        self.assertEqual(local_unit_request.current_validator, LocalUnitChangeRequest.Validator.GLOBAL)
+        self.assertEqual(local_unit_request.current_validator, Validator.GLOBAL)

local_units/utils.py

@@ -0,0 +1,40 @@
+from django.conf import settings
+from django.contrib.auth import get_user_model
+
+User = get_user_model()
+
+
+def get_email_context(instance):
+    from local_units.serializers import PrivateLocalUnitSerializer
+
+    # NOTE: Passing through serializer, might need more info in the future
+    local_unit_data = PrivateLocalUnitSerializer(instance).data
+    email_context = {
+        "id": local_unit_data["id"],
+        "frontend_url": settings.FRONTEND_URL,
+    }
+    return email_context
+
+
+def get_local_admins(instance):
+    """
+    Get the user with the country level admin permission for the country of the instance
+    """
+    country_admins = User.objects.filter(groups__permissions__codename=f"country_admin_{instance.country_id}")
+    return country_admins
+
+
+def get_region_admins(instance):
+    """
+    Get the user with the region level admin permission for the region of the instance
+    """
+    region_admins = User.objects.filter(groups__permissions__codename=f"region_admin_{instance.country.region_id}")
+    return region_admins
+
+
+def get_global_validators():
+    """
+    Get the user with the global validator permission
+    """
+    global_validators = User.objects.filter(groups__permissions__codename="local_unit_global_validator")
+    return global_validators