Merge pull request #343 from ral-facilities/bugfix/validation-error-c…

…ode-#319 Improve Search API Error Handling
ral-facilities · Feb 28, 2022 · 982518a · 982518a
2 parents a3943d1 + 1e42981
commit 982518a
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 10 deletions.
diff --git a/datagateway_api/src/search_api/helpers.py b/datagateway_api/src/search_api/helpers.py
@@ -2,9 +2,12 @@
 import json
 import logging
 
+from pydantic import ValidationError
+
 from datagateway_api.src.common.exceptions import (
     BadRequestError,
     MissingRecordError,
+    SearchAPIError,
 )
 from datagateway_api.src.common.filter_order_handler import FilterOrderHandler
 from datagateway_api.src.search_api.filters import (
@@ -36,20 +39,29 @@ def search_api_error_handling(method):
     def wrapper_error_handling(*args, **kwargs):
         try:
             return method(*args, **kwargs)
-        except (ValueError, TypeError, AttributeError) as e:
+        except ValidationError as e:
+            log.exception(msg=e.args)
+            assign_status_code(e, 500)
+            raise SearchAPIError(create_error_message(e))
+        except (ValueError, TypeError, AttributeError, KeyError) as e:
             log.exception(msg=e.args)
-            raise BadRequestError(create_error_message(BadRequestError()))
+            assign_status_code(e, 400)
+            raise BadRequestError(create_error_message(e))
         except Exception as e:
             log.exception(msg=e.args)
-            try:
-                e.status_code
-            except AttributeError:
-                # If no status code exists (for non-API defined exceptions), defensively
-                # assign a 500
-                e.status_code = 500
-
+            # Defensively assign a 500 if the exception doesn't already have a status
+            # code
+            assign_status_code(e, 500)
             raise type(e)(create_error_message(e))
 
+    def assign_status_code(e, status_code):
+        try:
+            # If no status code exists (for non-API defined exceptions), assign a status
+            # code
+            e.status_code
+        except AttributeError:
+            e.status_code = status_code
+
     def create_error_message(e):
         return {
             "error": {

diff --git a/test/search_api/test_error_handling.py b/test/search_api/test_error_handling.py
@@ -8,6 +8,7 @@
     SearchAPIError,
 )
 from datagateway_api.src.search_api.helpers import search_api_error_handling
+from datagateway_api.src.search_api.models import Document
 
 
 class TestErrorHandling:
@@ -24,14 +25,19 @@ class TestErrorHandling:
             pytest.param(ValueError, BadRequestError, 400, id="Value error"),
             pytest.param(AttributeError, BadRequestError, 400, id="Attribute error"),
             pytest.param(ImportError, ImportError, 500, id="Import error"),
+            pytest.param(Document, SearchAPIError, 500, id="Validation error"),
         ],
     )
     def test_valid_error_raised(
         self, raised_exception, expected_exception, status_code,
     ):
         @search_api_error_handling
         def raise_exception():
-            raise raised_exception()
+            if isinstance(raised_exception(), Exception):
+                raise raised_exception()
+            else:
+                # To raise Pydantic ValidationError from object creation
+                raised_exception()
 
         try:
             raise_exception()