illegal URL sets status code 404, suppress log for these kind of errors

Author: cruftex

src/main/java/com/headissue/Application.java

@@ -22,6 +22,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.servlet.ErrorPageErrorHandler;
 import org.eclipse.jetty.servlet.ServletContextHandler;
 import org.eclipse.jetty.util.resource.Resource;
 import org.eclipse.jetty.util.resource.ResourceCollection;
@@ -89,6 +90,10 @@ private static void awaitTermination() {
 
   private static ServletContextHandler buildHandler(File directory) {
     ServletContextHandler servletContextHandler = buildServletContextHandler();
+    final ErrorPageErrorHandler errorHandler = new ErrorPageErrorHandler();
+    errorHandler.addErrorPage(Throwable.class, "/500");
+    errorHandler.addErrorPage(NotFoundException.class, "/404");
+    servletContextHandler.setErrorHandler(errorHandler);
     ServletHandlerBuilder builder = new ServletHandlerBuilder(servletContextHandler);
     builder.addForwardIdToDocumentFilter();
     builder.addPdfUpload(directory);

src/main/java/com/headissue/NotFoundException.java

@@ -0,0 +1,11 @@
+package com.headissue;
+
+/** @author Jens Wilke */
+public class NotFoundException extends RuntimeException {
+
+  public NotFoundException() {}
+
+  public NotFoundException(Throwable cause) {
+    super(cause);
+  }
+}

src/main/java/com/headissue/servlet/SeePdfs.java

@@ -6,6 +6,7 @@
 
 import com.github.jknack.handlebars.Handlebars;
 import com.github.jknack.handlebars.internal.lang3.StringUtils;
+import com.headissue.NotFoundException;
 import com.headissue.config.NanoIdConfig;
 import com.headissue.domain.AccessRule;
 import com.headissue.domain.UtmParameters;
@@ -68,8 +69,7 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp)
     String accessId = getAccessId(req);
     Path accessYaml = getAccessYaml(accessId);
     if (Files.notExists(accessYaml)) {
-      req.getRequestDispatcher("/404").forward(req, resp);
-      return;
+      throw new NotFoundException();
     }
     AccessRule accessRule = yaml.loadAs(new FileInputStream(accessYaml.toFile()), AccessRule.class);
     if (isExpired(accessYaml)) {

src/main/java/com/headissue/servlet/TemplateRendering.java

@@ -1,11 +1,11 @@
 package com.headissue.servlet;
 
 import com.github.jknack.handlebars.Handlebars;
+import com.headissue.NotFoundException;
 import jakarta.servlet.ServletException;
 import jakarta.servlet.http.HttpServlet;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
-
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import org.eclipse.jetty.http.MimeTypes;
@@ -27,9 +27,12 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp)
       handlebars.compile("index.hbs").apply(null, resp.getWriter());
     } else {
       try {
+        if ("/404".equals(pathInfo)) {
+          resp.setStatus(404);
+        }
         handlebars.compile(pathInfo + ".hbs").apply(null, resp.getWriter());
       } catch (FileNotFoundException e) {
-        req.getRequestDispatcher("/404").forward(req, resp);
+        throw new NotFoundException(e);
       }
     }
   }

src/main/resources/logback.xml

@@ -10,21 +10,11 @@
         </encoder>
     </appender>
 
-    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
-        <file>${jetty.home:-target}/logs/jetty.log</file>
-        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
-            <fileNamePattern>${jetty.home:-target}/logs/jetty.log.%d{yyyy-MM-dd-HH-mm}.log.zip</fileNamePattern>
-        </rollingPolicy>
-        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
-            <maxFileSize>1KB</maxFileSize>
-        </triggeringPolicy>
-        <encoder>
-            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
-        </encoder>
-    </appender>
-
+    <!-- blank out log messages caused by illegal URLs that yield 404 -->
+    <logger level="ERROR" name="org.eclipse.jetty.server.HttpChannel" additivity="false">
+        <appender-ref ref="STDOUT" />
+    </logger>
     <root level="INFO">
         <appender-ref ref="STDOUT" />
-        <appender-ref ref="FILE" />
     </root>
 </configuration>

src/main/resources/static/500.hbs

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>404</title>
+    {{> "head.hbs"}}
+</head>
+<body style="background: url('/img/Solid-polymeric-foam.jpg'); background-size: cover">
+<main style="display: flex;
+    flex-direction: column;
+    flex-wrap: wrap;
+    justify-content: space-between;
+    align-content: flex-end;">
+    <div style="padding: 10px">
+        <h1 style="text-shadow: 1px 1px #888; color: red">Ouch!</h1>
+        <h2 style="text-shadow: 1px 1px #888;">Something bad has happened.</h2>
+    </div>
+    <div style="text-shadow: 1px 1px #888; font-size: 0.8rem">
+        <a href="https://commons.wikimedia.org/wiki/File:Solid-polymeric-foam.jpg">Giovanna Canu, Eva Santini</a>, <a
+            href="https://creativecommons.org/licenses/by/4.0">CC BY 4.0</a>, via Wikimedia Commons
+    </div>
+</main>
+
+{{> "molecule/footer.hbs" }}
+</body>
+</html>

src/test/java/com/headissue/feature/docs/AccessIT.java

@@ -69,4 +69,10 @@ void wherePdfIsDownloadable() {
     when.theyDownloadIt();
     then.theyShouldSeeItsDownloaded(tempDir);
   }
+
+  @Test
+  void whereTheLinkTargetDoesNotExist() {
+    when.theyOpenTheTestPdf("a;lkdfjas;dlkfjas;dlfkjasd;fkljasd");
+    then.theyShould404Page();
+  }
 }

src/test/java/com/headissue/feature/steps/Then.java

@@ -75,8 +75,8 @@ public void theyShouldSeeItsNotDownloadable() {
 
   public void theyShouldSeeItsDownloaded(Path tempDir) {
     await()
-        .alias("file downloaded to system")
-        .atMost(1, SECONDS)
+        .alias("file downloaded to system, at: " + tempDir)
+        .atMost(5, SECONDS)
         .until(
             () -> {
               try (Stream<Path> list = Files.list(tempDir)) {
@@ -99,4 +99,9 @@ public void theySeeTheExpiryMessage() {
               return true;
             });
   }
+
+  public void theyShould404Page() {
+    assertThat(
+        driver.findElement(cssSelector("body")).getText(), StringContains.containsString("404"));
+  }
 }