Merge pull request #14 from icerockdev/task/WD-321

WD-321 Add custom request/response configuration

Author: AlexeiiShvedov

README.md

@@ -12,7 +12,7 @@ repositories {
 }
 
 // Append dependency
-implementation("com.icerockdev:web-utils:0.3.0")
+implementation("com.icerockdev:web-utils:0.3.1")
 ````
 
 ## Library usage

sample/collection.http

@@ -1,4 +1,15 @@
+GET http://127.0.0.1:8080/
+Accept: text/plain
+
+###
+
+GET http://127.0.0.1:8080/object
+Accept: application/json
+
+###
+
 POST http://127.0.0.1:8080/object
+Accept: application/json
 Content-Type: application/json
 
 {
@@ -7,22 +18,28 @@ Content-Type: application/json
 }
 
 ###
+
+GET http://127.0.0.1:8080/custom-object
+Accept: application/json
+
+###
+
 GET http://127.0.0.1:8080/exception
-accept: application/json
+Accept: application/json
 
 ###
 
 GET http://127.0.0.1:8080/handled
-accept: application/json
+Accept: application/json
 
 ###
 
 GET http://127.0.0.1:8080/handled2
-accept: application/json
+Accept: application/json
 
 ###
 
 GET http://127.0.0.1:8080/get?age=10&TestValue=20&email=a@a.com&test=10&test=20&test&tmp=1&tmp=2&tmp=3
-accept: application/json
+Accept: application/json
 
-###
+###

sample/src/main/kotlin/com/icerockdev/sample/server.kt

@@ -12,6 +12,7 @@ import com.icerockdev.exception.ValidationException
 import com.icerockdev.util.QueryParser
 import com.icerockdev.util.receiveQuery
 import com.icerockdev.webserver.*
+import com.icerockdev.webserver.log.LoggingConfiguration
 import com.icerockdev.webserver.log.JsonDataLogger
 import com.icerockdev.webserver.log.JsonSecret
 import com.icerockdev.webserver.log.jsonLogger
@@ -41,6 +42,8 @@ fun Application.main() {
     }
     install(JsonDataLogger) {
         mapperConfiguration = getObjectMapper()
+        loggingConfiguration =
+            LoggingConfiguration(responseTypes = listOf(AbstractResponse::class, CustomResponse::class))
     }
     install(CallId, getCallConfiguration())
     install(ContentNegotiation) {
@@ -72,6 +75,10 @@ fun Application.main() {
                 }
                 call.respond(TestResponse2(200, request.email, request.password))
             }
+
+            get("/custom-object") {
+                call.respond(CustomResponse(200, "Custom message", listOf(1, 2, 3)))
+            }
         }
 
         get("/exception") {
@@ -104,6 +111,8 @@ class TestResponse(status: Int, message: String) :
     val data = message
 }
 
+class CustomResponse(var status: Int, var message: String, var list: List<Int>)
+
 data class QueryValues(
     private val email: String = "",
     private val age: Int?,

web-utils/build.gradle.kts

@@ -13,7 +13,7 @@ apply(plugin = "java")
 apply(plugin = "kotlin")
 
 group = "com.icerockdev"
-version = "0.3.0"
+version = "0.3.1"
 
 val sourcesJar by tasks.registering(Jar::class) {
     classifier = "sources"

web-utils/src/main/kotlin/com/icerockdev/api/AbstractResponse.kt

@@ -11,5 +11,4 @@ abstract class AbstractResponse(
     var message: String = "",
     var timestamp: Long = DateTimeUtil.getTimestamp(),
     var success: Boolean = false
-) {
-}
+)

web-utils/src/main/kotlin/com/icerockdev/api/ErrorResponse.kt

@@ -28,5 +28,4 @@ class ErrorResponse() : ResponseList() {
         setValidationParams(errorList)
         totalCount = errorList.count()
     }
-
 }

web-utils/src/main/kotlin/com/icerockdev/api/Response.kt

@@ -12,5 +12,4 @@ open class Response(
     message: String = "",
     timestamp: Long = DateTimeUtil.getTimestamp(),
     isSuccess: Boolean = true
-) : AbstractResponse(status, message, timestamp, isSuccess) {
-}
+) : AbstractResponse(status, message, timestamp, isSuccess)

web-utils/src/main/kotlin/com/icerockdev/webserver/log/JsonDataLogger.kt

@@ -16,8 +16,6 @@ import com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector
 import com.fasterxml.jackson.databind.jsontype.TypeSerializer
 import com.fasterxml.jackson.databind.ser.std.StdScalarSerializer
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
-import com.icerockdev.api.AbstractResponse
-import com.icerockdev.api.Request
 import com.icerockdev.webserver.Constants
 import com.icerockdev.webserver.Environment
 import io.ktor.application.*
@@ -36,6 +34,7 @@ class JsonDataLogger(configure: Configuration.() -> Unit) {
 
     private val mapper: ObjectMapper
     private val configuration: Configuration
+
     /**
      * Configuration type for [JsonDataLogger] feature
      */
@@ -46,6 +45,7 @@ class JsonDataLogger(configure: Configuration.() -> Unit) {
         var responseStatusCodeName: String = Constants.LOG_FIELD_STATUS_CODE
         var appEnvName: String = Constants.LOG_FIELD_ENV
         var systemEnvKey: String = "env"
+        var loggingConfiguration: LoggingConfiguration = LoggingConfiguration()
     }
 
     init {
@@ -78,17 +78,21 @@ class JsonDataLogger(configure: Configuration.() -> Unit) {
         // response data intercept
         pipeline.sendPipeline.insertPhaseBefore(ApplicationSendPipeline.Render, LoggingPhase)
         pipeline.sendPipeline.intercept(LoggingPhase) { subject ->
-            if (subject is AbstractResponse) {
-                MDC.put(configuration.responseBodyName, mapper.writeValueAsString(subject))
+            configuration.loggingConfiguration.responseTypes.forEach { type ->
+                if (type.isInstance(subject)) {
+                    MDC.put(configuration.responseBodyName, mapper.writeValueAsString(subject))
+                }
             }
         }
 
         // Received data intercept
         pipeline.receivePipeline.insertPhaseBefore(ApplicationReceivePipeline.After, LoggingPhase)
         pipeline.receivePipeline.intercept(LoggingPhase) { request ->
             val requestValue = request.value
-            if (requestValue is Request) {
-                MDC.put(configuration.requestBodyName, mapper.writeValueAsString(requestValue))
+            configuration.loggingConfiguration.requestTypes.forEach { type ->
+                if (type.isInstance(requestValue)) {
+                    MDC.put(configuration.requestBodyName, mapper.writeValueAsString(requestValue))
+                }
             }
         }
 
@@ -157,4 +161,4 @@ class SecretSerializer : StdScalarSerializer<Any?>(String::class.java, false) {
     override fun serialize(value: Any?, gen: JsonGenerator?, provider: SerializerProvider?) {
         gen!!.writeString("****")
     }
-}
+}

web-utils/src/main/kotlin/com/icerockdev/webserver/log/LoggingConfiguration.kt

@@ -0,0 +1,10 @@
+package com.icerockdev.webserver.log
+
+import com.icerockdev.api.AbstractResponse
+import com.icerockdev.api.Request
+import kotlin.reflect.KClass
+
+class LoggingConfiguration(
+    val requestTypes: List<KClass<*>> = listOf(Request::class),
+    val responseTypes: List<KClass<*>> = listOf(AbstractResponse::class)
+)