fix: if err & response are nil, return default status

[danielgtaylor]

Handle a special case where a handler with a response body returns a nil error and response struct. This just returns the operation's default status code. This should not be a common case, but is friendlier behavior than having the code panic.

Fixes #544

Summary by CodeRabbit

• New Features

  • Enhanced error handling in the registration process, ensuring graceful management of cases with no output.

• Tests

  • Introduced a new test case to verify the behavior of the system when a nil response is returned, ensuring the application does not panic and defaults to the correct HTTP status.

[coderabbitai]

Walkthrough

The changes introduce a conditional check in the Register function to handle nil outputs more gracefully, preventing panics in the application. A new test case is added to ensure that when a handler returns both nil output and error, the system responds with a default HTTP status code without crashing. These improvements enhance error handling and increase the robustness of the API's control flow.

Changes

Files	Change Summary
huma.go, huma_test.go	Added a conditional check in Register to manage nil outputs and created a test case to validate that the API responds correctly without panicking when both output and error are nil.

Assessment against linked issues

Objective	Addressed	Explanation
Returning nil for both output struct and error does not panic (#544)	✅

Poem

🐰 In the meadow where code does play,
A handler learned to find its way.
With checks in place, no more fright,
Even nils can now take flight!
Robust and strong, the API beams,
As rabbits hop and chase their dreams! 🌼

---

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>.
  • 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 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.76%. Comparing base (912f02e) to head (fc4ed20).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #546   +/-   ##
=======================================
  Coverage   92.76%   92.76%           
=======================================
  Files          22       22           
  Lines        3883     3886    +3     
=======================================
+ Hits         3602     3605    +3     
  Misses        236      236           
  Partials       45       45           

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

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 912f02e and fc4ed20.

Files selected for processing (2)

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

Additional comments not posted (2)

huma.go (1)

1382-1387: Handle nil output and error gracefully.

The added conditional check ensures that when both the output and error are nil, the function sets the HTTP status to op.DefaultStatus and returns early. This prevents potential panics or unintended 500 errors, aligning with the PR objectives to enhance robustness.

huma_test.go (1)

1435-1457: Add test case for nil response and error.

The new test case "response-nil" ensures that when both the response and error are nil, the system returns the default status code (200) without panicking. This test effectively validates the changes made in the Register function to handle this edge case.