[CDAPI-118]: Include correlation-id for status endpoint

Author: nhsd-rebecca-flynn

infrastructure/images/api-gateway-mock/resources/server.py

@@ -37,12 +37,16 @@
 def forward_request(path_params):
     app.logger.info("received request with data: %s", request.get_data(as_text=True))
 
+    x_correlation_id = request.headers.get("X-Correlation-ID")
+    forwarded_headers = {k.lower(): v for k, v in request.headers.items()}
+    forwarded_headers["nhsd-correlation-id"] = x_correlation_id
+
     response = requests.post(
         "http://pathology-api:8080/2015-03-31"  # NOSONAR python:S5332
         "/functions/function/invocations",
         json={
             "body": request.get_data(as_text=True).replace("\n", "").replace(" ", ""),
-            "headers": {k.lower(): v for k, v in request.headers.items()},
+            "headers": forwarded_headers,
             "requestContext": {
                 "http": {
                     "path": f"/{path_params}",

pathology-api/lambda_handler.py

@@ -136,16 +136,13 @@ def handler(data: dict[str, Any], context: LambdaContext) -> dict[str, Any]:
     headers = data.get("headers", {}) or {}
     correlation_id = headers.get(_CORRELATION_ID_HEADER)
     if not correlation_id:
-        raw_path = (data.get("rawPath") or "").lstrip("/")
-        if raw_path != "_status":
-            return {
-                "statusCode": 400,
-                "headers": {"Content-Type": "application/fhir+json"},
-                "body": OperationOutcome.create_validation_error(
-                    f"Missing required header: {_CORRELATION_ID_HEADER}"
-                ).model_dump_json(by_alias=True, exclude_none=True),
-            }
-        return app.resolve(data, context)
+        return {
+            "statusCode": 500,
+            "headers": {"Content-Type": "application/fhir+json"},
+            "body": OperationOutcome.create_server_error(
+                f"Missing required header: {_CORRELATION_ID_HEADER}"
+            ).model_dump_json(by_alias=True, exclude_none=True),
+        }
     with set_correlation_id(correlation_id):
         response = app.resolve(data, context)
         response.setdefault("headers", {})[_CORRELATION_ID_HEADER] = correlation_id

pathology-api/tests/conftest.py

@@ -247,7 +247,6 @@ def client(request: pytest.FixtureRequest, base_url: str) -> Client:
     if env == "local":
         return LocalClient(
             lambda_url=base_url,
-            headers={"nhsd-correlation-id": "local-test-correlation-id"},
         )
     elif env == "remote":
         return _create_remote_client(request)

pathology-api/tests/integration/test_endpoints.py

@@ -31,12 +31,14 @@ def test_bundle_returns_200(self, client: Client) -> None:
             data=bundle.model_dump_json(by_alias=True),
             path="FHIR/R4/Bundle",
             request_method="POST",
-            headers={"nhsd-correlation-id": "test-nhsd-correlation-id-555666777"},
+            headers={"X-Correlation-ID": "test-correlation-id-555666777"},
         )
 
         assert response.status_code == 200
         assert response.headers["Content-Type"] == "application/fhir+json"
-        assert response.headers.get("nhsd-correlation-id") is not None
+        assert response.headers["nhsd-correlation-id"].startswith(
+            ".test-correlation-id-555666777"
+        )
 
         response_data = response.json()
         response_bundle = Bundle.model_validate(response_data, by_alias=True)
@@ -258,9 +260,16 @@ class TestStatusEndpoint:
 
     @pytest.mark.status_auth_headers
     def test_status_returns_200(self, client: Client) -> None:
-        response = client.send_without_payload(request_method="GET", path="_status")
+        response = client.send_without_payload(
+            request_method="GET",
+            path="_status",
+            headers={"X-Correlation-ID": "test-correlation-id-555666777"},
+        )
         assert response.status_code == 200
         assert response.headers["Content-Type"] == "application/json"
+        assert response.headers["nhsd-correlation-id"].startswith(
+            ".test-correlation-id-555666777"
+        )
 
         parsed = StatusResponse.model_validate(response.json())
 

pathology-api/tests/schema/test_openapi_schema.py

@@ -33,11 +33,5 @@ def test_api_schema_compliance(case: Case, base_url: str) -> None:
     - Validates inputs properly
     - Returns appropriate status codes
     """
-    # In local testing there is no APIM proxy to inject nhsd-correlation-id,
-    # so we add it explicitly before calling the API.
-    if case.headers is None:
-        case.headers = {"nhsd-correlation-id": "local-test-correlation-id"}
-    else:
-        case.headers["nhsd-correlation-id"] = "local-test-correlation-id"
     # Call the API and validate the response against the schema
     case.call_and_validate(base_url=base_url, timeout=30)