5098 branch 2 update invalid accounts params (hyperledger#7402)

* 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: 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: 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> --------- Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> Signed-off-by: gconnect <agatevureglory@gmail.com>
gconnect · Aug 26, 2024 · f9c65c3 · f9c65c3
1 parent 7d60967
commit f9c65c3
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 10 deletions.
diff --git a/.../besu/ethereum/api/jsonrpc/internal/methods/permissioning/PermAddAccountsToAllowlist.java b/.../besu/ethereum/api/jsonrpc/internal/methods/permissioning/PermAddAccountsToAllowlist.java
@@ -16,6 +16,7 @@
 
 import org.hyperledger.besu.ethereum.api.jsonrpc.RpcMethod;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
@@ -44,7 +45,13 @@ public String getName() {
   @Override
   @SuppressWarnings("unchecked")
   public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
-    final List<String> accountsList = requestContext.getRequiredParameter(0, List.class);
+    final List<String> accountsList;
+    try {
+      accountsList = requestContext.getRequiredParameter(0, List.class);
+    } catch (Exception e) { // TODO:replace with JsonRpcParameter.JsonRpcParameterException
+      throw new InvalidJsonRpcParameters(
+          "Invalid accounts list parameter", RpcErrorType.INVALID_ACCOUNT_PARAMS, e);
+    }
 
     if (allowlistController.isPresent()) {
       final AllowlistOperationResult addResult =

diff --git a/.../ethereum/api/jsonrpc/internal/methods/permissioning/PermRemoveAccountsFromAllowlist.java b/.../ethereum/api/jsonrpc/internal/methods/permissioning/PermRemoveAccountsFromAllowlist.java
@@ -16,6 +16,7 @@
 
 import org.hyperledger.besu.ethereum.api.jsonrpc.RpcMethod;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
@@ -44,7 +45,14 @@ public String getName() {
   @Override
   @SuppressWarnings("unchecked")
   public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
-    final List<String> accountsList = requestContext.getRequiredParameter(0, List.class);
+    final List<String> accountsList;
+    try {
+      accountsList = requestContext.getRequiredParameter(0, List.class);
+    } catch (Exception e) { // TODO:replace with JsonRpcParameter.JsonRpcParameterException
+      throw new InvalidJsonRpcParameters(
+          "Invalid accounts list parameter", RpcErrorType.INVALID_ACCOUNT_PARAMS, e);
+    }
+
     if (allowlistController.isPresent()) {
       final AllowlistOperationResult removeResult =
           allowlistController.get().removeAccounts(accountsList);

diff --git a/...u/ethereum/api/jsonrpc/internal/methods/permissioning/PermAddAccountsToAllowlistTest.java b/...u/ethereum/api/jsonrpc/internal/methods/permissioning/PermAddAccountsToAllowlistTest.java
@@ -124,9 +124,8 @@ public void whenEmptyParamOnRequestShouldThrowInvalidJsonRpcException() {
 
     final Throwable thrown = catchThrowable(() -> method.response(request));
     assertThat(thrown)
-        .hasNoCause()
         .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessage("Missing required json rpc parameter at index 0");
+        .hasMessage("Invalid accounts list parameter");
   }
 
   private JsonRpcRequestContext request(final List<String> accounts) {

diff --git a/...u/ethereum/api/jsonrpc/internal/methods/permissioning/PermAddAccountsToWhitelistTest.java b/...u/ethereum/api/jsonrpc/internal/methods/permissioning/PermAddAccountsToWhitelistTest.java
@@ -125,9 +125,8 @@ public void whenEmptyParamOnRequestShouldThrowInvalidJsonRpcException() {
 
     final Throwable thrown = catchThrowable(() -> method.response(request));
     assertThat(thrown)
-        .hasNoCause()
         .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessage("Missing required json rpc parameter at index 0");
+        .hasMessage("Invalid accounts list parameter");
   }
 
   private JsonRpcRequestContext request(final List<String> accounts) {

diff --git a/...ereum/api/jsonrpc/internal/methods/permissioning/PermRemoveAccountsFromAllowlistTest.java b/...ereum/api/jsonrpc/internal/methods/permissioning/PermRemoveAccountsFromAllowlistTest.java
@@ -125,9 +125,8 @@ public void whenEmptyParamOnRequestShouldThrowInvalidJsonRpcException() {
 
     final Throwable thrown = catchThrowable(() -> method.response(request));
     assertThat(thrown)
-        .hasNoCause()
         .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessage("Missing required json rpc parameter at index 0");
+        .hasMessage("Invalid accounts list parameter");
   }
 
   private JsonRpcRequestContext request(final List<String> accounts) {

diff --git a/...ereum/api/jsonrpc/internal/methods/permissioning/PermRemoveAccountsFromWhitelistTest.java b/...ereum/api/jsonrpc/internal/methods/permissioning/PermRemoveAccountsFromWhitelistTest.java
@@ -126,9 +126,8 @@ public void whenEmptyParamOnRequestShouldThrowInvalidJsonRpcException() {
 
     final Throwable thrown = catchThrowable(() -> method.response(request));
     assertThat(thrown)
-        .hasNoCause()
         .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessage("Missing required json rpc parameter at index 0");
+        .hasMessage("Invalid accounts list parameter");
   }
 
   private JsonRpcRequestContext request(final List<String> accounts) {