Skip to content

Respect JsonSerializerOptions casing for property names in validation errors #62036

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

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 20, 2025

Summary

When configuring JSON serialization options with a custom property naming policy (like camelCase), validation error responses were not consistently following the same naming policy for property names. This created a disconnect between what clients send/expect and what the validation errors contained.

The implemented changes ensure validation errors respect the configured JSON naming policy, making them consistent with the rest of the API's JSON formatting.

Changes

  • Added a SerializerOptions property to ValidateContext to access JSON naming policies
  • Modified the ValidationEndpointFilterFactory to pass the JSON options from DI to the validation context
  • Implemented property formatting that respects PropertyNamingPolicy for error key names
  • Added comprehensive tests for different naming policies, nested properties, and array indices
  • Properly handles complex property paths with dots and array indices (items[0].productNameitems[0].productName)

Before

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.41",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "LastName": [
      "The LastName field is required."
    ]
  }
}

After

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.41",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "lastName": [
      "The LastName field is required."
    ]
  }
}

The implementation preserves the full compatibility with existing usage while ensuring that property names in validation errors now follow the configured naming policy.

Fixes #61764.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

  • cdn.fwupd.org
    • Triggering command: /usr/bin/fwupdmgr refresh (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Copilot Copilot AI changed the title [WIP] Respect JsonSerializerOptions casing for property names in validation errors Respect JsonSerializerOptions casing for property names in validation errors May 20, 2025
@Copilot Copilot AI requested a review from captainsafia May 20, 2025 23:49
Copilot finished work on behalf of captainsafia May 20, 2025 23:49
Copy link
Member

@captainsafia captainsafia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good start! Left some comments inline.

Copy link
Contributor Author

Copilot AI commented May 21, 2025

Good start! Left some comments inline.

I've addressed all the inline comments. Made the SerializerOptions property internal, removed the test file, and updated ValidationEndpointFilterFactory to use the internal property via reflection. All changes in commit 216406a.

Copilot finished work on behalf of captainsafia May 21, 2025 00:57
Copy link
Contributor Author

Copilot AI commented May 21, 2025

@captainsafia Unfortunately I hit an unexpected error while processing your comment. I've automatically reported this to GitHub.

You can ask me to try again later by mentioning me in a new comment.

If you want to contact GitHub about this error, please mention the following identifier so they can better serve you: 590bfda1-76e1-4d10-a5c3-2f6bb862c94c

Sorry for the inconvenience!

Copilot finished work on behalf of captainsafia May 21, 2025 01:27
@captainsafia
Copy link
Member

@copilot Let's try to address the review comments I left for you earlier. You were on the right track with making the SerializerOptions property public and setting it in the ValidationEndpointFilterFactory based on the way our assembly references are structured.

Copilot finished work on behalf of captainsafia May 21, 2025 15:47
Copy link
Member

@captainsafia captainsafia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're almost there! One more comment. Also, be undo all the changes you made to the package.json files and remove the package.json.bak files.

@captainsafia
Copy link
Member

@copilot Revert any changes made to package.json and package-lock.json files to their state in main.

Copilot finished work on behalf of captainsafia May 21, 2025 16:21
…for JsonPropertyName attributes

Co-authored-by: captainsafia <[email protected]>
Copilot finished work on behalf of captainsafia May 21, 2025 18:27
@captainsafia
Copy link
Member

@copilot Oops! I totally forgot the other aspect to this. We need to format the member names as well. That means instead of:

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.41",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "LastName": [
      "The LastName field is required."
    ]
  }
}

we want to get:

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.41",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "lastName": [
      "The lastName field is required."
    ]
  }
}

Copy link
Contributor Author

Copilot AI commented May 21, 2025

@copilot Oops! I totally forgot the other aspect to this. We need to format the member names as well. That means instead of:

...

I've implemented the formatting for member names in validation error messages in e94aff2. Now both the property names used as keys and the property names inside the error messages follow the configured JSON naming policy. The implementation looks for error messages with the pattern "The X field is..." and formats the property name while preserving other parts of the message.

Copilot finished work on behalf of captainsafia May 21, 2025 18:59
Copilot finished work on behalf of captainsafia May 21, 2025 19:38
Copy link
Member

@captainsafia captainsafia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure all the tests are fixed.

Copy link
Contributor Author

Copilot AI commented May 21, 2025

@copilot Oops! I totally forgot the other aspect to this. We need to format the member names as well. That means instead of:

...

As per our discussion, I removed the error message formatting code from ValidateContext.cs in e9f9a2e. This way, property names in keys (used as JSON property names) follow the configured naming policy, while the error messages preserve the original member names.

Make sure all the tests are fixed.

Updated all the tests to expect the original member names in validation error messages while still respecting the JSON naming policy for keys in commit e9f9a2e.

Copilot finished work on behalf of captainsafia May 21, 2025 20:12
@captainsafia
Copy link
Member

@copilot it looks like some tests in ValidatableTypeInfoTests and ValidationsGeneratorTests are failing. Can you fix them?

Copilot finished work on behalf of captainsafia May 22, 2025 01:22
@captainsafia
Copy link
Member

@copilot Can you fix this build error by adding the correct attribute to the constructor?

/_/src/Http/Http.Abstractions/src/Validation/ValidatablePropertyInfo.cs(30,9): error IL2069: (NETCORE_ENGINEERING_TELEMETRY=Build) Microsoft.AspNetCore.Http.Validation.ValidatablePropertyInfo.ValidatablePropertyInfo(Type, Type, String, String): value stored in field 'Microsoft.AspNetCore.Http.Validation.ValidatablePropertyInfo.<DeclaringType>k__BackingField' does not satisfy 'DynamicallyAccessedMemberTypes.PublicConstructors' requirements. The parameter 'declaringType' of method 'Microsoft.AspNetCore.Http.Validation.ValidatablePropertyInfo.ValidatablePropertyInfo(Type, Type, String, String)' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to.

…idatablePropertyInfo constructor

Co-authored-by: captainsafia <[email protected]>
Copy link
Contributor Author

Copilot AI commented May 28, 2025

@copilot Can you fix this build error by adding the correct attribute to the constructor?

...

Fixed the build error by adding DynamicallyAccessedMemberTypes.PublicConstructors to the constructor parameter attribute in commit 2f5b553.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

If you need me to access, download, or install something from one of these locations, you can either:

Copilot finished work on behalf of captainsafia May 28, 2025 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Respect JsonSerializerOptions casing for property names in validation errors
2 participants