enhance error handling

Author: akira-dev

flask_rest_jsonapi/decorators.py

@@ -22,13 +22,13 @@ def wrapper(*args, **kwargs):
                 error = jsonify(jsonapi_errors([{'source': '',
                                                  'detail': "Content-Type header must be application/vnd.api+json",
                                                  'title': 'InvalidRequestHeader',
-                                                 'status': 415}]))
+                                                 'status': '415'}]))
                 return make_response(error, 415, {'Content-Type': 'application/vnd.api+json'})
         if request.headers.get('Accept') and 'application/vnd.api+json' not in request.accept_mimetypes:
             error = jsonify(jsonapi_errors([{'source': '',
                                              'detail': "Accept header must be application/vnd.api+json",
                                              'title': 'InvalidRequestHeader',
-                                             'status': 406}]))
+                                             'status': '406'}]))
             return make_response(error, 406, {'Content-Type': 'application/vnd.api+json'})
         return func(*args, **kwargs)
     return wrapper

flask_rest_jsonapi/exceptions.py

@@ -7,16 +7,20 @@ class JsonApiException(Exception):
     """Base exception class for unknown errors"""
 
     title = 'Unknown error'
-    status = 500
+    status = '500'
 
-    def __init__(self, source, detail, title=None, status=None):
+    def __init__(self, source, detail, title=None, status=None, code=None, id_=None, links=None, meta=None):
         """Initialize a jsonapi exception
 
         :param dict source: the source of the error
         :param str detail: the detail of the error
         """
         self.source = source
         self.detail = detail
+        self.code = code
+        self.id = id_
+        self.links = links or {}
+        self.meta = meta or {}
         if title is not None:
             self.title = title
         if status is not None:
@@ -27,14 +31,18 @@ def to_dict(self):
         return {'status': self.status,
                 'source': self.source,
                 'title': self.title,
-                'detail': self.detail}
+                'detail': self.detail,
+                'id': self.id,
+                'code': self.code,
+                'links': self.links,
+                'meta': self.meta}
 
 
 class BadRequest(JsonApiException):
     """BadRequest error"""
 
-    title = "Bad request"
-    status = 400
+    title = 'Bad request'
+    status = '400'
 
 
 class InvalidField(BadRequest):
@@ -56,7 +64,7 @@ class InvalidInclude(BadRequest):
     resource schema
     """
 
-    title = "Invalid include querystring parameter."
+    title = 'Invalid include querystring parameter.'
 
     def __init__(self, detail):
         """Initialize InvalidInclude error instance
@@ -70,7 +78,7 @@ def __init__(self, detail):
 class InvalidFilters(BadRequest):
     """Error to warn that a specified filters in querystring parameter contains errors"""
 
-    title = "Invalid filters querystring parameter."
+    title = 'Invalid filters querystring parameter.'
 
     def __init__(self, detail):
         """Initialize InvalidField error instance
@@ -84,7 +92,7 @@ def __init__(self, detail):
 class InvalidSort(BadRequest):
     """Error to warn that a field specified in sort querystring parameter is not in the requested resource schema"""
 
-    title = "Invalid sort querystring parameter."
+    title = 'Invalid sort querystring parameter.'
 
     def __init__(self, detail):
         """Initialize InvalidField error instance
@@ -98,24 +106,24 @@ def __init__(self, detail):
 class ObjectNotFound(JsonApiException):
     """Error to warn that an object is not found in a database"""
 
-    title = "Object not found"
-    status = 404
+    title = 'Object not found'
+    status = '404'
 
 
 class RelatedObjectNotFound(ObjectNotFound):
     """Error to warn that a related object is not found"""
 
-    title = "Related object not found"
+    title = 'Related object not found'
 
 
 class RelationNotFound(JsonApiException):
     """Error to warn that a relationship is not found on a model"""
 
-    title = "Relation not found"
+    title = 'Relation not found'
 
 
 class InvalidType(JsonApiException):
     """Error to warn that there is a conflit between resource types"""
 
-    title = "Invalid type"
-    status = 409
+    title = 'Invalid type'
+    status = '409'

flask_rest_jsonapi/resource.py

@@ -75,7 +75,14 @@ def dispatch_request(self, *args, **kwargs):
         except Exception as e:
             if current_app.config['DEBUG'] is True:
                 raise e
-            exc = JsonApiException('', str(e))
+            exc = JsonApiException(getattr(e, 'source', ''),
+                                   getattr(e, 'detail', str(e)),
+                                   title=getattr(e, 'title', None),
+                                   status=getattr(e, 'status', None),
+                                   code=getattr(e, 'code', None),
+                                   id_=getattr(e, 'id', None),
+                                   links=getattr(e, 'links', None),
+                                   meta=getattr(e, 'meta', None))
             return make_response(jsonify(jsonapi_errors([exc.to_dict()])),
                                  exc.status,
                                  headers)