Mark user component query parameter as required#18631
Draft
wolfkill wants to merge 1 commit into
Draft
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #18631 +/- ##
============================================
+ Coverage 64.40% 64.41% +0.01%
Complexity 1137 1137
============================================
Files 3337 3337
Lines 206069 206069
Branches 32128 32128
============================================
+ Hits 132710 132731 +21
+ Misses 62726 62703 -23
- Partials 10633 10635 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
yashmayya
reviewed
May 31, 2026
| @ApiOperation(value = "Get an user in cluster", notes = "Get an user in cluster") | ||
| public String getUser(@PathParam("username") String username, | ||
| @ApiParam(value = "CONTROLLER|SERVER|BROKER") @QueryParam("component") String componentTypeStr) { | ||
| @ApiParam(value = "CONTROLLER|SERVER|BROKER", required = true) @QueryParam("component") |
Contributor
There was a problem hiding this comment.
required = true on a JAX-RS @QueryParam is just Swagger doc metadata — it doesn't make the framework reject a missing component. So the underlying bug still reproduces: with no component, validateComponentType returns null and getUser NPEs on componentType.name(). #18606 adds the actual guard that returns a clean 400.
| public class PinotAccessControlUserRestletResourceSwaggerTest { | ||
|
|
||
| @Test | ||
| public void testUserComponentQueryParamIsRequired() |
Contributor
yashmayya
added
rest-api
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
componentquery parameter as required for get, delete, and update User API operationsWhy
The User API needs
componentto identify the component-specific user entry. Without this Swagger metadata, the UI can present the field as optional even though the request path requires it.Fixes #14594
Tests
JAVA_HOME=/opt/homebrew/opt/openjdk@21/libexec/openjdk.jdk/Contents/Home ./mvnw -pl pinot-controller -am -Dtest=PinotAccessControlUserRestletResourceSwaggerTest -Dsurefire.failIfNoSpecifiedTests=false testfailed before the annotation change withcomponent must be marked required on getUser expected [true] but found [false]JAVA_HOME=/opt/homebrew/opt/openjdk@21/libexec/openjdk.jdk/Contents/Home ./mvnw -pl pinot-controller -am -Dtest=PinotAccessControlUserRestletResourceSwaggerTest -Dsurefire.failIfNoSpecifiedTests=false testgit diff --check