Warn on unexpected header, use HTTPException

Author: olliesilvester

src/daq_config_server/app.py

@@ -5,7 +5,7 @@
 from typing import Annotated
 
 import uvicorn
-from fastapi import FastAPI, Header
+from fastapi import FastAPI, Header, HTTPException
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import JSONResponse, Response
 
@@ -43,7 +43,7 @@ def get_configuration(
     Read a file and return its contents in a format specified by the accept header.
     """
     if not file_path.is_file():
-        raise FileNotFoundError(f"File {file_path} cannot be found")
+        raise HTTPException(status_code=404, detail=f"File {file_path} cannot be found")
 
     file_name = os.path.basename(file_path)
 

src/daq_config_server/client.py

@@ -1,4 +1,3 @@
-import json
 from enum import StrEnum
 from logging import Logger, getLogger
 from typing import Any, TypeVar
@@ -36,10 +35,16 @@ def _get(
 
         content_type = r.headers["content-type"].split(";")[0].strip()
 
+        if content_type != headers["Accept"]:
+            self._log.warning(
+                f"Server failed to parse the file as requested. Requested \
+                {headers['Accept']} but response came as content-type {content_type}"
+            )
+
         try:
             match content_type:
                 case ValidAcceptHeaders.JSON:
-                    content = json.loads(r.content)
+                    content = r.json()
                 case ValidAcceptHeaders.PLAIN_TEXT:
                     content = r.text
                 case _:

tests/unit_tests/test_api.py

@@ -57,9 +57,8 @@ async def test_get_configuration_on_plain_text_file(mock_app: TestClient):
 
 def test_get_configuration_exception_on_invalid_file(mock_app: TestClient):
     file_path = f"{TEST_DATA_DIR}/nonexistent_file.yaml"
-
-    with pytest.raises(FileNotFoundError):
-        mock_app.get(f"{ENDPOINTS.CONFIG}/{file_path}", headers=HEADER_DEFAULTS)
+    response = mock_app.get(f"{ENDPOINTS.CONFIG}/{file_path}", headers=HEADER_DEFAULTS)
+    assert response.status_code == status.HTTP_404_NOT_FOUND
 
 
 async def test_get_configuration_on_json_file(mock_app: TestClient):

tests/unit_tests/test_client.py

@@ -26,19 +26,56 @@ def test_get_file_contents(mock_request: MagicMock):
 def test_get_file_contents_warns_and_gives_bytes_on_invalid_json(
     mock_request: MagicMock,
 ):
+    content_type = ValidAcceptHeaders.JSON
     bad_json = "bad_dict}"
     mock_request.return_value = Response(
         status_code=status.HTTP_200_OK,
         json="test",
         headers={
-            "accept": ValidAcceptHeaders.JSON,
-            "content-type": ValidAcceptHeaders.JSON,
+            "content-type": content_type,
         },
         content=bad_json,
     )
     file_path = "test"
     url = "url"
     server = ConfigServer(url)
     server._log.warning = MagicMock()
-    assert server.get_file_contents(file_path) == bad_json.encode()
-    server._log.warning.assert_called_once()
+    assert (
+        server.get_file_contents(
+            file_path, requested_response_format=RequestedResponseFormats.DICT
+        )
+        == bad_json.encode()
+    )
+    assert (
+        f"Failed trying to convert to content-type {content_type} due to "
+        in server._log.warning.call_args[0][0]
+    )
+
+
+@patch("daq_config_server.client.requests.get")
+def test_logger_warning_if_content_type_doesnt_match_requested_type(
+    mock_request: MagicMock,
+):
+    headers = {"Accept": RequestedResponseFormats.DICT}
+    content_type = ValidAcceptHeaders.PLAIN_TEXT
+    text = "text"
+    mock_request.return_value = Response(
+        status_code=status.HTTP_200_OK,
+        json="test",
+        headers={
+            "content-type": content_type,
+        },
+        content=text,
+    )
+    file_path = "test"
+    url = "url"
+    server = ConfigServer(url)
+    server._log.warning = MagicMock()
+    server.get_file_contents(
+        file_path, requested_response_format=RequestedResponseFormats.DICT
+    )
+
+    server._log.warning.assert_called_once_with(
+        f"Server failed to parse the file as requested. Requested \
+                {headers['Accept']} but response came as content-type {content_type}"
+    )