User notifications bundle

engine/apps/alerts/constants.py

@@ -16,6 +16,8 @@ class ActionSource(IntegerChoices):
 
 NEXT_ESCALATION_DELAY = 5
 
+BUNDLED_NOTIFICATION_DELAY_SECONDS = 60 * 2  # 2 min
+
 
 # AlertGroup states verbal
 class AlertGroupState(str, Enum):

engine/apps/alerts/migrations/0052_usernotificationbundle_bundlednotification_and_more.py

@@ -0,0 +1,45 @@
+# Generated by Django 4.2.10 on 2024-06-20 11:00
+
+import apps.base.models.user_notification_policy
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('base', '0005_drop_unused_dynamic_settings'),
+        ('user_management', '0022_alter_team_unique_together'),
+        ('alerts', '0051_remove_escalationpolicy_custom_button_trigger'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='UserNotificationBundle',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('important', models.BooleanField()),
+                ('notification_channel', models.PositiveSmallIntegerField(default=None, null=True, validators=[apps.base.models.user_notification_policy.validate_channel_choice])),
+                ('last_notified_at', models.DateTimeField(default=None, null=True)),
+                ('notification_task_id', models.CharField(default=None, max_length=100, null=True)),
+                ('eta', models.DateTimeField(default=None, null=True)),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='notification_bundles', to='user_management.user')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='BundledNotification',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('bundle_uuid', models.CharField(db_index=True, default=None, max_length=100, null=True)),
+                ('alert_group', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='alerts.alertgroup')),
+                ('alert_receive_channel', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='alerts.alertreceivechannel')),
+                ('notification_bundle', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='notifications', to='alerts.usernotificationbundle')),
+                ('notification_policy', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='base.usernotificationpolicy')),
+            ],
+        ),
+        migrations.AddConstraint(
+            model_name='usernotificationbundle',
+            constraint=models.UniqueConstraint(fields=('user', 'important', 'notification_channel'), name='unique_user_notification_bundle'),
+        ),
+    ]

engine/apps/alerts/models/__init__.py

@@ -15,3 +15,4 @@
 from .maintainable_object import MaintainableObject  # noqa: F401
 from .resolution_note import ResolutionNote, ResolutionNoteSlackMessage  # noqa: F401
 from .user_has_notification import UserHasNotification  # noqa: F401
+from .user_notification_bundle import BundledNotification, UserNotificationBundle  # noqa: F401

engine/apps/alerts/models/user_has_notification.py

@@ -16,3 +16,11 @@ class UserHasNotification(models.Model):
 
     class Meta:
         unique_together = ("user", "alert_group")
+
+    def update_active_task_id(self, task_id):
+        """
+        `active_notification_policy_id` keeps celery task_id of the next scheduled `notify_user_task`
+        for the current user
+        """
+        self.active_notification_policy_id = task_id
+        self.save(update_fields=["active_notification_policy_id"])

engine/apps/alerts/models/user_notification_bundle.py

@@ -0,0 +1,72 @@
+import datetime
+
+from django.db import models
+from django.utils import timezone
+
+from apps.alerts.constants import BUNDLED_NOTIFICATION_DELAY_SECONDS
+from apps.base.models import UserNotificationPolicy
+from apps.base.models.user_notification_policy import validate_channel_choice
+
+
+class UserNotificationBundle(models.Model):
+    NOTIFICATION_CHANNELS_TO_BUNDLE = [
+        UserNotificationPolicy.NotificationChannel.SMS,
+    ]
+
+    user = models.ForeignKey("user_management.User", on_delete=models.CASCADE, related_name="notification_bundles")
+    important = models.BooleanField()
+    notification_channel = models.PositiveSmallIntegerField(
+        validators=[validate_channel_choice], null=True, default=None
+    )
+    last_notified_at = models.DateTimeField(default=None, null=True)
+    notification_task_id = models.CharField(max_length=100, null=True, default=None)
+    # estimated time of arrival for scheduled send_bundled_notification task
+    eta = models.DateTimeField(default=None, null=True)
+
+    class Meta:
+        constraints = [
+            models.UniqueConstraint(
+                fields=["user", "important", "notification_channel"], name="unique_user_notification_bundle"
+            )
+        ]
+
+    def notified_recently(self) -> bool:
+        return (
+            timezone.now() - self.last_notified_at < timezone.timedelta(seconds=BUNDLED_NOTIFICATION_DELAY_SECONDS)
+            if self.last_notified_at
+            else False
+        )
+
+    def eta_is_valid(self) -> bool:
+        """
+        `eta` shows eta of scheduled send_bundled_notification task and should never be less than the current time
+        (with a 1 minute buffer provided).
+        `eta` is None means that there is no scheduled task.
+        """
+        if not self.eta or self.eta + timezone.timedelta(minutes=1) >= timezone.now():
+            return True
+        return False
+
+    def get_notification_eta(self) -> datetime.datetime:
+        last_notified = self.last_notified_at if self.last_notified_at else timezone.now()
+        return last_notified + timezone.timedelta(seconds=BUNDLED_NOTIFICATION_DELAY_SECONDS)
+
+    def append_notification(self, alert_group, notification_policy):
+        self.notifications.create(
+            alert_group=alert_group, notification_policy=notification_policy, alert_receive_channel=alert_group.channel
+        )
+
+    @classmethod
+    def notification_is_bundleable(cls, notification_channel):
+        return notification_channel in cls.NOTIFICATION_CHANNELS_TO_BUNDLE
+
+
+class BundledNotification(models.Model):
+    alert_group = models.ForeignKey("alerts.AlertGroup", on_delete=models.CASCADE)
+    alert_receive_channel = models.ForeignKey("alerts.AlertReceiveChannel", on_delete=models.CASCADE)
+    notification_policy = models.ForeignKey("base.UserNotificationPolicy", on_delete=models.SET_NULL, null=True)
+    notification_bundle = models.ForeignKey(
+        UserNotificationBundle, on_delete=models.CASCADE, related_name="notifications"
+    )
+    created_at = models.DateTimeField(auto_now_add=True)
+    bundle_uuid = models.CharField(max_length=100, null=True, default=None, db_index=True)

engine/apps/alerts/paging.py

@@ -187,8 +187,7 @@ def unpage_user(alert_group: AlertGroup, user: User, from_user: User) -> None:
             user_has_notification = UserHasNotification.objects.filter(
                 user=user, alert_group=alert_group
             ).select_for_update()[0]
-            user_has_notification.active_notification_policy_id = None
-            user_has_notification.save(update_fields=["active_notification_policy_id"])
+            user_has_notification.update_active_task_id(task_id=None)
     except IndexError:
         return
     finally: