Added observation_flags in annotations

Author: epou

api/serializers.py

@@ -831,6 +831,29 @@ def to_internal_value(self, data):
         class Meta:
             fields = ("sex", "is_blood_fed", "is_gravid")
 
+    class ObservationFlagsSerializer(serializers.ModelSerializer):
+        is_favourite = WritableSerializerMethodField(
+            field_class=serializers.BooleanField,
+            default=False,
+        )
+        is_visible = WritableSerializerMethodField(
+            field_class=serializers.BooleanField,
+            default=True,
+        )
+
+        def get_is_favourite(self, obj) -> bool:
+            return obj.is_favourite
+
+        def get_is_visible(self, obj) -> bool:
+            return obj.status != ExpertReportAnnotation.STATUS_HIDDEN
+
+        class Meta:
+            model = ExpertReportAnnotation
+            fields = (
+                "is_favourite",
+                "is_visible"
+            )
+
     user_hidden_obj = serializers.HiddenField(default=serializers.CurrentUserDefault())
 
     user = SimpleAnnotatorUserSerializer(read_only=True)
@@ -842,6 +865,7 @@ class Meta:
     best_photo = SimplePhotoSerializer(read_only=True, allow_null=True)
     tags = TagListSerializerField(required=False, allow_empty=True)
     type = serializers.SerializerMethodField()
+    observation_flags = ObservationFlagsSerializer(source='*', required=False)
 
     is_flagged = WritableSerializerMethodField(
         field_class=serializers.BooleanField,
@@ -853,11 +877,6 @@ class Meta:
         default=False,
     )
 
-    is_favourite = WritableSerializerMethodField(
-        field_class=serializers.BooleanField,
-        default=False,
-    )
-
     def get_type(self, obj) -> Literal['short', 'long']:
         return 'short' if obj.simplified_annotation else 'long'
 
@@ -867,9 +886,6 @@ def get_is_flagged(self, obj) -> bool:
     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
@@ -886,11 +902,15 @@ def validate(self, data):
                 raise serializers.ValidationError("The photo does not does not exist or does not belong to the observation.")
 
         is_flagged = data.pop("is_flagged")
-        if is_flagged:
-            data["status"] = ExpertReportAnnotation.STATUS_FLAGGED
-        elif not data.get("status", None):
-            # Only set to PUBLIC if not set to HIDDEN
-            data["status"] = ExpertReportAnnotation.STATUS_PUBLIC
+        is_visible = data.pop("is_visible", self.ObservationFlagsSerializer().fields['is_visible'].default)
+        # Only if status not set yet (for example classification None sets it to hidden).
+        if not data.get("status", None):
+            if not is_visible:
+                data["status"] = ExpertReportAnnotation.STATUS_HIDDEN
+            elif is_flagged:
+                data["status"] = ExpertReportAnnotation.STATUS_FLAGGED
+            else:
+                data["status"] = ExpertReportAnnotation.STATUS_PUBLIC
 
         data['validation_complete_executive'] = data.pop("is_decisive")
 
@@ -951,7 +971,7 @@ class Meta:
             "type",
             "is_flagged",
             "is_decisive",
-            "is_favourite",
+            "observation_flags",
             "tags",
             "created_at",
             "updated_at",

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

@@ -92,7 +92,9 @@ stages:
         type: !anystr
         is_flagged: false
         is_decisive: false
-        is_favourite: false
+        observation_flags:
+          is_favourite: false
+          is_visible: true
         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
@@ -156,7 +158,9 @@ stages:
         type: !anystr
         is_flagged: false
         is_decisive: false
-        is_favourite: false
+        observation_flags:
+          is_favourite: false
+          is_visible: true
         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

@@ -22,7 +22,9 @@ variables:
     type: !anystr
     is_flagged: !anybool
     is_decisive: !anybool
-    is_favourite: !anybool
+    observation_flags:
+      is_favourite: !anybool
+      is_visible: !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

@@ -796,21 +796,61 @@ 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
 
+    def test_empty_observation_flags(self, api_client, endpoint, common_post_data, with_add_permission):
+        post_data = common_post_data
+        # Ensure observation_flags is not set
+        post_data.pop('observation_flags', None)
+
+        response = api_client.post(
+            endpoint,
+            data=post_data,
+            format='json'
+        )
+        assert response.status_code == status.HTTP_201_CREATED
+
+        assert response.data['observation_flags']['is_favourite'] == False
+        assert response.data['observation_flags']['is_visible'] == True
+
+    @pytest.mark.parametrize(
+        "is_visible, expected_result",
+        [
+            (True, ExpertReportAnnotation.STATUS_PUBLIC),
+            (False, ExpertReportAnnotation.STATUS_HIDDEN),
+        ]
+    )
+    def test_is_visible_sets_status_to_public(self, api_client, endpoint, common_post_data, with_add_permission, is_visible, expected_result):
+        post_data = common_post_data
+        post_data['observation_flags'] = {
+            'is_visible': is_visible
+        }
+
+        response = api_client.post(
+            endpoint,
+            data=post_data,
+            format='json'
+        )
+        assert response.status_code == status.HTTP_201_CREATED
+
+        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
+        post_data['observation_flags'] = {
+            '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
+        assert response.data['observation_flags']['is_favourite'] == is_favourite
 
         annotation = ExpertReportAnnotation.objects.get(pk=response.data['id'])
         assert annotation.is_favourite == is_favourite
@@ -834,7 +874,7 @@ def test_is_favourite_does_nothing_if_already_exists_FavoritedReports(self, api_
             format='json'
         )
         assert response.status_code == status.HTTP_201_CREATED
-        assert response.data['is_favourite'] is True
+        assert response.data['observation_flags']['is_favourite'] is True
 
         annotation = ExpertReportAnnotation.objects.get(pk=response.data['id'])
         assert annotation.is_favourite
@@ -905,6 +945,10 @@ def test_POST_always_saves_validation_complete_True(self, pre_assign, api_client
     def test_classification_null_shoud_set_status_to_hidden(self, api_client, endpoint, common_post_data, with_add_permission):
         post_data = common_post_data
         post_data['classification'] = None
+        # NOTE: force is_visible. Should set to hidden anyways.
+        post_data['observation_flags'] = {
+            "is_visible": True
+        }
 
         response = api_client.post(
             endpoint,