Add error handling for evaluation content retrieval and update provider method signature

Author: HazalCiplak

data_hub_api/docmaps/v2/api_router.py

@@ -34,6 +34,12 @@ def get_enhanced_preprints_docmaps_by_manuscript_id_by_publisher_elife(manuscrip
 
     @router.get("/v2/evaluation/get-by-evaluation-id", response_class=HTMLResponse)
     def get_evaluation_text_by_evaluation_id(evaluation_id: str):
-        return docmaps_provider.get_evaluation_content_by_id(evaluation_id)
+        evaluation_content = docmaps_provider.get_evaluation_content_by_id(evaluation_id)
+        if not evaluation_content:
+            raise HTTPException(
+                status_code=404,
+                detail=f"No evaluation content available for evaluation_id: {evaluation_id}"
+            )
+        return evaluation_content
 
     return router

data_hub_api/docmaps/v2/provider.py

@@ -88,5 +88,5 @@ def iter_docmaps_index_json_stream(self):
             raise
         LOGGER.info('Finished streaming docmaps index as JSON.')
 
-    def get_evaluation_content_by_id(self, evaluation_id: str) -> str:
+    def get_evaluation_content_by_id(self, evaluation_id: str) -> Optional[str]:
         return 'dummy evaluation content for evaluation_id: ' + evaluation_id

tests/unit_tests/docmaps/v2/api_router_test.py

@@ -72,6 +72,18 @@ def test_should_return_docmap_from_provider_by_publisher_for_individual_manuscri
         assert response.status_code == 200
         assert response.json() == article_docmap_list[0]
 
+    def test_should_return_not_found_status_code_for_invalid_evaluation_id(
+        self,
+        docmaps_provider_mock: MagicMock
+    ):
+        docmaps_provider_mock.get_evaluation_content_by_id.return_value = None
+        client = create_test_client(docmaps_provider_mock)
+        response = client.get(
+            '/v2/evaluation/get-by-evaluation-id',
+            params={'evaluation_id': 'non_existent_evaluation_id_1'}
+        )
+        assert response.status_code == 404
+
     def test_should_return_evaluation_content_from_provider(
         self,
         docmaps_provider_mock: MagicMock