update submissionBundle submissionstatus with evaluation_id

Author: jaymedina

synapseclient/models/submission_bundle.py

@@ -179,7 +179,8 @@ class SubmissionBundle(SubmissionBundleSynchronousProtocol):
     """
 
     def fill_from_dict(
-        self, synapse_submission_bundle: Dict[str, Union[bool, str, int, Dict]]
+        self,
+        synapse_submission_bundle: Dict[str, Union[bool, str, int, Dict]],
     ) -> "SubmissionBundle":
         """
         Converts a response from the REST API into this dataclass.
@@ -201,9 +202,10 @@ def fill_from_dict(
 
         submission_status_dict = synapse_submission_bundle.get("submissionStatus", None)
         if submission_status_dict:
-            self.submission_status = SubmissionStatus().fill_from_dict(
-                submission_status_dict
-            )
+            self.submission_status = SubmissionStatus().fill_from_dict(submission_status_dict)
+            # Manually set evaluation_id from the submission data if available
+            if self.submission_status and self.submission and self.submission.evaluation_id:
+                self.submission_status.evaluation_id = self.submission.evaluation_id
         else:
             self.submission_status = None
 
@@ -268,7 +270,8 @@ async def get_evaluation_submission_bundles_async(
 
         bundles = []
         for bundle_dict in response.get("results", []):
-            bundle = SubmissionBundle().fill_from_dict(bundle_dict)
+            bundle = SubmissionBundle()
+            bundle.fill_from_dict(bundle_dict)
             bundles.append(bundle)
 
         return bundles
@@ -327,7 +330,8 @@ async def get_user_submission_bundles_async(
         # Convert response to list of SubmissionBundle objects
         bundles = []
         for bundle_dict in response.get("results", []):
-            bundle = SubmissionBundle().fill_from_dict(bundle_dict)
+            bundle = SubmissionBundle()
+            bundle.fill_from_dict(bundle_dict)
             bundles.append(bundle)
 
         return bundles

synapseclient/models/submission_status.py

@@ -432,7 +432,8 @@ def _set_last_persistent_instance(self) -> None:
         self._last_persistent_instance = replace(self)
 
     def fill_from_dict(
-        self, synapse_submission_status: Dict[str, Union[bool, str, int, float, List]]
+        self,
+        synapse_submission_status: Dict[str, Union[bool, str, int, float, List]],
     ) -> "SubmissionStatus":
         """
         Converts a response from the REST API into this dataclass.
@@ -744,7 +745,7 @@ async def get_all_submission_statuses_async(
         for status_dict in response.get("results", []):
             submission_status = SubmissionStatus()
             submission_status.fill_from_dict(status_dict)
-            # Manually set evaluation_id since it's not part of the response
+            # Manually set evaluation_id since it's not in the SubmissionStatus response
             submission_status.evaluation_id = evaluation_id
             submission_status._set_last_persistent_instance()
             submission_statuses.append(submission_status)

tests/integration/synapseclient/models/synchronous/test_submission_status.py

@@ -97,7 +97,9 @@ async def test_get_submission_status_by_id(
         assert submission_status.id == test_submission.id
         assert submission_status.entity_id == test_submission.entity_id
         assert submission_status.evaluation_id == test_evaluation.id
-        assert submission_status.status is not None  # Should have some status (e.g., "RECEIVED")
+        assert (
+            submission_status.status is not None
+        )  # Should have some status (e.g., "RECEIVED")
         assert submission_status.etag is not None
         assert submission_status.status_version is not None
         assert submission_status.modified_on is not None
@@ -108,7 +110,9 @@ async def test_get_submission_status_without_id(self):
         submission_status = SubmissionStatus()
 
         # THEN it should raise a ValueError
-        with pytest.raises(ValueError, match="The submission status must have an ID to get"):
+        with pytest.raises(
+            ValueError, match="The submission status must have an ID to get"
+        ):
             submission_status.get(synapse_client=self.syn)
 
     async def test_get_submission_status_with_invalid_id(self):
@@ -229,17 +233,17 @@ async def test_store_submission_status_with_submission_annotations(
         # WHEN I add submission annotations and store
         test_submission_status.submission_annotations = {
             "score": 85.5,
-            "validation_passed": True,
+            "validation_passed": [True],
             "feedback": "Good work!",
         }
         updated_status = test_submission_status.store(synapse_client=self.syn)
 
         # THEN the submission annotations should be saved
         assert updated_status.submission_annotations is not None
         assert "score" in updated_status.submission_annotations
-        assert updated_status.submission_annotations["score"] == 85.5
-        assert updated_status.submission_annotations["validation_passed"] == True
-        assert updated_status.submission_annotations["feedback"] == "Good work!"
+        assert updated_status.submission_annotations["score"] == [85.5]
+        assert updated_status.submission_annotations["validation_passed"] == [True]
+        assert updated_status.submission_annotations["feedback"] == ["Good work!"]
 
     async def test_store_submission_status_with_legacy_annotations(
         self, test_submission_status: SubmissionStatus
@@ -255,8 +259,8 @@ async def test_store_submission_status_with_legacy_annotations(
         # THEN the legacy annotations should be saved
         assert updated_status.annotations is not None
         assert "internal_score" in updated_status.annotations
-        assert updated_status.annotations["internal_score"] == 92.3
-        assert updated_status.annotations["reviewer_notes"] == "Excellent submission"
+        assert updated_status.annotations["internal_score"] == [92.3]
+        assert updated_status.annotations["reviewer_notes"] == ["Excellent submission"]
 
     async def test_store_submission_status_with_combined_annotations(
         self, test_submission_status: SubmissionStatus
@@ -276,11 +280,11 @@ async def test_store_submission_status_with_combined_annotations(
         # THEN both types of annotations should be saved
         assert updated_status.submission_annotations is not None
         assert "public_score" in updated_status.submission_annotations
-        assert updated_status.submission_annotations["public_score"] == 78.0
+        assert updated_status.submission_annotations["public_score"] == [78.0]
 
         assert updated_status.annotations is not None
         assert "internal_review" in updated_status.annotations
-        assert updated_status.annotations["internal_review"] == True
+        assert updated_status.annotations["internal_review"] == [True]
 
     async def test_store_submission_status_with_private_annotations_false(
         self, test_submission_status: SubmissionStatus
@@ -292,10 +296,12 @@ async def test_store_submission_status_with_private_annotations_false(
             "public_notes": "This should be visible",
         }
         test_submission_status.private_status_annotations = False
-        
+
         # AND I create the request body to inspect it
-        request_body = test_submission_status.to_synapse_request(synapse_client=self.syn)
-        
+        request_body = test_submission_status.to_synapse_request(
+            synapse_client=self.syn
+        )
+
         # THEN the annotations should be marked as not private in the request
         assert "annotations" in request_body
         annotations_data = request_body["annotations"]
@@ -312,10 +318,12 @@ async def test_store_submission_status_with_private_annotations_true(
             "private_notes": "This should be private",
         }
         test_submission_status.private_status_annotations = True
-        
+
         # AND I create the request body to inspect it
-        request_body = test_submission_status.to_synapse_request(synapse_client=self.syn)
-        
+        request_body = test_submission_status.to_synapse_request(
+            synapse_client=self.syn
+        )
+
         # THEN the annotations should be marked as private in the request
         assert "annotations" in request_body
         annotations_data = request_body["annotations"]
@@ -328,7 +336,9 @@ async def test_store_submission_status_without_id(self):
         submission_status = SubmissionStatus(status="SCORED")
 
         # THEN it should raise a ValueError
-        with pytest.raises(ValueError, match="The submission status must have an ID to update"):
+        with pytest.raises(
+            ValueError, match="The submission status must have an ID to update"
+        ):
             submission_status.store(synapse_client=self.syn)
 
     async def test_store_submission_status_without_changes(
@@ -405,7 +415,9 @@ async def test_files(
             with tempfile.NamedTemporaryFile(
                 mode="w", delete=False, suffix=".txt"
             ) as temp_file:
-                temp_file.write(f"This is test content {i} for submission status testing.")
+                temp_file.write(
+                    f"This is test content {i} for submission status testing."
+                )
                 temp_file_path = temp_file.name
 
             try:
@@ -546,18 +558,18 @@ async def test_batch_update_submission_statuses(
             )
             assert updated_status.status == "VALIDATED"
             assert "batch_score" in updated_status.submission_annotations
-            assert updated_status.submission_annotations["batch_processed"] == True
+            assert updated_status.submission_annotations["batch_processed"] == [True]
 
     async def test_batch_update_submission_statuses_large_batch(
         self, test_evaluation: Evaluation
     ):
         """Test batch update behavior with larger batch (approaching limits)."""
         # Note: This test demonstrates the pattern but doesn't create 500 submissions
         # as that would be too expensive for regular test runs
-        
+
         # GIVEN I have a list of statuses (simulated for this test)
         statuses = []
-        
+
         # WHEN I try to batch update (even with empty list)
         response = SubmissionStatus.batch_update_submission_statuses(
             evaluation_id=test_evaluation.id,
@@ -600,8 +612,10 @@ async def test_batch_update_submission_statuses_with_batch_tokens(
 
         # IF there's a second batch and we got a batch token
         if len(batch2) > 0:
-            batch_token = response1.get("batchToken") if isinstance(response1, dict) else None
-            
+            batch_token = (
+                response1.get("batchToken") if isinstance(response1, dict) else None
+            )
+
             # WHEN I update the second batch with the token
             response2 = SubmissionStatus.batch_update_submission_statuses(
                 evaluation_id=test_evaluation.id,
@@ -644,10 +658,7 @@ async def test_to_synapse_request_with_annotations_missing_evaluation_id(self):
         """Test that annotations require evaluation_id."""
         # WHEN I try to create a request with annotations but no evaluation_id
         submission_status = SubmissionStatus(
-            id="123",
-            etag="some-etag", 
-            status_version=1,
-            annotations={"test": "value"}
+            id="123", etag="some-etag", status_version=1, annotations={"test": "value"}
         )
 
         # THEN it should raise a ValueError
@@ -663,7 +674,7 @@ async def test_to_synapse_request_valid_attributes(self):
             status_version=1,
             status="SCORED",
             evaluation_id="eval123",
-            submission_annotations={"score": 85.5}
+            submission_annotations={"score": 85.5},
         )
 
         # THEN it should create a valid request body
@@ -690,21 +701,15 @@ async def test_fill_from_dict_with_complete_response(self):
             "canCancel": False,
             "cancelRequested": False,
             "annotations": {
-                "stringAnnos": {
-                    "internal_note": ["This is internal"]
-                },
+                "stringAnnos": {"internal_note": ["This is internal"]},
                 "doubleAnnos": {},
-                "longAnnos": {}
+                "longAnnos": {},
             },
             "submissionAnnotations": {
-                "stringAnnos": {
-                    "feedback": ["Great work!"]
-                },
-                "doubleAnnos": {
-                    "score": [92.5]
-                },
-                "longAnnos": {}
-            }
+                "stringAnnos": {"feedback": ["Great work!"]},
+                "doubleAnnos": {"score": [92.5]},
+                "longAnnos": {},
+            },
         }
 
         # WHEN I fill a SubmissionStatus from the response
@@ -730,10 +735,7 @@ async def test_fill_from_dict_with_complete_response(self):
     async def test_fill_from_dict_with_minimal_response(self):
         """Test filling a SubmissionStatus from a minimal API response."""
         # GIVEN a minimal API response
-        api_response = {
-            "id": "123456",
-            "status": "RECEIVED"
-        }
+        api_response = {"id": "123456", "status": "RECEIVED"}
 
         # WHEN I fill a SubmissionStatus from the response
         submission_status = SubmissionStatus()