fix: use status code returned from NewError when writing errors

[danielgtaylor]

This PR fixes a bug where huma.NewError might be used to modify an outgoing status code (e.g. turning a 422 into a 400 to match a legacy API contract or match company standards). Previously the updated status code was incorrectly ignored, making it impossible to update the response status code without a hacky solution like a middleware.

Fixes #561

Summary by CodeRabbit

• New Features

  • Enhanced error handling in the API to return a 400 status code for validation errors instead of 422, improving clarity for users.

• Tests

  • Introduced a new test to validate the updated error handling behavior for custom validation errors.

[coderabbitai]

Walkthrough

The pull request introduces changes to the WriteErr function in error.go, enhancing type safety by using the NewError function for error creation. Additionally, a new test function, TestCustomValidationErrorStatus, is added in huma_test.go to modify the HTTP status code for validation errors from 422 to 400. This ensures clearer communication of validation failures in the API response.

Changes

Files	Change Summary
error.go	Modified WriteErr function to use NewError for creating error instances, improving type safety and clarity.
huma_test.go	Added TestCustomValidationErrorStatus to change HTTP status code from 422 to 400 for validation errors in tests.

Assessment against linked issues

Objective	Addressed	Explanation
Change default HTTP Status Code on Validation Error (Issue #561)	✅

Possibly related PRs

• fix: automatically precompute schema validation messages #545: Modifies huma.go to enhance request body handling and schema validation, impacting error processing.
• fix: if err & response are nil, return default status #546: Introduces a new test case in huma_test.go that enhances error handling and aligns with changes in WriteErr.

Poem

In the code where errors dwell,
A rabbit hops, all is well.
With status changed from four-two-two,
To four hundred, clear and true.
Hooray for tests that help us see,
How validation sets us free! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2c56d8a and 2cff828.

Files selected for processing (2)

• error.go (1 hunks)
• huma_test.go (1 hunks)

Additional comments not posted (2)

error.go (1)

255-259: Approved: The changes improve error handling by correctly using the status code returned from NewError.

The modifications in this code segment enhance the error handling logic in the following ways:

• The err variable is now explicitly assigned using the NewError function, making it clear that a new error instance is being created with the provided status code, message, and error details.
• The status variable is updated based on the value returned from NewError, ensuring that any modifications made to the status code during error creation are correctly propagated to the response.

These changes improve code clarity and ensure that the correct status code is used throughout the error handling process.

huma_test.go (1)

2301-2325: LGTM!

The test function TestCustomValidationErrorStatus is well-structured and provides good coverage for the custom validation error status scenario. It correctly overrides huma.NewError to change the status code, posts an invalid request, asserts the expected error response, and cleans up after the test.

The test helps ensure that the huma.NewError override works as expected and the API returns the correct status code and error message when validation fails.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.78%. Comparing base (2c56d8a) to head (2cff828).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #581   +/-   ##
=======================================
  Coverage   92.78%   92.78%           
=======================================
  Files          22       22           
  Lines        3893     3894    +1     
=======================================
+ Hits         3612     3613    +1     
  Misses        236      236           
  Partials       45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.