fix: panic - allow for parameters to be subtype of string #592

hlavavit · 2024-09-30T13:39:00Z

Huma panics when query param is slice of string subtypes

for example

results in panic

reflect.Set: value of type []string is not assignable to type []enum.DeviceEvent
goroutine 35 [running]:
net/http.(*conn).serve.func1()
	C:/Software/go/go1.22.5/src/net/http/server.go:1903 +0x13f
panic({0x125ba40?, 0xc00046e440?})
	C:/Software/go/go1.22.5/src/runtime/panic.go:770 +0x136
reflect.Value.assignTo({0x124da20, 0xc0005101f8, 0x97}, {0x1375748, 0xb}, 0x124a5a0, 0x0)
	C:/Software/go/go1.22.5/src/reflect/value.go:3356 +0x4b1
reflect.Value.Set({0x124a5a0, 0xc00050c998, 0x197}, {0x124da20, 0xc0005101f8, 0x97})
	C:/Software/go/go1.22.5/src/reflect/value.go:2325 +0xcf
github.com/danielgtaylor/huma/v2.Register[...].func1.2(0xc0002c3420)
	C:/Users/hlavacekv/go/pkg/mod/github.com/danielgtaylor/huma/v2@v2.23.0/huma.go:953 +0x2bbb

This pullrequest is a fix to that. First time i used golang reflection so feel free to clean it up a bit.

Summary by CodeRabbit

New Features
- Enhanced API parameter handling for complex data types and multipart requests.
- Introduced a new custom type for testing, improving test coverage for middleware and parameter scenarios.
Bug Fixes
- Improved error handling and validation for request bodies and parameters, ensuring more robust API responses.
Tests
- Expanded test cases to include new scenarios for cookies, multipart uploads, and nested resolvers, enhancing overall test coverage and clarity.

coderabbitai · 2024-09-30T13:39:08Z

Walkthrough

The changes in this pull request enhance the huma.go and huma_test.go files, focusing on improving parameter parsing, response generation, and error handling within the API framework. Modifications include support for slice types of string subtypes in the Every method, refined input body validation in the Register function, and expanded test cases for middleware and parameter handling. The updates aim to improve the robustness and flexibility of the API, particularly in handling complex data types and multipart requests.

Changes

Files	Change Summary
`huma.go`	Enhanced parameter parsing and response generation, added support for slice types in the `Every` method, improved validation and error handling in the `Register` function.
`huma_test.go`	Introduced `CustomStringParam` for testing, expanded middleware test cases, refined request body handling, and improved error handling across various test scenarios.

Possibly related PRs

fix: unsupported param type url.URL #584: The changes in this PR also modify the Register function in huma.go, enhancing its ability to handle specific parameter types, which aligns with the main PR's updates to the same function for improved parameter parsing and validation.

Suggested reviewers

danielgtaylor

Poem

In the code where rabbits play,
New features hop in bright array.
With strings and slices, oh what fun!
Validations shine like the sun.
Let's celebrate this joyful spree,
Hooray for changes, one, two, three! 🐇✨

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

🪧 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.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8313d66 and 420c69f.

📒 Files selected for processing (2)

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

🔇 Additional comments (5)

huma_test.go (5)

72-73: Definition of new type CustomStringParam

The new type CustomStringParam defined as an alias for string is appropriately declared. This allows for custom handling or validation of string parameters if needed.

350-369: Addition of CustomStringParam to query parameters

The query parameters QueryCustomString and QueryCustomStrings are correctly added to the input struct using the new type CustomStringParam and its slice []CustomStringParam. The struct tags are appropriately specified for proper query binding.

388-388: Assertion of QueryCustomString value

The assertion correctly verifies that input.QueryCustomString matches the expected value of CustomStringParam("bar").

397-397: Assertion of QueryCustomStrings values

The assertion accurately checks that input.QueryCustomStrings contains the expected slice []CustomStringParam{"foo", "bar"}.

425-425: Update test URL to include new query parameters

The test URL is properly updated to include the customString and customStrings query parameters with appropriate values, ensuring that these parameters are correctly parsed and tested.

huma.go

hlavavit · 2024-09-30T15:13:34Z

Bot saved me wrong merge removed that one line i next commit

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a7244da and 3252a7a.

📒 Files selected for processing (2)

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

🔇 Additional comments (5)

huma_test.go (5)

72-73: Definition of CustomStringParam is appropriate

The new type CustomStringParam defined as string is suitable for testing custom parameter types.

350-369: New custom query parameters using CustomStringParam are correctly added

The QueryCustomString and QueryCustomStrings parameters are appropriately defined using the CustomStringParam type and added to the test input struct, effectively testing custom parameter handling.

388-388: Assertion of CustomStringParam value is correct

The assertion correctly compares input.QueryCustomString with CustomStringParam("bar"), ensuring proper handling of custom string parameters.

397-397: Assertion of []CustomStringParam values is correct

The assertion correctly compares input.QueryCustomStrings with []CustomStringParam{"foo", "bar"}, ensuring proper handling of slices of custom string parameters.

425-425: Test URL includes new custom query parameters

The test URL correctly includes customString and customStrings query parameters, facilitating proper testing of custom string parameter handling.

huma.go

codecov · 2024-09-30T20:10:02Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.81%. Comparing base (8313d66) to head (3252a7a).
Report is 10 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #592      +/-   ##
==========================================
+ Coverage   92.80%   92.81%   +0.01%     
==========================================
  Files          22       22              
  Lines        3903     3911       +8     
==========================================
+ Hits         3622     3630       +8     
  Misses        236      236              
  Partials       45       45

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

hlavavit changed the title ~~fix: allow for parameters to be subtype of string~~ fix: panic - allow for parameters to be subtype of string Sep 30, 2024

coderabbitai bot reviewed Sep 30, 2024

View reviewed changes

huma.go Show resolved Hide resolved

fix: allow for parameters to be subtype of string

3252a7a

hlavavit force-pushed the fix/paniconcustomtype branch from a7244da to 3252a7a Compare September 30, 2024 15:22

coderabbitai bot reviewed Sep 30, 2024

View reviewed changes

huma.go Show resolved Hide resolved

danielgtaylor approved these changes Oct 4, 2024

View reviewed changes

danielgtaylor merged commit 0fcf21d into danielgtaylor:main Oct 4, 2024
5 checks passed

This was referenced Oct 9, 2024

fix: marshal empty security object #603

Merged

fix: recompute property names after schema transform #611

Merged

coderabbitai bot mentioned this pull request Oct 26, 2024

fix: set defaults during validation to prevent override zero values #628

Closed

This was referenced Nov 6, 2024

refactor: use WriteErr function for handling error returned by handler #640

Merged

fix: marking visited types in findInType #641

Merged

coderabbitai bot mentioned this pull request Nov 20, 2024

Exclude embedded fields in response header docs #656

Merged

coderabbitai bot mentioned this pull request Nov 27, 2024

Chi is a dep even for pure go implementations, refactor its usage in the main package to pure go. #661

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: panic - allow for parameters to be subtype of string #592

fix: panic - allow for parameters to be subtype of string #592

Uh oh!

hlavavit commented Sep 30, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 30, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

hlavavit commented Sep 30, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

codecov bot commented Sep 30, 2024 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

fix: panic - allow for parameters to be subtype of string #592

fix: panic - allow for parameters to be subtype of string #592

Uh oh!

Conversation

hlavavit commented Sep 30, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hlavavit commented Sep 30, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Sep 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hlavavit commented Sep 30, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 30, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Sep 30, 2024 •

edited

Loading