fix: automatically precompute schema validation messages

danielgtaylor commented 4 weeks ago

This fix makes it easier to use custom schemas by removing the need to manually call schema.PrecomputeMessages() before the server starts up.

Fixes #454.

Summary by CodeRabbit

New Features
- Enhanced request body handling and schema validation for improved reliability.
- Introduced a new test function to validate error reporting for custom schemas.
Bug Fixes
- Strengthened checks on input bodies to ensure proper validation before processing.
Tests
- Added a specific test scenario for validating API behavior with invalid input for custom schemas.
Documentation
- Improved clarity on how message precomputation is handled within schema validations.

coderabbitai[bot] commented 4 weeks ago

Walkthrough

The recent changes enhance the huma framework's handling of request bodies and schema validation. Key improvements include automatic precomputation of schema messages when custom schemas are used, ensuring more robust validation. New test cases bolster error reporting capabilities, ensuring that invalid input scenarios are adequately handled without manual intervention.

Changes

Files	Change Summary
huma.go, huma_test.go	Enhanced request body handling and schema validation. Added new test for custom schema errors.
schema.go	Updated `schemaFromType` to automatically call `PrecomputeMessages()` on custom schemas.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Huma
    participant SchemaProvider

    Client->>Huma: POST / with custom RequestBody
    Huma->>SchemaProvider: Get Schema
    SchemaProvider->>Huma: Return Schema
    Huma->>Schema: Call PrecomputeMessages()
    Schema-->>Huma: Precomputed Messages
    Huma->>Huma: Validate input against Schema
    Huma-->>Client: Return Response

Assessment against linked issues

Objective	Addressed	Explanation
Need to explicitly call `PrecomputeMessages()` (Issue #454)	✅
Ensure custom schemas validate correctly in tests	✅

🐰 In a field where schemas grow,
Precomputation helps us know,
With tests that catch the errors fast,
Our API thrives, robust and vast!
🥕✨

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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 4 weeks ago

Codecov Report

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

Project coverage is 92.76%. Comparing base (b13a422) to head (7be3b0c). Report is 2 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #545 +/- ## ========================================== + Coverage 92.75% 92.76% +0.01% ========================================== Files 22 22 Lines 3876 3883 +7 ========================================== + Hits 3595 3602 +7 Misses 236 236 Partials 45 45 ```

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

danielgtaylor / huma