Merge pull request #2040 from IFRCGo/fix/surge-alert

Surge Alert Status and Ordering based on status and opens fields

Author: szabozoltan69

deploy/helm/ifrcgo-helm/values.yaml

@@ -111,6 +111,8 @@ cronjobs:
     schedule: '0 9 * * *'
   - command: 'ingest_country_plan_file'
     schedule: '1 0 * * *'
+  - command: 'update_surge_alert_status'
+    schedule: '1 */12 * * *'
 
 elasticsearch:
   enabled: true

main/enums.py

@@ -5,6 +5,7 @@
 from flash_update import enums as flash_update_enums
 from deployments import enums as deployments_enums
 from per import enums as per_enums
+from notifications import enums as notifications_enums
 
 
 apps_enum_register = [
@@ -13,6 +14,7 @@
     ('flash_update', flash_update_enums.enum_register),
     ('deployments', deployments_enums.enum_register),
     ('per', per_enums.enum_register),
+    ('notifications', notifications_enums.enum_register),
 ]
 
 

notifications/drf_views.py

@@ -33,6 +33,7 @@ class SurgeAlertFilter(filters.FilterSet):
         help_text='Molnix_tag names, comma separated',
         widget=CSVWidget,
     )
+    status = filters.NumberFilter(field_name='status', lookup_expr='exact')
 
     class Meta:
         model = SurgeAlert
@@ -62,7 +63,7 @@ class SurgeAlertViewset(viewsets.ReadOnlyModelViewSet):
         prefetch_related('molnix_tags', 'molnix_tags__groups').\
         select_related('event', 'country').all()
     filterset_class = SurgeAlertFilter
-    ordering_fields = ('created_at', 'atype', 'category', 'event', 'is_stood_down',)
+    ordering_fields = ('created_at', 'atype', 'category', 'event', 'is_stood_down', 'status', 'opens')
     search_fields = ('operation', 'message', 'event__name',)  # for /docs
 
     def get_serializer_class(self):

notifications/enums.py

@@ -0,0 +1,5 @@
+from . import models
+
+enum_register = {
+    'surge_alert_status': models.SurgeAlertStatus,
+}

notifications/management/commands/update_surge_alert_status.py

@@ -0,0 +1,31 @@
+import logging
+from django.db import models
+
+from django.core.management.base import BaseCommand
+from django.utils import timezone
+from notifications.models import SurgeAlert, SurgeAlertStatus
+
+logger = logging.getLogger(__name__)
+
+class Command(BaseCommand):
+    '''
+        Updating the Alert Status according:
+        If the alert status is marked as stood_down, then the status is Stood Down.
+        If the closing timestamp (closes) is earlier than the current date, the status is displayed as Closed. Otherwise, it is displayed as Open.
+    '''
+    help = 'Update alert status'
+
+    def handle(self, *args, **options):
+        now = timezone.now()
+        try:
+            SurgeAlert.objects.update(
+                status=models.Case(
+                    models.When(is_stood_down=True, then=models.Value(SurgeAlertStatus.STOOD_DOWN)),
+                    models.When(closes__lt=now, then=models.Value(SurgeAlertStatus.CLOSED)),
+                    models.When(closes__gte=now, then=models.Value(SurgeAlertStatus.OPEN)),
+                    default=models.F('status'),
+                    output_field=models.IntegerField()
+                )
+            )
+        except Exception as e:
+            logger.error('Error while updating alerts status', exc_info=True)

notifications/migrations/0014_surgealert_status.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.23 on 2024-02-13 09:43
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('notifications', '0013_auto_20230410_0720'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='surgealert',
+            name='status',
+            field=models.IntegerField(choices=[(0, 'Open'), (1, 'Stood Down'), (2, 'Closed')], default=0, verbose_name='alert status'),
+        ),
+    ]

notifications/models.py

@@ -24,6 +24,15 @@ class SurgeAlertCategory(models.IntegerChoices):
     STAND_DOWN = 4, _('stand down')
 
 
+class SurgeAlertStatus(models.IntegerChoices):
+    '''
+    Note: Ordering value should be in order of Open, Stood Down, Closed to supported custom defined ordering logic
+    '''
+    OPEN = 0, _('Open')
+    STOOD_DOWN = 1, _('Stood Down')
+    CLOSED = 2, _('Closed')
+
+
 class SurgeAlert(models.Model):
 
     atype = models.IntegerField(choices=SurgeAlertType.choices, verbose_name=_('alert type'), default=0)
@@ -54,17 +63,29 @@ class SurgeAlert(models.Model):
 
     # Don't set `auto_now_add` so we can modify it on save
     created_at = models.DateTimeField(verbose_name=_('created at'))
+    status = models.IntegerField(choices=SurgeAlertStatus.choices, verbose_name=_('alert status'), default=SurgeAlertStatus.OPEN)
 
     class Meta:
         ordering = ['-created_at']
         verbose_name = _('Surge Alert')
         verbose_name_plural = _('Surge Alerts')
 
     def save(self, *args, **kwargs):
+        """
+        If the alert status is marked as stood_down, then the status is Stood Down.
+        If the closing timestamp (closes) is earlier than the current date, the status is displayed as Closed.
+        Otherwise, it is displayed as Open.
+        """
         # On save, if `created` is not set, make it the current time
         if (not self.id and not self.created_at) or (self.created_at > timezone.now()):
             self.created_at = timezone.now()
         self.is_stood_down = self.molnix_status == 'unfilled'
+        if self.is_stood_down:
+            self.status = SurgeAlertStatus.STOOD_DOWN
+        elif self.closes and self.closes < timezone.now():
+            self.status = SurgeAlertStatus.CLOSED
+        else:
+            self.status = SurgeAlertStatus.OPEN
         return super(SurgeAlert, self).save(*args, **kwargs)
 
     def __str__(self):

notifications/serializers.py

@@ -11,15 +11,16 @@ class SurgeAlertSerializer(ModelSerializer):
     event = SurgeEventSerializer()
     country = MiniCountrySerializer()
     atype_display = serializers.CharField(source='get_atype_display', read_only=True)
+    status_display = serializers.CharField(source='get_status_display', read_only=True)
     category_display = serializers.CharField(source='get_category_display', read_only=True)
     molnix_tags = MolnixTagSerializer(many=True, read_only=True)
 
     class Meta:
         model = SurgeAlert
         fields = (
-            'operation', 'country', 'message', 'deployment_needed', 'is_private', 'event', 'created_at', 'id',
+            'operation','country', 'message', 'deployment_needed', 'is_private', 'event', 'created_at', 'id',
             'atype', 'atype_display', 'category', 'category_display', 'molnix_id', 'molnix_tags',
-            'molnix_status', 'opens', 'closes', 'start', 'end', 'is_active', 'is_stood_down'
+            'molnix_status', 'opens', 'closes', 'start', 'end', 'is_active', 'is_stood_down','status', 'status_display'
         )
 
 

notifications/tests.py

@@ -1,4 +1,6 @@
-from datetime import datetime, timezone
+from datetime import datetime, timedelta
+from django.utils import timezone
+from unittest.mock import patch
 from django.conf import settings
 from modeltranslation.utils import build_localized_fieldname
 
@@ -10,8 +12,9 @@
 from api.factories.country import CountryFactory
 from deployments.factories.molnix_tag import MolnixTagFactory
 
-from notifications.models import SurgeAlert, SurgeAlertType
+from notifications.models import SurgeAlert, SurgeAlertStatus, SurgeAlertType
 from notifications.factories import SurgeAlertFactory
+from django.core.management import call_command
 
 
 class NotificationTestCase(APITestCase):
@@ -136,3 +139,97 @@ def _to_csv(*items):
             molnix_tag_names=_to_csv('OP-6700', 'L-FRA', 'AMER'),
         ))
         self.assertEqual(response['count'], 2)
+
+    def test_surge_alert_status(self):
+        region_1, region_2 = RegionFactory.create_batch(2)
+        country_1 = CountryFactory.create(iso3='ATL', region=region_1)
+        country_2 = CountryFactory.create(iso3='NPT', region=region_2)
+
+        molnix_tag_1 = MolnixTagFactory.create(name='OP-6700')
+        molnix_tag_2 = MolnixTagFactory.create(name='L-FRA')
+        molnix_tag_3 = MolnixTagFactory.create(name='AMER')
+
+        alert1 = SurgeAlertFactory.create(
+            message='CEA Coordinator, Floods, Atlantis',
+            country=country_1,
+            molnix_tags=[molnix_tag_1, molnix_tag_2],
+            opens=timezone.now() - timedelta(days=2),
+            closes=timezone.now() + timedelta(days=5)
+        )
+        alert2 = SurgeAlertFactory.create(
+            message='WASH Coordinator, Earthquake, Neptunus',
+            country=country_2,
+            molnix_tags=[molnix_tag_1, molnix_tag_3],
+            opens=timezone.now() - timedelta(days=2),
+            closes=timezone.now() - timedelta(days=1)
+        )
+        alert3 = SurgeAlertFactory.create(
+            message='New One',
+            country=country_2,
+            molnix_tags=[molnix_tag_1, molnix_tag_3],
+            molnix_status='unfilled',
+        )
+
+        self.assertEqual(alert1.status, SurgeAlertStatus.OPEN)
+        self.assertEqual(alert2.status, SurgeAlertStatus.CLOSED)
+        self.assertEqual(alert3.status, SurgeAlertStatus.STOOD_DOWN)
+
+        def _fetch(filters):
+            return self.client.get('/api/v2/surge_alert/', filters).json()
+
+        response = _fetch(dict({
+            'status': SurgeAlertStatus.OPEN
+        }))
+
+        self.assertEqual(response['count'], 1)
+        self.assertEqual(response['results'][0]['status'], SurgeAlertStatus.OPEN)
+
+        response = _fetch(dict({
+            'status': SurgeAlertStatus.CLOSED
+        }))
+        self.assertEqual(response['count'], 1)
+        self.assertEqual(response['results'][0]['status'], SurgeAlertStatus.CLOSED)
+
+        response = _fetch(dict({
+            'status': SurgeAlertStatus.STOOD_DOWN
+        }))
+        self.assertEqual(response['count'], 1)
+        self.assertEqual(response['results'][0]['status'], SurgeAlertStatus.STOOD_DOWN)
+
+
+class SurgeAlertTestCase(APITestCase):
+    def test_update_alert_status_command(self):
+        region_1, region_2 = RegionFactory.create_batch(2)
+        country_1 = CountryFactory.create(iso3='NPP', region=region_1)
+        country_2 = CountryFactory.create(iso3='CTT', region=region_2)
+
+        molnix_tag_1 = MolnixTagFactory.create(name='OP-6700')
+        molnix_tag_2 = MolnixTagFactory.create(name='L-FRA')
+        molnix_tag_3 = MolnixTagFactory.create(name='AMER')
+
+        alert1 = SurgeAlertFactory.create(
+            message='CEA Coordinator, Floods, Atlantis',
+            country=country_1,
+            molnix_tags=[molnix_tag_1, molnix_tag_2],
+            opens=timezone.now() - timedelta(days=2),
+            closes=timezone.now() + timedelta(seconds=5)
+        )
+        alert2 = SurgeAlertFactory.create(
+            message='WASH Coordinator, Earthquake, Neptunus',
+            country=country_2,
+            molnix_tags=[molnix_tag_1, molnix_tag_3],
+            opens=timezone.now() - timedelta(days=2),
+            closes=timezone.now() - timedelta(days=1)
+        )
+        self.assertEqual(alert1.status, SurgeAlertStatus.OPEN)
+        self.assertEqual(alert2.status, SurgeAlertStatus.CLOSED)
+
+        with patch('django.utils.timezone.now') as mock_now:
+            mock_now.return_value = datetime.now() + timedelta(days=1)
+            call_command('update_surge_alert_status')
+
+        alert1.refresh_from_db()
+        alert2.refresh_from_db()
+
+        self.assertEqual(alert1.status, SurgeAlertStatus.CLOSED)
+        self.assertEqual(alert2.status, SurgeAlertStatus.CLOSED)