Skip to content

Exclude additional types from being validated #37150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pranavkm merged 1 commit into from
Oct 1, 2021
Merged

Exclude additional types from being validated #37150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/Mvc/Mvc.Core/src/Infrastructure/MvcCoreMvcOptionsSetup.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using System.Threading;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Formatters;
Expand Down Expand Up @@ -134,6 +135,11 @@ internal static void ConfigureAdditionalModelMetadataDetailsProviders(IList<IMet

// Add types to be excluded from Validation
modelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(Type)));
modelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(Delegate)));
modelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(MethodInfo)));
modelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(MemberInfo)));
modelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(ParameterInfo)));
modelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(Assembly)));
modelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(Uri)));
modelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(CancellationToken)));
modelMetadataDetailsProviders.Add(new SuppressChildValidationMetadataProvider(typeof(IFormFile)));
Expand Down
25 changes: 25 additions & 0 deletions src/Mvc/Mvc/test/MvcOptionsSetupTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,31 @@ public void Setup_SetsUpMetadataDetailsProviders()
Assert.Equal(typeof(Type), excludeFilter.Type);
},
provider =>
{
var excludeFilter = Assert.IsType<SuppressChildValidationMetadataProvider>(provider);
Assert.Equal(typeof(Delegate), excludeFilter.Type);
},
provider =>
{
var excludeFilter = Assert.IsType<SuppressChildValidationMetadataProvider>(provider);
Assert.Equal(typeof(MethodInfo), excludeFilter.Type);
},
provider =>
{
var excludeFilter = Assert.IsType<SuppressChildValidationMetadataProvider>(provider);
Assert.Equal(typeof(MemberInfo), excludeFilter.Type);
},
provider =>
{
var excludeFilter = Assert.IsType<SuppressChildValidationMetadataProvider>(provider);
Assert.Equal(typeof(ParameterInfo), excludeFilter.Type);
},
provider =>
{
var excludeFilter = Assert.IsType<SuppressChildValidationMetadataProvider>(provider);
Assert.Equal(typeof(Assembly), excludeFilter.Type);
},
provider =>
{
var excludeFilter = Assert.IsType<SuppressChildValidationMetadataProvider>(provider);
Assert.Equal(typeof(Uri), excludeFilter.Type);
Expand Down
13 changes: 8 additions & 5 deletions src/Mvc/test/Mvc.IntegrationTests/ModelBindingTestHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@ public static ParameterBinder GetParameterBinder(IServiceProvider serviceProvide
public static ParameterBinder GetParameterBinder(
IModelMetadataProvider metadataProvider,
IModelBinderProvider binderProvider = null,
MvcOptions mvcOptions = null)
MvcOptions mvcOptions = null,
ObjectModelValidator validator = null)
{
var services = GetServices(metadataProvider, mvcOptions: mvcOptions);
var options = services.GetRequiredService<IOptions<MvcOptions>>();
Expand All @@ -97,13 +98,15 @@ public static ParameterBinder GetParameterBinder(
options.Value.ModelBinderProviders.Insert(0, binderProvider);
}

validator ??= new DefaultObjectValidator(
metadataProvider,
new[] { new CompositeModelValidatorProvider(GetModelValidatorProviders(options)) },
options.Value);

return new ParameterBinder(
metadataProvider,
new ModelBinderFactory(metadataProvider, options, services),
new DefaultObjectValidator(
metadataProvider,
new[] { new CompositeModelValidatorProvider(GetModelValidatorProviders(options)) },
options.Value),
validator,
options,
NullLoggerFactory.Instance);
}
Expand Down
97 changes: 97 additions & 0 deletions src/Mvc/test/Mvc.IntegrationTests/ValidationIntegrationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.AspNetCore.Mvc.ModelBinding.Metadata;
using Microsoft.AspNetCore.Mvc.ModelBinding.Validation;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Xunit;
Expand Down Expand Up @@ -2437,10 +2439,105 @@ public async Task Validation_InifnitelyRecursiveModel_ValidationOnTopLevelParame

private static void Validation_InifnitelyRecursiveModel_ValidationOnTopLevelParameterMethod([Required] RecursiveModel model) { }

[Fact]
public async Task Validation_ModelWithNonNullableReferenceTypes_DoesNotValidateNonNullablePropertiesOnFrameworkTypes()
{
// Arrange
var parameterInfo = GetType().GetMethod(nameof(Validation_ModelWithNonNullableReferenceTypes_DoesNotValidateNonNullablePropertiesOnFrameworkTypesAction), BindingFlags.NonPublic | BindingFlags.Static)
.GetParameters()
.First();

var modelMetadataProvider = TestModelMetadataProvider.CreateDefaultProvider();
var services = ModelBindingTestHelper.GetServices(modelMetadataProvider);
var modelMetadata = modelMetadataProvider.GetMetadataForParameter(parameterInfo);
var options = services.GetRequiredService<IOptions<MvcOptions>>().Value;
var validator = new RecordingObjectValidator(
modelMetadataProvider,
TestModelValidatorProvider.CreateDefaultProvider().ValidatorProviders,
options);
var parameterBinder = ModelBindingTestHelper.GetParameterBinder(modelMetadataProvider, mvcOptions: options, validator: validator);

var parameter = new ParameterDescriptor()
{
Name = parameterInfo.Name,
ParameterType = parameterInfo.ParameterType,
};

var testContext = ModelBindingTestHelper.GetTestContext(request =>
{
request.QueryString = new QueryString("?Name=CoolName");
});
var modelState = testContext.ModelState;

// Act
var modelBindingResult = await parameterBinder.BindModelAsync(parameter, testContext, modelMetadataProvider, modelMetadata);

// Assert
Assert.True(modelBindingResult.IsModelSet);

var model = Assert.IsType<ModelWithNonNullableReferenceTypeProperties>(modelBindingResult.Model);
Assert.Equal("CoolName", model.Name);

Assert.True(modelState.IsValid);
Assert.Equal(ModelValidationState.Valid, modelState.ValidationState);

var visited = validator.ValidationVisitor.Visited;
Assert.Collection(
visited,
Copy link
Contributor Author

@pranavkm pranavkm Sep 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without the change, validation validates about 260k models.

v => Assert.Equal(typeof(ModelWithNonNullableReferenceTypeProperties), v.ModelType),
v => Assert.Equal(typeof(string), v.ModelType),
v => Assert.Equal(typeof(Delegate), v.ModelType));
}

#nullable enable
private static void Validation_ModelWithNonNullableReferenceTypes_DoesNotValidateNonNullablePropertiesOnFrameworkTypesAction(ModelWithNonNullableReferenceTypeProperties model) { }

public class ModelWithNonNullableReferenceTypeProperties
{
public string Name { get; set; } = default!;

public Delegate Delegate { get; set; } = typeof(ModelWithNonNullableReferenceTypeProperties).GetMethod(nameof(SomeMethod))!.CreateDelegate<Action>();

public static void SomeMethod() { }
}
#nullable restore

private static void AssertRequiredError(string key, ModelError error)
{
Assert.Equal(ValidationAttributeUtil.GetRequiredErrorMessage(key), error.ErrorMessage);
Assert.Null(error.Exception);
}

private class RecordingObjectValidator : DefaultObjectValidator
{
public RecordingObjectValidator(IModelMetadataProvider modelMetadataProvider, IList<IModelValidatorProvider> validatorProviders, MvcOptions mvcOptions)
: base(modelMetadataProvider, validatorProviders, mvcOptions)
{
}

public RecordingValidationVisitor ValidationVisitor { get; private set; }

public override ValidationVisitor GetValidationVisitor(ActionContext actionContext, IModelValidatorProvider validatorProvider, ValidatorCache validatorCache, IModelMetadataProvider metadataProvider, ValidationStateDictionary validationState)
{
ValidationVisitor = new RecordingValidationVisitor(actionContext, validatorProvider, validatorCache, metadataProvider, validationState);
return ValidationVisitor;
}
}

private class RecordingValidationVisitor : ValidationVisitor
{
public RecordingValidationVisitor(ActionContext actionContext, IModelValidatorProvider validatorProvider, ValidatorCache validatorCache, IModelMetadataProvider metadataProvider, ValidationStateDictionary validationState)
: base(actionContext, validatorProvider, validatorCache, metadataProvider, validationState)
{
}

public List<ModelMetadata> Visited = new();

protected override bool Visit(ModelMetadata metadata, string key, object model)
{
Visited.Add(metadata);
return base.Visit(metadata, key, model);
}
}
}
}