Added is_favourite field to annotations

Author: epou

api/filters.py

@@ -4,7 +4,7 @@
 
 from django_filters import rest_framework as filters
 
-from tigacrafting.models import IdentificationTask, ExpertReportAnnotation, Taxon
+from tigacrafting.models import IdentificationTask, ExpertReportAnnotation, Taxon, FavoritedReports
 from tigaserver_app.models import Report, Notification, OWCampaigns, EuropeCountry, Photo
 
 User = get_user_model()
@@ -247,6 +247,22 @@ def filter_by_is_decisive(self, queryset, name, value):
             )
         )
 
+    is_favourite = filters.BooleanFilter(
+        method="filter_by_is_favourite"
+    )
+
+    def filter_by_is_favourite(self, queryset, name, value):
+        if not value:
+            return queryset
+        return queryset.annotate(
+            is_favourite=models.Exists(
+                FavoritedReports.objects.filter(
+                    user=models.OuterRef('user'),
+                    report=models.OuterRef('report'),
+                )
+            )
+        ).filter(is_favourite=value)
+
     order_by = filters.OrderingFilter(
         fields=(("created", "created_at"), ("last_modified", "updated_at"))
     )

api/serializers.py

@@ -18,7 +18,8 @@
     Taxon,
     ExpertReportAnnotation,
     UserStat,
-    PhotoPrediction
+    PhotoPrediction,
+    FavoritedReports
 )
 from tigaserver_app.models import (
     NotificationContent,
@@ -815,12 +816,20 @@ class Meta:
         default=False,
     )
 
+    is_favourite = WritableSerializerMethodField(
+        field_class=serializers.BooleanField,
+        default=False,
+    )
+
     def get_is_flagged(self, obj) -> bool:
         return obj.status == ExpertReportAnnotation.STATUS_FLAGGED
 
     def get_is_decisive(self, obj) -> bool:
         return obj.validation_complete_executive or obj.revise
 
+    def get_is_favourite(self, obj) -> bool:
+        return obj.is_favourite
+
     def validate(self, data):
         data['user'] = data.pop('user_hidden_obj')
         data['validation_complete'] = True
@@ -847,6 +856,33 @@ def validate(self, data):
 
         return data
 
+    def create(self, validated_data):
+        is_favourite = validated_data.pop("is_favourite", False)
+        with transaction.atomic():
+            instance = super().create(validated_data)
+            if is_favourite:
+                FavoritedReports.objects.get_or_create(
+                    user=instance.user,
+                    report=instance.report,
+                )
+        return instance
+
+    def update(self, instance, validated_data):
+        is_favourite = validated_data.pop("is_favourite", False)
+        with transaction.atomic():
+            instance = super().update(instance, validated_data)
+            if is_favourite:
+                FavoritedReports.objects.get_or_create(
+                    user=instance.user,
+                    report=instance.report,
+                )
+            else:
+                FavoritedReports.objects.filter(
+                    user=instance.user,
+                    report=instance.report,
+                ).delete()
+        return instance
+
     class Meta:
         model = ExpertReportAnnotation
         fields = (
@@ -860,6 +896,7 @@ class Meta:
             "feedback",
             "is_flagged",
             "is_decisive",
+            "is_favourite",
             "tags",
             "created_at",
             "updated_at",

api/tests/integration/identification_tasks/annotations/create.tavern.yml

@@ -91,6 +91,7 @@ stages:
           user_note: null
         is_flagged: false
         is_decisive: false
+        is_favourite: false
         tags: !anylist
         created_at: !re_fullmatch \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}Z
         updated_at: !re_fullmatch \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}Z
@@ -153,6 +154,7 @@ stages:
           user_note: null
         is_flagged: false
         is_decisive: false
+        is_favourite: false
         tags: !anylist
         created_at: !re_fullmatch \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}Z
         updated_at: !re_fullmatch \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}Z

api/tests/integration/identification_tasks/annotations/schema.yml

@@ -21,6 +21,7 @@ variables:
       user_note: !anything
     is_flagged: !anybool
     is_decisive: !anybool
+    is_favourite: !anybool
     created_at: !re_fullmatch \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}Z
     updated_at: !re_fullmatch \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}Z
     tags: !anylist

api/tests/test_views.py

@@ -15,7 +15,7 @@
 
 from rest_framework_simplejwt.settings import api_settings
 
-from tigacrafting.models import ExpertReportAnnotation, IdentificationTask, PhotoPrediction
+from tigacrafting.models import ExpertReportAnnotation, IdentificationTask, PhotoPrediction, FavoritedReports
 from tigaserver_app.models import TigaUser, Report, Device, MobileApp
 
 from api.tests.clients import AppAPIClient
@@ -796,6 +796,53 @@ def test_is_flagged_sets_status_to_flagged(self, api_client, endpoint, common_po
         annotation = ExpertReportAnnotation.objects.get(pk=response.data['id'])
         assert annotation.status == expected_result
 
+    @pytest.mark.parametrize(
+        "is_favourite",
+        [True, False]
+    )
+    def test_is_favourite_creates_FavoritedReports(self, api_client, endpoint, common_post_data, with_add_permission, is_favourite):
+        post_data = common_post_data
+        post_data['is_favourite'] = is_favourite
+
+        response = api_client.post(
+            endpoint,
+            data=post_data,
+            format='json'
+        )
+        assert response.status_code == status.HTTP_201_CREATED
+        assert response.data['is_favourite'] == is_favourite
+
+        annotation = ExpertReportAnnotation.objects.get(pk=response.data['id'])
+        assert annotation.is_favourite == is_favourite
+        assert FavoritedReports.objects.filter(
+            report=annotation.identification_task.report,
+            user=annotation.user
+        ).exists() == is_favourite
+
+    def test_is_favourite_does_nothing_if_already_exists_FavoritedReports(self, api_client, user, identification_task, endpoint, common_post_data, with_add_permission):
+        FavoritedReports.objects.create(
+            report=identification_task.report,
+            user=user
+        )
+
+        post_data = common_post_data
+        post_data['is_favourite'] = True
+
+        response = api_client.post(
+            endpoint,
+            data=post_data,
+            format='json'
+        )
+        assert response.status_code == status.HTTP_201_CREATED
+        assert response.data['is_favourite'] is True
+
+        annotation = ExpertReportAnnotation.objects.get(pk=response.data['id'])
+        assert annotation.is_favourite
+        assert FavoritedReports.objects.filter(
+            report=annotation.identification_task.report,
+            user=annotation.user
+        ).exists()
+
     @pytest.mark.parametrize(
         "pre_assign",
         [True, False]

api/views.py

@@ -31,7 +31,7 @@
 from rest_framework.viewsets import ReadOnlyModelViewSet
 from rest_framework_simplejwt.tokens import Token
 
-from tigacrafting.models import IdentificationTask, ExpertReportAnnotation, Taxon, PhotoPrediction
+from tigacrafting.models import IdentificationTask, ExpertReportAnnotation, Taxon, PhotoPrediction, FavoritedReports
 from tigaserver_app.models import (
     TigaUser,
     EuropeCountry,
@@ -601,6 +601,13 @@ class AnnotationViewSet(NestedViewSetMixin, ListModelMixin, RetrieveModelMixin,
             'report',
             'best_photo',
             'taxon',
+        ).annotate(
+            is_favourite=models.Exists(
+                FavoritedReports.objects.filter(
+                    user=models.OuterRef('user'),
+                    report=models.OuterRef('report')
+                )
+            )
         )
         serializer_class = AnnotationSerializer
         filterset_class = AnnotationFilter

tigacrafting/models.py

@@ -865,6 +865,10 @@ def is_high_confidence(self) -> bool:
             return False
         return get_is_high_confidence(value=self.confidence)
 
+    @cached_property
+    def is_favourite(self) -> bool:
+        return FavoritedReports.objects.filter(user=self.user, report=self.report).exists()
+
     @classmethod
     def _get_auto_message(cls, category: 'Categories', validation_value: int, locale: str = 'en') -> Optional[str]:
         msg_dict = other_insect_msg_dict