KTOR-5409 Response doesn't contain error message (#3605)

ktorio · Jun 12, 2023 · c2d8a21 · c2d8a21
1 parent 720a835
commit c2d8a21
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/...rver/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/DefaultEnginePipeline.kt b/...rver/ktor-server-host-common/jvmAndNix/src/io/ktor/server/engine/DefaultEnginePipeline.kt
@@ -49,12 +49,17 @@ public fun defaultEnginePipeline(environment: ApplicationEnvironment): EnginePip
  return pipeline
 }
 
+/**
+ * Logs the [error] and responds with an appropriate error status code.
+ */
 public suspend fun handleFailure(call: ApplicationCall, error: Throwable) {
  logError(call, error)
  tryRespondError(call, defaultExceptionStatusCode(error) ?: HttpStatusCode.InternalServerError)
 }
 
-@OptIn(InternalAPI::class)
+/**
+ * Logs the [error] with MDC setup.
+ */
 public suspend fun logError(call: ApplicationCall, error: Throwable) {
  call.application.mdcProvider.withMDCBlock(call) {
  call.application.environment.logFailure(call, error)
@@ -92,7 +97,7 @@ private fun ApplicationEnvironment.logFailure(call: ApplicationCall, cause: Thro
  "(request error: $cause)"
  }
 
- val infoString = "$status: $logString. Exception ${cause::class}: ${cause.message}]"
+ val infoString = "$status: $logString. Exception ${cause::class}: ${cause.message}"
  when (cause) {
  is CancellationException,
  is ClosedChannelException,

diff --git a/...ns/ktor-server-call-logging/jvm/test/io/ktor/server/plugins/callloging/CallLoggingTest.kt b/...ns/ktor-server-call-logging/jvm/test/io/ktor/server/plugins/callloging/CallLoggingTest.kt
@@ -34,6 +34,7 @@ class CallLoggingTest {
  private val logger: Logger = object : Logger by LoggerFactory.getLogger("ktor.test") {
  override fun trace(message: String?) = add("TRACE: $message")
  override fun debug(message: String?) = add("DEBUG: $message")
+ override fun debug(message: String?, cause: Throwable) = add("DEBUG: $message")
  override fun info(message: String?) = add("INFO: $message")
 
  private fun add(message: String?) {
@@ -478,6 +479,32 @@ class CallLoggingTest {
  assertContains(messages, "INFO: 500 Internal Server Error: GET - /error in 0ms")
  }
 
+ @Test
+ fun logErrorMessage() = testApplication {
+ environment {
+ log = logger
+ config = MapApplicationConfig("ktor.test.throwOnException" to "false")
+ }
+ install(CallLogging) {
+ level = Level.DEBUG
+ disableDefaultColors()
+ clock { 0 }
+ }
+ routing {
+ get("/") {
+ throw BadRequestException("Message of exception")
+ }
+ }
+
+ client.get("/").apply {
+ assertEquals(HttpStatusCode.BadRequest, status)
+ assertContains(
+ messages,
+ "DEBUG: Unhandled: GET - /. Exception class io.ktor.server.plugins.BadRequestException: Message of exception"
+ )
+ }
+ }
+
  private fun green(value: Any): String = colored(value, Ansi.Color.GREEN)
  private fun red(value: Any): String = colored(value, Ansi.Color.RED)
  private fun cyan(value: Any): String = colored(value, Ansi.Color.CYAN)

diff --git a/...erver/ktor-server-test-host/jvmAndNix/src/io/ktor/server/testing/TestApplicationEngine.kt b/...erver/ktor-server-test-host/jvmAndNix/src/io/ktor/server/testing/TestApplicationEngine.kt
@@ -100,6 +100,8 @@ class TestApplicationEngine(
  }
 
  private suspend fun PipelineContext<Unit, ApplicationCall>.handleTestFailure(cause: Throwable) {
+ logError(call, cause)
+
  val throwOnException = environment.config
  .propertyOrNull(CONFIG_KEY_THROW_ON_EXCEPTION)
  ?.getString()?.toBoolean() ?: true