Skip to content

[helix-rest] Surface validation reason in addVirtualTopologyGroup 400 response#199

Open
LZD-PratyushBhatt wants to merge 1 commit into
devfrom
lzd/surface-addvtg-error-reason
Open

[helix-rest] Surface validation reason in addVirtualTopologyGroup 400 response#199
LZD-PratyushBhatt wants to merge 1 commit into
devfrom
lzd/surface-addvtg-error-reason

Conversation

@LZD-PratyushBhatt

Copy link
Copy Markdown
Collaborator

The addVirtualTopologyGroup IllegalArgumentException handler in ClusterAccessor returned only the echoed payload and command name, so the actual precondition failure (for example "Number of virtual groups cannot be greater than the number of zones.") was visible only in the helix-rest server log. Callers such as ACM received an opaque "Illegal input ... for command addVirtualTopologyGroup" with no cause.

Append ex.getMessage() to the badRequest body so the reason travels on the wire, and add a test asserting the reason is present in the 400 body.

Issues

  • My PR addresses the following Helix issues and references them in the PR description:

(#200 - Link your issue number here: You can write "Fixes #XXX". Please use the proper keyword so that the issue gets closed automatically. See https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue
Any of the following keywords can be used: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved)

Description

  • Here are some details about my PR, including screenshots of any UI changes:

(Write a concise description including what, why, how)

Tests

  • The following tests are written for this issue:

(List the names of added unit/integration tests)

  • The following is the result of the "mvn test" command on the appropriate module:

(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)

Changes that Break Backward Compatibility (Optional)

  • My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:

(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)

Documentation (Optional)

  • In case of new functionality, my PR adds documentation in the following wiki page:

(Link the GitHub wiki you added)

Commits

  • My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Code Quality

  • My diff has been formatted using helix-style.xml
    (helix-style-intellij.xml if IntelliJ IDE is used)

… response

The addVirtualTopologyGroup IllegalArgumentException handler in ClusterAccessor
returned only the echoed payload and command name, so the actual precondition
failure (for example "Number of virtual groups cannot be greater than the number
of zones.") was visible only in the helix-rest server log. Callers such as ACM
received an opaque "Illegal input ... for command addVirtualTopologyGroup" with
no cause.

Append ex.getMessage() to the badRequest body so the reason travels on the wire,
and add a test asserting the reason is present in the 400 body.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant