BITMAKER-2625 estela: Propose Model and implementation for Activity Menu (#160)

* Call save_action method in views and serializers
* Refactor Activity and Notification code
* Changed Project ordering to use the name field
* Fixed serializers and migrations. 
* Update serializers and views to correctly use activity and notification
* Fix cronjob "run once" method

---------

Co-authored-by: Raymond Negron <raymond1242@Raymonds-MacBook-Air.local>
Co-authored-by: mgonnav <mateo@emegona.com>

Author: 3 people

estela-api/api/mixins.py

@@ -5,7 +5,7 @@
 from rest_framework.permissions import IsAuthenticated
 
 from api.permissions import IsProjectUser, IsAdminOrReadOnly
-from core.models import Notification
+from core.models import Notification, Activity
 
 
 class APIPageNumberPagination(PageNumberPagination):
@@ -22,14 +22,13 @@ class BaseViewSet(viewsets.GenericViewSet):
     pagination_class = APIPageNumberPagination
 
 
-class NotificationsHandlerMixin:
-    def save_notification(self, user, message, project):
-        notification = Notification(
-            message=message,
-            user=user,
-            project=project,
+class ActionHandlerMixin:
+    def save_action(self, user, description, project):
+        activity = Activity.objects.create(
+            user=user, project=project, description=description
         )
-        notification.save()
+
+        notifications = []
         for _user in project.users.all():
-            notification.users.add(_user, through_defaults={"seen": False})
-        notification.save()
+            notifications.append(Notification(user=_user, activity=activity))
+        Notification.objects.bulk_create(notifications)

estela-api/api/serializers/cronjob.py

@@ -1,9 +1,7 @@
 from croniter import croniter
 from rest_framework import serializers
 
-from api import errors
-
-from api.mixins import NotificationsHandlerMixin
+from api.mixins import ActionHandlerMixin
 from api.serializers.job_specific import (
     SpiderJobArgSerializer,
     SpiderJobEnvVarSerializer,
@@ -119,7 +117,8 @@ def create(self, validated_data):
 
 
 class SpiderCronJobUpdateSerializer(
-    serializers.ModelSerializer, NotificationsHandlerMixin
+    serializers.ModelSerializer,
+    ActionHandlerMixin,
 ):
     def validate(self, attrs):
         attrs = super(SpiderCronJobUpdateSerializer, self).validate(attrs)
@@ -149,35 +148,38 @@ def update(self, instance, validated_data):
         data_status = validated_data.get("data_status", "")
         data_expiry_days = int(validated_data.get("data_expiry_days", 1))
         name = instance.name
-        message = ""
+        description = ""
+
         if "schedule" in validated_data:
             instance.schedule = schedule
             update_schedule(name, schedule)
-            message = f"changed the schedule of Scheduled-job-{instance.cjid}."
+            description = f"changed the schedule of Sche-Job-{instance.cjid}."
+
         if "status" in validated_data:
             instance.status = status
             if status == SpiderCronJob.ACTIVE_STATUS:
                 enable_cronjob(name)
-                message = f"enabled Scheduled-job-{instance.cjid}."
+                description = f"enabled Sche-Job-{instance.cjid}."
             elif status == SpiderCronJob.DISABLED_STATUS:
                 disable_cronjob(name)
-                message = f"disabled Scheduled-job-{instance.cjid}."
+                description = f"disabled Sche-Job-{instance.cjid}."
+
         if "unique_collection" in validated_data:
             instance.unique_collection = unique_collection
+
         if "data_status" in validated_data:
             if data_status == DataStatus.PERSISTENT_STATUS:
                 instance.data_status = DataStatus.PERSISTENT_STATUS
-                message = f"changed data persistence of Scheduled-job-{instance.cjid} to persistent."
+                description = f"changed data persistence of Sche-Job-{instance.cjid} to persistent."
             elif data_status == DataStatus.PENDING_STATUS and data_expiry_days > 0:
                 instance.data_status = DataStatus.PENDING_STATUS
                 instance.data_expiry_days = data_expiry_days
-                message = f"changed data persistence of Scheduled-job-{instance.cjid} to {data_expiry_days} days."
-            else:
-                raise serializers.ValidationError({"error": errors.INVALID_DATA_STATUS})
+                days_ = data_expiry_days
+                description = f"changed data persistence of Sche-Job-{instance.cjid} to {days_} days."
 
-        self.save_notification(
+        self.save_action(
             user=user,
-            message=message,
+            description=description,
             project=instance.spider.project,
         )
         instance.save()

estela-api/api/serializers/notification.py

@@ -1,58 +1,21 @@
 from rest_framework import serializers
 
-from api.serializers.project import ProjectDetailSerializer, UserDetailSerializer
-from core.models import Notification, UserNotification
+from api.serializers.project import ActivitySerializer
+from core.models import Notification
 
 
 class NotificationSerializer(serializers.ModelSerializer):
-    user = UserDetailSerializer(
-        required=True, help_text="User who performed the action."
-    )
-    project = ProjectDetailSerializer(
-        required=True, help_text="Project where the action was performed."
-    )
+    activity = ActivitySerializer(required=True, help_text="Activity being notified.")
 
     class Meta:
         model = Notification
-        fields = ("nid", "message", "user", "project")
+        fields = ("nid", "activity", "seen")
 
 
-class UserNotificationSerializer(serializers.ModelSerializer):
-    id = serializers.IntegerField(
-        required=True, help_text="Unique user notification ID."
-    )
-    notification = NotificationSerializer(
-        required=True, help_text="Notification to which the user is subscribed."
-    )
-
-    class Meta:
-        model = UserNotification
-        fields = ("id", "notification", "seen", "created")
-
-    def to_representation(self, instance):
-        ret = super().to_representation(instance)
-        user = instance.notification.user
-
-        is_superuser = user.is_superuser or user.is_staff
-        user_in_project = instance.notification.project.users.filter(id=user.id)
-        if is_superuser and not user_in_project:
-            ret["notification"]["user"]["username"] = "Bitmaker Cloud Admin"
-        else:
-            ret["notification"]["user"][
-                "username"
-            ] = user.username
-        return ret
-
-
-class UserNotificationUpdateSerializer(serializers.ModelSerializer):
-    seen = serializers.BooleanField(
-        required=False,
-        help_text="Whether the user has seen the notification.",
-    )
-
+class NotificationUpdateSerializer(serializers.ModelSerializer):
     class Meta:
-        model = UserNotification
-        fields = ("id", "seen")
+        model = Notification
+        fields = ("nid", "seen")
 
     def update(self, instance, validated_data):
         instance.seen = validated_data.get("seen", instance.seen)

estela-api/api/serializers/project.py

@@ -1,7 +1,7 @@
 from django.contrib.auth.models import User
 from rest_framework import serializers
 
-from core.models import DataStatus, Permission, Project, UsageRecord
+from core.models import DataStatus, Permission, Project, UsageRecord, Activity
 
 
 class UserDetailSerializer(serializers.ModelSerializer):
@@ -162,3 +162,41 @@ class Meta:
             "data_status",
             "data_expiry_days",
         )
+
+
+class ActivitySerializer(serializers.ModelSerializer):
+    user = UserDetailSerializer(
+        required=True, help_text="User who performed the deploy."
+    )
+    project = ProjectDetailSerializer(
+        required=True, help_text="Project where the activity was performed."
+    )
+
+    class Meta:
+        model = Activity
+        fields = (
+            "user",
+            "project",
+            "description",
+            "created",
+        )
+
+    def to_representation(self, instance):
+        ret = super().to_representation(instance)
+        user = instance.user
+
+        is_superuser = user.is_superuser or user.is_staff
+        user_in_project = instance.project.users.filter(id=user.id)
+        if is_superuser and not user_in_project:
+            ret["user"]["username"] = user.username + " (admin)"
+
+        return ret
+
+
+class ProjectActivitySerializer(serializers.Serializer):
+    results = ActivitySerializer(
+        many=True, required=True, help_text="Project activities."
+    )
+    count = serializers.IntegerField(
+        required=True, help_text="Project activities count."
+    )

estela-api/api/urls.py

@@ -20,7 +20,7 @@
 )
 router.register(
     prefix=r"notifications",
-    viewset=notification_views.UserNotificationViewSet,
+    viewset=notification_views.NotificationViewSet,
     basename="notification",
 )
 router.register(

estela-api/api/views/cronjob.py

@@ -8,7 +8,7 @@
 from rest_framework.response import Response
 
 from api.filters import SpiderCronJobFilter
-from api.mixins import BaseViewSet, NotificationsHandlerMixin
+from api.mixins import BaseViewSet, ActionHandlerMixin
 from api.serializers.cronjob import (
     SpiderCronJobCreateSerializer,
     SpiderCronJobSerializer,
@@ -20,7 +20,7 @@
 
 class SpiderCronJobViewSet(
     BaseViewSet,
-    NotificationsHandlerMixin,
+    ActionHandlerMixin,
     mixins.CreateModelMixin,
     mixins.RetrieveModelMixin,
     mixins.UpdateModelMixin,
@@ -90,11 +90,10 @@ def create(self, request, *args, **kwargs):
             data_expiry_days=data_expiry_days,
         )
 
-        # Send notification action
         project = get_object_or_404(Project, pid=self.kwargs["pid"])
-        self.save_notification(
+        self.save_action(
             user=request.user,
-            message=f"scheduled a new Scheduled-job-{cronjob.cjid} for spider {spider.name}.",
+            description=f"scheduled a new Sche-Job-{cronjob.cjid} for spider {spider.name}.",
             project=project,
         )
 
@@ -128,6 +127,11 @@ def update(self, request, *args, **kwargs):
     def destroy(self, request, *args, **kwargs):
         instance = self.get_object()
         self.perform_destroy(instance)
+        self.save_action(
+            user=request.user,
+            description=f"deleted Sche-Job-{instance.cjid} for spider {instance.spider.name}.",
+            project=instance.spider.project,
+        )
         return Response(status=status.HTTP_204_NO_CONTENT)
 
     def perform_destroy(self, instance):

estela-api/api/views/deploy.py

@@ -4,7 +4,7 @@
 from rest_framework.response import Response
 from rest_framework.exceptions import ParseError, APIException, PermissionDenied
 
-from api.mixins import BaseViewSet, NotificationsHandlerMixin
+from api.mixins import BaseViewSet, ActionHandlerMixin
 from api.serializers.deploy import (
     DeploySerializer,
     DeployCreateSerializer,
@@ -19,8 +19,8 @@
 
 class DeployViewSet(
     BaseViewSet,
-    NotificationsHandlerMixin,
     viewsets.ModelViewSet,
+    ActionHandlerMixin,
 ):
     model_class = Deploy
     serializer_class = DeploySerializer
@@ -94,9 +94,9 @@ def update(self, request, *args, **kwargs):
 
         # Send action notification
         project = get_object_or_404(Project, pid=self.kwargs["pid"])
-        self.save_notification(
+        self.save_action(
             user=instance.user,
-            message=f"made a new Deploy #{serializer.data['did']}.",
+            description=f"made a new Deploy #{serializer.data['did']}.",
             project=project,
         )
 

estela-api/api/views/job.py

@@ -7,7 +7,7 @@
 from rest_framework.exceptions import ParseError
 
 from api.filters import SpiderJobFilter
-from api.mixins import BaseViewSet, NotificationsHandlerMixin
+from api.mixins import BaseViewSet, ActionHandlerMixin
 from api.serializers.job import (
     SpiderJobSerializer,
     SpiderJobCreateSerializer,
@@ -19,7 +19,7 @@
 
 class SpiderJobViewSet(
     BaseViewSet,
-    NotificationsHandlerMixin,
+    ActionHandlerMixin,
     mixins.CreateModelMixin,
     mixins.RetrieveModelMixin,
     mixins.UpdateModelMixin,
@@ -140,9 +140,9 @@ def create(self, request, *args, **kwargs):
 
         # Send action notification
         project = get_object_or_404(Project, pid=self.kwargs["pid"])
-        self.save_notification(
+        self.save_action(
             user=request.user,
-            message=f"run a new job for spider {spider.name}.",
+            description=f"run Job-{serializer.data['jid']} for spider {spider.name}.",
             project=project,
         )
 

estela-api/api/views/notification.py

@@ -4,30 +4,30 @@
 
 from api.mixins import BaseViewSet
 from api.serializers.notification import (
-    UserNotificationSerializer,
-    UserNotificationUpdateSerializer,
+    NotificationSerializer,
+    NotificationUpdateSerializer,
 )
-from core.models import UserNotification
+from core.models import Notification
 
 
-class UserNotificationViewSet(BaseViewSet, viewsets.ModelViewSet):
-    model_class = UserNotification
-    serializer_class = UserNotificationSerializer
-    queryset = UserNotification.objects.all()
+class NotificationViewSet(BaseViewSet, viewsets.ModelViewSet):
+    model_class = Notification
+    serializer_class = NotificationSerializer
+    queryset = Notification.objects.all()
 
     def get_queryset(self):
         if self.request is None:
-            return UserNotification.objects.none()
-        return UserNotification.objects.filter(user=self.request.user)
+            return Notification.objects.none()
+        return Notification.objects.filter(user=self.request.user).order_by("-activity__created")
 
     @swagger_auto_schema(
-        request_body=UserNotificationUpdateSerializer,
-        responses={status.HTTP_200_OK: UserNotificationUpdateSerializer()},
+        request_body=NotificationUpdateSerializer,
+        responses={status.HTTP_200_OK: NotificationUpdateSerializer()},
     )
     def update(self, request, *args, **kwargs):
         partial = kwargs.pop("partial", False)
         instance = self.get_object()
-        serializer = UserNotificationUpdateSerializer(
+        serializer = NotificationUpdateSerializer(
             instance, data=request.data, partial=partial
         )
         serializer.is_valid(raise_exception=True)