added ValidateModelState as feature flag in options

Author: sigent

src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs

@@ -125,6 +125,16 @@ public class JsonApiOptions
         /// </remarks>
         public bool EnableOperations { get; set; }
 
+        /// <summary>
+        /// Whether or not to validate model state.
+        /// </summary>
+        /// <example>
+        /// <code>
+        /// options.ValidateModelState = true;
+        /// </code>
+        /// </example>
+        public bool ValidateModelState { get; set; }
+
         [Obsolete("JsonContract resolver can now be set on SerializerSettings.")]
         public IContractResolver JsonContractResolver
         {

src/JsonApiDotNetCore/Controllers/BaseJsonApiController.cs

@@ -153,7 +153,7 @@ public virtual async Task<IActionResult> PostAsync([FromBody] T entity)
 
             if (!_jsonApiContext.Options.AllowClientGeneratedIds && !string.IsNullOrEmpty(entity.StringId))
                 return Forbidden();
-            if (!ModelState.IsValid)
+            if (_jsonApiContext.Options.ValidateModelState && !ModelState.IsValid)
                 return BadRequest(ModelState.ConvertToErrorCollection());
 
             entity = await _create.CreateAsync(entity);
@@ -167,7 +167,7 @@ public virtual async Task<IActionResult> PatchAsync(TId id, [FromBody] T entity)
 
             if (entity == null)
                 return UnprocessableEntity();
-            if (!ModelState.IsValid)
+            if (_jsonApiContext.Options.ValidateModelState && !ModelState.IsValid)
                 return BadRequest(ModelState.ConvertToErrorCollection());
 
             var updatedEntity = await _update.UpdateAsync(id, entity);

test/UnitTests/Controllers/BaseJsonApiController_Tests.cs

@@ -146,6 +146,8 @@ public async Task PatchAsync_Calls_Service()
             const int id = 0;
             var resource = new Resource();
             var serviceMock = new Mock<IUpdateService<Resource>>();
+            _jsonApiContextMock.Setup(a => a.ApplyContext<Resource>(It.IsAny<BaseJsonApiController<Resource>>())).Returns(_jsonApiContextMock.Object);
+            _jsonApiContextMock.SetupGet(a => a.Options).Returns(new JsonApiOptions());
             var controller = new BaseJsonApiController<Resource>(_jsonApiContextMock.Object, update: serviceMock.Object);
 
             // act
@@ -157,12 +159,34 @@ public async Task PatchAsync_Calls_Service()
         }
 
         [Fact]
-        public async Task PatchAsync_ModelStateInvalid()
+        public async Task PatchAsync_ModelStateInvalid_ValidateModelStateDisbled()
+        {
+            // arrange
+            const int id = 0;
+            var resource = new Resource();
+            var serviceMock = new Mock<IUpdateService<Resource>>();
+            _jsonApiContextMock.Setup(a => a.ApplyContext<Resource>(It.IsAny<BaseJsonApiController<Resource>>())).Returns(_jsonApiContextMock.Object);
+            _jsonApiContextMock.SetupGet(a => a.Options).Returns(new JsonApiOptions { ValidateModelState = false });
+            var controller = new BaseJsonApiController<Resource>(_jsonApiContextMock.Object, update: serviceMock.Object);
+
+            // act
+            var response = await controller.PatchAsync(id, resource);
+
+            // assert
+            serviceMock.Verify(m => m.UpdateAsync(id, It.IsAny<Resource>()), Times.Once);
+            VerifyApplyContext();
+            Assert.IsNotType<BadRequestObjectResult>(response);
+        }
+
+        [Fact]
+        public async Task PatchAsync_ModelStateInvalid_ValidateModelStateEnabled()
         {
             // arrange
             const int id = 0;
             var resource = new Resource();
             var serviceMock = new Mock<IUpdateService<Resource>>();
+            _jsonApiContextMock.Setup(a => a.ApplyContext<Resource>(It.IsAny<BaseJsonApiController<Resource>>())).Returns(_jsonApiContextMock.Object);
+            _jsonApiContextMock.SetupGet(a => a.Options).Returns(new JsonApiOptions{ValidateModelState = true});
             var controller = new BaseJsonApiController<Resource>(_jsonApiContextMock.Object, update: serviceMock.Object);
             controller.ModelState.AddModelError("Id", "Failed Validation");
 
@@ -211,13 +235,34 @@ public async Task PostAsync_Calls_Service()
         }
 
         [Fact]
-        public async Task PostAsync_ModelStateInvalid()
+        public async Task PostAsync_ModelStateInvalid_ValidateModelStateDisabled()
         {
             // arrange
             var resource = new Resource();
             var serviceMock = new Mock<ICreateService<Resource>>();
             _jsonApiContextMock.Setup(a => a.ApplyContext<Resource>(It.IsAny<BaseJsonApiController<Resource>>())).Returns(_jsonApiContextMock.Object);
-            _jsonApiContextMock.SetupGet(a => a.Options).Returns(new JsonApiOptions());
+            _jsonApiContextMock.SetupGet(a => a.Options).Returns(new JsonApiOptions { ValidateModelState = false });
+            var controller = new BaseJsonApiController<Resource>(_jsonApiContextMock.Object, create: serviceMock.Object);
+            serviceMock.Setup(m => m.CreateAsync(It.IsAny<Resource>())).ReturnsAsync(resource);
+            controller.ControllerContext = new Microsoft.AspNetCore.Mvc.ControllerContext { HttpContext = new DefaultHttpContext() };
+
+            // act
+            var response = await controller.PostAsync(resource);
+
+            // assert
+            serviceMock.Verify(m => m.CreateAsync(It.IsAny<Resource>()), Times.Once);
+            VerifyApplyContext();
+            Assert.IsNotType<BadRequestObjectResult>(response);
+        }
+
+        [Fact]
+        public async Task PostAsync_ModelStateInvalid_ValidateModelStateEnabled()
+        {
+            // arrange
+            var resource = new Resource();
+            var serviceMock = new Mock<ICreateService<Resource>>();
+            _jsonApiContextMock.Setup(a => a.ApplyContext<Resource>(It.IsAny<BaseJsonApiController<Resource>>())).Returns(_jsonApiContextMock.Object);
+            _jsonApiContextMock.SetupGet(a => a.Options).Returns(new JsonApiOptions { ValidateModelState = true });
             var controller = new BaseJsonApiController<Resource>(_jsonApiContextMock.Object, create: serviceMock.Object);
             controller.ModelState.AddModelError("Id", "Failed Validation");