-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Respect JsonSerializerOptions in validation errors #62341
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -3,6 +3,9 @@ | |||||
|
||||||
using System.ComponentModel.DataAnnotations; | ||||||
using System.Diagnostics.CodeAnalysis; | ||||||
using System.Reflection; | ||||||
using System.Text.Json; | ||||||
using System.Text.Json.Serialization; | ||||||
|
||||||
namespace Microsoft.Extensions.Validation; | ||||||
|
||||||
|
@@ -13,12 +16,13 @@ namespace Microsoft.Extensions.Validation; | |||||
public abstract class ValidatablePropertyInfo : IValidatableInfo | ||||||
{ | ||||||
private RequiredAttribute? _requiredAttribute; | ||||||
private readonly bool _hasDisplayAttribute; | ||||||
|
||||||
/// <summary> | ||||||
/// Creates a new instance of <see cref="ValidatablePropertyInfo"/>. | ||||||
/// </summary> | ||||||
protected ValidatablePropertyInfo( | ||||||
[param: DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties)] | ||||||
[param: DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicConstructors)] | ||||||
Type declaringType, | ||||||
Type propertyType, | ||||||
string name, | ||||||
|
@@ -28,12 +32,18 @@ protected ValidatablePropertyInfo( | |||||
PropertyType = propertyType; | ||||||
Name = name; | ||||||
DisplayName = displayName; | ||||||
|
||||||
// Cache the HasDisplayAttribute result to avoid repeated reflection calls | ||||||
// We only check for the existence of the DisplayAttribute here and not the | ||||||
// Name value itself since we rely on the source generator populating it | ||||||
var property = DeclaringType.GetProperty(Name); | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [nitpick] Consider specifying explicit BindingFlags (e.g. BindingFlags.Public | BindingFlags.Instance) with GetProperty to ensure the lookup behavior is unambiguous.
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||
_hasDisplayAttribute = property is not null && HasDisplayAttribute(property); | ||||||
} | ||||||
|
||||||
/// <summary> | ||||||
/// Gets the member type. | ||||||
/// </summary> | ||||||
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties)] | ||||||
[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.PublicConstructors)] | ||||||
internal Type DeclaringType { get; } | ||||||
|
||||||
/// <summary> | ||||||
|
@@ -65,18 +75,24 @@ public virtual async Task ValidateAsync(object? value, ValidateContext context, | |||||
var validationAttributes = GetValidationAttributes(); | ||||||
|
||||||
// Calculate and save the current path | ||||||
var namingPolicy = context.SerializerOptions?.PropertyNamingPolicy; | ||||||
var memberName = GetJsonPropertyName(Name, property, namingPolicy); | ||||||
var originalPrefix = context.CurrentValidationPath; | ||||||
if (string.IsNullOrEmpty(originalPrefix)) | ||||||
{ | ||||||
context.CurrentValidationPath = Name; | ||||||
context.CurrentValidationPath = memberName; | ||||||
} | ||||||
else | ||||||
{ | ||||||
context.CurrentValidationPath = $"{originalPrefix}.{Name}"; | ||||||
context.CurrentValidationPath = $"{originalPrefix}.{memberName}"; | ||||||
} | ||||||
|
||||||
context.ValidationContext.DisplayName = DisplayName; | ||||||
context.ValidationContext.MemberName = Name; | ||||||
// Format the display name and member name according to JsonPropertyName attribute first, then naming policy | ||||||
// If the property has a [Display] attribute (either on property or record parameter), use DisplayName directly without formatting | ||||||
context.ValidationContext.DisplayName = _hasDisplayAttribute | ||||||
? DisplayName | ||||||
: GetJsonPropertyName(DisplayName, property, namingPolicy); | ||||||
context.ValidationContext.MemberName = memberName; | ||||||
|
||||||
// Check required attribute first | ||||||
if (_requiredAttribute is not null || validationAttributes.TryGetRequiredAttribute(out _requiredAttribute)) | ||||||
|
@@ -172,4 +188,61 @@ void ValidateValue(object? val, string name, string errorPrefix, ValidationAttri | |||||
} | ||||||
} | ||||||
} | ||||||
|
||||||
/// <summary> | ||||||
/// Gets the effective member name for JSON serialization, considering <see cref="JsonPropertyNameAttribute"/> and naming policy. | ||||||
/// </summary> | ||||||
/// <param name="targetValue">The target value to get the name for.</param> | ||||||
/// <param name="property">The property info to get the name for.</param> | ||||||
/// <param name="namingPolicy">The JSON naming policy to apply if no <see cref="JsonPropertyNameAttribute"/> is present.</param> | ||||||
/// <returns>The effective property name for JSON serialization.</returns> | ||||||
private static string GetJsonPropertyName(string targetValue, PropertyInfo property, JsonNamingPolicy? namingPolicy) | ||||||
{ | ||||||
var jsonPropertyName = property.GetCustomAttribute<JsonPropertyNameAttribute>()?.Name; | ||||||
|
||||||
if (jsonPropertyName is not null) | ||||||
{ | ||||||
return jsonPropertyName; | ||||||
} | ||||||
|
||||||
if (namingPolicy is not null) | ||||||
{ | ||||||
return namingPolicy.ConvertName(targetValue); | ||||||
} | ||||||
|
||||||
return targetValue; | ||||||
} | ||||||
|
||||||
/// <summary> | ||||||
/// Determines whether the property has a <see cref="DisplayAttribute"/>, either directly on the property | ||||||
/// or on the corresponding constructor parameter if the declaring type is a record. | ||||||
/// </summary> | ||||||
/// <param name="property">The property to check.</param> | ||||||
/// <returns>True if the property has a <see cref="DisplayAttribute"/> , false otherwise.</returns> | ||||||
private bool HasDisplayAttribute(PropertyInfo property) | ||||||
{ | ||||||
// Check if the property itself has the DisplayAttribute with a valid Name | ||||||
if (property.GetCustomAttribute<DisplayAttribute>() is { Name: not null }) | ||||||
{ | ||||||
return true; | ||||||
} | ||||||
|
||||||
// Look for a constructor parameter matching the property name (case-insensitive) | ||||||
// to account for the record scenario | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and primary ctors? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not quite since there isn't the same case-based 1:1 mapping between property names and parameter names when using primary constructors. It's a variation of #61526. |
||||||
foreach (var constructor in DeclaringType.GetConstructors()) | ||||||
{ | ||||||
foreach (var parameter in constructor.GetParameters()) | ||||||
{ | ||||||
if (string.Equals(parameter.Name, property.Name, StringComparison.OrdinalIgnoreCase)) | ||||||
{ | ||||||
if (parameter.GetCustomAttribute<DisplayAttribute>() is { Name: not null }) | ||||||
{ | ||||||
return true; | ||||||
} | ||||||
} | ||||||
} | ||||||
} | ||||||
|
||||||
return false; | ||||||
} | ||||||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,8 @@ | |
|
||
using System.ComponentModel.DataAnnotations; | ||
using System.Diagnostics.CodeAnalysis; | ||
using System.Text.Json; | ||
using Microsoft.Extensions.Options; | ||
|
||
namespace Microsoft.Extensions.Validation; | ||
|
||
|
@@ -60,6 +62,52 @@ public sealed class ValidateContext | |
/// </summary> | ||
public int CurrentDepth { get; set; } | ||
|
||
private JsonSerializerOptions? _cachedSerializerOptions; | ||
private bool _serializerOptionsResolved; | ||
|
||
internal JsonSerializerOptions? SerializerOptions | ||
{ | ||
get | ||
{ | ||
if (_serializerOptionsResolved) | ||
{ | ||
return _cachedSerializerOptions; | ||
} | ||
|
||
_cachedSerializerOptions = ResolveSerializerOptions(); | ||
_serializerOptionsResolved = true; | ||
return _cachedSerializerOptions; | ||
} | ||
} | ||
|
||
/// <summary> | ||
/// Attempts to resolve the <see cref="JsonSerializerOptions"/> used for serialization | ||
/// using reflection to access JsonOptions from the ASP.NET Core shared framework. | ||
/// </summary> | ||
private JsonSerializerOptions? ResolveSerializerOptions() | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How AOT friendly is this? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it's generally safe. The main issue would be the resolution of the I am long overdue for adding a native AoT test project to this package... :/ |
||
{ | ||
var targetType = "Microsoft.AspNetCore.Http.Json.JsonOptions, Microsoft.AspNetCore.Http.Extensions"; | ||
var jsonOptionsType = Type.GetType(targetType, throwOnError: false); | ||
if (jsonOptionsType is null) | ||
{ | ||
return null; | ||
} | ||
|
||
var iOptionsType = typeof(IOptions<>).MakeGenericType(jsonOptionsType); | ||
|
||
var optionsObj = ValidationContext.GetService(iOptionsType); | ||
if (optionsObj is null) | ||
{ | ||
return null; | ||
} | ||
|
||
var valueProp = iOptionsType.GetProperty("Value")!; | ||
var jsonOptions = valueProp.GetValue(optionsObj); | ||
var serializerProp = jsonOptionsType.GetProperty("SerializerOptions")!; | ||
|
||
return serializerProp.GetValue(jsonOptions) as JsonSerializerOptions; | ||
} | ||
|
||
/// <summary> | ||
/// Optional event raised when a validation error is reported. | ||
/// </summary> | ||
|
@@ -68,7 +116,6 @@ public sealed class ValidateContext | |
internal void AddValidationError(string propertyName, string key, string[] error, object? container) | ||
{ | ||
ValidationErrors ??= []; | ||
|
||
ValidationErrors[key] = error; | ||
OnValidationError?.Invoke(new ValidationErrorContext | ||
{ | ||
|
@@ -110,7 +157,7 @@ internal void AddOrExtendValidationError(string name, string key, string error, | |
|
||
if (ValidationErrors.TryGetValue(key, out var existingErrors) && !existingErrors.Contains(error)) | ||
{ | ||
ValidationErrors[key] = [.. existingErrors, error]; | ||
ValidationErrors[key] = [..existingErrors, error]; | ||
} | ||
else | ||
{ | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Comment about why we don't use the name from the attribute
And maybe we should set
DisplayName
to the attributes value if the provided value happens to be null? (I know the API definition says non-null but...)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What would this help with?