Flatten JSON structure of log messages

marcin-cebo · marcin-cebo · commit c7618cf7c82f · 2025-10-03T11:54:08.000+02:00
diff --git a/pubnub-kotlin/pubnub-kotlin-core-api/src/jvmMain/kotlin/com/pubnub/api/logging/LogMessageContent.kt b/pubnub-kotlin/pubnub-kotlin-core-api/src/jvmMain/kotlin/com/pubnub/api/logging/LogMessageContent.kt
@@ -29,32 +29,53 @@ sealed class LogMessageContent {
      * Error message with type, message, and stack trace.
      */
     data class Error(
+        @SerializedName("type")
+        val type: String? = null,
         @SerializedName("message")
-        val message: ErrorDetails
+        val message: String,
+        @SerializedName("stack")
+        val stack: List<String>? = null
     ) : LogMessageContent()
 
     /**
      * Network request message.
      */
     data class NetworkRequest(
-        @SerializedName("message")
-        val message: NetworkLog.Request
+        @SerializedName("origin")
+        val origin: String,
+        @SerializedName("path")
+        val path: String,
+        @SerializedName("query")
+        val query: Map<String, String>? = null,
+        @SerializedName("method")
+        val method: HttpMethod,
+        @SerializedName("headers")
+        val headers: Map<String, String>? = null,
+        @SerializedName("formData")
+        val formData: Map<String, String>? = null,
+        @SerializedName("body")
+        val body: String? = null,
+        @SerializedName("timeout")
+        val timeout: Long? = null,
+        @SerializedName("identifier")
+        val identifier: String? = null,
+        @SerializedName("canceled")
+        val canceled: Boolean = false,
+        @SerializedName("failed")
+        val failed: Boolean = false
     ) : LogMessageContent()
 
     /**
      * Network response message.
      */
     data class NetworkResponse(
-        @SerializedName("message")
-        val message: NetworkLog.Response
+        @SerializedName("url")
+        val url: String,
+        @SerializedName("status")
+        val status: Int,
+        @SerializedName("headers")
+        val headers: Map<String, String>? = null,
+        @SerializedName("body")
+        val body: String? = null
     ) : LogMessageContent()
 }
-
-data class ErrorDetails(
-    @SerializedName("type")
-    val type: String? = null,
-    @SerializedName("message")
-    val message: String,
-    @SerializedName("stack")
-    val stack: List<String>? = null
-)
diff --git a/pubnub-kotlin/pubnub-kotlin-core-api/src/jvmMain/kotlin/com/pubnub/api/logging/NetworkLog.kt b/pubnub-kotlin/pubnub-kotlin-core-api/src/jvmMain/kotlin/com/pubnub/api/logging/NetworkLog.kt
diff --git a/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/PubNubImpl.kt b/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/PubNubImpl.kt
@@ -52,7 +52,6 @@ import com.pubnub.api.endpoints.push.RemoveAllPushChannelsForDevice
 import com.pubnub.api.endpoints.push.RemoveChannelsFromPush
 import com.pubnub.api.enums.PNPushEnvironment
 import com.pubnub.api.enums.PNPushType
-import com.pubnub.api.logging.ErrorDetails
 import com.pubnub.api.logging.LogConfig
 import com.pubnub.api.logging.LogMessage
 import com.pubnub.api.logging.LogMessageContent
@@ -257,10 +256,9 @@ open class PubNubImpl(
                     logger.error(
                         LogMessage(
                             message = LogMessageContent.Error(
-                                message = ErrorDetails(
-                                    type = e.javaClass.simpleName,
-                                    message = "Failed calling getCryptoModuleWithLogConfig"
-                                )
+                                type = e.javaClass.simpleName,
+                                message = "Failed calling getCryptoModuleWithLogConfig",
+                                stack = null
                             ),
                             details = "details",
                         )
diff --git a/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/logging/CompositeLogger.kt b/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/logging/CompositeLogger.kt
@@ -1,7 +1,8 @@
 package com.pubnub.internal.logging
 
+import com.google.gson.Gson
+import com.google.gson.GsonBuilder
 import com.pubnub.api.logging.CustomLogger
-import com.pubnub.api.logging.ErrorDetails
 import com.pubnub.api.logging.LogMessage
 import com.pubnub.api.logging.LogMessageContent
 import com.pubnub.api.logging.LogMessageType
@@ -38,6 +39,11 @@ class CompositeLogger(
     }
 
     override fun debug(message: LogMessage) {
+        // todo remove
+        val prettyGson: Gson = GsonBuilder().setPrettyPrinting().create()
+        val toJson = prettyGson.toJson(message)
+        println("-=JSON:\n$toJson")
+
         val enhancedLogMessage = LogMessage(
             message = message.message,
             details = message.details,
@@ -146,10 +152,9 @@ class CompositeLogger(
                 try {
                     val logMessage = LogMessage(
                         message = LogMessageContent.Error(
-                            ErrorDetails(
-                                type = this::class.java.simpleName,
-                                message = "Custom logger ${logger.name} failed: ${e.message}",
-                            )
+                            type = this::class.java.simpleName,
+                            message = "Custom logger ${logger.name} failed: ${e.message}",
+                            stack = null
                         ),
                         type = LogMessageType.ERROR,
                         location = "CompositeLogger",
diff --git a/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/logging/networkLogging/CustomPnHttpLoggingInterceptor.kt b/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/logging/networkLogging/CustomPnHttpLoggingInterceptor.kt
@@ -1,13 +1,9 @@
 package com.pubnub.internal.logging.networkLogging
 
 import com.pubnub.api.enums.PNLogVerbosity
-import com.pubnub.api.logging.ErrorDetails
 import com.pubnub.api.logging.HttpMethod
 import com.pubnub.api.logging.LogMessage
 import com.pubnub.api.logging.LogMessageContent
-import com.pubnub.api.logging.NetworkLog
-import com.pubnub.api.logging.NetworkRequestMessage
-import com.pubnub.api.logging.NetworkResponseMessage
 import com.pubnub.internal.logging.PNLogger
 import com.pubnub.internal.managers.MapperManager
 import okhttp3.Interceptor
@@ -62,7 +58,7 @@ class CustomPnHttpLoggingInterceptor(
         // Parse headers
         val headers = request.headers.toMap()
 
-        val networkRequest = NetworkRequestMessage(
+        val networkRequest = LogMessageContent.NetworkRequest(
             origin = origin,
             path = path,
             query = queryParams.takeIf { it.isNotEmpty() },
@@ -71,16 +67,13 @@ class CustomPnHttpLoggingInterceptor(
             formData = null, // TODO: Parse form data if needed
             body = request.body.toString(),
             timeout = null, // TODO: Extract from request if available
-        )
-
-        val requestLog = NetworkLog.Request(
-            message = networkRequest,
+            identifier = null,
             canceled = false,
             failed = false
         )
 
         val logMessage = LogMessage(
-            message = LogMessageContent.NetworkRequest(requestLog),
+            message = networkRequest,
             details = "HTTP Request",
             location = location,
         )
@@ -121,17 +114,13 @@ class CustomPnHttpLoggingInterceptor(
             }
         } ?: (null to response)
 
-        val networkResponse = NetworkResponseMessage(
-            url = url,
-            status = status,
-            headers = headers.takeIf { it.isNotEmpty() },
-            body = body
-        )
-
-        val responseLog = NetworkLog.Response(message = networkResponse)
-
         val logMessage = LogMessage(
-            message = LogMessageContent.NetworkResponse(responseLog),
+            message = LogMessageContent.NetworkResponse(
+                url = url,
+                status = status,
+                headers = headers.takeIf { it.isNotEmpty() },
+                body = body
+            ),
             details = "HTTP Response",
             location = location,
         )
@@ -150,11 +139,9 @@ class CustomPnHttpLoggingInterceptor(
         val duration = System.currentTimeMillis() - requestStartTime
 
         val errorDetails = LogMessageContent.Error(
-            message = ErrorDetails(
-                type = error.javaClass.simpleName,
-                message = error.message ?: "Unknown error",
-                stack = error.stackTrace.take(10).map { it.toString() }
-            )
+            type = error.javaClass.simpleName,
+            message = error.message ?: "Unknown error",
+            stack = error.stackTrace.take(10).map { it.toString() }
         )
 
         val logMessage = LogMessage(
diff --git a/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/logging/networkLogging/LogMessageFormatter.kt b/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/logging/networkLogging/LogMessageFormatter.kt
@@ -23,14 +23,13 @@ object LogMessageFormatter {
                 is LogMessageContent.Text -> content.message
                 is LogMessageContent.Object -> prettyGson.toJson(mapOf("operation" to content.operation, "arguments" to content.arguments))
                 is LogMessageContent.Error -> {
-                    val err = content.message
-                    "Error(type=${err.type}, message=${err.message}, stack=${err.stack?.joinToString("\n")})"
+                    "Error(type=${content.type}, message=${content.message}, stack=${content.stack?.joinToString("\n")})"
                 }
                 is LogMessageContent.NetworkRequest -> {
-                    "NetworkRequest:\n${prettyGson.toJson(content.message)}"
+                    "NetworkRequest:\n${prettyGson.toJson(content)}"
                 }
                 is LogMessageContent.NetworkResponse -> {
-                    "NetworkResponse:\n${prettyGson.toJson(content.message)}"
+                    "NetworkResponse:\n${prettyGson.toJson(content)}"
                 }
                 else -> content.toString()
             }
diff --git a/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/managers/MapperManager.kt b/pubnub-kotlin/pubnub-kotlin-impl/src/main/kotlin/com/pubnub/internal/managers/MapperManager.kt
@@ -19,7 +19,6 @@ import com.google.gson.stream.JsonToken
 import com.google.gson.stream.JsonWriter
 import com.pubnub.api.PubNubError
 import com.pubnub.api.PubNubException
-import com.pubnub.api.logging.ErrorDetails
 import com.pubnub.api.logging.LogConfig
 import com.pubnub.api.logging.LogMessage
 import com.pubnub.api.logging.LogMessageContent
@@ -270,10 +269,9 @@ class MapperManager(private val logConfig: LogConfig) {
             log.error(
                 LogMessage(
                     message = LogMessageContent.Error(
-                        ErrorDetails(
-                            type = e.javaClass.simpleName,
-                            message = "Serialization of content failed due to: ${e.message}"
-                        )
+                        type = e.javaClass.simpleName,
+                        message = "Serialization of content failed due to: ${e.message}",
+                        stack = null
                     )
                 )
             )
diff --git a/pubnub-kotlin/pubnub-kotlin-impl/src/test/kotlin/com/pubnub/internal/logging/networkLogging/LogMessageFormatterTest.kt b/pubnub-kotlin/pubnub-kotlin-impl/src/test/kotlin/com/pubnub/internal/logging/networkLogging/LogMessageFormatterTest.kt
@@ -1,13 +1,9 @@
 package com.pubnub.internal.logging.networkLogging
 
-import com.pubnub.api.logging.ErrorDetails
 import com.pubnub.api.logging.HttpMethod
 import com.pubnub.api.logging.LogMessage
 import com.pubnub.api.logging.LogMessageContent
 import com.pubnub.api.logging.LogMessageType
-import com.pubnub.api.logging.NetworkLog
-import com.pubnub.api.logging.NetworkRequestMessage
-import com.pubnub.api.logging.NetworkResponseMessage
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Assertions.assertFalse
 import org.junit.jupiter.api.Assertions.assertTrue
@@ -44,15 +40,14 @@ class LogMessageFormatterTest {
 
     @Test
     fun `should format error message content with stack trace`() {
-        val errorDetails = ErrorDetails(
+        val errorContent = LogMessageContent.Error(
             type = "RuntimeException",
             message = "Something went wrong",
             stack = listOf(
                 "at com.example.Test.method1(Test.java:10)",
                 "at com.example.Test.method2(Test.java:20)"
             )
         )
-        val errorContent = LogMessageContent.Error(errorDetails)
 
         val result = LogMessageFormatter.formatMessageContent(errorContent)
 
@@ -64,12 +59,11 @@ class LogMessageFormatterTest {
 
     @Test
     fun `should format error message content without stack trace`() {
-        val errorDetails = ErrorDetails(
+        val errorContent = LogMessageContent.Error(
             type = "IOException",
             message = "Network error",
             stack = null
         )
-        val errorContent = LogMessageContent.Error(errorDetails)
 
         val result = LogMessageFormatter.formatMessageContent(errorContent)
 
@@ -80,7 +74,7 @@ class LogMessageFormatterTest {
 
     @Test
     fun `should format network request message content as JSON`() {
-        val networkRequest = NetworkRequestMessage(
+        val requestContent = LogMessageContent.NetworkRequest(
             origin = "https://ps.pndsn.com",
             path = "/v2/subscribe/demo/my-channel/0",
             query = mapOf("uuid" to "test-uuid"),
@@ -89,10 +83,10 @@ class LogMessageFormatterTest {
             formData = null,
             body = """{"message": "hello"}""",
             timeout = 5000,
-            identifier = "req-123"
+            identifier = "req-123",
+            canceled = false,
+            failed = false
         )
-        val requestLog = NetworkLog.Request(networkRequest, canceled = false, failed = false)
-        val requestContent = LogMessageContent.NetworkRequest(requestLog)
 
         val result = LogMessageFormatter.formatMessageContent(requestContent)
 
@@ -108,14 +102,12 @@ class LogMessageFormatterTest {
 
     @Test
     fun `should format network response message content as JSON`() {
-        val networkResponse = NetworkResponseMessage(
+        val responseContent = LogMessageContent.NetworkResponse(
             url = "https://ps.pndsn.com/v2/subscribe/demo/my-channel/0",
             status = 200,
             headers = mapOf("Content-Type" to "application/json"),
             body = """{"status": 200, "message": "OK"}"""
         )
-        val responseLog = NetworkLog.Response(networkResponse)
-        val responseContent = LogMessageContent.NetworkResponse(responseLog)
 
         val result = LogMessageFormatter.formatMessageContent(responseContent)
 
@@ -178,23 +170,23 @@ class LogMessageFormatterTest {
 
     @Test
     fun `simplified extension function should format complex network request`() {
-        val networkRequest = NetworkRequestMessage(
-            origin = "https://ps.pndsn.com",
-            path = "/publish/demo/my-channel/0",
-            query = mapOf("pnsdk" to "kotlin/1.0.0", "uuid" to "user-123"),
-            method = HttpMethod.POST,
-            headers = mapOf(
-                "Content-Type" to "application/json",
-                "Authorization" to "Bearer token123"
-            ),
-            formData = null,
-            body = """{"text": "Hello World!", "meta": {"timestamp": 1234567890}}""",
-            timeout = 10000,
-            identifier = "publish-req-789"
-        )
-        val requestLog = NetworkLog.Request(networkRequest, canceled = false, failed = false)
         val logMessage = LogMessage(
-            message = LogMessageContent.NetworkRequest(requestLog),
+            message = LogMessageContent.NetworkRequest(
+                origin = "https://ps.pndsn.com",
+                path = "/publish/demo/my-channel/0",
+                query = mapOf("pnsdk" to "kotlin/1.0.0", "uuid" to "user-123"),
+                method = HttpMethod.POST,
+                headers = mapOf(
+                    "Content-Type" to "application/json",
+                    "Authorization" to "Bearer token123"
+                ),
+                formData = null,
+                body = """{"text": "Hello World!", "meta": {"timestamp": 1234567890}}""",
+                timeout = 10000,
+                identifier = "publish-req-789",
+                canceled = false,
+                failed = false
+            ),
             details = "Publishing message to channel",
             type = LogMessageType.NETWORK_REQUEST,
             location = "PublishEndpoint",

Original file line number	Diff line number	Diff line change
`@@ -23,14 +23,13 @@ object LogMessageFormatter {`
`23`	`23`	`is LogMessageContent.Text -> content.message`
`24`	`24`	`is LogMessageContent.Object -> prettyGson.toJson(mapOf("operation" to content.operation, "arguments" to content.arguments))`
`25`	`25`	`is LogMessageContent.Error -> {`
`26`		`- val err = content.message`
`27`		`- "Error(type=${err.type}, message=${err.message}, stack=${err.stack?.joinToString("\n")})"`
	`26`	`+ "Error(type=${content.type}, message=${content.message}, stack=${content.stack?.joinToString("\n")})"`
`28`	`27`	`}`
`29`	`28`	`is LogMessageContent.NetworkRequest -> {`
`30`		`- "NetworkRequest:\n${prettyGson.toJson(content.message)}"`
	`29`	`+ "NetworkRequest:\n${prettyGson.toJson(content)}"`
`31`	`30`	`}`
`32`	`31`	`is LogMessageContent.NetworkResponse -> {`
`33`		`- "NetworkResponse:\n${prettyGson.toJson(content.message)}"`
	`32`	`+ "NetworkResponse:\n${prettyGson.toJson(content)}"`
`34`	`33`	`}`
`35`	`34`	`else -> content.toString()`
`36`	`35`	`}`