[exceptions] Include eof/timeout handling in main exception handler path

javalin · Apr 2, 2023 · afb30d5 · afb30d5
1 parent 97ff3ba
commit afb30d5
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/javalin/src/main/java/io/javalin/http/servlet/ExceptionMapper.kt b/javalin/src/main/java/io/javalin/http/servlet/ExceptionMapper.kt
@@ -27,6 +27,7 @@ class ExceptionMapper(val cfg: JavalinConfig) {
             return handle(ctx, t.cause as Exception)
         }
         when {
+            JettyUtil.isExpectedException(t) -> JettyUtil.logExpectedException(t)
             t is Exception && HttpResponseExceptionMapper.canHandle(t) && noUserHandler(t) -> HttpResponseExceptionMapper.handle(t as HttpResponseException, ctx)
             t is Exception -> Util.findByClass(handlers, t.javaClass)?.handle(t, ctx) ?: uncaughtException(ctx, t)
             else -> handleUnexpectedThrowable(ctx.res(), t)
@@ -40,11 +41,10 @@ class ExceptionMapper(val cfg: JavalinConfig) {
 
     internal fun handleUnexpectedThrowable(res: HttpServletResponse, throwable: Throwable): Nothing? {
         val unwrapped = (throwable as? CompletionException)?.cause ?: throwable
-        if (JettyUtil.isClientAbortException(unwrapped) || JettyUtil.isJettyTimeoutException(unwrapped)) {
-            JavalinLogger.debug("Client aborted or timed out", throwable)
-            return null // jetty aborts and timeouts happen when clients disconnect, they are not actually unexpected
-        }
         res.status = HttpStatus.INTERNAL_SERVER_ERROR.code
+        if (JettyUtil.isExpectedException(unwrapped)) {
+            return null.also { JettyUtil.logExpectedException(unwrapped) }
+        }
         JavalinLogger.error("Exception occurred while servicing http-request", throwable)
         return null
     }

diff --git a/javalin/src/main/java/io/javalin/jetty/JettyUtil.kt b/javalin/src/main/java/io/javalin/jetty/JettyUtil.kt
@@ -36,4 +36,7 @@ object JettyUtil {
     // This is rare, but intended (see issues #163 and #1277)
     fun isJettyTimeoutException(t: Throwable) = t is IOException && t.cause is TimeoutException
 
+    fun isExpectedException(t: Throwable) = isClientAbortException(t) || isJettyTimeoutException(t)
+    fun logExpectedException(t: Throwable) = JavalinLogger.debug("Client aborted or timed out", t)
+
 }
diff --git a/javalin/src/test/java/io/javalin/TestExceptionMapper.kt b/javalin/src/test/java/io/javalin/TestExceptionMapper.kt
@@ -18,6 +18,7 @@ import io.javalin.testing.TestUtil
 import io.javalin.testing.TypedException
 import io.javalin.testing.httpCode
 import org.assertj.core.api.Assertions.assertThat
+import org.eclipse.jetty.io.EofException
 import org.junit.jupiter.api.Test
 import kotlin.reflect.full.allSuperclasses
 
@@ -103,4 +104,9 @@ class TestExceptionMapper {
         assertThat(http.jsonGet("/").body).contains("""MY MESSAGE WITH \nNEWLINES\n""")
     }
 
+    @Test
+    fun `jetty eof exceptions are ignored and logged as debug`() = TestUtil.test { app, http ->
+        app.get("/") { throw EofException() }
+        assertThat(http.get("/").httpCode()).isEqualTo(OK)
+    }
 }