Update GetGraffiti

Author: courtneyeh

validator/client/src/main/java/tech/pegasys/teku/validator/client/restapi/apis/GetGraffiti.java

@@ -16,7 +16,6 @@
 import static tech.pegasys.teku.ethereum.json.types.SharedApiTypes.PUBKEY_API_TYPE;
 import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_NOT_FOUND;
 import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_OK;
-import static tech.pegasys.teku.infrastructure.json.types.CoreTypes.STRING_TYPE;
 import static tech.pegasys.teku.validator.client.restapi.ValidatorRestApi.TAG_GRAFFITI;
 import static tech.pegasys.teku.validator.client.restapi.ValidatorTypes.PARAM_PUBKEY_TYPE;
 
@@ -25,29 +24,38 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.function.Function;
+import org.apache.tuweni.bytes.Bytes;
 import org.apache.tuweni.bytes.Bytes32;
 import tech.pegasys.teku.bls.BLSPublicKey;
+import tech.pegasys.teku.infrastructure.json.types.DeserializableTypeDefinition;
 import tech.pegasys.teku.infrastructure.json.types.SerializableTypeDefinition;
 import tech.pegasys.teku.infrastructure.restapi.endpoints.EndpointMetadata;
 import tech.pegasys.teku.infrastructure.restapi.endpoints.RestApiEndpoint;
 import tech.pegasys.teku.infrastructure.restapi.endpoints.RestApiRequest;
+import tech.pegasys.teku.validator.api.Bytes32Parser;
 import tech.pegasys.teku.validator.client.KeyManager;
 import tech.pegasys.teku.validator.client.Validator;
 
 public class GetGraffiti extends RestApiEndpoint {
-  public static final String ROUTE = "/eth/v1/validator/{pubkey}/graffiti";
+  static final String ROUTE = "/eth/v1/validator/{pubkey}/graffiti";
   private final KeyManager keyManager;
 
-  private static final SerializableTypeDefinition<GraffitiResponse> GRAFFITI_TYPE =
+  public static final DeserializableTypeDefinition<Bytes32> GRAFFITI_TYPE =
+      DeserializableTypeDefinition.string(Bytes32.class)
+          .formatter(GetGraffiti::processGraffitiString)
+          .parser(Bytes32Parser::toBytes32)
+          .build();
+
+  private static final SerializableTypeDefinition<GraffitiResponse> GRAFFITI_RESPONSE_TYPE =
       SerializableTypeDefinition.object(GraffitiResponse.class)
           .withOptionalField("pubkey", PUBKEY_API_TYPE, GraffitiResponse::getPublicKey)
-          .withField("graffiti", STRING_TYPE, GraffitiResponse::getGraffiti)
+          .withField("graffiti", GRAFFITI_TYPE, GraffitiResponse::getGraffiti)
           .build();
 
   private static final SerializableTypeDefinition<GraffitiResponse> RESPONSE_TYPE =
       SerializableTypeDefinition.object(GraffitiResponse.class)
           .name("GraffitiResponse")
-          .withField("data", GRAFFITI_TYPE, Function.identity())
+          .withField("data", GRAFFITI_RESPONSE_TYPE, Function.identity())
           .build();
 
   public GetGraffiti(final KeyManager keyManager) {
@@ -68,7 +76,7 @@ public GetGraffiti(final KeyManager keyManager) {
   }
 
   @Override
-  public void handleRequest(RestApiRequest request) throws JsonProcessingException {
+  public void handleRequest(final RestApiRequest request) throws JsonProcessingException {
     final BLSPublicKey publicKey = request.getPathParameter(PARAM_PUBKEY_TYPE);
 
     final Optional<Validator> maybeValidator = keyManager.getValidatorByPublicKey(publicKey);
@@ -77,20 +85,22 @@ public void handleRequest(RestApiRequest request) throws JsonProcessingException
       return;
     }
 
-    final String graffiti =
-        maybeValidator.get().getGraffiti().map(this::processGraffitiBytes).orElse("");
-    request.respondOk(new GraffitiResponse(publicKey, graffiti));
+    request.respondOk(new GraffitiResponse(publicKey, maybeValidator.get().getGraffiti()));
   }
 
-  private String processGraffitiBytes(final Bytes32 graffiti) {
+  private static String processGraffitiString(final Bytes32 graffiti) {
     return new String(graffiti.toArrayUnsafe(), StandardCharsets.UTF_8).strip().replace("\0", "");
   }
 
   static class GraffitiResponse {
     private final Optional<BLSPublicKey> publicKey;
-    private final String graffiti;
+    private final Bytes32 graffiti;
+
+    GraffitiResponse(final BLSPublicKey publicKey, final Optional<Bytes32> graffiti) {
+      this(publicKey, graffiti.orElse(Bytes32Parser.toBytes32(Bytes.EMPTY.toArray())));
+    }
 
-    GraffitiResponse(final BLSPublicKey publicKey, final String graffiti) {
+    GraffitiResponse(final BLSPublicKey publicKey, final Bytes32 graffiti) {
       this.publicKey = Optional.of(publicKey);
       this.graffiti = graffiti;
     }
@@ -99,19 +109,19 @@ Optional<BLSPublicKey> getPublicKey() {
       return publicKey;
     }
 
-    String getGraffiti() {
+    Bytes32 getGraffiti() {
       return graffiti;
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(final Object o) {
       if (this == o) {
         return true;
       }
       if (o == null || getClass() != o.getClass()) {
         return false;
       }
-      GraffitiResponse that = (GraffitiResponse) o;
+      final GraffitiResponse that = (GraffitiResponse) o;
       return Objects.equals(publicKey, that.publicKey) && Objects.equals(graffiti, that.graffiti);
     }
 

validator/client/src/test/java/tech/pegasys/teku/validator/client/restapi/apis/GetGraffitiTest.java

@@ -48,19 +48,20 @@ class GetGraffitiTest {
   private final GetGraffiti handler = new GetGraffiti(keyManager);
   private StubRestApiRequest request;
 
+  final String stringGraffiti = "Test graffiti";
+  final Bytes32 bytesGraffiti = Bytes32Parser.toBytes32(stringGraffiti);
+
   private final DataStructureUtil dataStructureUtil =
       new DataStructureUtil(TestSpecFactory.createDefault());
 
   @Test
   void shouldGetGraffiti() throws JsonProcessingException {
-    final String stringGraffiti = "Test graffiti";
-    final Bytes32 graffiti = Bytes32Parser.toBytes32(stringGraffiti);
-    checkGraffiti(() -> Optional.of(graffiti), stringGraffiti);
+    checkGraffiti(Optional.of(bytesGraffiti));
   }
 
   @Test
   void shouldGetEmptyGraffiti() throws JsonProcessingException {
-    checkGraffiti(Optional::empty, "");
+    checkGraffiti(Optional.empty());
   }
 
   @Test
@@ -82,7 +83,7 @@ void shouldHandleValidatorNotFound() throws IOException {
   @Test
   void metadata_shouldHandle200() throws JsonProcessingException {
     final GetGraffiti.GraffitiResponse response =
-        new GetGraffiti.GraffitiResponse(dataStructureUtil.randomPublicKey(), "Test graffiti");
+        new GetGraffiti.GraffitiResponse(dataStructureUtil.randomPublicKey(), bytesGraffiti);
     final String responseData = getResponseStringFromMetadata(handler, SC_OK, response);
     assertThat(responseData)
         .isEqualTo(
@@ -111,22 +112,22 @@ void metadata_shouldHandle500() throws JsonProcessingException {
     verifyMetadataErrorResponse(handler, SC_INTERNAL_SERVER_ERROR);
   }
 
-  private void checkGraffiti(final GraffitiProvider graffitiProvider, final String expectedGraffiti)
-      throws JsonProcessingException {
+  private void checkGraffiti(final Optional<Bytes32> graffiti) throws JsonProcessingException {
+    final GraffitiProvider provider = () -> graffiti;
     final BLSPublicKey publicKey = dataStructureUtil.randomPublicKey();
     request =
         StubRestApiRequest.builder()
             .metadata(handler.getMetadata())
             .pathParameter("pubkey", publicKey.toHexString())
             .build();
 
-    final Validator validator = new Validator(publicKey, NO_OP_SIGNER, graffitiProvider);
+    final Validator validator = new Validator(publicKey, NO_OP_SIGNER, provider);
     when(keyManager.getValidatorByPublicKey(eq(publicKey))).thenReturn(Optional.of(validator));
 
     handler.handleRequest(request);
 
     final GetGraffiti.GraffitiResponse expectedResponse =
-        new GetGraffiti.GraffitiResponse(publicKey, expectedGraffiti);
+        new GetGraffiti.GraffitiResponse(publicKey, graffiti);
     assertThat(request.getResponseCode()).isEqualTo(SC_OK);
     assertThat(request.getResponseBody()).isEqualTo(expectedResponse);
   }