Skip to content
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.

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

Prefer TypeConverter over TryParse #46577

Merged
merged 3 commits into from
Feb 15, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ public void Configure(MvcOptions options)
options.ModelBinderProviders.Add(new FloatingPointTypeModelBinderProvider());
options.ModelBinderProviders.Add(new EnumTypeModelBinderProvider(options));
options.ModelBinderProviders.Add(new DateTimeModelBinderProvider());
options.ModelBinderProviders.Add(new TryParseModelBinderProvider());
options.ModelBinderProviders.Add(new SimpleTypeModelBinderProvider());
options.ModelBinderProviders.Add(new TryParseModelBinderProvider());
options.ModelBinderProviders.Add(new CancellationTokenModelBinderProvider());
options.ModelBinderProviders.Add(new ByteArrayModelBinderProvider());
options.ModelBinderProviders.Add(new FormFileModelBinderProvider());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public class SimpleTypeModelBinderProvider : IModelBinderProvider
{
ArgumentNullException.ThrowIfNull(context);

if (!context.Metadata.IsComplexType)
if (context.Metadata.IsConvertibleType)
{
var loggerFactory = context.Services.GetRequiredService<ILoggerFactory>();
return new SimpleTypeModelBinder(context.Metadata.ModelType, loggerFactory);
Expand Down
2 changes: 1 addition & 1 deletion src/Mvc/Mvc/test/MvcOptionsSetupTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ public void Setup_SetsUpModelBinderProviders()
binder => Assert.IsType<FloatingPointTypeModelBinderProvider>(binder),
binder => Assert.IsType<EnumTypeModelBinderProvider>(binder),
binder => Assert.IsType<DateTimeModelBinderProvider>(binder),
binder => Assert.IsType<TryParseModelBinderProvider>(binder),
binder => Assert.IsType<SimpleTypeModelBinderProvider>(binder),
binder => Assert.IsType<TryParseModelBinderProvider>(binder),
binder => Assert.IsType<CancellationTokenModelBinderProvider>(binder),
binder => Assert.IsType<ByteArrayModelBinderProvider>(binder),
binder => Assert.IsType<FormFileModelBinderProvider>(binder),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.ComponentModel;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Text;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Abstractions;
Expand Down Expand Up @@ -699,6 +702,50 @@ public async Task BindParameter_FromFormData_BindsCorrectly(Dictionary<string, S
Assert.Equal(new[] { "line 1", "line 2" }, entry.RawValue);
}

[Fact]
public async Task BindParameter_PrefersTypeConverter_OverTryParse()
{
// Arrange
var parameterBinder = ModelBindingTestHelper.GetParameterBinder();
var parameter = new ParameterDescriptor()
{
Name = "Parameter1",
BindingInfo = new BindingInfo(),
ParameterType = typeof(SampleModel)
};

var testContext = ModelBindingTestHelper.GetTestContext(request =>
{
request.QueryString = QueryString.Create("Parameter1", "someValue");
});

var modelState = testContext.ModelState;

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

// Assert

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

// Model
var model = Assert.IsType<SampleModel>(modelBindingResult.Model);
Assert.Equal("someValue", model.Value);
Assert.Equal("Converter", model.Source);

// ModelState
Assert.True(modelState.IsValid);

Assert.Single(modelState.Keys);
var key = Assert.Single(modelState.Keys);
Assert.Equal("Parameter1", key);
Assert.Equal("someValue", modelState[key].AttemptedValue);
Assert.Equal("someValue", modelState[key].RawValue);
Assert.Empty(modelState[key].Errors);
Assert.Equal(ModelValidationState.Valid, modelState[key].ValidationState);
}

private class Person
{
public Address Address { get; set; }
Expand All @@ -712,4 +759,35 @@ private class Address

public int Zip { get; set; }
}

[TypeConverter(typeof(SampleModelTypeConverter))]
private class SampleModel
{
public string Value { get; set; }
public string Source { get; set; }

public static bool TryParse([NotNullWhen(true)] string s, [MaybeNullWhen(false)] out SampleModel result)
{
result = new SampleModel() { Value = s, Source = "TryParse" };
return true;
}
}

private class SampleModelTypeConverter : TypeConverter
{
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
{
return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
}

public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
{
if (value is string s)
{
return new SampleModel() { Value = s, Source = "Converter" };
}

return base.ConvertFrom(context, culture, value);
}
}
}