Skip to content

Commit e7ebb34

Browse files
authored
Skip non-public properties in validations generator (#63076)
* Skip non-public properties in validations generator * Update ValidationsGenerator.TypesParser.cs
1 parent 5723334 commit e7ebb34

File tree

4 files changed

+273
-18
lines changed

4 files changed

+273
-18
lines changed

src/Validation/gen/Parsers/ValidationsGenerator.TypesParser.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,12 @@ internal bool TryExtractValidatableType(ITypeSymbol incomingTypeSymbol, WellKnow
6565
return false;
6666
}
6767

68+
// Skip types that are not accessible from generated code
69+
if (typeSymbol.DeclaredAccessibility is not Accessibility.Public)
70+
{
71+
return false;
72+
}
73+
6874
visitedTypes.Add(typeSymbol);
6975

7076
// Extract validatable types discovered in base types of this type and add them to the top-level list.
@@ -150,6 +156,12 @@ internal ImmutableArray<ValidatableProperty> ExtractValidatableMembers(ITypeSymb
150156
continue;
151157
}
152158

159+
// Skip properties that are not accessible from generated code
160+
if (correspondingProperty.DeclaredAccessibility is not Accessibility.Public)
161+
{
162+
continue;
163+
}
164+
153165
// Skip properties that have JsonIgnore attribute
154166
if (correspondingProperty.IsJsonIgnoredProperty(jsonIgnoreAttributeSymbol))
155167
{
@@ -194,6 +206,12 @@ internal ImmutableArray<ValidatableProperty> ExtractValidatableMembers(ITypeSymb
194206
continue;
195207
}
196208

209+
// Skip properties that are not accessible from generated code
210+
if (member.DeclaredAccessibility is not Accessibility.Public)
211+
{
212+
continue;
213+
}
214+
197215
// Skip properties that have JsonIgnore attribute
198216
if (member.IsJsonIgnoredProperty(jsonIgnoreAttributeSymbol))
199217
{

src/Validation/test/Microsoft.Extensions.Validation.GeneratorTests/ValidationsGenerator.ComplexType.cs

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -532,4 +532,95 @@ async Task ValidInputProducesNoWarnings(Endpoint endpoint)
532532
}
533533
});
534534
}
535+
536+
[Fact]
537+
public async Task SkipsClassesWithNonAccessibleTypes()
538+
{
539+
// Arrange
540+
var source = """
541+
using System;
542+
using System.ComponentModel.DataAnnotations;
543+
using System.Collections.Generic;
544+
using System.Threading.Tasks;
545+
using Microsoft.AspNetCore.Builder;
546+
using Microsoft.AspNetCore.Http;
547+
using Microsoft.Extensions.Validation;
548+
using Microsoft.AspNetCore.Routing;
549+
using Microsoft.Extensions.DependencyInjection;
550+
using Microsoft.AspNetCore.Mvc;
551+
552+
var builder = WebApplication.CreateBuilder();
553+
554+
builder.Services.AddValidation();
555+
556+
var app = builder.Build();
557+
558+
app.MapPost("/accessibility-test", (AccessibilityTestType accessibilityTest) => Results.Ok("Passed"!));
559+
560+
app.Run();
561+
562+
public class AccessibilityTestType
563+
{
564+
[Required]
565+
public string PublicProperty { get; set; } = "";
566+
567+
[Required]
568+
private string PrivateProperty { get; set; } = "";
569+
570+
[Required]
571+
protected string ProtectedProperty { get; set; } = "";
572+
573+
[Required]
574+
private PrivateNestedType PrivateNestedProperty { get; set; } = new();
575+
576+
[Required]
577+
protected ProtectedNestedType ProtectedNestedProperty { get; set; } = new();
578+
579+
[Required]
580+
internal InternalNestedType InternalNestedProperty { get; set; } = new();
581+
582+
private class PrivateNestedType
583+
{
584+
[Required]
585+
public string RequiredProperty { get; set; } = "";
586+
}
587+
588+
protected class ProtectedNestedType
589+
{
590+
[Required]
591+
public string RequiredProperty { get; set; } = "";
592+
}
593+
594+
internal class InternalNestedType
595+
{
596+
[Required]
597+
public string RequiredProperty { get; set; } = "";
598+
}
599+
}
600+
""";
601+
await Verify(source, out var compilation);
602+
await VerifyEndpoint(compilation, "/accessibility-test", async (endpoint, serviceProvider) =>
603+
{
604+
await ValidPublicPropertyStillValidated(endpoint);
605+
606+
async Task ValidPublicPropertyStillValidated(Endpoint endpoint)
607+
{
608+
var payload = """
609+
{
610+
"PublicProperty": ""
611+
}
612+
""";
613+
var context = CreateHttpContextWithPayload(payload, serviceProvider);
614+
615+
await endpoint.RequestDelegate(context);
616+
617+
var problemDetails = await AssertBadRequest(context);
618+
Assert.Collection(problemDetails.Errors, kvp =>
619+
{
620+
Assert.Equal("PublicProperty", kvp.Key);
621+
Assert.Equal("The PublicProperty field is required.", kvp.Value.Single());
622+
});
623+
}
624+
});
625+
}
535626
}

src/Validation/test/Microsoft.Extensions.Validation.GeneratorTests/snapshots/ValidationsGeneratorTests.CanValidateParameters#ValidatableInfoResolver.g.verified.cs

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -82,30 +82,12 @@ public bool TryGetValidatableTypeInfo(global::System.Type type, [global::System.
8282
validatableInfo = new GeneratedValidatableTypeInfo(
8383
type: typeof(global::System.Collections.Generic.Dictionary<string, global::TestService>),
8484
members: [
85-
new GeneratedValidatablePropertyInfo(
86-
containingType: typeof(global::System.Collections.Generic.Dictionary<string, global::TestService>),
87-
propertyType: typeof(global::System.Collections.Generic.ICollection<global::TestService>),
88-
name: "System.Collections.Generic.IDictionary<TKey,TValue>.Values",
89-
displayName: "System.Collections.Generic.IDictionary<TKey,TValue>.Values"
90-
),
91-
new GeneratedValidatablePropertyInfo(
92-
containingType: typeof(global::System.Collections.Generic.Dictionary<string, global::TestService>),
93-
propertyType: typeof(global::System.Collections.Generic.IEnumerable<global::TestService>),
94-
name: "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values",
95-
displayName: "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values"
96-
),
9785
new GeneratedValidatablePropertyInfo(
9886
containingType: typeof(global::System.Collections.Generic.Dictionary<string, global::TestService>),
9987
propertyType: typeof(global::TestService),
10088
name: "this[]",
10189
displayName: "this[]"
10290
),
103-
new GeneratedValidatablePropertyInfo(
104-
containingType: typeof(global::System.Collections.Generic.Dictionary<string, global::TestService>),
105-
propertyType: typeof(global::System.Collections.ICollection),
106-
name: "System.Collections.IDictionary.Values",
107-
displayName: "System.Collections.IDictionary.Values"
108-
),
10991
]
11092
);
11193
return true;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
//HintName: ValidatableInfoResolver.g.cs
2+
#nullable enable annotations
3+
//------------------------------------------------------------------------------
4+
// <auto-generated>
5+
// This code was generated by a tool.
6+
//
7+
// Changes to this file may cause incorrect behavior and will be lost if
8+
// the code is regenerated.
9+
// </auto-generated>
10+
//------------------------------------------------------------------------------
11+
#nullable enable
12+
#pragma warning disable ASP0029
13+
14+
namespace System.Runtime.CompilerServices
15+
{
16+
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Validation.ValidationsGenerator, Version=42.42.42.42, Culture=neutral, PublicKeyToken=adb9793829ddae60", "42.42.42.42")]
17+
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
18+
file sealed class InterceptsLocationAttribute : System.Attribute
19+
{
20+
public InterceptsLocationAttribute(int version, string data)
21+
{
22+
}
23+
}
24+
}
25+
26+
namespace Microsoft.Extensions.Validation.Generated
27+
{
28+
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Validation.ValidationsGenerator, Version=42.42.42.42, Culture=neutral, PublicKeyToken=adb9793829ddae60", "42.42.42.42")]
29+
file sealed class GeneratedValidatablePropertyInfo : global::Microsoft.Extensions.Validation.ValidatablePropertyInfo
30+
{
31+
public GeneratedValidatablePropertyInfo(
32+
[param: global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties | global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)]
33+
global::System.Type containingType,
34+
global::System.Type propertyType,
35+
string name,
36+
string displayName) : base(containingType, propertyType, name, displayName)
37+
{
38+
ContainingType = containingType;
39+
Name = name;
40+
}
41+
42+
[global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties | global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)]
43+
internal global::System.Type ContainingType { get; }
44+
internal string Name { get; }
45+
46+
protected override global::System.ComponentModel.DataAnnotations.ValidationAttribute[] GetValidationAttributes()
47+
=> ValidationAttributeCache.GetValidationAttributes(ContainingType, Name);
48+
}
49+
50+
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Validation.ValidationsGenerator, Version=42.42.42.42, Culture=neutral, PublicKeyToken=adb9793829ddae60", "42.42.42.42")]
51+
file sealed class GeneratedValidatableTypeInfo : global::Microsoft.Extensions.Validation.ValidatableTypeInfo
52+
{
53+
public GeneratedValidatableTypeInfo(
54+
[param: global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces)]
55+
global::System.Type type,
56+
ValidatablePropertyInfo[] members) : base(type, members) { }
57+
}
58+
59+
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Validation.ValidationsGenerator, Version=42.42.42.42, Culture=neutral, PublicKeyToken=adb9793829ddae60", "42.42.42.42")]
60+
file class GeneratedValidatableInfoResolver : global::Microsoft.Extensions.Validation.IValidatableInfoResolver
61+
{
62+
public bool TryGetValidatableTypeInfo(global::System.Type type, [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)] out global::Microsoft.Extensions.Validation.IValidatableInfo? validatableInfo)
63+
{
64+
validatableInfo = null;
65+
if (type == typeof(global::AccessibilityTestType))
66+
{
67+
validatableInfo = new GeneratedValidatableTypeInfo(
68+
type: typeof(global::AccessibilityTestType),
69+
members: [
70+
new GeneratedValidatablePropertyInfo(
71+
containingType: typeof(global::AccessibilityTestType),
72+
propertyType: typeof(string),
73+
name: "PublicProperty",
74+
displayName: "PublicProperty"
75+
),
76+
]
77+
);
78+
return true;
79+
}
80+
81+
return false;
82+
}
83+
84+
// No-ops, rely on runtime code for ParameterInfo-based resolution
85+
public bool TryGetValidatableParameterInfo(global::System.Reflection.ParameterInfo parameterInfo, [global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)] out global::Microsoft.Extensions.Validation.IValidatableInfo? validatableInfo)
86+
{
87+
validatableInfo = null;
88+
return false;
89+
}
90+
}
91+
92+
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Validation.ValidationsGenerator, Version=42.42.42.42, Culture=neutral, PublicKeyToken=adb9793829ddae60", "42.42.42.42")]
93+
file static class GeneratedServiceCollectionExtensions
94+
{
95+
[InterceptsLocation]
96+
public static global::Microsoft.Extensions.DependencyInjection.IServiceCollection AddValidation(this global::Microsoft.Extensions.DependencyInjection.IServiceCollection services, global::System.Action<global::Microsoft.Extensions.Validation.ValidationOptions>? configureOptions = null)
97+
{
98+
// Use non-extension method to avoid infinite recursion.
99+
return global::Microsoft.Extensions.DependencyInjection.ValidationServiceCollectionExtensions.AddValidation(services, options =>
100+
{
101+
options.Resolvers.Insert(0, new GeneratedValidatableInfoResolver());
102+
if (configureOptions is not null)
103+
{
104+
configureOptions(options);
105+
}
106+
});
107+
}
108+
}
109+
110+
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Extensions.Validation.ValidationsGenerator, Version=42.42.42.42, Culture=neutral, PublicKeyToken=adb9793829ddae60", "42.42.42.42")]
111+
file static class ValidationAttributeCache
112+
{
113+
private sealed record CacheKey(
114+
[param: global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties | global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)]
115+
[property: global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties | global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)]
116+
global::System.Type ContainingType,
117+
string PropertyName);
118+
private static readonly global::System.Collections.Concurrent.ConcurrentDictionary<CacheKey, global::System.ComponentModel.DataAnnotations.ValidationAttribute[]> _cache = new();
119+
120+
public static global::System.ComponentModel.DataAnnotations.ValidationAttribute[] GetValidationAttributes(
121+
[global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties | global::System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)]
122+
global::System.Type containingType,
123+
string propertyName)
124+
{
125+
var key = new CacheKey(containingType, propertyName);
126+
return _cache.GetOrAdd(key, static k =>
127+
{
128+
var results = new global::System.Collections.Generic.List<global::System.ComponentModel.DataAnnotations.ValidationAttribute>();
129+
130+
// Get attributes from the property
131+
var property = k.ContainingType.GetProperty(k.PropertyName);
132+
if (property != null)
133+
{
134+
var propertyAttributes = global::System.Reflection.CustomAttributeExtensions
135+
.GetCustomAttributes<global::System.ComponentModel.DataAnnotations.ValidationAttribute>(property, inherit: true);
136+
137+
results.AddRange(propertyAttributes);
138+
}
139+
140+
// Check constructors for parameters that match the property name
141+
// to handle record scenarios
142+
foreach (var constructor in k.ContainingType.GetConstructors())
143+
{
144+
// Look for parameter with matching name (case insensitive)
145+
var parameter = global::System.Linq.Enumerable.FirstOrDefault(
146+
constructor.GetParameters(),
147+
p => string.Equals(p.Name, k.PropertyName, global::System.StringComparison.OrdinalIgnoreCase));
148+
149+
if (parameter != null)
150+
{
151+
var paramAttributes = global::System.Reflection.CustomAttributeExtensions
152+
.GetCustomAttributes<global::System.ComponentModel.DataAnnotations.ValidationAttribute>(parameter, inherit: true);
153+
154+
results.AddRange(paramAttributes);
155+
156+
break;
157+
}
158+
}
159+
160+
return results.ToArray();
161+
});
162+
}
163+
}
164+
}

0 commit comments

Comments
 (0)