Merge pull request #267 from adrienlauer/undertow-error-pages

Add support for Undertow error pages

Author: adrienlauer

web/specs/src/main/java/org/seedstack/seed/web/WebConfig.java

@@ -5,6 +5,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
+
 package org.seedstack.seed.web;
 
 import java.util.ArrayList;
@@ -161,6 +162,7 @@ public static class ServerConfig {
  private boolean http2 = DEFAULT_HTTP2_ACTIVATION;
  private boolean https = DEFAULT_HTTPS_ACTIVATION;
  private List<String> welcomeFiles = new ArrayList<>();
+ private List<ErrorPage> errorPages = new ArrayList<>();
 
  public ServerConfig() {
  addWelcomeFile(DEFAULT_WELCOME_FILE);
@@ -236,6 +238,20 @@ public ServerConfig addWelcomeFile(String welcomeFile) {
  return this;
  }
 
+ public List<ErrorPage> getErrorPages() {
+ return Collections.unmodifiableList(errorPages);
+ }
+
+ public ServerConfig setErrorPages(List<ErrorPage> errorPages) {
+ this.errorPages = errorPages;
+ return this;
+ }
+
+ public ServerConfig addErrorPage(ErrorPage errorPage) {
+ this.errorPages.add(errorPage);
+ return this;
+ }
+
  @Config("sessions")
  public static class SessionsConfig {
  private static final int DEFAULT_SESSION_TIMEOUT = 1000 * 60 * 15;
@@ -251,5 +267,42 @@ public SessionsConfig setTimeout(int timeout) {
  return this;
  }
  }
+
+ public static class ErrorPage {
+ private String location;
+ private Integer errorCode;
+ private Class<? extends Exception> exceptionType;
+
+ public String getLocation() {
+ return location;
+ }
+
+ public ErrorPage setLocation(String location) {
+ this.location = location;
+ return this;
+ }
+
+ public Integer getErrorCode() {
+ return errorCode;
+ }
+
+ public ErrorPage setErrorCode(Integer errorCode) {
+ this.errorCode = errorCode;
+ return this;
+ }
+
+ public Class<? extends Throwable> getExceptionType() {
+ return exceptionType;
+ }
+
+ public ErrorPage setExceptionType(Class<? extends Exception> exceptionType) {
+ this.exceptionType = exceptionType;
+ return this;
+ }
+
+ public boolean isDefault() {
+ return exceptionType == null && errorCode == null;
+ }
+ }
  }
 }

web/undertow/src/main/java/org/seedstack/seed/undertow/internal/DeploymentManagerFactory.java

@@ -5,6 +5,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
+
 package org.seedstack.seed.undertow.internal;
 
 import static org.seedstack.shed.ClassLoaders.findMostCompleteClassLoader;
@@ -14,10 +15,14 @@
 import io.undertow.servlet.Servlets;
 import io.undertow.servlet.api.DeploymentInfo;
 import io.undertow.servlet.api.DeploymentManager;
+import io.undertow.servlet.api.ErrorPage;
 import io.undertow.servlet.api.ServletContainerInitializerInfo;
 import io.undertow.servlet.util.ImmediateInstanceHandle;
 import io.undertow.websockets.jsr.WebSocketDeploymentInfo;
+import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.ServiceLoader;
 import java.util.Set;
@@ -59,6 +64,7 @@ private DeploymentInfo configureDeploymentInfo() {
  .setDefaultSessionTimeout(serverConfig.sessions().getTimeout())
  .setResourceManager(new ClassPathResourceManager(mostCompleteClassLoader, META_INF_RESOURCES))
  .addWelcomePages(serverConfig.getWelcomeFiles())
+ .addErrorPages(buildUndertowErrorPages(serverConfig.getErrorPages()))
  .addServletContextAttribute(
  WebSocketDeploymentInfo.ATTRIBUTE_NAME,
  new WebSocketDeploymentInfo()
@@ -81,6 +87,20 @@ private DeploymentInfo configureDeploymentInfo() {
  return deploymentInfo;
  }
 
+ private Collection<ErrorPage> buildUndertowErrorPages(List<WebConfig.ServerConfig.ErrorPage> errorPages) {
+ List<ErrorPage> undertowErrorPages = new ArrayList<>();
+ for (WebConfig.ServerConfig.ErrorPage errorPage : errorPages) {
+ if (errorPage.getExceptionType() != null) {
+ undertowErrorPages.add(new ErrorPage(errorPage.getLocation(), errorPage.getExceptionType()));
+ } else if (errorPage.getErrorCode() != null) {
+ undertowErrorPages.add(new ErrorPage(errorPage.getLocation(), errorPage.getErrorCode()));
+ } else {
+ undertowErrorPages.add(new ErrorPage(errorPage.getLocation()));
+ }
+ }
+ return undertowErrorPages;
+ }
+
  private <T extends ServletContainerInitializer> ServletContainerInitializerInfo
  createServletContainerInitializerInfo(
  final T servletContainerInitializer) {

web/undertow/src/test/java/org/seedstack/seed/undertow/AbstractUndertowIT.java

@@ -5,6 +5,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
+
 package org.seedstack.seed.undertow;
 
 import io.restassured.response.Response;
@@ -91,5 +92,30 @@ public void explicitSubdirWelcomeFiles() {
  .get(baseUrl + "/welcome");
  }
 
+ @Test
+ @ConfigurationProfiles("errorPages")
+ public void errorPages() {
+ expect()
+ .statusCode(404)
+ .body(Matchers.containsString("<h1>Not found!</h1>"))
+ .when()
+ .get(baseUrl + "/error?code=404");
+ expect()
+ .statusCode(415)
+ .body(Matchers.containsString("<h1>Unsupported media type!</h1>"))
+ .when()
+ .get(baseUrl + "/error?code=415");
+ expect()
+ .statusCode(403)
+ .body(Matchers.containsString("<h1>An error occurred!</h1>"))
+ .when()
+ .get(baseUrl + "/error?code=403");
+ expect()
+ .statusCode(500)
+ .body(Matchers.containsString("<h1>An error occurred!</h1>"))
+ .when()
+ .get(baseUrl + "/exceptionError");
+ }
+
  abstract ResponseSpecification expect();
 }

web/undertow/src/test/java/org/seedstack/seed/undertow/fixtures/ErrorServlet.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright © 2013-2019, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.seedstack.seed.undertow.fixtures;
+
+import java.io.IOException;
+import javax.servlet.ServletException;
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+@WebServlet(value = {"/error"})
+public class ErrorServlet extends HttpServlet {
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+ int code = Integer.parseInt(req.getParameter("code"));
+ resp.sendError(code);
+ }
+}

web/undertow/src/test/java/org/seedstack/seed/undertow/fixtures/ExceptionErrorServlet.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright © 2013-2019, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.seedstack.seed.undertow.fixtures;
+
+import java.io.IOException;
+import javax.servlet.ServletException;
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+@WebServlet(value = {"/exceptionError"})
+public class ExceptionErrorServlet extends HttpServlet {
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+ throw new IllegalStateException("ERROR!");
+ }
+}

web/undertow/src/test/resources/META-INF/resources/errors/404.html

@@ -0,0 +1 @@
+<h1>Not found!</h1>

web/undertow/src/test/resources/META-INF/resources/errors/415.html

@@ -0,0 +1 @@
+<h1>Unsupported media type!</h1>

web/undertow/src/test/resources/META-INF/resources/errors/default.html

@@ -0,0 +1 @@
+<h1>An error occurred!</h1>

web/undertow/src/test/resources/application.yaml

@@ -15,6 +15,12 @@ web:
  contextPath: context/ # keep this strange form to test for context path normalization
  https<https>: true
  welcomeFiles<welcome>: [ 'welcome1.html', 'welcome2.html' ]
+ errorPages<errorPages>:
+ - location: /errors/404.html
+ errorCode: 404
+ - location: /errors/415.html
+ errorCode: 415
+ - location: /errors/default.html
  server<refresh>:
  port: ${sys.customUndertowPort:'9001'}