- 
                Notifications
    
You must be signed in to change notification settings  - Fork 10.5k
 
Add JsonIgnore attribute support to Minimal API validation generator #63075
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
          
     Merged
      
      
    
  
     Merged
                    Changes from 4 commits
      Commits
    
    
            Show all changes
          
          
            5 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      690e927
              
                Initial plan
              
              
                Copilot 07e71a6
              
                Add JsonIgnore attribute support to validation generator
              
              
                Copilot 2247d7f
              
                Fix JsonIgnore test case to prevent circular reference stack overflow
              
              
                Copilot d038ce7
              
                Update CanValidateComplexTypesWithJsonIgnore test with record type cases
              
              
                Copilot cabe2b1
              
                Remove unused IsJsonIgnoredParameter method and clean up test snapshots
              
              
                Copilot File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| 
          
            
          
           | 
    @@ -114,6 +114,8 @@ internal ImmutableArray<ValidatableProperty> ExtractValidatableMembers(ITypeSymb | |
| WellKnownTypeData.WellKnownType.Microsoft_AspNetCore_Http_Metadata_IFromServiceMetadata); | ||
| var fromKeyedServiceAttributeSymbol = wellKnownTypes.Get( | ||
| WellKnownTypeData.WellKnownType.Microsoft_Extensions_DependencyInjection_FromKeyedServicesAttribute); | ||
| var jsonIgnoreAttributeSymbol = wellKnownTypes.Get( | ||
| WellKnownTypeData.WellKnownType.System_Text_Json_Serialization_JsonIgnoreAttribute); | ||
| 
     | 
||
| // Special handling for record types to extract properties from | ||
| // the primary constructor. | ||
| 
          
            
          
           | 
    @@ -148,6 +150,12 @@ internal ImmutableArray<ValidatableProperty> ExtractValidatableMembers(ITypeSymb | |
| continue; | ||
| } | ||
| 
     | 
||
| // Skip parameters that have JsonIgnore attribute | ||
| if (parameter.IsJsonIgnoredParameter(jsonIgnoreAttributeSymbol)) | ||
| { | ||
| continue; | ||
| } | ||
| 
     | 
||
| // Check if the property's type is validatable, this resolves | ||
| // validatable types in the inheritance hierarchy | ||
| var hasValidatableType = TryExtractValidatableType( | ||
| 
          
            
          
           | 
    @@ -186,6 +194,12 @@ internal ImmutableArray<ValidatableProperty> ExtractValidatableMembers(ITypeSymb | |
| continue; | ||
| } | ||
| 
     | 
||
| // Skip properties that have JsonIgnore attribute | ||
| if (member.IsJsonIgnoredProperty(jsonIgnoreAttributeSymbol)) | ||
        
    
 | 
||
| { | ||
| continue; | ||
| } | ||
| 
     | 
||
| var hasValidatableType = TryExtractValidatableType(member.Type, wellKnownTypes, ref validatableTypes, ref visitedTypes); | ||
| var attributes = ExtractValidationAttributes(member, wellKnownTypes, out var isRequired); | ||
| 
     | 
||
| 
          
            
          
           | 
    ||
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
      
      Oops, something went wrong.
        
    
  
      
      Oops, something went wrong.
        
    
  
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.
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.
Not relevant for this change, but does this comparison work for derived types?
e.g.
MyFromKeyedServicesAttribute : FromKeyedServicesAttributeSee code a few lines above
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.
It won't, but
JsonIgnoreAttributeis sealed so there's not likely to be derived types.FromKeyedServicesis not.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.
So we should update the keyed service check in a separate PR
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.
Yep -- we want to probably do an audit across the repo for anywhere we type check on
FromKeyedServicesandFromServicessince both of those are unsealed.