5098 branch 4 update invalid address params #7405
Merged
Conversation
This file contains 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
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…ion, apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…ion, apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…-branch-2-update-invalid-accounts-params
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…' into 5098-branch-3-update-invalid-address-hash-params
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…-branch-2-update-invalid-accounts-params
…' into 5098-branch-3-update-invalid-address-hash-params
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…-branch-2-update-invalid-accounts-params
…' into 5098-branch-3-update-invalid-address-hash-params
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…ounts-params' into 5098-branch-2-update-invalid-accounts-params
…' into 5098-branch-3-update-invalid-address-hash-params
…rams' into 5098-branch-4-update-invalid-address-params
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…' into 5098-branch-3-update-invalid-address-hash-params
…rams' into 5098-branch-4-update-invalid-address-params
…rams' into 5098-branch-4-update-invalid-address-params
siladu
reviewed
Jul 31, 2024
...nsus/clique/src/main/java/org/hyperledger/besu/consensus/clique/jsonrpc/methods/Discard.java
Show resolved
Hide resolved
| address = requestContext.getRequiredParameter(0, Address.class); | ||
| } catch (Exception e) { // TODO:replace with JsonRpcParameter.JsonRpcParameterException | ||
| throw new InvalidJsonRpcParameters( | ||
| "Invalid address parameter", RpcErrorType.INVALID_ADDRESS_PARAMS, e); |
There was a problem hiding this comment.
IIUC, there's two messages related to this error:
- The string here: "Invalid address parameter"
- The one hardcoded against INVALID_ADDESS_PARAMS (added the previous PR):
"Invalid address params"
Why do we need both and is there a reason we need all the extra RpcErrorTypes versus dynamically passing the string here?
There was a problem hiding this comment.
There are times when the message can add some extra context, but for the most part it's redundant.
There was a problem hiding this comment.
So how does this work, does one override the other or does it respond with both?
Have you got an example where the message gives extra context?
There was a problem hiding this comment.
To be honest, I don't really know the full context of how each message is used and where.
There was a problem hiding this comment.
Updating for completeness...we figured out that this error message is displaying in a DEBUG log stack, whereas the one attached to INVALID_ADDRESS_PARAMS is what the user actually sees. At least in the example tested.
| @@ -121,7 +121,7 @@ public void discardWithoutAddress() { | |||
| final Discard discard = new Discard(validatorProvider); | |||
|
|
|||
| assertThatThrownBy(() -> discard.response(requestWithParams())) | |||
| .hasMessage("Missing required json rpc parameter at index 0") | |||
| .hasMessage("Invalid address parameter") | |||
There was a problem hiding this comment.
Wondering if also knowing the parameter index could be useful for users in any of these RPC error? e.g. if you have multiple parameters with values that either are or could look like an Address (i.e. a hash)
There was a problem hiding this comment.
Hmm, could be useful yeah. I'll update for this PR and we can assess whether we want to apply it across all of the PRs
There was a problem hiding this comment.
@siladu Feel free to take another look now that I've updated the exception messages. Do you think we should apply this across the board?
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…dJsonRpcParameters Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
gconnect
pushed a commit
to gconnect/besu
that referenced
this pull request
Aug 26, 2024
* 5098: Add RpcErrorTypes Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Modify InvalidJsonRpcParameters and InvalidJsonRpcRequestException, apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Modify InvalidJsonRpcParameters and InvalidJsonRpcRequestException, apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Add JsonRpcParameterException for later use Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update locations for RpcErrorType.INVALID_ACCOUNTS_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Address review comments, apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update with changes from branch 1 Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update code to use RpcErrorType.INVALID_ADDRESS_HASH_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update plugin-api gradle hash Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Add comment on INVALID_PARAMS_ERROR_CODE Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Apply spotless on latest changes Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update code to use RpcErrorType.INVALID_ADDRESS_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken unit test Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken unit test Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Add index to exception messages Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: apoply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update BaseJsonRpcProcessor to utilise RpcErrorType from InvalidJsonRpcParameters Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> --------- Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: gconnect <agatevureglory@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR description
Update code to use RpcErrorType.INVALID_ADDRESS_PARAMS
Fixed Issue(s)
#5098