Merge pull request #371 from rtablada/rt/validations-422

Validations Send source.pointer

Author: jaredcnance

src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs

@@ -8,7 +8,7 @@
 
 namespace JsonApiDotNetCore.Controllers
 {
-    public class BaseJsonApiController<T> 
+    public class BaseJsonApiController<T>
         : BaseJsonApiController<T, int>
         where T : class, IIdentifiable<int>
     {
@@ -47,7 +47,7 @@ public class BaseJsonApiController<T, TId>
         private readonly ICreateService<T, TId> _create;
         private readonly IUpdateService<T, TId> _update;
         private readonly IUpdateRelationshipService<T, TId> _updateRelationships;
-        private readonly IDeleteService<T, TId> _delete;        
+        private readonly IDeleteService<T, TId> _delete;
         private readonly IJsonApiContext _jsonApiContext;
 
         public BaseJsonApiController(
@@ -156,7 +156,7 @@ public virtual async Task<IActionResult> PostAsync([FromBody] T entity)
                 return Forbidden();
 
             if (_jsonApiContext.Options.ValidateModelState && !ModelState.IsValid)
-                return BadRequest(ModelState.ConvertToErrorCollection());
+                return UnprocessableEntity(ModelState.ConvertToErrorCollection<T>(_jsonApiContext.ContextGraph));
 
             entity = await _create.CreateAsync(entity);
 
@@ -169,8 +169,9 @@ public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] T entity)
 
             if (entity == null)
                 return UnprocessableEntity();
+
             if (_jsonApiContext.Options.ValidateModelState && !ModelState.IsValid)
-                return BadRequest(ModelState.ConvertToErrorCollection());
+                return UnprocessableEntity(ModelState.ConvertToErrorCollection<T>(_jsonApiContext.ContextGraph));
 
             var updatedEntity = await _update.UpdateAsync(id, entity);
 

src/JsonApiDotNetCore/Extensions/ModelStateExtensions.cs

@@ -1,3 +1,4 @@
+using System;
 using JsonApiDotNetCore.Internal;
 using Microsoft.AspNetCore.Mvc.ModelBinding;
 using Microsoft.EntityFrameworkCore.Internal;
@@ -6,6 +7,7 @@ namespace JsonApiDotNetCore.Extensions
 {
     public static class ModelStateExtensions
     {
+        [Obsolete("Use Generic Method ConvertToErrorCollection<T>(IContextGraph contextGraph) instead for full validation errors")]
         public static ErrorCollection ConvertToErrorCollection(this ModelStateDictionary modelState)
         {
             ErrorCollection collection = new ErrorCollection();
@@ -23,6 +25,34 @@ public static ErrorCollection ConvertToErrorCollection(this ModelStateDictionary
                 }
             }
 
+            return collection;
+        }
+        public static ErrorCollection ConvertToErrorCollection<T>(this ModelStateDictionary modelState, IContextGraph contextGraph)
+        {
+            ErrorCollection collection = new ErrorCollection();
+            foreach (var entry in modelState)
+            {
+                if (entry.Value.Errors.Any() == false)
+                    continue;
+
+                var attrName = contextGraph.GetPublicAttributeName<T>(entry.Key);
+
+                foreach (var modelError in entry.Value.Errors)
+                {
+                    if (modelError.Exception is JsonApiException jex)
+                        collection.Errors.AddRange(jex.GetError().Errors);
+                    else
+                        collection.Errors.Add(new Error(
+                            status: 422,
+                            title: entry.Key,
+                            detail: modelError.ErrorMessage,
+                            meta: modelError.Exception != null ? ErrorMeta.FromException(modelError.Exception) : null,
+                            source: attrName == null ? null : new {
+                                pointer = $"/data/attributes/{attrName}"
+                            }));
+                }
+            }
+
             return collection;
         }
     }

src/JsonApiDotNetCore/Internal/ContextGraph.cs

@@ -122,7 +122,7 @@ public string GetPublicAttributeName<TParent>(string internalAttributeName)
         {
             return GetContextEntity(typeof(TParent))
                 .Attributes
-                .Single(a => a.InternalAttributeName == internalAttributeName)
+                .SingleOrDefault(a => a.InternalAttributeName == internalAttributeName)?
                 .PublicAttributeName;
         }
   }

src/JsonApiDotNetCore/Internal/Error.cs

@@ -9,17 +9,17 @@ public class Error
     {
         public Error()
         { }
-        
+
         [Obsolete("Use Error constructors with int typed status")]
-        public Error(string status, string title, ErrorMeta meta = null, string source = null)
+        public Error(string status, string title, ErrorMeta meta = null, object source = null)
         {
             Status = status;
             Title = title;
             Meta = meta;
             Source = source;
         }
 
-        public Error(int status, string title, ErrorMeta meta = null, string source = null)
+        public Error(int status, string title, ErrorMeta meta = null, object source = null)
         {
             Status = status.ToString();
             Title = title;
@@ -28,7 +28,7 @@ public Error(int status, string title, ErrorMeta meta = null, string source = nu
         }
 
         [Obsolete("Use Error constructors with int typed status")]
-        public Error(string status, string title, string detail, ErrorMeta meta = null, string source = null)
+        public Error(string status, string title, string detail, ErrorMeta meta = null, object source = null)
         {
             Status = status;
             Title = title;
@@ -37,29 +37,29 @@ public Error(string status, string title, string detail, ErrorMeta meta = null,
             Source = source;
         }
 
-        public Error(int status, string title, string detail, ErrorMeta meta = null, string source = null)
+        public Error(int status, string title, string detail, ErrorMeta meta = null, object source = null)
         {
             Status = status.ToString();
             Title = title;
             Detail = detail;
             Meta = meta;
             Source = source;
         }
-        
+
         [JsonProperty("title")]
         public string Title { get; set; }
 
         [JsonProperty("detail")]
         public string Detail { get; set; }
-        
+
         [JsonProperty("status")]
         public string Status { get; set; }
 
         [JsonIgnore]
         public int StatusCode => int.Parse(Status);
 
         [JsonProperty("source")]
-        public string Source { get; set; }
+        public object Source { get; set; }
 
         [JsonProperty("meta")]
         public ErrorMeta Meta { get; set; }
@@ -73,8 +73,8 @@ public class ErrorMeta
         [JsonProperty("stackTrace")]
         public string[] StackTrace { get; set; }
 
-        public static ErrorMeta FromException(Exception e) 
-            => new ErrorMeta { 
+        public static ErrorMeta FromException(Exception e)
+            => new ErrorMeta {
                 StackTrace = e.Demystify().ToString().Split(new[] { "\n"}, int.MaxValue, StringSplitOptions.RemoveEmptyEntries)
             };
     }