Merge pull request #1166 from ae-utbm/com-notification

Com notification

com/ics_calendar.py

@@ -68,7 +68,7 @@ class IcsCalendar:
                 start=news_date.start_date,
                 end=news_date.end_date,
                 url=as_absolute_url(
-                    reverse("com:news_detail", kwargs={"news_id": news_date.news.id})
+                    reverse("com:news_detail", kwargs={"news_id": news_date.news_id})
                 ),
             )
             calendar.events.append(event)

com/models.py

@@ -27,7 +27,7 @@ from django.conf import settings
 from django.core.exceptions import ValidationError
 from django.core.mail import EmailMultiAlternatives
 from django.db import models, transaction
-from django.db.models import F, Q
+from django.db.models import Exists, F, OuterRef, Q
 from django.shortcuts import render
 from django.templatetags.static import static
 from django.urls import reverse
@@ -55,9 +55,17 @@ class Sith(models.Model):
 
 
 class NewsQuerySet(models.QuerySet):
-    def moderated(self) -> Self:
+    def published(self) -> Self:
         return self.filter(is_published=True)
 
+    def waiting_moderation(self) -> Self:
+        """Filter all non-finished non-published news"""
+        # Because of the way News and NewsDates are created,
+        # there may be some cases where this method is called before
+        # the NewsDates linked to a Date are actually persisted in db.
+        # Thus, it's important to filter by "not past date" rather than by "future date"
+        return self.filter(~Q(dates__start_date__lt=timezone.now()), is_published=False)
+
     def viewable_by(self, user: User) -> Self:
         """Filter news that the given user can view.
 
@@ -127,20 +135,28 @@ class News(models.Model):
 
     def save(self, *args, **kwargs):
         super().save(*args, **kwargs)
-        if self.is_published:
+        if not self.is_published:
-            return
+            admins_without_notif = User.objects.filter(
-        for user in User.objects.filter(
+                ~Exists(
-            groups__id__in=[settings.SITH_GROUP_COM_ADMIN_ID]
+                    Notification.objects.filter(
-        ):
+                        user=OuterRef("pk"), type="NEWS_MODERATION"
-            Notification.objects.create(
+                    )
-                user=user, url=reverse("com:news_admin_list"), type="NEWS_MODERATION"
+                ),
+                groups__id=settings.SITH_GROUP_COM_ADMIN_ID,
             )
+            notif_url = reverse("com:news_admin_list")
+            new_notifs = [
+                Notification(user=user, url=notif_url, type="NEWS_MODERATION")
+                for user in admins_without_notif
+            ]
+            Notification.objects.bulk_create(new_notifs)
+        self.update_moderation_notifs()
 
     def get_absolute_url(self):
         return reverse("com:news_detail", kwargs={"news_id": self.id})
 
     def get_full_url(self):
-        return "https://%s%s" % (settings.SITH_URL, self.get_absolute_url())
+        return f"https://{settings.SITH_URL}{self.get_absolute_url()}"
 
     def is_owned_by(self, user):
         if user.is_anonymous:
@@ -159,19 +175,16 @@ class News(models.Model):
             or (user.is_authenticated and self.author_id == user.id)
         )
 
-
+    @staticmethod
-def news_notification_callback(notif: Notification):
+    def update_moderation_notifs():
-    # the NewsDate linked to the News
+        count = News.objects.waiting_moderation().count()
-    # which creation triggered this callback may not exist yet,
+        notifs_qs = Notification.objects.filter(
-    # so it's important to filter by "not past date" rather than by "future date"
+            type="NEWS_MODERATION", user__groups__id=settings.SITH_GROUP_COM_ADMIN_ID
-    count = News.objects.filter(
+        )
-        ~Q(dates__start_date__gt=timezone.now()), is_published=False
+        if count:
-    ).count()
+            notifs_qs.update(viewed=False, param=str(count))
-    if count:
+        else:
-        notif.viewed = False
+            notifs_qs.update(viewed=True)
-        notif.param = str(count)
-    else:
-        notif.viewed = True
 
 
 class NewsDateQuerySet(models.QuerySet):

com/tests/test_notifications.py

@@ -1,13 +1,22 @@
+from datetime import timedelta
+
 import pytest
 from django.conf import settings
+from django.utils.timezone import now
 from model_bakery import baker
 
-from com.models import News
+from com.models import News, NewsDate
+from core.baker_recipes import subscriber_user
 from core.models import Group, Notification, User
 
 
 @pytest.mark.django_db
 def test_notification_created():
+    # this news is unpublished, but is set in the past
+    # it shouldn't be taken into account when counting the number
+    # of news that are to be moderated
+    past_news = baker.make(News, is_published=False)
+    baker.make(NewsDate, news=past_news, start_date=now() - timedelta(days=1))
     com_admin_group = Group.objects.get(pk=settings.SITH_GROUP_COM_ADMIN_ID)
     com_admin_group.users.all().delete()
     Notification.objects.all().delete()
@@ -15,9 +24,28 @@ def test_notification_created():
     for i in range(2):
         # news notifications are permanent, so the notification created
         # during the first iteration should be reused during the second one.
-        baker.make(News)
+        baker.make(News, is_published=False)
         notifications = list(Notification.objects.all())
         assert len(notifications) == 1
         assert notifications[0].user == com_admin
         assert notifications[0].type == "NEWS_MODERATION"
         assert notifications[0].param == str(i + 1)
+
+
+@pytest.mark.django_db
+def test_notification_edited_when_moderating_news():
+    com_admin_group = Group.objects.get(pk=settings.SITH_GROUP_COM_ADMIN_ID)
+    com_admins = subscriber_user.make(_quantity=3)
+    com_admin_group.users.set(com_admins)
+    Notification.objects.all().delete()
+    news = baker.make(News, is_published=False)
+    assert Notification.objects.count() == 3
+    assert Notification.objects.filter(viewed=False).count() == 3
+
+    news.is_published = True
+    news.moderator = com_admins[0]
+    news.save()
+    # when the news is moderated, the notification should be marked as read
+    # for all admins
+    assert Notification.objects.count() == 3
+    assert Notification.objects.filter(viewed=False).count() == 0

sith/settings.py

@@ -686,8 +686,10 @@ SITH_NOTIFICATIONS = [
 # The keys are the notification names as found in SITH_NOTIFICATIONS, and the
 # values are the callback function to update the notifs.
 # The callback must take the notif object as first and single argument.
+# If a notification is permanent but requires no post-action, set the
+# callback import string as None
 SITH_PERMANENT_NOTIFICATIONS = {
-    "NEWS_MODERATION": "com.models.news_notification_callback",
+    "NEWS_MODERATION": None,
     "SAS_MODERATION": "sas.models.sas_notification_callback",
 }