Fix slf4j wrapper and log field separator

coditory · Feb 11, 2024 · 18012e8 · 18012e8
1 parent 23e6e70
commit 18012e8
Show file tree

Hide file tree

Showing 9 changed files with 139 additions and 9 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -5,7 +5,7 @@ labels: bug
 ---
 
 <!-- The bug you're experiencing might have already be reported. -->
-<!-- Please search in the [issues](https://github.com/coditory/sherlock-distributed-lock/issues) before creating one. -->
+<!-- Please search in the [issues](https://github.com/coditory/klog/issues) before creating one. -->
 
 ## Context
 <!-- How has this issue affected you? What are you trying to accomplish? -->

diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -4,7 +4,7 @@ about: Suggest new features/changes
 labels: feature
 ---
 <!-- Your feature request may already be reported. -->
-<!-- Please search in the [issues](https://github.com/coditory/sherlock-distributed-lock/issues) before creating a new one. -->
+<!-- Please search in the [issues](https://github.com/coditory/klog/issues) before creating a new one. -->
 
 ## Context
 <!--- What are you trying to accomplish? -->

diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

diff --git a/klog-slf4j/src/main/kotlin/com/coditory/klog/slf4j/Slf4jLoggerWrapper.kt b/klog-slf4j/src/main/kotlin/com/coditory/klog/slf4j/Slf4jLoggerWrapper.kt
@@ -31,7 +31,7 @@ class Slf4jLoggerWrapper(
     override fun trace(
         format: String?,
         vararg arguments: Any?,
-    ) = logger.trace { MessageFormatter.format(format, arguments).message ?: "" }
+    ) = logger.trace { MessageFormatter.arrayFormat(format, arguments).message ?: "" }
 
     override fun trace(
         msg: String?,
@@ -60,7 +60,7 @@ class Slf4jLoggerWrapper(
     override fun debug(
         format: String?,
         vararg arguments: Any?,
-    ) = logger.debug { MessageFormatter.format(format, arguments).message ?: "" }
+    ) = logger.debug { MessageFormatter.arrayFormat(format, arguments).message ?: "" }
 
     override fun debug(
         msg: String?,
@@ -89,7 +89,7 @@ class Slf4jLoggerWrapper(
     override fun info(
         format: String?,
         vararg arguments: Any?,
-    ) = logger.info { MessageFormatter.format(format, arguments).message ?: "" }
+    ) = logger.info { MessageFormatter.arrayFormat(format, arguments).message ?: "" }
 
     override fun info(
         msg: String?,
@@ -118,7 +118,7 @@ class Slf4jLoggerWrapper(
     override fun warn(
         format: String?,
         vararg arguments: Any?,
-    ) = logger.warn { MessageFormatter.format(format, arguments).message ?: "" }
+    ) = logger.warn { MessageFormatter.arrayFormat(format, arguments).message ?: "" }
 
     override fun warn(
         msg: String?,
@@ -147,7 +147,7 @@ class Slf4jLoggerWrapper(
     override fun error(
         format: String?,
         vararg arguments: Any?,
-    ) = logger.error { MessageFormatter.format(format, arguments).message ?: "" }
+    ) = logger.error { MessageFormatter.arrayFormat(format, arguments).message ?: "" }
 
     override fun error(
         msg: String?,

diff --git a/klog/src/main/kotlin/com/coditory/klog/publish/InMemoryTextPublisher.kt b/klog/src/main/kotlin/com/coditory/klog/publish/InMemoryTextPublisher.kt
@@ -0,0 +1,63 @@
+package com.coditory.klog.publish
+
+import com.coditory.klog.LogEvent
+import com.coditory.klog.text.TextLogEventSerializer
+import com.coditory.klog.text.plain.PlainTextLogEventSerializer
+
+class InMemoryTextPublisher(
+    private val serializer: TextLogEventSerializer = PlainTextLogEventSerializer(),
+) : BlockingPublisher {
+    private val logs = mutableListOf<LogEntry>()
+
+    @Synchronized
+    override fun publishBlocking(event: LogEvent) {
+        val sb = StringBuilder()
+        serializer.format(event, sb)
+        logs.add(
+            LogEntry(
+                event = event,
+                message = sb.toString(),
+            ),
+        )
+    }
+
+    @Synchronized
+    fun getLogs(): List<String> = logs.map { it.message }
+
+    @Synchronized
+    fun getLastLog(): String? = logs.lastOrNull()?.message
+
+    @Synchronized
+    fun getLogEntries(): List<LogEntry> = logs
+
+    @Synchronized
+    fun getLastLogEntry(): LogEntry? = logs.lastOrNull()
+
+    @Synchronized
+    fun getLogEvents(): List<LogEvent> = logs.map { it.event }
+
+    @Synchronized
+    fun getLastLogEvent(): LogEvent? = logs.lastOrNull()?.event
+
+    @Synchronized
+    fun clear() {
+        logs.clear()
+    }
+
+    data class LogEntry(
+        val event: LogEvent,
+        val message: String,
+    )
+
+    companion object {
+        const val TEST_THREAD_NAME = "@THREAD"
+
+        fun testPublisher(): InMemoryTextPublisher {
+            return InMemoryTextPublisher(
+                PlainTextLogEventSerializer(
+                    threadFormatter = { _, appendable -> appendable.append(TEST_THREAD_NAME) },
+                ),
+            )
+        }
+    }
+}
diff --git a/klog/src/main/kotlin/com/coditory/klog/text/plain/PlainTextLogEventSerializer.kt b/klog/src/main/kotlin/com/coditory/klog/text/plain/PlainTextLogEventSerializer.kt
@@ -37,7 +37,7 @@ class PlainTextLogEventSerializer(
                 if (field == LogEventField.MESSAGE) {
                     sized.append(messageSeparator)
                 } else {
-                    sized.append(' ')
+                    sized.appendLazy(' ')
                 }
                 length = sized.length()
             }

diff --git a/klog/src/main/kotlin/com/coditory/klog/text/shared/SizedAppendable.kt b/klog/src/main/kotlin/com/coditory/klog/text/shared/SizedAppendable.kt
@@ -8,12 +8,27 @@ internal class SizedAppendable(
     private val maxLengthMarker: String = MAX_LENGTH_MARKER,
 ) : Appendable {
     private var length: Int = 0
+    private var lazyAppend: CharSequence? = null
+    private var lazyAppendChar: Char? = null
 
     fun length(): Int {
         return length
     }
 
+    fun appendLazy(csq: CharSequence): Appendable {
+        lazyAppend = csq
+        lazyAppendChar = null
+        return this
+    }
+
+    fun appendLazy(c: Char): Appendable {
+        lazyAppend = null
+        lazyAppendChar = c
+        return this
+    }
+
     override fun append(csq: CharSequence?): Appendable {
+        lazyAppend()
         if (length >= maxLength) return this
         if (csq != null) {
             val csqLength = min(csq.length, maxLength - length)
@@ -29,6 +44,7 @@ internal class SizedAppendable(
         start: Int,
         end: Int,
     ): Appendable {
+        lazyAppend()
         if (length >= maxLength) return this
         if (csq != null && start < end) {
             val csqLength = min(end - start, maxLength - length)
@@ -40,6 +56,7 @@ internal class SizedAppendable(
     }
 
     override fun append(c: Char): Appendable {
+        lazyAppend()
         if (length >= maxLength) return this
         length++
         appendable.append(c)
@@ -53,6 +70,23 @@ internal class SizedAppendable(
         }
     }
 
+    private fun lazyAppend() {
+        if (length >= maxLength) {
+            return
+        }
+        val lazy = lazyAppend
+        if (lazy != null) {
+            lazyAppend = null
+            append(lazy)
+            return
+        }
+        val lazyChar = lazyAppendChar
+        if (lazyChar != null) {
+            lazyAppendChar = null
+            append(lazyChar)
+        }
+    }
+
     companion object {
         const val LONG_TEXT_LENGTH: Int = 10 * 1024
         const val MAX_LENGTH_MARKER: String = " [trimmed]"

diff --git a/klog/src/test/kotlin/com/coditory/klog/KlogComplexPlainTextSpec.kt b/klog/src/test/kotlin/com/coditory/klog/KlogComplexPlainTextSpec.kt
@@ -0,0 +1,32 @@
+package com.coditory.klog
+
+import com.coditory.klog.publish.InMemoryTextPublisher
+import com.coditory.klog.publish.InMemoryTextPublisher.Companion.TEST_THREAD_NAME
+import com.coditory.klog.shared.UpdatableFixedClock
+import com.coditory.klog.shared.UpdatableFixedClock.Companion.DEFAULT_FIXED_TIME_LOG_STR
+import io.kotest.core.spec.style.FunSpec
+import io.kotest.matchers.shouldBe
+
+class KlogComplexPlainTextSpec : FunSpec({
+    val clock = UpdatableFixedClock()
+    val publisher = InMemoryTextPublisher.testPublisher()
+    val klog =
+        klog {
+            clock(clock)
+            stream {
+                blockingPublisher(publisher)
+            }
+        }
+
+    val logger = klog.logger("com.coditory.Logger")
+
+    beforeTest {
+        publisher.clear()
+    }
+
+    test("should emit a basic info log event") {
+        logger.info { "Hello" }
+        publisher.getLogs().size shouldBe 1
+        publisher.getLastLog() shouldBe "$DEFAULT_FIXED_TIME_LOG_STR INFO $TEST_THREAD_NAME com.coditory.Logger: Hello"
+    }
+})
diff --git a/klog/src/test/kotlin/com/coditory/klog/shared/UpdatableFixedClock.kt b/klog/src/test/kotlin/com/coditory/klog/shared/UpdatableFixedClock.kt
@@ -32,6 +32,7 @@ class UpdatableFixedClock(
 
     companion object {
         // Always use instant with nanos for testing. Some databases (like mongo) trim nanos - you should test for that!
+        val DEFAULT_FIXED_TIME_LOG_STR = "2015-12-03T11:15:30.123456+01:00"
         val DEFAULT_FIXED_TIME = Instant.parse("2015-12-03T10:15:30.123456Z")
         val DEFAULT_ZONE_ID = ZoneId.of("Europe/Warsaw")
     }