-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement body logging for stream responses
Fixes problems introduced in Ktor 1.4.2 where JacksonConverter started to return OutputStreamContent + Add tests with Jackson and Gson
- Loading branch information
Showing
6 changed files
with
391 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
src/main/kotlin/com/korrit/kotlin/ktor/features/logging/ObservedContent.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| package com.korrit.kotlin.ktor.features.logging | ||
|
|
||
| import io.ktor.application.ApplicationCall | ||
| import io.ktor.http.content.OutgoingContent | ||
| import io.ktor.util.pipeline.PipelineContext | ||
| import io.ktor.util.split | ||
| import io.ktor.utils.io.ByteChannel | ||
| import io.ktor.utils.io.ByteReadChannel | ||
| import io.ktor.utils.io.writeFully | ||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.launch | ||
|
|
||
| internal class ObservedContent(private val channel: ByteReadChannel) : OutgoingContent.ReadChannelContent() { | ||
| override fun readFrom(): ByteReadChannel = channel | ||
| } | ||
|
|
||
| internal suspend fun PipelineContext<Any, ApplicationCall>.observe(): Pair<ByteReadChannel, OutgoingContent> { | ||
| return when (val body = subject) { | ||
| is OutgoingContent.ByteArrayContent -> { | ||
| val observer = ByteChannel().apply { | ||
| writeFully(body.bytes()) | ||
| close(null) | ||
| } | ||
|
|
||
| observer to body | ||
| } | ||
| is OutgoingContent.ReadChannelContent -> { | ||
| val (observer, observed) = body.readFrom().split(this) | ||
|
|
||
| observer to ObservedContent(observed) | ||
| } | ||
| is OutgoingContent.WriteChannelContent -> { | ||
| val (observer, observed) = body.toReadChannel(this).split(this) | ||
|
|
||
| observer to ObservedContent(observed) | ||
| } | ||
| else -> { | ||
| val emptyObserver = ByteChannel().apply { | ||
| close(null) | ||
| } | ||
|
|
||
| emptyObserver to body as OutgoingContent | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun OutgoingContent.WriteChannelContent.toReadChannel(scope: CoroutineScope): ByteReadChannel { | ||
| val channel = ByteChannel() | ||
| scope.launch(Dispatchers.Unconfined) { | ||
| writeTo(channel) | ||
| channel.close(null) | ||
| } | ||
| return channel | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
src/test/kotlin/com/korrit/kotlin/ktor/features/logging/LoggingWithGsonTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| package com.korrit.kotlin.ktor.features.logging | ||
|
|
||
| import ch.qos.logback.classic.Level.DEBUG | ||
| import com.google.gson.Gson | ||
| import com.koriit.kotlin.slf4j.logger | ||
| import com.koriit.kotlin.slf4j.mdc.correlation.correlateThread | ||
| import io.ktor.application.call | ||
| import io.ktor.application.install | ||
| import io.ktor.features.CallId | ||
| import io.ktor.features.ContentNegotiation | ||
| import io.ktor.features.DoubleReceive | ||
| import io.ktor.gson.gson | ||
| import io.ktor.http.HttpHeaders | ||
| import io.ktor.http.HttpMethod.Companion.Post | ||
| import io.ktor.request.receive | ||
| import io.ktor.response.respond | ||
| import io.ktor.routing.post | ||
| import io.ktor.routing.routing | ||
| import io.ktor.server.engine.applicationEngineEnvironment | ||
| import io.ktor.server.testing.TestApplicationEngine | ||
| import io.ktor.server.testing.handleRequest | ||
| import io.ktor.server.testing.setBody | ||
| import io.mockk.spyk | ||
| import io.mockk.verify | ||
| import org.junit.jupiter.api.Assertions.assertTrue | ||
| import org.junit.jupiter.api.Test | ||
| import java.util.UUID | ||
|
|
||
| internal class LoggingWithGsonTest { | ||
|
|
||
| private val testLogger = spyk(logger {}) | ||
| private val gson = Gson() | ||
|
|
||
| private data class SampleRequest(val field: String, val innerObject: SampleRequest? = null) | ||
|
|
||
| init { | ||
| correlateThread() | ||
| testLogger as ch.qos.logback.classic.Logger | ||
| testLogger.level = DEBUG | ||
| } | ||
|
|
||
| @Test | ||
| fun `Should log body, full url and headers with Gson`() { | ||
| val server = testServer { | ||
| logRequests = true | ||
| logResponses = true | ||
| logFullUrl = true | ||
| logBody = true | ||
| logHeaders = true | ||
| } | ||
|
|
||
| server.start() | ||
|
|
||
| val reqeust = SampleRequest(field = "value", innerObject = SampleRequest("value2")) | ||
|
|
||
| server.handleRequest(Post, "/api?queryParam=true") { | ||
| addHeader("My-Header", "My-Value") | ||
| addHeader("Content-Type", "application/json") | ||
| setBody(gson.toJson(reqeust)) | ||
| } | ||
|
|
||
| val payloads = mutableListOf<String>() | ||
|
|
||
| verify(exactly = 2) { | ||
| testLogger.info( | ||
| withArg { | ||
| payloads.add(it) | ||
| } | ||
| ) | ||
| } | ||
| verify(exactly = 1) { | ||
| testLogger.info(any(), *anyVararg()) | ||
| } | ||
|
|
||
| val request = payloads[0] | ||
| assertTrue(request.contains("POST")) | ||
| assertTrue(request.contains("/api?queryParam=true")) | ||
| assertTrue(request.contains("My-Header")) | ||
| assertTrue(request.contains("My-Value")) | ||
| assertTrue(request.contains("""{"field":"value","innerObject":{"field":"value2"}}""")) | ||
|
|
||
| val response = payloads[1] | ||
| assertTrue(response.contains("200 OK")) | ||
| assertTrue(request.contains("/api?queryParam=true")) | ||
| assertTrue(response.contains("""{"field":"value","innerObject":{"field":"value2"}}""")) | ||
|
|
||
| server.stop(0, 0) | ||
| } | ||
|
|
||
| private fun testServer( | ||
| installCallId: Boolean = true, | ||
| installDoubleReceive: Boolean = true, | ||
| rootPath: String = "", | ||
| configureLogging: Logging.Configuration.() -> Unit = {} | ||
| ): TestApplicationEngine { | ||
| return TestApplicationEngine( | ||
| applicationEngineEnvironment { | ||
| this.rootPath = rootPath | ||
| module { | ||
| if (installCallId) { | ||
| install(CallId) { | ||
| header(HttpHeaders.XRequestId) | ||
| generate { UUID.randomUUID().toString() } | ||
| verify { it.isNotBlank() } | ||
| } | ||
| } | ||
| if (installDoubleReceive) { | ||
| install(DoubleReceive) { | ||
| receiveEntireContent = true | ||
| } | ||
| } | ||
|
|
||
| install(Logging) { | ||
| logger = testLogger | ||
| configureLogging() | ||
| } | ||
|
|
||
| install(ContentNegotiation) { | ||
| gson {} | ||
| } | ||
|
|
||
| routing { | ||
| post("/api") { | ||
| val body: SampleRequest = call.receive() | ||
| call.respond(body) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ) | ||
| } | ||
| } |
Oops, something went wrong.