FIX: Add x-upstream-source to most /smda responses

Author: mferrera

src/fmu_settings_api/deps.py

@@ -122,11 +122,13 @@ async def ensure_smda_session(session: Session) -> None:
         raise HTTPException(
             status_code=401,
             detail="User SMDA API key is not configured",
+            headers={"x-upstream-source": "SMDA"},
         )
     if session.access_tokens.smda_api is None:
         raise HTTPException(
             status_code=401,
             detail="SMDA access token is not set",
+            headers={"x-upstream-source": "SMDA"},
         )
 
 

src/fmu_settings_api/v1/routes/smda/main.py

@@ -1,10 +1,11 @@
 """Routes for querying SMDA's API."""
 
 import asyncio
+from collections.abc import Generator
 from textwrap import dedent
 
 import httpx
-from fastapi import APIRouter, HTTPException
+from fastapi import APIRouter, Depends, HTTPException, Response
 from fmu.settings.models.smda import (
     CoordinateSystem,
     FieldItem,
@@ -29,7 +30,16 @@
 )
 from fmu_settings_api.v1.responses import GetSessionResponses, inline_add_response
 
-router = APIRouter(prefix="/smda", tags=["smda"])
+
+def _add_response_headers(response: Response) -> Generator[None]:
+    """Adds headers specific to the /smda route."""
+    response.headers["x-upstream-source"] = "SMDA"
+    yield
+
+
+router = APIRouter(
+    prefix="/smda", tags=["smda"], dependencies=[Depends(_add_response_headers)]
+)
 
 
 @router.get(
@@ -57,7 +67,11 @@ async def get_health(session: SessionDep) -> Ok:
     """Returns a simple 200 OK if able to query SMDA."""
     # Handled on the route dependency, duplicated for typing
     if session.access_tokens.smda_api is None:
-        raise HTTPException(status_code=401, detail="SMDA access token is not set")
+        raise HTTPException(
+            status_code=401,
+            detail="SMDA access token is not set",
+            headers={"x-upstream-source": "SMDA"},
+        )
 
     try:
         smda = SmdaAPI(
@@ -75,7 +89,11 @@ async def get_health(session: SessionDep) -> Ok:
             headers={"x-upstream-source": "SMDA"},
         ) from e
     except Exception as e:
-        raise HTTPException(status_code=500, detail=str(e)) from e
+        raise HTTPException(
+            status_code=500,
+            detail=str(e),
+            headers={"x-upstream-source": "SMDA"},
+        ) from e
 
 
 @router.post(
@@ -104,7 +122,11 @@ async def get_health(session: SessionDep) -> Ok:
 async def post_field(session: SessionDep, field: SmdaField) -> SmdaFieldSearchResult:
     """Searches for a field identifier in SMDA."""
     if session.access_tokens.smda_api is None:
-        raise HTTPException(status_code=401, detail="SMDA access token is not set")
+        raise HTTPException(
+            status_code=401,
+            detail="SMDA access token is not set",
+            headers={"x-upstream-source": "SMDA"},
+        )
 
     try:
         smda = SmdaAPI(
@@ -127,13 +149,20 @@ async def post_field(session: SessionDep, field: SmdaField) -> SmdaFieldSearchRe
         raise HTTPException(
             status_code=500,
             detail="Malformed response from SMDA: no 'data' field present",
+            headers={"x-upstream-source": "SMDA"},
         ) from e
     except TimeoutError as e:
         raise HTTPException(
-            status_code=503, detail="SMDA API request timed out. Please try again."
+            status_code=503,
+            detail="SMDA API request timed out. Please try again.",
+            headers={"x-upstream-source": "SMDA"},
         ) from e
     except Exception as e:
-        raise HTTPException(status_code=500, detail=str(e)) from e
+        raise HTTPException(
+            status_code=500,
+            detail=str(e),
+            headers={"x-upstream-source": "SMDA"},
+        ) from e
 
 
 @router.post(
@@ -183,7 +212,11 @@ async def post_masterdata(
         )
     # Handled on the route dependency, duplicated for typing
     if session.access_tokens.smda_api is None:
-        raise HTTPException(status_code=401, detail="SMDA access token is not set")
+        raise HTTPException(
+            status_code=401,
+            detail="SMDA access token is not set",
+            headers={"x-upstream-source": "SMDA"},
+        )
 
     # Sorted for tests as sets don't guarantee order
     unique_field_identifiers = sorted({field.identifier for field in smda_fields})
@@ -210,6 +243,7 @@ async def post_masterdata(
             raise HTTPException(
                 status_code=404,
                 detail=f"No fields found for identifiers: {unique_field_identifiers}",
+                headers={"x-upstream-source": "SMDA"},
             )
 
         field_items = [FieldItem(**field) for field in field_results]
@@ -241,7 +275,9 @@ async def post_masterdata(
 
         if field_coordinate_system is None:
             raise HTTPException(
-                status_code=404, detail="Projected field coordinate system not found"
+                status_code=404,
+                detail="Projected field coordinate system not found",
+                headers={"x-upstream-source": "SMDA"},
             )
 
         return SmdaMasterdataResult(
@@ -264,10 +300,17 @@ async def post_masterdata(
         raise HTTPException(
             status_code=500,
             detail="Malformed response from SMDA: {e}",
+            headers={"x-upstream-source": "SMDA"},
         ) from e
     except Exception as e:
-        raise HTTPException(status_code=500, detail=str(e)) from e
+        raise HTTPException(
+            status_code=500,
+            detail=str(e),
+            headers={"x-upstream-source": "SMDA"},
+        ) from e
     except TimeoutError as e:
         raise HTTPException(
-            status_code=503, detail="SMDA API request timed out. Please try again."
+            status_code=503,
+            detail="SMDA API request timed out. Please try again.",
+            headers={"x-upstream-source": "SMDA"},
         ) from e

tests/test_v1/test_smda.py

@@ -46,6 +46,7 @@ def test_get_health(client_with_session: TestClient, session_tmp_path: Path) ->
     """Test 401 returns when the user has no SMDA API key set in their configuration."""
     response = client_with_session.get(f"{ROUTE}/health")
     assert response.status_code == status.HTTP_401_UNAUTHORIZED, response.json()
+    assert response.headers["x-upstream-source"] == "SMDA"
     assert response.json()["detail"] == "User SMDA API key is not configured"
 
 
@@ -64,6 +65,7 @@ def test_get_health_has_user_api_key(
 
     response = client_with_session.get(f"{ROUTE}/health")
     assert response.status_code == status.HTTP_401_UNAUTHORIZED, response.json()
+    assert response.headers["x-upstream-source"] == "SMDA"
     assert response.json()["detail"] == "SMDA access token is not set"
 
 
@@ -72,7 +74,7 @@ async def test_get_health_has_user_api_key_and_access_token(
     session_tmp_path: Path,
     mock_SmdaAPI_get: AsyncMock,
 ) -> None:
-    """Test 401 returns when an API key exists but an SMDA access token is not set."""
+    """Test 200 returns when an API key and SMDA access token are set."""
     mock_response = MagicMock(spec=httpx.Response)
     mock_response.status_code = httpx.codes.OK
     mock_response.json.return_value = {"status": "ok"}
@@ -81,6 +83,7 @@ async def test_get_health_has_user_api_key_and_access_token(
 
     response = client_with_smda_session.get(f"{ROUTE}/health")
     assert response.status_code == status.HTTP_200_OK, response.json()
+    assert response.headers["x-upstream-source"] == "SMDA"
     assert response.json()["status"] == "ok"
 
 
@@ -103,8 +106,8 @@ async def test_get_health_request_failure_raises_exception(
     response = client_with_smda_session.get(f"{ROUTE}/health")
 
     assert response.status_code == status.HTTP_401_UNAUTHORIZED, response.json()
-    assert response.json()["detail"] == "SMDA error requesting https://smda"
     assert response.headers["x-upstream-source"] == "SMDA"
+    assert response.json()["detail"] == "SMDA error requesting https://smda"
 
 
 async def test_post_field_succeeds_with_one(
@@ -135,6 +138,7 @@ async def test_post_field_succeeds_with_one(
         f"{ROUTE}/field", json={"identifier": "TROLL"}
     )
     assert response.status_code == status.HTTP_200_OK, response.json()
+    assert response.headers["x-upstream-source"] == "SMDA"
     assert SmdaFieldSearchResult.model_validate(
         response.json()
     ) == SmdaFieldSearchResult(
@@ -169,6 +173,7 @@ async def test_post_field_succeeds_with_none(
     )
 
     assert response.status_code == status.HTTP_200_OK, response.json()
+    assert response.headers["x-upstream-source"] == "SMDA"
     assert SmdaFieldSearchResult.model_validate(
         response.json()
     ) == SmdaFieldSearchResult(
@@ -198,6 +203,7 @@ async def test_post_field_with_no_identifier_raises(
     response = client_with_smda_session.post(f"{ROUTE}/field", json={"identifier": ""})
 
     assert response.status_code == status.HTTP_200_OK, response.json()
+    assert response.headers["x-upstream-source"] == "SMDA"
     assert SmdaFieldSearchResult.model_validate(
         response.json()
     ) == SmdaFieldSearchResult(
@@ -223,6 +229,7 @@ async def test_post_field_has_bad_response_raises(
     assert response.status_code == status.HTTP_500_INTERNAL_SERVER_ERROR, (
         response.json()
     )
+    assert response.headers["x-upstream-source"] == "SMDA"
     assert (
         response.json()["detail"]
         == "Malformed response from SMDA: no 'data' field present"
@@ -319,6 +326,7 @@ async def test_post_masterdata_success(
         )
 
     assert response.status_code == status.HTTP_200_OK, response.json()
+    assert response.headers["x-upstream-source"] == "SMDA"
     response_data = response.json()
     assert len(response_data["field"]) == 1
     assert response_data["field"][0]["identifier"] == "DROGON"
@@ -399,6 +407,7 @@ async def test_post_masterdata_missing_coordinate_system(
         )
 
     assert response.status_code == status.HTTP_404_NOT_FOUND, response.json()
+    assert response.headers["x-upstream-source"] == "SMDA"
     assert "Projected field coordinate system not found" in response.json()["detail"]
 
 
@@ -425,6 +434,7 @@ async def test_post_masterdata_malformed_response(
     assert response.status_code == status.HTTP_500_INTERNAL_SERVER_ERROR, (
         response.json()
     )
+    assert response.headers["x-upstream-source"] == "SMDA"
     assert "Malformed response from SMDA" in response.json()["detail"]
 
 
@@ -500,6 +510,7 @@ async def test_post_masterdata_multiple_fields(
         )
 
     assert response.status_code == status.HTTP_200_OK, response.json()
+    assert response.headers["x-upstream-source"] == "SMDA"
     response_data = response.json()
     assert len(response_data["field"]) == 2  # noqa
 
@@ -586,5 +597,5 @@ async def test_post_masterdata_request_fails(
     )
 
     assert response.status_code == status.HTTP_401_UNAUTHORIZED, response.json()
-    assert response.json()["detail"] == "SMDA error requesting https://smda"
     assert response.headers["x-upstream-source"] == "SMDA"
+    assert response.json()["detail"] == "SMDA error requesting https://smda"