fix(de-serialization): improve error handling

Author: jaredcnance

src/JsonApiDotNetCore/Formatters/JsonApiReader.cs

@@ -1,6 +1,8 @@
 using System;
 using System.IO;
+using System.Text;
 using System.Threading.Tasks;
+using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Serialization;
 using JsonApiDotNetCore.Services;
 using Microsoft.AspNetCore.Mvc.Formatters;
@@ -50,6 +52,13 @@ public Task<InputFormatterResult> ReadAsync(InputFormatterContext context)
                 context.HttpContext.Response.StatusCode = 422;
                 return InputFormatterResult.FailureAsync();
             }
+            catch(JsonApiException jex)
+            {
+                _logger?.LogError(new EventId(), jex, "An error occurred while de-serializing the payload");
+                context.HttpContext.Response.StatusCode = jex.GetStatusCode();
+                context.HttpContext.Response.Body = new MemoryStream(Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(jex.GetError())));
+                return InputFormatterResult.FailureAsync();
+            }
         }
 
         private string GetRequestBody(Stream body)

src/JsonApiDotNetCore/Serialization/JsonApiDeSerializer.cs

@@ -16,7 +16,7 @@ public class JsonApiDeSerializer : IJsonApiDeSerializer
         private readonly IJsonApiContext _jsonApiContext;
         private readonly IGenericProcessorFactory _genericProcessorFactor;
 
-        public JsonApiDeSerializer( 
+        public JsonApiDeSerializer(
             IJsonApiContext jsonApiContext,
             IGenericProcessorFactory genericProcessorFactory)
         {
@@ -26,9 +26,16 @@ public JsonApiDeSerializer(
 
         public object Deserialize(string requestBody)
         {
-            var document = JsonConvert.DeserializeObject<Document>(requestBody);
-            var entity = DocumentToObject(document.Data);
-            return entity;
+            try
+            {
+                var document = JsonConvert.DeserializeObject<Document>(requestBody);
+                var entity = DocumentToObject(document.Data);
+                return entity;
+            }
+            catch (Exception e)
+            {
+                throw new JsonApiException("400", "Failed to deserialize request body", e.Message);
+            }
         }
 
         public object Deserialize<TEntity>(string requestBody)
@@ -38,26 +45,40 @@ public object Deserialize<TEntity>(string requestBody)
 
         public object DeserializeRelationship(string requestBody)
         {
-            var data = JToken.Parse(requestBody)["data"];
+            try
+            {
+                var data = JToken.Parse(requestBody)["data"];
 
-            if(data is JArray)
-                return data.ToObject<List<DocumentData>>();
+                if (data is JArray)
+                    return data.ToObject<List<DocumentData>>();
 
-            return new List<DocumentData> { data.ToObject<DocumentData>() };
+                return new List<DocumentData> { data.ToObject<DocumentData>() };
+            }
+            catch (Exception e)
+            {
+                throw new JsonApiException("400", "Failed to deserialize request body", e.Message);
+            }
         }
 
         public List<TEntity> DeserializeList<TEntity>(string requestBody)
         {
-            var documents = JsonConvert.DeserializeObject<Documents>(requestBody);
+            try
+            {
+                var documents = JsonConvert.DeserializeObject<Documents>(requestBody);
+
+                var deserializedList = new List<TEntity>();
+                foreach (var data in documents.Data)
+                {
+                    var entity = DocumentToObject(data);
+                    deserializedList.Add((TEntity)entity);
+                }
 
-            var deserializedList = new List<TEntity>();
-            foreach (var data in documents.Data)
+                return deserializedList;
+            }
+            catch (Exception e)
             {
-                var entity = DocumentToObject(data);
-                deserializedList.Add((TEntity)entity);
+                throw new JsonApiException("400", "Failed to deserialize request body", e.Message);
             }
-
-            return deserializedList;
         }
 
         private object DocumentToObject(DocumentData data)
@@ -66,7 +87,7 @@ private object DocumentToObject(DocumentData data)
             _jsonApiContext.RequestEntity = contextEntity;
 
             var entity = Activator.CreateInstance(contextEntity.EntityType);
-            
+
             entity = SetEntityAttributes(entity, contextEntity, data.Attributes);
             entity = SetRelationships(entity, contextEntity, data.Relationships);
 
@@ -106,8 +127,8 @@ private object SetEntityAttributes(
         }
 
         private object SetRelationships(
-            object entity, 
-            ContextEntity contextEntity, 
+            object entity,
+            ContextEntity contextEntity,
             Dictionary<string, RelationshipData> relationships)
         {
             if (relationships == null || relationships.Count == 0)
@@ -117,18 +138,18 @@ private object SetRelationships(
 
             foreach (var attr in contextEntity.Relationships)
             {
-                entity = attr.IsHasOne 
-                    ? SetHasOneRelationship(entity, entityProperties, attr, contextEntity, relationships) 
+                entity = attr.IsHasOne
+                    ? SetHasOneRelationship(entity, entityProperties, attr, contextEntity, relationships)
                     : SetHasManyRelationship(entity, entityProperties, attr, contextEntity, relationships);
             }
 
             return entity;
         }
 
-        private object SetHasOneRelationship(object entity, 
-            PropertyInfo[] entityProperties, 
-            RelationshipAttribute attr, 
-            ContextEntity contextEntity, 
+        private object SetHasOneRelationship(object entity,
+            PropertyInfo[] entityProperties,
+            RelationshipAttribute attr,
+            ContextEntity contextEntity,
             Dictionary<string, RelationshipData> relationships)
         {
             var entityProperty = entityProperties.FirstOrDefault(p => p.Name == $"{attr.InternalRelationshipName}Id");
@@ -142,7 +163,7 @@ private object SetHasOneRelationship(object entity,
             {
                 var relationshipAttr = _jsonApiContext.RequestEntity.Relationships
                         .SingleOrDefault(r => r.PublicRelationshipName == relationshipName);
-                
+
                 var data = (Dictionary<string, string>)relationshipData.ExposedData;
 
                 if (data == null) return entity;
@@ -159,9 +180,9 @@ private object SetHasOneRelationship(object entity,
         }
 
         private object SetHasManyRelationship(object entity,
-            PropertyInfo[] entityProperties, 
-            RelationshipAttribute attr, 
-            ContextEntity contextEntity, 
+            PropertyInfo[] entityProperties,
+            RelationshipAttribute attr,
+            ContextEntity contextEntity,
             Dictionary<string, RelationshipData> relationships)
         {
             var entityProperty = entityProperties.FirstOrDefault(p => p.Name == attr.InternalRelationshipName);
@@ -179,7 +200,7 @@ private object SetHasManyRelationship(object entity,
 
                 var genericProcessor = _genericProcessorFactor.GetProcessor(attr.Type);
                 var ids = relationshipData.ManyData.Select(r => r["id"]);
-                genericProcessor.SetRelationships(entity, attr, ids);    
+                genericProcessor.SetRelationships(entity, attr, ids);
             }
 
             return entity;