Make 404 page work on Undertow

Signed-off-by: Phillip Kruger <[email protected]>
quarkusio · Jun 26, 2024 · 2e37b5f · 2e37b5f
1 parent a5ffb89
commit 2e37b5f
Show file tree

Hide file tree

Showing 11 changed files with 387 additions and 289 deletions.
diff --git a/core/runtime/src/main/java/io/quarkus/runtime/TemplateHtmlBuilder.java b/core/runtime/src/main/java/io/quarkus/runtime/TemplateHtmlBuilder.java
@@ -240,7 +240,7 @@ public TemplateHtmlBuilder staticResourcePath(String title, String description)
     }
 
     public TemplateHtmlBuilder servletMapping(String title) {
-        return resourcePath(title, false, false, null);
+        return resourcePath(title, false, true, null);
     }
 
     private TemplateHtmlBuilder resourcePath(String title, boolean withListStart, boolean withAnchor, String description) {

diff --git a/...time/src/main/java/io/quarkus/resteasy/runtime/standalone/ResteasyStandaloneRecorder.java b/...time/src/main/java/io/quarkus/resteasy/runtime/standalone/ResteasyStandaloneRecorder.java
@@ -40,7 +40,7 @@
 import io.quarkus.vertx.http.runtime.HttpBuildTimeConfig;
 import io.quarkus.vertx.http.runtime.HttpCompressionHandler;
 import io.quarkus.vertx.http.runtime.HttpConfiguration;
-import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundHandler;
+import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundData;
 import io.quarkus.vertx.http.runtime.devmode.RouteDescription;
 import io.quarkus.vertx.http.runtime.devmode.RouteMethodDescription;
 import io.quarkus.vertx.http.runtime.security.HttpSecurityRecorder.DefaultAuthFailureHandler;
@@ -107,7 +107,7 @@ public Handler<RoutingContext> vertxRequestHandler(Supplier<Vertx> vertx, Execut
             if (LaunchMode.current() == LaunchMode.DEVELOPMENT) {
                 // For Not Found Screen
                 Registry registry = deployment.getRegistry();
-                ResourceNotFoundHandler.runtimeRoutes = fromBoundResourceInvokers(registry, nonJaxRsClassNameToMethodPaths);
+                ResourceNotFoundData.setRuntimeRoutes(fromBoundResourceInvokers(registry, nonJaxRsClassNameToMethodPaths));
             }
 
             return handler;

diff --git a/...e/src/main/java/io/quarkus/resteasy/reactive/server/runtime/ResteasyReactiveRecorder.java b/...e/src/main/java/io/quarkus/resteasy/reactive/server/runtime/ResteasyReactiveRecorder.java
@@ -69,7 +69,7 @@
 import io.quarkus.security.identity.CurrentIdentityAssociation;
 import io.quarkus.vertx.http.runtime.CurrentVertxRequest;
 import io.quarkus.vertx.http.runtime.HttpBuildTimeConfig;
-import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundHandler;
+import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundData;
 import io.quarkus.vertx.http.runtime.devmode.RouteDescription;
 import io.quarkus.vertx.http.runtime.devmode.RouteMethodDescription;
 import io.quarkus.vertx.http.runtime.security.HttpSecurityRecorder.DefaultAuthFailureHandler;
@@ -158,7 +158,7 @@ closeTaskHandler, contextFactory, new ArcThreadSetupAction(beanContainer.request
 
         if (LaunchMode.current() == LaunchMode.DEVELOPMENT) {
             // For Not Found Screen
-            ResourceNotFoundHandler.runtimeRoutes = fromClassMappers(deployment.getClassMappers());
+            ResourceNotFoundData.setRuntimeRoutes(fromClassMappers(deployment.getClassMappers()));
             // For Dev UI Screen
             RuntimeResourceVisitor.visitRuntimeResources(deployment.getClassMappers(), ScoreSystem.ScoreVisitor);
         }

diff --git a/...ns/undertow/runtime/src/main/java/io/quarkus/undertow/runtime/QuarkusNotFoundServlet.java b/...ns/undertow/runtime/src/main/java/io/quarkus/undertow/runtime/QuarkusNotFoundServlet.java
@@ -0,0 +1,33 @@
+package io.quarkus.undertow.runtime;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+import jakarta.enterprise.inject.spi.CDI;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServlet;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+
+import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundData;
+import io.vertx.core.json.Json;
+
+public class QuarkusNotFoundServlet extends HttpServlet {
+
+    @Override
+    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+        ResourceNotFoundData resourceNotFoundData = CDI.current().select(ResourceNotFoundData.class).get();
+        String accept = req.getHeader("Accept");
+        if (accept != null && accept.contains("application/json")) {
+            resp.setContentType("application/json");
+            resp.setCharacterEncoding(StandardCharsets.UTF_8.name());
+            resp.getWriter().write(Json.encodePrettily(resourceNotFoundData.getJsonContent()));
+        } else {
+            //We default to HTML representation
+            resp.setContentType("text/html");
+            resp.setCharacterEncoding(StandardCharsets.UTF_8.name());
+            resp.getWriter().write(resourceNotFoundData.getHTMLContent());
+        }
+    }
+
+}
diff --git a/...ndertow/runtime/src/main/java/io/quarkus/undertow/runtime/UndertowDeploymentRecorder.java b/...ndertow/runtime/src/main/java/io/quarkus/undertow/runtime/UndertowDeploymentRecorder.java
@@ -54,7 +54,7 @@
 import io.quarkus.vertx.http.runtime.HttpCompressionHandler;
 import io.quarkus.vertx.http.runtime.HttpConfiguration;
 import io.quarkus.vertx.http.runtime.VertxHttpRecorder;
-import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundHandler;
+import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundData;
 import io.quarkus.vertx.http.runtime.security.QuarkusHttpUser;
 import io.undertow.httpcore.BufferAllocator;
 import io.undertow.httpcore.StatusCodes;
@@ -278,7 +278,7 @@ public void addServletMapping(RuntimeValue<DeploymentInfo> info, String name, St
         if (sv != null) {
             sv.addMapping(mapping);
             if (LaunchMode.current() == LaunchMode.DEVELOPMENT) {
-                ResourceNotFoundHandler.addServlet(mapping);
+                ResourceNotFoundData.addServlet(mapping);
             }
         }
     }
@@ -463,20 +463,27 @@ public DeploymentManager bootServletContainer(RuntimeValue<DeploymentInfo> info,
         if (info.getValue().getExceptionHandler() == null) {
             //if a 500 error page has not been mapped we change the default to our more modern one, with a UID in the
             //log. If this is not production we also include the stack trace
-            boolean alreadyMapped = false;
+            boolean alreadyMapped500 = false;
+            boolean alreadyMapped404 = false;
             for (ErrorPage i : info.getValue().getErrorPages()) {
                 if (i.getErrorCode() != null && i.getErrorCode() == StatusCodes.INTERNAL_SERVER_ERROR) {
-                    alreadyMapped = true;
-                    break;
+                    alreadyMapped500 = true;
+                } else if (i.getErrorCode() != null && i.getErrorCode() == StatusCodes.NOT_FOUND) {
+                    alreadyMapped404 = true;
                 }
             }
-            if (!alreadyMapped || launchMode.isDevOrTest()) {
+            if (!alreadyMapped500 || launchMode.isDevOrTest()) {
                 info.getValue().setExceptionHandler(new QuarkusExceptionHandler());
                 info.getValue().addErrorPage(new ErrorPage("/@QuarkusError", StatusCodes.INTERNAL_SERVER_ERROR));
                 info.getValue().addServlet(new ServletInfo("@QuarkusError", QuarkusErrorServlet.class)
                         .addMapping("/@QuarkusError").setAsyncSupported(true)
                         .addInitParam(QuarkusErrorServlet.SHOW_STACK, Boolean.toString(launchMode.isDevOrTest())));
             }
+            if (!alreadyMapped404 && launchMode.equals(LaunchMode.DEVELOPMENT)) {
+                info.getValue().addErrorPage(new ErrorPage("/@QuarkusNotFound", StatusCodes.NOT_FOUND));
+                info.getValue().addServlet(new ServletInfo("@QuarkusNotFound", QuarkusNotFoundServlet.class)
+                        .addMapping("/@QuarkusNotFound").setAsyncSupported(true));
+            }
         }
         setupRequestScope(info.getValue(), beanContainer);
 

diff --git a/...tx-http/deployment/src/main/java/io/quarkus/devui/deployment/menu/EndpointsProcessor.java b/...tx-http/deployment/src/main/java/io/quarkus/devui/deployment/menu/EndpointsProcessor.java
@@ -3,13 +3,16 @@
 import io.quarkus.deployment.IsDevelopment;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.devui.deployment.InternalPageBuildItem;
+import io.quarkus.devui.spi.JsonRPCProvidersBuildItem;
 import io.quarkus.devui.spi.page.Page;
 import io.quarkus.vertx.http.deployment.NonApplicationRootPathBuildItem;
+import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundData;
 
 /**
  * This creates Endpoints Page
  */
 public class EndpointsProcessor {
+    private static final String NAMESPACE = "devui-endpoints";
     private static final String DEVUI = "dev-ui";
 
     @BuildStep(onlyIf = IsDevelopment.class)
@@ -23,17 +26,22 @@ InternalPageBuildItem createEndpointsPage(NonApplicationRootPathBuildItem nonApp
 
         // Page
         endpointsPage.addPage(Page.webComponentPageBuilder()
-                .namespace("devui-endpoints")
+                .namespace(NAMESPACE)
                 .title("Endpoints")
                 .icon("font-awesome-solid:plug")
                 .componentLink("qwc-endpoints.js"));
 
         endpointsPage.addPage(Page.webComponentPageBuilder()
-                .namespace("devui-endpoints")
+                .namespace(NAMESPACE)
                 .title("Routes")
                 .icon("font-awesome-solid:route")
                 .componentLink("qwc-routes.js"));
 
         return endpointsPage;
     }
+
+    @BuildStep(onlyIf = IsDevelopment.class)
+    JsonRPCProvidersBuildItem createJsonRPCService() {
+        return new JsonRPCProvidersBuildItem(NAMESPACE, ResourceNotFoundData.class);
+    }
 }
diff --git a/.../deployment/src/main/java/io/quarkus/vertx/http/deployment/devmode/NotFoundProcessor.java b/.../deployment/src/main/java/io/quarkus/vertx/http/deployment/devmode/NotFoundProcessor.java
@@ -11,6 +11,8 @@
 import org.eclipse.microprofile.config.Config;
 import org.eclipse.microprofile.config.ConfigProvider;
 
+import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
+import io.quarkus.arc.deployment.BeanContainerBuildItem;
 import io.quarkus.deployment.IsDevelopment;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.annotations.Record;
@@ -20,6 +22,7 @@
 import io.quarkus.vertx.http.deployment.HttpRootPathBuildItem;
 import io.quarkus.vertx.http.deployment.VertxWebRouterBuildItem;
 import io.quarkus.vertx.http.runtime.devmode.AdditionalRouteDescription;
+import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundData;
 import io.quarkus.vertx.http.runtime.devmode.ResourceNotFoundRecorder;
 import io.quarkus.vertx.http.runtime.devmode.RouteDescription;
 import io.vertx.core.Handler;
@@ -29,11 +32,19 @@ public class NotFoundProcessor {
 
     private static final String META_INF_RESOURCES = "META-INF/resources";
 
+    @BuildStep(onlyIf = IsDevelopment.class)
+    AdditionalBeanBuildItem resourceNotFoundDataAvailable() {
+        return AdditionalBeanBuildItem.builder()
+                .addBeanClass(ResourceNotFoundData.class)
+                .setUnremovable().build();
+    }
+
     @BuildStep(onlyIf = IsDevelopment.class)
     @Record(RUNTIME_INIT)
     void routeNotFound(ResourceNotFoundRecorder recorder,
             VertxWebRouterBuildItem router,
             HttpRootPathBuildItem httpRoot,
+            BeanContainerBuildItem beanContainer,
             LaunchModeBuildItem launchMode,
             ApplicationArchivesBuildItem applicationArchivesBuildItem,
             List<RouteDescriptionBuildItem> routeDescriptions,
@@ -66,6 +77,7 @@ void routeNotFound(ResourceNotFoundRecorder recorder,
                 router.getHttpRouter(),
                 router.getMainRouter(),
                 router.getManagementRouter(),
+                beanContainer.getValue(),
                 getBaseUrl(launchMode),
                 httpRoot.getRootPath(),
                 routes,

diff --git a/extensions/vertx-http/dev-ui-resources/src/main/resources/dev-ui/qwc/qwc-endpoints.js b/extensions/vertx-http/dev-ui-resources/src/main/resources/dev-ui/qwc/qwc-endpoints.js
@@ -1,14 +1,15 @@
 import { LitElement, html, css} from 'lit';
-import { basepath } from 'devui-data';
 import '@vaadin/progress-bar';
 import '@vaadin/grid';
 import { columnBodyRenderer } from '@vaadin/grid/lit.js';
 import '@vaadin/grid/vaadin-grid-sort-column.js';
+import { JsonRpc } from 'jsonrpc';
 
 /**
  * This component show all available endpoints
  */
 export class QwcEndpoints extends LitElement {
+    jsonRpc = new JsonRpc(this);
 
     static styles = css`
         .infogrid {
@@ -44,25 +45,15 @@ export class QwcEndpoints extends LitElement {
         this._info = null;
     }
 
-    async connectedCallback() {
+    connectedCallback() {
         super.connectedCallback();
-        await this.load();
+        this.jsonRpc.getJsonContent().then(jsonRpcResponse => {
+            this._info = jsonRpcResponse.result;
+        });
     }
-
-    async load() {
-        const response = await fetch("/quarkus404", {
-		method: 'GET',
-		headers: {
-			'Accept': 'application/json'
-		}
-	});
-        const data = await response.json();
-        this._info = data;
-    }
-
+
     render() {
         if (this._info) {
-
             const typeTemplates = [];
             for (const [type, list] of Object.entries(this._info)) {
                 typeTemplates.push(html`${this._renderType(type,list)}`);