Update syncing status requirements in getHealth (Consensys#8143)

Author: courtneyeh

Diff for: data/beaconrestapi/src/integration-test/resources/tech/pegasys/teku/beaconrestapi/beacon/paths/_eth_v1_node_health.json

@@ -26,7 +26,7 @@
         "content" : { }
       },
       "400" : {
-        "description" : "The request could not be processed, check the response for more information.",
+        "description" : "Invalid syncing status code",
         "content" : {
           "application/json" : {
             "schema" : {

Diff for: data/beaconrestapi/src/main/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetHealth.java

@@ -22,11 +22,13 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import io.javalin.http.Header;
+import java.util.Optional;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import tech.pegasys.teku.api.ChainDataProvider;
 import tech.pegasys.teku.api.DataProvider;
 import tech.pegasys.teku.api.SyncDataProvider;
+import tech.pegasys.teku.api.exceptions.BadRequestException;
 import tech.pegasys.teku.infrastructure.restapi.endpoints.EndpointMetadata;
 import tech.pegasys.teku.infrastructure.restapi.endpoints.RestApiEndpoint;
 import tech.pegasys.teku.infrastructure.restapi.endpoints.RestApiRequest;
@@ -53,6 +55,7 @@ public GetHealth(final DataProvider provider) {
             .response(SC_OK, "Node is ready")
             .response(SC_PARTIAL_CONTENT, "Node is syncing but can serve incomplete data")
             .response(SC_SERVICE_UNAVAILABLE, "Node not initialized or having issues")
+            .withBadRequestResponse(Optional.of("Invalid syncing status code"))
             .build());
     this.syncProvider = syncProvider;
     this.chainDataProvider = chainDataProvider;
@@ -72,7 +75,13 @@ public void handleRequest(RestApiRequest request) throws JsonProcessingException
 
   private int getResponseCodeFromQueryParams(final RestApiRequest request) {
     try {
-      return request.getOptionalQueryParameter(SYNCING_PARAMETER).orElse(SC_PARTIAL_CONTENT);
+      final int responseCode =
+          request.getOptionalQueryParameter(SYNCING_PARAMETER).orElse(SC_PARTIAL_CONTENT);
+      if (responseCode < 100 || responseCode > 599) {
+        throw new BadRequestException("Invalid syncing status code");
+      } else {
+        return responseCode;
+      }
     } catch (IllegalArgumentException ex) {
       LOG.trace("Illegal parameter in GetHealth", ex);
     }

Diff for: data/beaconrestapi/src/test/java/tech/pegasys/teku/beaconrestapi/handlers/v1/node/GetHealthTest.java

@@ -15,6 +15,7 @@
 
 import static jakarta.servlet.http.HttpServletResponse.SC_CONTINUE;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.mockito.Mockito.when;
 import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_BAD_REQUEST;
 import static tech.pegasys.teku.infrastructure.http.HttpStatusCodes.SC_INTERNAL_SERVER_ERROR;
@@ -28,6 +29,9 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+import tech.pegasys.teku.api.exceptions.BadRequestException;
 import tech.pegasys.teku.beacon.sync.events.SyncState;
 import tech.pegasys.teku.beaconrestapi.AbstractMigratedBeaconHandlerTest;
 
@@ -111,6 +115,18 @@ public void shouldReturnUnavailableWhenStoreNotAvailable() throws Exception {
     assertThat(request.getResponseCode()).isEqualTo(SC_SERVICE_UNAVAILABLE);
   }
 
+  @ParameterizedTest(name = "syncingStatus: {0}")
+  @ValueSource(ints = {98, 600})
+  public void shouldThrowBadRequestWhenInvalidSyncingStatusOutsideBounds(final int syncingStatus) {
+    when(chainDataProvider.isStoreAvailable()).thenReturn(true);
+    when(syncService.getCurrentSyncState()).thenReturn(SyncState.SYNCING);
+    request.setOptionalQueryParameter(SYNCING_STATUS, String.valueOf(syncingStatus));
+
+    assertThatThrownBy(() -> handler.handleRequest(request))
+        .isInstanceOf(BadRequestException.class)
+        .hasMessageContaining("Invalid syncing status code");
+  }
+
   @Test
   void metadata_shouldHandle400() throws JsonProcessingException {
     verifyMetadataErrorResponse(handler, SC_BAD_REQUEST);