5098 branch 12 update invalid block index and number (#7440)

* 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: Update with usage of RpcErrorType.INVALID_AUTH_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update with usage of RpcErrorType.INVALID_BLOB_COUNT Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update with usage of RpcErrorType.INVALID_BLOB_GAS_USED_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update with usage of RpcErrorType.INVALID_BLOCK_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update with usage of RpcErrorType.INVALID_BLOCK_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update with usage of RpcErrorType.INVALID_BLOCK_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update with usage of RpcErrorType.INVALID_BLOCK_COUNT_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken integration 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> * 5098: Include parameter index in INVALID_AUTH_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Include parameter index in INVALID_BLOCK_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Include parameter index in INVALID_BLOCK_COUNT_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken integration test Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Rename INVALID_AUTH_PARAMS to INVALID_PROPOSAL_PARAMS Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update INVALID_BLOCK_HASH_PARAMS locations Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken unit test Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update RpcErrorType.INVALID_BLOCK_INDEX Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Update RpcErrorType.INVALID_BLOCK_NUMBER Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken tests Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken test Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Apply spotless Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken tests Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken tests Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken tests Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Fix broken tests Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net> * 5098: Remove TODO by wrapping unexpected exception and rethrowing 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> Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
2026-01-09 23:38:08 -05:00 · 2024-08-13 15:38:20 +10:00
parent 50f8add052
commit c61cf0b5af
21 changed files with 108 additions and 42 deletions
--- a/consensus/clique/src/test/java/org/hyperledger/besu/consensus/clique/jsonrpc/methods/CliqueGetSignerMetricsTest.java
+++ b/consensus/clique/src/test/java/org/hyperledger/besu/consensus/clique/jsonrpc/methods/CliqueGetSignerMetricsTest.java
@@ -75,14 +75,14 @@ public class CliqueGetSignerMetricsTest {
  public void exceptionWhenInvalidStartBlockSupplied() {
    assertThatThrownBy(() -> method.response(requestWithParams("INVALID")))
        .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessageContaining("Invalid json rpc parameter at index 0");
+        .hasMessageContaining("Invalid start block parameter (index 0)");
  }

  @Test
  public void exceptionWhenInvalidEndBlockSupplied() {
    assertThatThrownBy(() -> method.response(requestWithParams("1", "INVALID")))
        .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessageContaining("Invalid json rpc parameter at index 1");
+        .hasMessageContaining("Invalid end block parameter (index 1)");
  }

  @Test
--- a/consensus/common/src/main/java/org/hyperledger/besu/consensus/common/jsonrpc/AbstractGetSignerMetricsMethod.java
+++ b/consensus/common/src/main/java/org/hyperledger/besu/consensus/common/jsonrpc/AbstractGetSignerMetricsMethod.java
@@ -18,6 +18,7 @@ import org.hyperledger.besu.consensus.common.BlockInterface;
 import org.hyperledger.besu.consensus.common.validator.ValidatorProvider;
 import org.hyperledger.besu.datatypes.Address;
 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.parameters.BlockParameter;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
@@ -66,17 +67,27 @@ public abstract class AbstractGetSignerMetricsMethod {
   */
  public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {

-    final Optional<BlockParameter> startBlockParameter =
-        requestContext.getOptionalParameter(0, BlockParameter.class);
-    final Optional<BlockParameter> endBlockParameter =
-        requestContext.getOptionalParameter(1, BlockParameter.class);
+    final Optional<BlockParameter> startBlockParameter;
+    try {
+      startBlockParameter = requestContext.getOptionalParameter(0, BlockParameter.class);
+    } catch (Exception e) { // TODO:replace with JsonRpcParameter.JsonRpcParameterException
+      throw new InvalidJsonRpcParameters(
+          "Invalid start block parameter (index 0)", RpcErrorType.INVALID_BLOCK_NUMBER_PARAMS, e);
+    }
+    final Optional<BlockParameter> endBlockParameter;
+    try {
+      endBlockParameter = requestContext.getOptionalParameter(1, BlockParameter.class);
+    } catch (Exception e) { // TODO:replace with JsonRpcParameter.JsonRpcParameterException
+      throw new InvalidJsonRpcParameters(
+          "Invalid end block parameter (index 1)", RpcErrorType.INVALID_BLOCK_NUMBER_PARAMS, e);
+    }

    final long fromBlockNumber = getFromBlockNumber(startBlockParameter);
    final long toBlockNumber = getEndBlockNumber(endBlockParameter);

    if (!isValidParameters(fromBlockNumber, toBlockNumber)) {
      return new JsonRpcErrorResponse(
-          requestContext.getRequest().getId(), RpcErrorType.INVALID_PARAMS);
+          requestContext.getRequest().getId(), RpcErrorType.INVALID_BLOCK_NUMBER_PARAMS);
    }

    final Map<Address, SignerMetricResult> proposersMap = new HashMap<>();
--- a/consensus/ibft/src/test/java/org/hyperledger/besu/consensus/ibft/jsonrpc/methods/IbftGetSignerMetricsTest.java
+++ b/consensus/ibft/src/test/java/org/hyperledger/besu/consensus/ibft/jsonrpc/methods/IbftGetSignerMetricsTest.java
@@ -75,14 +75,14 @@ public class IbftGetSignerMetricsTest {
  public void exceptionWhenInvalidStartBlockSupplied() {
    assertThatThrownBy(() -> method.response(requestWithParams("INVALID")))
        .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessageContaining("Invalid json rpc parameter at index 0");
+        .hasMessageContaining("Invalid start block parameter (index 0)");
  }

  @Test
  public void exceptionWhenInvalidEndBlockSupplied() {
    assertThatThrownBy(() -> method.response(requestWithParams("1", "INVALID")))
        .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessageContaining("Invalid json rpc parameter at index 1");
+        .hasMessageContaining("Invalid end block parameter (index 1)");
  }

  @Test
--- a/consensus/qbft/src/test/java/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftGetSignerMetricsTest.java
+++ b/consensus/qbft/src/test/java/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftGetSignerMetricsTest.java
@@ -75,14 +75,14 @@ public class QbftGetSignerMetricsTest {
  public void exceptionWhenInvalidStartBlockSupplied() {
    assertThatThrownBy(() -> method.response(requestWithParams("INVALID")))
        .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessageContaining("Invalid json rpc parameter at index 0");
+        .hasMessageContaining("Invalid start block parameter (index 0)");
  }

  @Test
  public void exceptionWhenInvalidEndBlockSupplied() {
    assertThatThrownBy(() -> method.response(requestWithParams("1", "INVALID")))
        .isInstanceOf(InvalidJsonRpcParameters.class)
-        .hasMessageContaining("Invalid json rpc parameter at index 1");
+        .hasMessageContaining("Invalid end block parameter (index 1)");
  }

  @Test