Merge branch 'main' into feature/eli-138-fix-cohort-label

Author: shweta-nhs

src/eligibility_signposting_api/views/eligibility.py

@@ -30,6 +30,13 @@
 
 @eligibility_blueprint.before_request
 def before_request() -> None:
+    logger.info(
+        "request details",
+        extra={
+            "X-Request-ID": request.headers.get("X-Request-ID"),
+            "X-Correlation-ID": request.headers.get("X-Correlation-ID"),
+        },
+    )
     AuditContext.add_request_details(request)
 
 

tests/unit/views/test_eligibility.py

@@ -687,3 +687,43 @@ def test_build_response_include_values_that_are_not_null(client: FlaskClient):
         assert action["description"] == "Contact GP"
         assert action["urlLink"] == "https://example.dummy/"
         assert action["urlLabel"] == "GP contact"
+
+
+@pytest.mark.parametrize(
+    ("headers", "expected_request_id"),
+    [
+        ({"X-Request-ID": "test-request-id-123"}, "test-request-id-123"),
+        (
+            {"X-Request-ID": ""},
+            "",
+        ),
+        (
+            {},  # No headers provided
+            None,
+        ),
+    ],
+)
+def test_request_id_from_header_logging_variants(
+    app: Flask, client: FlaskClient, caplog, headers: dict[str, str], expected_request_id: str
+):
+    """
+    This test checks that the x-request-ID is logged so that it can be used to correlate logs
+    with that of the logs from api-gateway
+    """
+    with (
+        get_app_container(app).override.service(EligibilityService, new=FakeEligibilityService()),
+        get_app_container(app).override.service(AuditService, new=FakeAuditService()),
+    ):
+        with caplog.at_level(logging.INFO):
+            response = client.get("/patient-check/12345", headers=headers)
+
+        request_id_logged = False
+        for record in caplog.records:
+            request_id = getattr(record, "X-Request-ID", None)
+
+            if request_id == expected_request_id:
+                request_id_logged = True
+                break
+
+        assert request_id_logged
+        assert response.status_code == HTTPStatus.OK