[NRL-1150] Switch ParseError to use loc if present

Author: mattdean3-nhs

layer/nrlf/core/errors.py

@@ -1,13 +1,25 @@
 from typing import List, Optional
 
 from pydantic import ValidationError
+from pydantic_core import ErrorDetails
 
 from nrlf.core.response import Response
 from nrlf.core.types import CodeableConcept
 from nrlf.producer.fhir.r4 import model as producer_model
 from nrlf.producer.fhir.r4.model import OperationOutcome, OperationOutcomeIssue
 
 
+def diag_for_error(error: ErrorDetails) -> str:
+    if error["loc"]:
+        return f"{error['loc'][0]}: {error['msg']}"
+    else:
+        return f"root: {error['msg']}"
+
+
+def expression_for_error(error: ErrorDetails) -> Optional[str]:
+    return str(error["loc"][0] if error["loc"] else "root")
+
+
 class OperationOutcomeError(Exception):
     """
     Will instantly trigger an OperationOutcome error response when raised
@@ -59,8 +71,8 @@ def from_validation_error(
                 severity="error",
                 code="invalid",
                 details=details,  # type: ignore
-                diagnostics=f"{msg} ({error['loc']}: {error['msg']})",
-                expression=[str(error["loc"])],  # type: ignore
+                diagnostics=f"{msg} ({diag_for_error(error)})",
+                expression=[expression_for_error(error)],  # type: ignore
             )
             for error in exc.errors()
         ]

layer/nrlf/core/tests/test_request.py

@@ -194,27 +194,26 @@ def test_parse_body_invalid_docref_json():
     response = error.value.response.model_dump()
 
     assert response["statusCode"] == "400"
-    assert response["body"] == json.dumps(
-        {
-            "resourceType": "OperationOutcome",
-            "issue": [
-                {
-                    "severity": "error",
-                    "code": "invalid",
-                    "details": {
-                        "coding": [
-                            {
-                                "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
-                                "code": "MESSAGE_NOT_WELL_FORMED",
-                                "display": "Message not well formed",
-                            }
-                        ],
-                    },
-                    "diagnostics": "Request body could not be parsed ((): Invalid JSON: control character (\\\\u0000-\\\\u001F) found while parsing a string at line 72 column 0)",
-                }
-            ],
-        }
-    )
+    assert json.loads(response["body"]) == {
+        "resourceType": "OperationOutcome",
+        "issue": [
+            {
+                "severity": "error",
+                "code": "invalid",
+                "details": {
+                    "coding": [
+                        {
+                            "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                            "code": "MESSAGE_NOT_WELL_FORMED",
+                            "display": "Message not well formed",
+                        }
+                    ],
+                },
+                "diagnostics": "Request body could not be parsed (root: Invalid JSON: control character (\\u0000-\\u001F) found while parsing a string at line 72 column 0)",
+                "expression": ["root"],
+            }
+        ],
+    }
 
 
 def test_parse_body_invalid_json():
@@ -224,10 +223,10 @@ def test_parse_body_invalid_json():
     with pytest.raises(ParseError) as error:
         parse_body(model, body)
 
-    response = error.value.response
+    response = error.value.response.model_dump()
 
-    assert response.statusCode == "400"
-    assert json.loads(response.body) == {
+    assert response["statusCode"] == "400"
+    assert json.loads(response["body"]) == {
         "resourceType": "OperationOutcome",
         "issue": [
             {
@@ -240,10 +239,56 @@ def test_parse_body_invalid_json():
                             "code": "MESSAGE_NOT_WELL_FORMED",
                             "display": "Message not well formed",
                         }
-                    ],
+                    ]
                 },
-                "diagnostics": "",
-            }
+                "diagnostics": "Request body could not be parsed (resourceType: Field required)",
+                "expression": ["resourceType"],
+            },
+            {
+                "severity": "error",
+                "code": "invalid",
+                "details": {
+                    "coding": [
+                        {
+                            "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                            "code": "MESSAGE_NOT_WELL_FORMED",
+                            "display": "Message not well formed",
+                        }
+                    ]
+                },
+                "diagnostics": "Request body could not be parsed (status: Field required)",
+                "expression": ["status"],
+            },
+            {
+                "severity": "error",
+                "code": "invalid",
+                "details": {
+                    "coding": [
+                        {
+                            "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                            "code": "MESSAGE_NOT_WELL_FORMED",
+                            "display": "Message not well formed",
+                        }
+                    ]
+                },
+                "diagnostics": "Request body could not be parsed (type: Input should be an object)",
+                "expression": ["type"],
+            },
+            {
+                "severity": "error",
+                "code": "invalid",
+                "details": {
+                    "coding": [
+                        {
+                            "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                            "code": "MESSAGE_NOT_WELL_FORMED",
+                            "display": "Message not well formed",
+                        }
+                    ]
+                },
+                "diagnostics": "Request body could not be parsed (content: Field required)",
+                "expression": ["content"],
+            },
         ],
     }
 
@@ -252,13 +297,13 @@ def test_parse_body_not_json():
     model = DocumentReference
     body = "is not json"
 
-    with pytest.raises(OperationOutcomeError) as error:
+    with pytest.raises(ParseError) as error:
         parse_body(model, body)
 
-    exc = error.value
+    response = error.value.response
 
-    assert exc.status_code == "400"
-    assert exc.operation_outcome.model_dump(exclude_none=True) == {
+    assert response.statusCode == "400"
+    assert json.loads(response.body) == {
         "resourceType": "OperationOutcome",
         "issue": [
             {
@@ -268,12 +313,13 @@ def test_parse_body_not_json():
                     "coding": [
                         {
                             "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
-                            "code": "INVALID_PARAMETER",
-                            "display": "The parameter value is not valid",
+                            "code": "MESSAGE_NOT_WELL_FORMED",
+                            "display": "Message not well formed",
                         }
-                    ],
+                    ]
                 },
-                "diagnostics": "Invalid query parameter",
+                "diagnostics": "Request body could not be parsed (root: Invalid JSON: expected value at line 1 column 1)",
+                "expression": ["root"],
             }
         ],
     }