Implement evaluation content endpoint by delegating to provider (#406)

* Implement evaluation content endpoint by delegating to provider

* Rename test class to align with naming conventions

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

* Added test_should_return_none_for_invalid_evaluation_id

* implemented test_should_return_evaluation_content_for_valid_evaluation_id

---------

Co-authored-by: HazalCiplak <hazalciplak@gmail.com>

Author: de-code

data_hub_api/docmaps/v2/api_input_typing.py

@@ -7,6 +7,7 @@
     {
         'hypothesis_id': str,
         'annotation_created_timestamp': datetime,
+        'annotation_content': str,
         'tags': list,
         'uri': str,
         'source_version': str,

data_hub_api/docmaps/v2/api_router.py

@@ -34,7 +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):
-        evaluation_text = 'dummy evaluation text for evaluation_id: ' + evaluation_id
-        return evaluation_text
+        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

@@ -87,3 +87,16 @@ def iter_docmaps_index_json_stream(self):
             LOGGER.exception('Error while streaming docmaps index as JSON: %s', e)
             raise
         LOGGER.info('Finished streaming docmaps index as JSON.')
+
+    def get_evaluation_content_by_id(self, evaluation_id: str) -> Optional[str]:
+        LOGGER.debug('Getting evaluation content for evaluation_id: %s', evaluation_id)
+        bq_result_list = self._query_results_cache.get_or_load(
+            load_fn=self._load_query_results_from_bq
+        )
+        LOGGER.debug('bq_result_list: %r', bq_result_list)
+        for bq_result in bq_result_list:
+            for manuscript_version in bq_result.get('manuscript_versions', []):
+                for evaluation in manuscript_version.get('evaluations', []):
+                    if evaluation['hypothesis_id'] == evaluation_id:
+                        return evaluation['annotation_content']
+        return None

tests/unit_tests/docmaps/v2/api_router_test.py

@@ -9,6 +9,8 @@
 
 PREPRINT_DOI = '10.1101/doi1'
 MANUSCRIPT_ID = 'manuscript_id_1'
+EVALUATION_ID_1 = 'evaluation_content_id_1'
+EVALUATION_CONTENT_1 = 'evaluation content for evaluation_content_id_1'
 
 
 @pytest.fixture(name='docmaps_provider_mock')
@@ -69,3 +71,32 @@ 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
+    ):
+        docmaps_provider_mock.get_evaluation_content_by_id.return_value = EVALUATION_CONTENT_1
+        client = create_test_client(docmaps_provider_mock)
+        response = client.get(
+            '/v2/evaluation/get-by-evaluation-id',
+            params={'evaluation_id': EVALUATION_ID_1}
+        )
+        docmaps_provider_mock.get_evaluation_content_by_id.assert_called_with(
+            EVALUATION_ID_1
+        )
+        assert response.status_code == 200
+        assert response.text == EVALUATION_CONTENT_1
+        assert response.headers['content-type'] == 'text/html; charset=utf-8'

tests/unit_tests/docmaps/v2/provider_test.py

@@ -11,7 +11,11 @@
     get_docmap_item_for_query_result_item,
     DocmapsProvider
 )
-from tests.unit_tests.docmaps.v2.test_data import DOCMAPS_QUERY_RESULT_ITEM_1
+from tests.unit_tests.docmaps.v2.test_data import (
+    DOCMAPS_QUERY_RESULT_EVALUATION_1,
+    DOCMAPS_QUERY_RESULT_ITEM_1,
+    MANUSCRIPT_VERSION_1
+)
 
 
 @pytest.fixture(name='iter_dict_from_bq_query_mock', autouse=True)
@@ -26,7 +30,7 @@ def _get_docmaps_index_dict(provider: DocmapsProvider) -> dict:
     )
 
 
-class TestEnhancedPreprintsDocmapsProvider:
+class TestDocmapsProvider:
     def test_should_create_index_with_non_empty_docmaps(
         self,
         iter_dict_from_bq_query_mock: MagicMock
@@ -55,3 +59,27 @@ def test_should_cache_docmaps_query_results(
         assert docmaps_index['docmaps'] == [
             get_docmap_item_for_query_result_item(cast(ApiInput, DOCMAPS_QUERY_RESULT_ITEM_1))
         ]
+
+    def test_should_return_none_for_invalid_evaluation_id(
+        self,
+        iter_dict_from_bq_query_mock: MagicMock
+    ):
+        iter_dict_from_bq_query_mock.return_value = []
+        docmaps_provider = DocmapsProvider()
+        assert docmaps_provider.get_evaluation_content_by_id('not_found_id_1') is None
+
+    def test_should_return_evaluation_content_for_valid_evaluation_id(
+        self,
+        iter_dict_from_bq_query_mock: MagicMock
+    ):
+        iter_dict_from_bq_query_mock.return_value = [{
+            **DOCMAPS_QUERY_RESULT_ITEM_1,
+            'manuscript_versions': [{
+                **MANUSCRIPT_VERSION_1,  # type: ignore
+                'evaluations': [DOCMAPS_QUERY_RESULT_EVALUATION_1]
+            }]
+        }]
+        docmaps_provider = DocmapsProvider()
+        assert docmaps_provider.get_evaluation_content_by_id(
+            DOCMAPS_QUERY_RESULT_EVALUATION_1['hypothesis_id']
+        ) == DOCMAPS_QUERY_RESULT_EVALUATION_1['annotation_content']

tests/unit_tests/docmaps/v2/test_data.py

@@ -231,9 +231,13 @@
 ANNOTATION_CREATED_TIMESTAMP_2 = datetime.fromisoformat('2021-01-01T01:02:03+00:00')
 ANNOTATION_CREATED_TIMESTAMP_3 = datetime.fromisoformat('2022-01-01T01:02:03+00:00')
 
+ANNOTATION_CONTENT_1 = 'annotation_content_1'
+ANNOTATION_CONTENT_2 = 'annotation_content_2'
+
 DOCMAPS_QUERY_RESULT_EVALUATION_1: ApiEvaluationInput = {
     'hypothesis_id': HYPOTHESIS_ID_1,
     'annotation_created_timestamp': ANNOTATION_CREATED_TIMESTAMP_1,
+    'annotation_content': ANNOTATION_CONTENT_1,
     'tags': [],
     'uri': PREPRINT_LINK_1,
     'source_version': PREPRINT_VERSION_1,
@@ -243,6 +247,7 @@
 DOCMAPS_QUERY_RESULT_EVALUATION_2: ApiEvaluationInput = {
     'hypothesis_id': HYPOTHESIS_ID_2,
     'annotation_created_timestamp': ANNOTATION_CREATED_TIMESTAMP_2,
+    'annotation_content': ANNOTATION_CONTENT_2,
     'tags': [],
     'uri': PREPRINT_LINK_2,
     'source_version': PREPRINT_VERSION_2,