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.

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

Jump to bottom

Options validation source generator #87587

Merged
merged 13 commits into from
Jun 20, 2023
Merged

Options validation source generator #87587

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
304dd3d
Options validation source generator
tarekgh May 19, 2023
b662e52
Add source gen to the package and clean up some resources
tarekgh Jun 15, 2023
f20f8e6
Change the initialization to use ForAttributeWithMetadataName
tarekgh Jun 15, 2023
86409c0
Excluding tests on WASM
tarekgh Jun 16, 2023
9456bf5
Address Martin's feedback
tarekgh Jun 17, 2023
f61cae6
Address Jeff's comments
tarekgh Jun 17, 2023
8e6c7a0
Replace the calls of ValidationAttribute.GetValidationResult with Val…
tarekgh Jun 17, 2023
c18789c
Avoid calling List.Clean and create the list with initial capacity
tarekgh Jun 18, 2023
8ea301d
Pass down the SematicModel from the generator to the parser
tarekgh Jun 18, 2023
54a2f97
Add isolated unit test
tarekgh Jun 18, 2023
9119332
Final fixes
tarekgh Jun 20, 2023
c98e5fc
Fix resource messages
tarekgh Jun 20, 2023
ec2c6e4
Address more feedback
tarekgh Jun 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 15 additions & 4 deletions src/libraries/Microsoft.Extensions.Options/gen/Emitter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ internal sealed class Emitter : EmitterBase
private const string StaticFieldHolderClassesNamespace = "__OptionValidationStaticInstances";
private const string StaticValidationAttributeHolderClassFQN = $"global::{StaticFieldHolderClassesNamespace}.{StaticValidationAttributeHolderClassName}";
private const string StaticValidatorHolderClassFQN = $"global::{StaticFieldHolderClassesNamespace}.{StaticValidatorHolderClassName}";
private const string StaticListType = "global::System.Collections.Generic.List";
private const string StaticValidationResultType = "global::System.ComponentModel.DataAnnotations.ValidationResult";
private const string StaticValidationAttributeType = "global::System.ComponentModel.DataAnnotations.ValidationAttribute";

private sealed record StaticFieldInfo(string FieldTypeFQN, int FieldOrder, string FieldName, IList<string> InstantiationLines);

public string Emit(
Expand Down Expand Up @@ -159,6 +163,8 @@ private void GenModelSelfValidationIfNecessary(ValidatedModel modelToValidate)
OutLn($"var baseName = (string.IsNullOrEmpty(name) ? \"{modelToValidate.SimpleName}\" : name) + \".\";");
OutLn($"var builder = new global::Microsoft.Extensions.Options.ValidateOptionsResultBuilder();");
OutLn($"var context = new global::System.ComponentModel.DataAnnotations.ValidationContext(options);");
OutLn($"var validationResults = new {StaticListType}<{StaticValidationResultType}>();");
OutLn($"var validationAttributes = new {StaticListType}<{StaticValidationAttributeType}>();");
OutLn();

foreach (var vm in modelToValidate.MembersToValidate)
Expand Down Expand Up @@ -187,18 +193,23 @@ private void GenModelSelfValidationIfNecessary(ValidatedModel modelToValidate)
OutCloseBrace();
}

private void GenMemberValidation(ValidatedMember vm,
ref Dictionary<string, StaticFieldInfo> staticValidationAttributesDict)
private void GenMemberValidation(ValidatedMember vm, ref Dictionary<string, StaticFieldInfo> staticValidationAttributesDict)
{
OutLn($"context.MemberName = \"{vm.Name}\";");
OutLn($"context.DisplayName = baseName + \"{vm.Name}\";");

foreach (var attr in vm.ValidationAttributes)
{
var staticValidationAttributeInstance = GetOrAddStaticValidationAttribute(ref staticValidationAttributesDict, attr);

OutLn($"builder.AddResult({StaticValidationAttributeHolderClassFQN}.{staticValidationAttributeInstance.FieldName}.GetValidationResult(options.{vm.Name}, context));");
OutLn($"validationAttributes.Add({StaticValidationAttributeHolderClassFQN}.{staticValidationAttributeInstance.FieldName});");
}

OutLn($"if (!global::System.ComponentModel.DataAnnotations.Validator.TryValidateValue(options.{vm.Name}!, context, validationResults, validationAttributes))");
OutOpenBrace();
OutLn($"builder.AddResults(validationResults);");
OutCloseBrace();
OutLn($"validationResults.Clear();");
OutLn($"validationAttributes.Clear();");
}

private StaticFieldInfo GetOrAddStaticValidationAttribute(ref Dictionary<string, StaticFieldInfo> staticValidationAttributesDict, ValidationAttributeInfo attr)
Expand Down