feat: case-insensitive field matching for JSON/CBOR

danielgtaylor commented 1 month ago

This PR updates the field validation to use case-insensitive matches when validating input objects. This is done because:

Go's JSON & CBOR unmarshalers use this behavior, preferring exact matches but falling back to case-insensitive ones.
Updating legacy services to Huma may require supporting clients which send different cases, and this makes it easier to switch to Huma.

Fixes #577.

Summary by CodeRabbit

New Features
- Introduced a global variable for controlling case sensitivity in field name validation, enhancing flexibility for clients with varying casing conventions.
- Added new test cases to validate case-insensitive property handling.
Bug Fixes
- Improved error handling for unexpected properties to support case-insensitive checks.
Tests
- Enhanced test structure to allow setup and teardown functions for more complex scenarios.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce a new global variable ValidateStrictCasing in validate.go, which controls case sensitivity during validation. The validation logic has been updated to allow case-insensitive checks for map keys when this variable is disabled. Additionally, the error handling for unexpected properties has been modified to support case-insensitive checks. In validate_test.go, the test structure has been enhanced to include setup and teardown functions, and new test cases have been added to validate case-insensitive handling.

Changes

File	Change Summary
validate.go	Introduced `ValidateStrictCasing` variable; modified validation logic for case-insensitive checks; updated error handling for unexpected properties.
validate_test.go	Enhanced test structure with `before` and `cleanup` fields; added new test cases for case-insensitive property handling; updated `TestValidate` logic.

Assessment against linked issues

Objective	Addressed	Explanation
Introduce case insensitivity for JSON tags (#577)	✅

Possibly related PRs

#611: Changes in validate_test.go related to schema transformations and validation logic are directly relevant to the modifications made in this PR, focusing on enhancing validation logic for case sensitivity.

Suggested reviewers

superstas

Poem

In the fields where data plays,
A rabbit hops through JSON ways.
With casing loose, it finds its way,
Validations bright, come what may!
Hooray for changes, let’s all cheer,
For every field, we hold so dear! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.90%. Comparing base (52482f3) to head (91ff308). Report is 2 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #629 +/- ## ========================================== + Coverage 92.88% 92.90% +0.02% ========================================== Files 22 22 Lines 4834 4848 +14 ========================================== + Hits 4490 4504 +14 Misses 299 299 Partials 45 45 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jc-fireball commented 1 month ago

Thanks for the change.

danielgtaylor / huma