Implement exploded query parameters #498
Conversation
Allow query parameters such as /foo?bar=baz&bar=qux rather than requiring multiple values to be comma separated. This has worse performance than comma seprated so is not enabled by default and requires adding the `explode` tag to the query parameter. Signed-off-by: Chris Marchbanks <[email protected]>
WalkthroughThe changes introduce the ability to handle multiple query parameters with the same name using the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Server
participant Huma
Client->>Server: GET /path?foo=bar&foo=baz
Server->>Huma: Parse query parameters
Huma->>Server: Parsed parameters {foo: ["bar", "baz"]}
Server->>Client: Response
Assessment against linked issues
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- docs/docs/features/request-inputs.md (1 hunks)
- huma.go (13 hunks)
- huma_test.go (2 hunks)
Additional comments not posted (6)
docs/docs/features/request-inputs.md (1)
36-36: LGTM!The documentation explains the
explodetag for query parameters clearly.huma.go (2)
105-105: LGTM!The addition of the
Explodefield to theparamFieldInfostruct is straightforward and aligns with the new feature.
140-146: LGTM!The parsing logic for query parameters correctly accommodates the
explodetag.huma_test.go (3)
370-370: Ensure proper field tagging.The new field
QueryExplodedis correctly tagged withquery:"exploded,explode".
405-405: Validate assert statement.The assertion
assert.Equal(t, []string{"foo", "bar"}, input.QueryExploded)correctly tests the functionality of theexplodetag.
416-416: Ensure test URL correctness.The test URL includes the
explodedquery parameters correctly:exploded=foo&exploded=bar.
There was a problem hiding this comment.
Looks really clean in there. I left a minor suggestion inline. I was trying to come up with alternative names for Explode, but didn't come up with anything better. The name works, but could maybe be more specific. Thanks for tackling this issue. It will help me get through a blocker.
| nope := false | ||
| explode = &nope | ||
| // easier if we use comma-separated values, so we disable explode by default. | ||
| if slicesContains(split[1:], "explode") { |
There was a problem hiding this comment.
Consider using the built in slices package: https://pkg.go.dev/slices#Contains
There was a problem hiding this comment.
This is to support Go 1.20 FYI. Once Go 1.23 is released I will probably make the minimum required version 1.21 and we can start using the slices package.
Thinking about this some more over the weekend, maybe |
That could work. I know it's a bit verbose, but "Support Multiples" is potentially more specific. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #498 +/- ##
==========================================
- Coverage 92.85% 92.84% -0.01%
==========================================
Files 22 22
Lines 3791 3787 -4
==========================================
- Hits 3520 3516 -4
Misses 227 227
Partials 44 44 ☔ View full report in Codecov by Sentry. |
Allow query parameters such as /foo?bar=baz&bar=qux rather than requiring multiple values to be comma separated. This has worse performance than comma seprated so is not enabled by default and requires adding the
explodetag to the query parameter.Closes: #452
Summary by CodeRabbit
explodetag in URI query strings, offering an alternative to comma-separated lists for multiple values.explodefeature.