Upgraded to use javalin 6 (Consensys#8003)

* Upgraded to use javalin 6

fixes Consensys#7982

Author: rolfyone

CHANGELOG.md

@@ -13,5 +13,6 @@ the [releases page](https://github.com/Consensys/teku/releases).
 
 ### Additions and Improvements
 - Improve block rewards calculation performance for `/eth/v3/validator/blocks/{slot}` block production beacon node API.
+- Updated Javalin to v.6 (used by rest-api and keymanager-api).
 
 ### Bug Fixes

data/beaconrestapi/src/test/java/tech/pegasys/teku/beaconrestapi/handlers/v1/events/StubContext.java

@@ -13,16 +13,22 @@
 
 package tech.pegasys.teku.beaconrestapi.handlers.v1.events;
 
+import io.javalin.config.Key;
 import io.javalin.http.Context;
 import io.javalin.http.HandlerType;
 import io.javalin.http.HttpStatus;
+import io.javalin.json.JsonMapper;
+import io.javalin.plugin.ContextPlugin;
+import io.javalin.security.RouteRole;
 import jakarta.servlet.ServletOutputStream;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
 import java.io.InputStream;
 import java.util.Map;
+import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Supplier;
+import java.util.stream.Stream;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -36,12 +42,6 @@ public StubContext(final HttpServletRequest req, final HttpServletResponse res)
     this.res = res;
   }
 
-  @Override
-  @SuppressWarnings("TypeParameterUnusedInFormals")
-  public <T> T appAttribute(@NotNull final String s) {
-    return null;
-  }
-
   @NotNull
   @Override
   public String endpointHandlerPath() {
@@ -107,4 +107,41 @@ public Context result(@NotNull final InputStream inputStream) {
   public InputStream resultInputStream() {
     return null;
   }
+
+  @Override
+  public <T> T appData(@NotNull Key<T> key) {
+    return null;
+  }
+
+  @NotNull
+  @Override
+  public JsonMapper jsonMapper() {
+    return null;
+  }
+
+  @NotNull
+  @Override
+  public Context minSizeForCompression(int i) {
+    return null;
+  }
+
+  @NotNull
+  @Override
+  public Set<RouteRole> routeRoles() {
+    return null;
+  }
+
+  @NotNull
+  @Override
+  public Context skipRemainingHandlers() {
+    return null;
+  }
+
+  @Override
+  public <T> T with(@NotNull Class<? extends ContextPlugin<?, T>> aClass) {
+    return null;
+  }
+
+  @Override
+  public void writeJsonStream(@NotNull Stream<?> stream) {}
 }

gradle/versions.gradle

@@ -27,8 +27,8 @@ dependencyManagement {
 
     dependency 'info.picocli:picocli:4.7.5'
 
-    dependency 'io.javalin:javalin:5.6.3'
-    dependency 'io.javalin:javalin-rendering:5.6.2'
+    dependency 'io.javalin:javalin:6.1.0'
+    dependency 'io.javalin:javalin-rendering:6.1.0'
 
     dependency 'io.libp2p:jvm-libp2p:1.1.0-RELEASE'
     dependency 'tech.pegasys:jblst:0.3.11'

infrastructure/restapi/src/main/java/tech/pegasys/teku/infrastructure/restapi/AuthorizationManager.java infrastructure/restapi/src/main/java/tech/pegasys/teku/infrastructure/restapi/AuthorizationHandler.java

@@ -17,26 +17,23 @@
 
 import io.javalin.http.Context;
 import io.javalin.http.Handler;
-import io.javalin.security.AccessManager;
-import io.javalin.security.RouteRole;
 import java.io.File;
 import java.io.IOException;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.Set;
 import java.util.stream.Stream;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import tech.pegasys.teku.infrastructure.exceptions.InvalidConfigurationException;
 
-public class AuthorizationManager implements AccessManager {
+public class AuthorizationHandler implements Handler {
   private static final Logger LOG = LogManager.getLogger();
   private static final String BEARER_PREFIX = "Bearer ";
   private final String bearer;
 
-  public AuthorizationManager(final Path path) {
+  public AuthorizationHandler(final Path path) {
     bearer = readPasswordFile(path);
   }
 
@@ -88,13 +85,12 @@ private void unauthorized(final Context ctx, final String message) {
     LOG.debug(message);
     ctx.json("{\n  \"status\": 401, \n \"message\":\"Unauthorized\"\n}");
     ctx.status(SC_UNAUTHORIZED);
+    ctx.skipRemainingHandlers();
   }
 
   @Override
-  public void manage(final Handler handler, final Context ctx, final Set<? extends RouteRole> set)
-      throws Exception {
-    if (ctx.matchedPath().equals("/swagger-docs")) {
-      handler.handle(ctx);
+  public void handle(final Context ctx) throws Exception {
+    if (ctx.path().startsWith("/swagger-") || ctx.path().startsWith("/webjars")) {
       return;
     }
 
@@ -108,11 +104,9 @@ public void manage(final Handler handler, final Context ctx, final Set<? extends
       unauthorized(ctx, "API Reject - authorization bearer missing from request header");
       return;
     }
+
     if (!auth.substring(BEARER_PREFIX.length()).equals(bearer)) {
       unauthorized(ctx, "API Reject - Unauthorized");
-      return;
     }
-
-    handler.handle(ctx);
   }
 }

infrastructure/restapi/src/main/java/tech/pegasys/teku/infrastructure/restapi/RestApi.java

@@ -64,7 +64,7 @@ protected SafeFuture<?> doStart() {
         // throwing it here will terminate the process effectively.
         LOG.error("Failed to start Rest API", e);
         throw e;
-      } else if (app.jettyServer() == null || !app.jettyServer().started) {
+      } else if (app.jettyServer() == null || !app.jettyServer().started()) {
         // failing to create the jetty server or start the jetty server is fatal.
         throw new IllegalStateException("Rest API failed to start", e);
       } else {
@@ -95,7 +95,7 @@ private void checkAccessFile(final Path path) {
         throw new IllegalStateException("Failed to initialise access file for validator-api.");
       }
     }
-    app.updateConfig(config -> config.accessManager(new AuthorizationManager(path)));
+    app.beforeMatched(new AuthorizationHandler(path));
   }
 
   @Override

infrastructure/restapi/src/main/java/tech/pegasys/teku/infrastructure/restapi/RestApiBuilder.java

@@ -20,6 +20,7 @@
 import static tech.pegasys.teku.infrastructure.json.types.CoreTypes.HTTP_ERROR_RESPONSE_TYPE;
 
 import io.javalin.Javalin;
+import io.javalin.compression.CompressionStrategy;
 import io.javalin.config.JavalinConfig;
 import io.javalin.plugin.bundled.CorsPluginConfig;
 import io.javalin.util.JavalinLogger;
@@ -131,14 +132,15 @@ public RestApi build() {
             config -> {
               config.http.defaultContentType = "application/json";
               config.showJavalinBanner = false;
-              config.compression.gzipOnly();
               // Work around a bug in Javalin where it decides whether to compress on each call to
               // write which could result in a mix of compressed and uncompressed content
               // and means it doesn't evaluate the length of the response correctly.
-              config.pvt.compressionStrategy.setMinSizeForCompression(0);
+              CompressionStrategy strategy = CompressionStrategy.GZIP;
+              strategy.setDefaultMinSizeForCompression(0);
+              config.http.customCompression(strategy);
               configureCors(config);
               swaggerBuilder.configureUI(config);
-              config.jetty.server(this::createJettyServer);
+              config.jetty.modifyServer(this::modifyJettyServer);
             });
 
     if (!hostAllowlist.isEmpty()) {
@@ -182,16 +184,15 @@ private void addExceptionHandler(
   private void configureCors(final JavalinConfig config) {
     if (!corsAllowedOrigins.isEmpty()) {
       if (corsAllowedOrigins.contains("*")) {
-        config.plugins.enableCors(cors -> cors.add(CorsPluginConfig::anyHost));
+        config.bundledPlugins.enableCors(cors -> cors.addRule(CorsPluginConfig.CorsRule::anyHost));
       } else {
-        config.plugins.enableCors(
-            cors -> corsAllowedOrigins.forEach(origin -> cors.add(it -> it.allowHost(origin))));
+        config.bundledPlugins.enableCors(
+            cors -> corsAllowedOrigins.forEach(origin -> cors.addRule(it -> it.allowHost(origin))));
       }
     }
   }
 
-  private Server createJettyServer() {
-    final Server server = new Server();
+  private void modifyJettyServer(final Server server) {
     final ServerConnector connector;
     if (maybeKeystorePath.isPresent()) {
       connector = new ServerConnector(server, getSslContextFactory());
@@ -201,7 +202,6 @@ private Server createJettyServer() {
     connector.setPort(port);
     connector.setHost(listenAddress);
     server.setConnectors(new Connector[] {connector});
-
     maxUrlLength.ifPresent(
         maxLength -> {
           LOG.debug("Setting Max URL length to {}", maxLength);
@@ -215,7 +215,6 @@ private Server createJettyServer() {
           }
         });
     JavalinLogger.startupInfo = false;
-    return server;
   }
 
   private SslContextFactory.Server getSslContextFactory() {

infrastructure/restapi/src/main/java/tech/pegasys/teku/infrastructure/restapi/SwaggerUIBuilder.java

@@ -17,10 +17,15 @@
 import io.javalin.config.JavalinConfig;
 import io.javalin.http.Handler;
 import io.javalin.http.staticfiles.Location;
+import io.javalin.rendering.template.JavalinThymeleaf;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
+import org.thymeleaf.TemplateEngine;
+import org.thymeleaf.templatemode.TemplateMode;
+import org.thymeleaf.templateresolver.ClassLoaderTemplateResolver;
+import org.thymeleaf.templateresolver.ITemplateResolver;
 import tech.pegasys.teku.infrastructure.restapi.openapi.OpenApiDocBuilder;
 
 public class SwaggerUIBuilder {
@@ -41,7 +46,7 @@ public class SwaggerUIBuilder {
 
   private static final Handler INDEX =
       (ctx) -> {
-        Map<String, Object> model = new HashMap<>();
+        final Map<String, Object> model = new HashMap<>();
         model.put("title", "Teku REST API");
         model.put("basePath", SWAGGER_HOSTED_PATH);
         ctx.render("index.html", model);
@@ -71,7 +76,8 @@ public void configureUI(final JavalinConfig config) {
         SWAGGER_HOSTED_PATH + SWAGGER_INITIALIZER_JS,
         SWAGGER_UI_PATCHED + SWAGGER_INITIALIZER_JS,
         Location.CLASSPATH);
-    ThymeleafConfigurator.enableThymeleafTemplates(SWAGGER_UI_PATCHED + "/");
+    config.fileRenderer(createThymeleafRenderer(SWAGGER_UI_PATCHED + "/"));
+
     config.spaRoot.addHandler(SWAGGER_UI_PATH, INDEX);
   }
 
@@ -84,4 +90,20 @@ public Optional<String> configureDocs(
     app.get(SWAGGER_DOCS_PATH, ctx -> ctx.json(apiDocs));
     return Optional.of(apiDocs);
   }
+
+  private JavalinThymeleaf createThymeleafRenderer(final String templatePath) {
+    final TemplateEngine templateEngine = new TemplateEngine();
+    templateEngine.addTemplateResolver(templateResolver(templatePath));
+    return new JavalinThymeleaf(templateEngine);
+  }
+
+  private ITemplateResolver templateResolver(final String prefix) {
+    final ClassLoaderTemplateResolver templateResolver =
+        new ClassLoaderTemplateResolver(Thread.currentThread().getContextClassLoader());
+    templateResolver.setTemplateMode(TemplateMode.HTML);
+    templateResolver.setPrefix(prefix);
+    templateResolver.setSuffix(".html");
+    templateResolver.setCharacterEncoding("UTF-8");
+    return templateResolver;
+  }
 }

infrastructure/restapi/src/main/java/tech/pegasys/teku/infrastructure/restapi/ThymeleafConfigurator.java

@@ -27,7 +27,8 @@ private JavalinEndpointAdapter(final RestApiEndpoint endpoint) {
 
   public static void addEndpoint(final Javalin app, final RestApiEndpoint endpoint) {
     final EndpointMetadata metadata = endpoint.getMetadata();
-    app.addHandler(metadata.getMethod(), metadata.getPath(), new JavalinEndpointAdapter(endpoint));
+    app.addHttpHandler(
+        metadata.getMethod(), metadata.getPath(), new JavalinEndpointAdapter(endpoint));
   }
 
   @Override

infrastructure/restapi/src/main/java/tech/pegasys/teku/infrastructure/restapi/endpoints/JavalinEndpointAdapter.java

@@ -77,6 +77,10 @@ public <T> Optional<T> getOptionalRequestBody() throws JsonProcessingException {
   public JavalinRestApiRequest(final Context context, final EndpointMetadata metadata) {
     this.context = context;
     this.metadata = metadata;
+    // Work around a bug in Javalin where it decides whether to compress on each call to
+    // write which could result in a mix of compressed and uncompressed content
+    // and means it doesn't evaluate the length of the response correctly.
+    this.context.minSizeForCompression(0);
     this.pathParamMap = context.pathParamMap();
     this.queryParamMap = context.queryParamMap();
     this.headerMap = context.headerMap();