Make IdentificationTask.result null if source is null

Author: epou

api/serializers.py

@@ -1171,7 +1171,7 @@ class IdentificationTaskResultSerializer(serializers.ModelSerializer):
         confidence = serializers.FloatField(min_value=0, max_value=1, read_only=True)
         confidence_label = serializers.SerializerMethodField()
         is_high_confidence = serializers.SerializerMethodField()
-        source = serializers.ChoiceField(source='result_source',choices=IdentificationTask.ResultSource.choices, allow_null=True)
+        source = serializers.ChoiceField(source='result_source',choices=IdentificationTask.ResultSource.choices)
 
         def get_confidence_label(self, obj) -> str:
             return obj.confidence_label
@@ -1180,7 +1180,7 @@ def get_is_high_confidence(self, obj) -> bool:
             return obj.is_high_confidence
 
         def to_representation(self, instance):
-            if self.allow_null and not instance.is_done:
+            if self.allow_null and not instance.result_source:
                 return None  # Return None or an empty dict as needed
             return super().to_representation(instance)
 
@@ -1214,7 +1214,7 @@ class Meta(BaseAssignmentSerializer.Meta):
     observation = SimplifiedObservationWithPhotosSerializer(source='report', read_only=True)
     public_photo = SimplePhotoSerializer(source='photo', required=True)
     review = IdentificationTaskReviewSerializer(source='*', allow_null=True, read_only=True)
-    result = IdentificationTaskResultSerializer(source='*', read_only=True)
+    result = IdentificationTaskResultSerializer(source='*', read_only=True, allow_null=True)
     assignments = UserAssignmentSerializer(many=True, read_only=True)
 
     class Meta:

api/tests/integration/identification_tasks/get.tavern.yml

@@ -58,7 +58,11 @@ stages:
         Authorization: "Bearer {jwt_token_user_can_view:s}"
     response:
       status_code: 200
-      json: !force_format_include "{response_data_validation}"
+      strict:
+        - json:off
+      json:
+        observation:
+          uuid: "{identification_task.report.pk}"
 
 ---
 

api/tests/integration/identification_tasks/list.tavern.yml

@@ -43,6 +43,7 @@ includes:
 marks:
   - usefixtures:
     - api_live_url
+    - annotation
     - identification_task
     - jwt_token_user_can_view
 

api/tests/test_views.py

@@ -174,6 +174,44 @@ class TestObservationAPI(BaseReportTest):
     def report_object(self, app_user):
         return create_observation_object(user=app_user)
 
+@pytest.mark.django_db
+class TestIdentificationTaskAPI:
+    @classmethod
+    def build_url(cls, identification_task):
+        return f"/api/v1/identification-tasks/{identification_task.pk}/"
+
+    @pytest.fixture
+    def permitted_user(self, user):
+        grant_permission_to_user(type='view', model_class=IdentificationTask, user=user)
+        Token.objects.create(user=user)
+        return user
+
+    @pytest.fixture
+    def api_client(self, user):
+        api_client = APIClient()
+        api_client.force_login(user=user)
+
+        return api_client
+
+    @pytest.mark.parametrize(
+        "result_source, expect_null",
+        [
+            (IdentificationTask.ResultSource.AI, False),
+            (IdentificationTask.ResultSource.EXPERT, False),
+            (None, True)
+        ]
+    )
+    def test_result(self, api_client, permitted_user, identification_task, result_source, expect_null):
+        identification_task.result_source = result_source
+        identification_task.save()
+
+        response = api_client.get(
+            self.build_url(identification_task=identification_task),
+            format='json'
+        )
+        assert response.status_code == status.HTTP_200_OK
+        assert (response.data['result'] == None) == expect_null
+
 @pytest.mark.django_db
 class TestIdentificationTaskPredictionAPI:
     @classmethod