Add log filtering

JuulLabs · Sep 10, 2021 · d3ec183 · d3ec183
1 parent adbc347
commit d3ec183
Show file tree

Hide file tree

Showing 2 changed files with 192 additions and 0 deletions.
diff --git a/logging/src/commonMain/kotlin/FilterLogger.kt b/logging/src/commonMain/kotlin/FilterLogger.kt
@@ -0,0 +1,51 @@
+package com.juul.tuulbox.logging
+
+public fun interface LogFilter {
+    public fun canLog(tag: String, message: String, metadata: ReadMetadata, throwable: Throwable?): Boolean
+}
+
+public fun Logger.withFilter(
+    filter: LogFilter
+): Logger = FilterLogger(filter, this)
+
+private class FilterLogger(
+    private val filter: LogFilter,
+    private val inner: Logger,
+) : Logger {
+
+    override fun verbose(tag: String, message: String, metadata: ReadMetadata, throwable: Throwable?) {
+        if (filter.canLog(tag, message, metadata, throwable)) {
+            inner.verbose(tag, message, metadata, throwable)
+        }
+    }
+
+    override fun debug(tag: String, message: String, metadata: ReadMetadata, throwable: Throwable?) {
+        if (filter.canLog(tag, message, metadata, throwable)) {
+            inner.debug(tag, message, metadata, throwable)
+        }
+    }
+
+    override fun info(tag: String, message: String, metadata: ReadMetadata, throwable: Throwable?) {
+        if (filter.canLog(tag, message, metadata, throwable)) {
+            inner.info(tag, message, metadata, throwable)
+        }
+    }
+
+    override fun warn(tag: String, message: String, metadata: ReadMetadata, throwable: Throwable?) {
+        if (filter.canLog(tag, message, metadata, throwable)) {
+            inner.warn(tag, message, metadata, throwable)
+        }
+    }
+
+    override fun error(tag: String, message: String, metadata: ReadMetadata, throwable: Throwable?) {
+        if (filter.canLog(tag, message, metadata, throwable)) {
+            inner.error(tag, message, metadata, throwable)
+        }
+    }
+
+    override fun assert(tag: String, message: String, metadata: ReadMetadata, throwable: Throwable?) {
+        if (filter.canLog(tag, message, metadata, throwable)) {
+            inner.assert(tag, message, metadata, throwable)
+        }
+    }
+}
diff --git a/logging/src/commonTest/kotlin/FilterLoggerTests.kt b/logging/src/commonTest/kotlin/FilterLoggerTests.kt
@@ -0,0 +1,141 @@
+package com.juul.tuulbox.logging
+
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertSame
+import kotlin.test.assertTrue
+
+class FilterLoggerTests {
+
+    @Test
+    fun verbose_whenDenied_doesNotCallInner() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> false }
+            .verbose("tag", "message", Metadata(), throwable)
+        assertTrue(inner.verboseCalls.isEmpty())
+    }
+
+    @Test
+    fun verbose_whenPermitted_callsInnerWithSameArguments() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> true }
+            .verbose("tag", "message", Metadata(), throwable)
+        val call = inner.verboseCalls.single()
+        assertEquals("tag", call.tag)
+        assertEquals("message", call.message)
+        assertEquals(Metadata(), call.metadata)
+        assertSame(throwable, call.throwable)
+    }
+
+    @Test
+    fun debug_whenDenied_doesNotCallInner() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> false }
+            .debug("tag", "message", Metadata(), throwable)
+        assertTrue(inner.debugCalls.isEmpty())
+    }
+
+    @Test
+    fun debug_whenPermitted_callsInnerWithSameArguments() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> true }
+            .debug("tag", "message", Metadata(), throwable)
+        val call = inner.debugCalls.single()
+        assertEquals("tag", call.tag)
+        assertEquals("message", call.message)
+        assertEquals(Metadata(), call.metadata)
+        assertSame(throwable, call.throwable)
+    }
+
+    @Test
+    fun info_whenDenied_doesNotCallInner() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> false }
+            .info("tag", "message", Metadata(), throwable)
+        assertTrue(inner.infoCalls.isEmpty())
+    }
+
+    @Test
+    fun info_whenPermitted_callsInnerWithSameArguments() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> true }
+            .info("tag", "message", Metadata(), throwable)
+        val call = inner.infoCalls.single()
+        assertEquals("tag", call.tag)
+        assertEquals("message", call.message)
+        assertEquals(Metadata(), call.metadata)
+        assertSame(throwable, call.throwable)
+    }
+
+    @Test
+    fun warn_whenDenied_doesNotCallInner() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> false }
+            .warn("tag", "message", Metadata(), throwable)
+        assertTrue(inner.warnCalls.isEmpty())
+    }
+
+    @Test
+    fun warn_whenPermitted_callsInnerWithSameArguments() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> true }
+            .warn("tag", "message", Metadata(), throwable)
+        val call = inner.warnCalls.single()
+        assertEquals("tag", call.tag)
+        assertEquals("message", call.message)
+        assertEquals(Metadata(), call.metadata)
+        assertSame(throwable, call.throwable)
+    }
+
+    @Test
+    fun error_whenDenied_doesNotCallInner() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> false }
+            .error("tag", "message", Metadata(), throwable)
+        assertTrue(inner.errorCalls.isEmpty())
+    }
+
+    @Test
+    fun error_whenPermitted_callsInnerWithSameArguments() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> true }
+            .error("tag", "message", Metadata(), throwable)
+        val call = inner.errorCalls.single()
+        assertEquals("tag", call.tag)
+        assertEquals("message", call.message)
+        assertEquals(Metadata(), call.metadata)
+        assertSame(throwable, call.throwable)
+    }
+
+    @Test
+    fun assert_whenDenied_doesNotCallInner() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> false }
+            .assert("tag", "message", Metadata(), throwable)
+        assertTrue(inner.assertCalls.isEmpty())
+    }
+
+    @Test
+    fun assert_whenPermitted_callsInnerWithSameArguments() {
+        val inner = CallListLogger()
+        val throwable = Throwable()
+        inner.withFilter { _, _, _, _ -> true }
+            .assert("tag", "message", Metadata(), throwable)
+        val call = inner.assertCalls.single()
+        assertEquals("tag", call.tag)
+        assertEquals("message", call.message)
+        assertEquals(Metadata(), call.metadata)
+        assertSame(throwable, call.throwable)
+    }
+}