feat: configurable debug string limit (#60)

Author: nathanfallet

README.md

@@ -47,7 +47,7 @@ To use kdriver, add the following to your `build.gradle.kts`:
 
 ```kotlin
 dependencies {
-    implementation("dev.kdriver:core:0.5.4")
+    implementation("dev.kdriver:core:0.5.5")
 }
 ```
 

build.gradle.kts

@@ -6,7 +6,7 @@ plugins {
 
 allprojects {
     group = "dev.kdriver"
-    version = "0.5.4"
+    version = "0.5.5"
     project.ext.set("url", "https://github.com/cdpdriver/kdriver")
     project.ext.set("license.name", "Apache 2.0")
     project.ext.set("license.url", "https://www.apache.org/licenses/LICENSE-2.0.txt")

core/src/commonMain/kotlin/dev/kdriver/core/browser/Config.kt

@@ -18,6 +18,7 @@ class Config(
     val browserConnectionTimeout: Long = Defaults.BROWSER_CONNECTION_TIMEOUT,
     val browserConnectionMaxTries: Int = Defaults.BROWSER_CONNECTION_MAX_TRIES,
     val autoDiscoverTargets: Boolean = Defaults.AUTO_DISCOVER_TARGETS,
+    val debugStringLimit: Int = Defaults.DEBUG_STRING_LIMIT,
 ) {
 
     private val logger = KtorSimpleLogger("Config")
@@ -118,6 +119,7 @@ class Config(
         const val BROWSER_CONNECTION_TIMEOUT: Long = 500
         const val BROWSER_CONNECTION_MAX_TRIES: Int = 60
         const val AUTO_DISCOVER_TARGETS: Boolean = true
+        const val DEBUG_STRING_LIMIT: Int = 128
     }
 
 }

core/src/commonMain/kotlin/dev/kdriver/core/browser/ConfigBuilder.kt

@@ -30,6 +30,7 @@ class ConfigBuilder {
     var browserConnectionTimeout: Long = Defaults.BROWSER_CONNECTION_TIMEOUT
     var browserConnectionMaxTries: Int = Defaults.BROWSER_CONNECTION_MAX_TRIES
     var autoDiscoverTargets: Boolean = Defaults.AUTO_DISCOVER_TARGETS
+    var debugStringLimit: Int = Defaults.DEBUG_STRING_LIMIT
 
     /**
      * Builds the Config instance with the configured parameters.
@@ -49,6 +50,7 @@ class ConfigBuilder {
             browserConnectionTimeout = browserConnectionTimeout,
             browserConnectionMaxTries = browserConnectionMaxTries,
             autoDiscoverTargets = autoDiscoverTargets,
+            debugStringLimit = debugStringLimit
         )
     }
 }

core/src/commonMain/kotlin/dev/kdriver/core/connection/DefaultConnection.kt

@@ -3,6 +3,7 @@ package dev.kdriver.core.connection
 import dev.kdriver.cdp.*
 import dev.kdriver.cdp.domain.*
 import dev.kdriver.core.browser.Browser
+import dev.kdriver.core.browser.Config.Defaults
 import dev.kdriver.core.browser.WebSocketInfo
 import io.ktor.client.*
 import io.ktor.client.plugins.websocket.*
@@ -33,7 +34,6 @@ open class DefaultConnection(
 ) : OwnedConnection {
 
     private val logger = KtorSimpleLogger("Connection")
-    private val debugStringLimit = 64
 
     private val client = HttpClient(getWebSocketClientEngine()) {
         install(WebSockets)
@@ -82,7 +82,7 @@ open class DefaultConnection(
                     try {
                         frame as? Frame.Text ?: continue
                         val text = frame.readText()
-                        logger.debug("WS < CDP: ${text.take(debugStringLimit)}")
+                        logger.debug("WS < CDP: ${text.take(owner?.config?.debugStringLimit ?: Defaults.DEBUG_STRING_LIMIT)}")
                         val received = Serialization.json.decodeFromString<Message>(text)
                         allMessages.emit(received)
                     } catch (e: Exception) {
@@ -108,7 +108,7 @@ open class DefaultConnection(
         val requestId = currentIdMutex.withLock { currentId++ }
         val jsonString = Serialization.json.encodeToString(Request(requestId, method, parameter))
         wsSession?.send(jsonString)
-        logger.debug("WS > CDP: ${jsonString.take(debugStringLimit)}")
+        logger.debug("WS > CDP: ${jsonString.take(owner?.config?.debugStringLimit ?: Defaults.DEBUG_STRING_LIMIT)}")
 
         val result = responses.first { it.id == requestId }
         result.error?.throwAsException(method)

docs/home/quickstart.md

@@ -12,7 +12,7 @@ To install, add the dependency to your `build.gradle.kts`:
 
 ```kotlin
 dependencies {
-    implementation("dev.kdriver:core:0.5.4")
+    implementation("dev.kdriver:core:0.5.5")
 }
 ```