kordlib · lukellmann · Dec 23, 2023 · Dec 20, 2023
diff --git a/.github/workflows/deployment-ci.yml b/.github/workflows/deployment-ci.yml
@@ -24,7 +24,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: temurin
           java-version: 11
@@ -49,7 +49,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Set up JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: temurin
           java-version: 11

diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml
@@ -20,7 +20,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up JDK
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: temurin
           java-version: 11

diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -6,6 +6,12 @@ repositories {
     mavenCentral()
 }
 
+kotlin {
+    compilerOptions {
+        allWarningsAsErrors = true
+    }
+}
+
 dependencies {
     implementation(libs.bundles.pluginsForBuildSrc)
 }
diff --git a/common/build.gradle.kts b/common/build.gradle.kts
@@ -11,8 +11,6 @@ kotlin {
                 api(libs.kotlinx.coroutines.core)
                 api(libs.kotlinx.serialization.json)
                 api(libs.kotlinx.datetime)
-                api(libs.kotlin.logging)
-
                 api(libs.ktor.client.core)
 
                 compileOnly(projects.kspAnnotations)
@@ -52,15 +50,15 @@ internal const val BUILD_CONFIG_GENERATED_COMMIT_HASH: String = "<commit hash>"
 internal const val BUILD_CONFIG_GENERATED_SHORT_COMMIT_HASH: String = "<short commit hash>"
 */
 buildConfig {
-    packageName("dev.kord.common")
-    className("BuildConfigGenerated")
+    packageName = "dev.kord.common"
+    className = "BuildConfigGenerated"
 
     useKotlinOutput {
         topLevelConstants = true
         internalVisibility = true
     }
 
-    buildConfigField("String", "BUILD_CONFIG_GENERATED_LIBRARY_VERSION", "\"$libraryVersion\"")
-    buildConfigField("String", "BUILD_CONFIG_GENERATED_COMMIT_HASH", "\"$commitHash\"")
-    buildConfigField("String", "BUILD_CONFIG_GENERATED_SHORT_COMMIT_HASH", "\"$shortCommitHash\"")
+    buildConfigField("BUILD_CONFIG_GENERATED_LIBRARY_VERSION", libraryVersion)
+    buildConfigField("BUILD_CONFIG_GENERATED_COMMIT_HASH", commitHash)
+    buildConfigField("BUILD_CONFIG_GENERATED_SHORT_COMMIT_HASH", shortCommitHash)
 }
diff --git a/core/api/core.api b/core/api/core.api
@@ -102,6 +102,7 @@ public final class dev/kord/core/KordKt {
 	public static final fun Kord (Ljava/lang/String;Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public static synthetic fun Kord$default (Ljava/lang/String;Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
 	public static final fun getKordLogger ()Lmu/KLogger;
+	public static final fun logCaughtThrowable (Ljava/lang/Throwable;)V
 }
 
 public abstract interface class dev/kord/core/KordObject {

diff --git a/core/build.gradle.kts b/core/build.gradle.kts
@@ -25,6 +25,16 @@ kotlin {
 
                 api(libs.kord.cache.api)
                 api(libs.kord.cache.map)
+
+                implementation(libs.kotlin.logging)
+
+                // TODO remove when kordLogger is removed
+                implementation(libs.kotlin.logging.old)
+            }
+        }
+        jvmMain {
+            dependencies {
+                implementation(libs.slf4j.api)
             }
         }
         jvmTest {

diff --git a/core/src/commonMain/kotlin/Kord.kt b/core/src/commonMain/kotlin/Kord.kt
@@ -31,16 +31,21 @@ import dev.kord.rest.builder.interaction.*
 import dev.kord.rest.builder.user.CurrentUserModifyBuilder
 import dev.kord.rest.request.RestRequestException
 import dev.kord.rest.service.RestClient
+import io.github.oshai.kotlinlogging.KotlinLogging
 import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.*
-import mu.KLogger
-import mu.KotlinLogging
 import kotlin.contracts.InvocationKind
 import kotlin.contracts.contract
 import kotlin.coroutines.CoroutineContext
 import kotlinx.coroutines.channels.Channel as CoroutineChannel
 
-public val kordLogger: KLogger = KotlinLogging.logger { }
+@Deprecated("Use your own logger instead, this will be removed in the future.", level = DeprecationLevel.WARNING)
+public val kordLogger: mu.KLogger = mu.KotlinLogging.logger { }
+
+private val logger = KotlinLogging.logger { }
+
+@PublishedApi
+internal fun logCaughtThrowable(throwable: Throwable): Unit = logger.catching(throwable)
 
 
 /**
@@ -634,6 +639,6 @@ public inline fun <reified T : Event> Kord.on(
 ): Job =
     events.buffer(CoroutineChannel.UNLIMITED).filterIsInstance<T>()
         .onEach { event ->
-            scope.launch { runCatching { consumer(event) }.onFailure { kordLogger.catching(it) } }
+            scope.launch { runCatching { consumer(event) }.onFailure(::logCaughtThrowable) }
         }
         .launchIn(scope)
diff --git a/core/src/commonMain/kotlin/gateway/handler/DefaultGatewayEventInterceptor.kt b/core/src/commonMain/kotlin/gateway/handler/DefaultGatewayEventInterceptor.kt
@@ -3,7 +3,7 @@ package dev.kord.core.gateway.handler
 import dev.kord.common.annotation.KordPreview
 import dev.kord.core.Kord
 import dev.kord.core.gateway.ShardEvent
-import mu.KotlinLogging
+import io.github.oshai.kotlinlogging.KotlinLogging
 import dev.kord.core.event.Event as CoreEvent
 
 private val logger = KotlinLogging.logger { }

diff --git a/core/src/commonMain/kotlin/live/LiveKordEntity.kt b/core/src/commonMain/kotlin/live/LiveKordEntity.kt
@@ -6,7 +6,7 @@ import dev.kord.core.entity.KordEntity
 import dev.kord.core.event.Event
 import dev.kord.core.event.message.MessageUpdateEvent
 import dev.kord.core.event.message.ReactionAddEvent
-import dev.kord.core.kordLogger
+import dev.kord.core.logCaughtThrowable
 import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.flow.*
@@ -53,5 +53,5 @@ public inline fun <reified T : Event> LiveKordEntity.on(
     noinline consumer: suspend (T) -> Unit
 ): Job =
     events.buffer(Channel.UNLIMITED).filterIsInstance<T>().onEach {
-        runCatching { consumer(it) }.onFailure { kordLogger.catching(it) }
-    }.catch { kordLogger.catching(it) }.launchIn(scope)
+        runCatching { consumer(it) }.onFailure(::logCaughtThrowable)
+    }.catch { logCaughtThrowable(it) }.launchIn(scope)
diff --git a/gateway/api/gateway.api b/gateway/api/gateway.api
@@ -669,6 +669,7 @@ public final class dev/kord/gateway/GatewayConfigurationBuilder {
 public final class dev/kord/gateway/GatewayKt {
 	public static final fun editPresence (Ldev/kord/gateway/Gateway;Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public static final fun getGatewayOnLogger ()Lmu/KLogger;
+	public static final fun logCaughtThrowable (Ljava/lang/Throwable;)V
 	public static final fun requestGuildMembers (Ldev/kord/gateway/Gateway;Ldev/kord/common/entity/Snowflake;Lkotlin/jvm/functions/Function1;)Lkotlinx/coroutines/flow/Flow;
 	public static final fun requestGuildMembers (Ldev/kord/gateway/Gateway;Ldev/kord/gateway/RequestGuildMembers;)Lkotlinx/coroutines/flow/Flow;
 	public static synthetic fun requestGuildMembers$default (Ldev/kord/gateway/Gateway;Ldev/kord/common/entity/Snowflake;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;

diff --git a/gateway/build.gradle.kts b/gateway/build.gradle.kts
@@ -12,9 +12,19 @@ kotlin {
                 api(libs.bundles.ktor.client.serialization)
                 api(libs.ktor.client.websockets)
 
+                implementation(libs.kotlin.logging)
+
+                // TODO remove when gatewayOnLogger and mu.KLogger.error() are removed
+                implementation(libs.kotlin.logging.old)
+
                 compileOnly(projects.kspAnnotations)
             }
         }
+        jvmMain {
+            dependencies {
+                implementation(libs.slf4j.api)
+            }
+        }
         jsMain {
             dependencies {
                 implementation(libs.kotlin.node)

diff --git a/gateway/src/commonMain/kotlin/DefaultGateway.kt b/gateway/src/commonMain/kotlin/DefaultGateway.kt
@@ -7,6 +7,7 @@ import dev.kord.gateway.GatewayCloseCode.*
 import dev.kord.gateway.handler.*
 import dev.kord.gateway.ratelimit.IdentifyRateLimiter
 import dev.kord.gateway.retry.Retry
+import io.github.oshai.kotlinlogging.KotlinLogging
 import io.ktor.client.*
 import io.ktor.client.plugins.websocket.*
 import io.ktor.client.request.*
@@ -22,7 +23,6 @@ import kotlinx.coroutines.flow.*
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
 import kotlinx.serialization.json.Json
-import mu.KotlinLogging
 import kotlin.contracts.InvocationKind
 import kotlin.contracts.contract
 import kotlin.coroutines.CoroutineContext
@@ -119,7 +119,7 @@ public class DefaultGateway(private val data: DefaultGatewayData) : Gateway {
                  */
                 inflater = Inflater()
             } catch (exception: Exception) {
-                defaultGatewayLogger.error(exception)
+                defaultGatewayLogger.error(exception) { "" }
                 if (exception.isTimeout()) {
                     data.eventFlow.emit(Close.Timeout)
                 }
@@ -131,15 +131,15 @@ public class DefaultGateway(private val data: DefaultGatewayData) : Gateway {
             try {
                 readSocket()
             } catch (exception: Exception) {
-                defaultGatewayLogger.error(exception)
+                defaultGatewayLogger.error(exception) { "" }
             }
 
             defaultGatewayLogger.trace { "gateway connection closing" }
 
             try {
                 handleClose()
             } catch (exception: Exception) {
-                defaultGatewayLogger.error(exception)
+                defaultGatewayLogger.error(exception) { "" }
             }
 
             defaultGatewayLogger.trace { "handled gateway connection closed" }
@@ -189,7 +189,7 @@ public class DefaultGateway(private val data: DefaultGatewayData) : Gateway {
             val event = jsonParser.decodeFromString(Event.DeserializationStrategy, json) ?: return
             data.eventFlow.emit(event)
         } catch (exception: Exception) {
-            defaultGatewayLogger.error(exception)
+            defaultGatewayLogger.error(exception) { "" }
         }
 
     }

diff --git a/gateway/src/commonMain/kotlin/Event.kt b/gateway/src/commonMain/kotlin/Event.kt
@@ -4,6 +4,7 @@ import dev.kord.common.entity.*
 import dev.kord.common.entity.optional.Optional
 import dev.kord.common.entity.optional.OptionalSnowflake
 import dev.kord.common.serialization.DurationInSeconds
+import io.github.oshai.kotlinlogging.KotlinLogging
 import kotlinx.datetime.Instant
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.KSerializer
@@ -21,7 +22,6 @@ import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
 import kotlinx.serialization.json.JsonElement
 import kotlinx.serialization.json.JsonObject
-import mu.KotlinLogging
 import kotlin.jvm.JvmField
 import kotlinx.serialization.DeserializationStrategy as KDeserializationStrategy
 

diff --git a/gateway/src/commonMain/kotlin/Gateway.kt b/gateway/src/commonMain/kotlin/Gateway.kt
@@ -4,11 +4,10 @@ import dev.kord.common.entity.Snowflake
 import dev.kord.common.entity.optional.Optional
 import dev.kord.gateway.builder.PresenceBuilder
 import dev.kord.gateway.builder.RequestGuildMembersBuilder
+import io.github.oshai.kotlinlogging.KotlinLogging
 import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.flow.*
-import mu.KLogger
-import mu.KotlinLogging
 import kotlin.contracts.InvocationKind
 import kotlin.contracts.contract
 import kotlin.coroutines.CoroutineContext
@@ -140,11 +139,18 @@ public suspend inline fun Gateway.start(token: String, config: GatewayConfigurat
     start(builder.build())
 }
 
+@Suppress("unused")
+@Deprecated("Binary compatibility, remove after deprecation cycle.", level = DeprecationLevel.WARNING)
+@PublishedApi
+internal val gatewayOnLogger: mu.KLogger = mu.KotlinLogging.logger("Gateway.on")
+
 /**
- * Logger used to report throwables caught in [Gateway.on].
+ * Logger used to report [Throwable]s caught in [Gateway.on].
  */
+private val logger = KotlinLogging.logger("Gateway.on")
+
 @PublishedApi
-internal val gatewayOnLogger: KLogger = KotlinLogging.logger("Gateway.on")
+internal fun logCaughtThrowable(throwable: Throwable): Unit = logger.catching(throwable)
 
 /**
  * Convenience method that will invoke the [consumer] on every event [T] created by [Gateway.events].
@@ -162,7 +168,7 @@ public inline fun <reified T : Event> Gateway.on(
     crossinline consumer: suspend T.() -> Unit
 ): Job {
     return this.events.buffer(Channel.UNLIMITED).filterIsInstance<T>().onEach {
-        launch { it.runCatching { it.consumer() }.onFailure(gatewayOnLogger::error) }
+        launch { it.runCatching { it.consumer() }.onFailure(::logCaughtThrowable) }
     }.launchIn(scope)
 }
 

diff --git a/gateway/src/commonMain/kotlin/Ticker.kt b/gateway/src/commonMain/kotlin/Ticker.kt
@@ -1,13 +1,13 @@
 package dev.kord.gateway
 
+import io.github.oshai.kotlinlogging.KotlinLogging
 import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.flow
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
-import mu.KotlinLogging
 import kotlin.coroutines.CoroutineContext
 
 private val logger = KotlinLogging.logger { }
@@ -33,7 +33,7 @@ public class Ticker(private val dispatcher: CoroutineDispatcher = Dispatchers.De
                 try {
                     block()
                 } catch (exception: Exception) {
-                    logger.error(exception)
+                    logger.error(exception) { "" }
                 }
             }.launchIn(this)
         }

diff --git a/gateway/src/commonMain/kotlin/Utils.kt b/gateway/src/commonMain/kotlin/Utils.kt
@@ -2,5 +2,7 @@ package dev.kord.gateway
 
 import mu.KLogger
 
+@Suppress("DeprecatedCallableAddReplaceWith")
+@Deprecated("Binary compatibility, remove after deprecation cycle.", level = DeprecationLevel.WARNING)
 @PublishedApi
 internal fun KLogger.error(throwable: Throwable): Unit = error(throwable) { "" }
diff --git a/gateway/src/commonMain/kotlin/handler/Handler.kt b/gateway/src/commonMain/kotlin/handler/Handler.kt
@@ -1,12 +1,12 @@
 package dev.kord.gateway.handler
 
 import dev.kord.gateway.Event
+import io.github.oshai.kotlinlogging.KotlinLogging
 import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.filterIsInstance
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
-import mu.KotlinLogging
 import kotlin.coroutines.CoroutineContext
 
 private val logger = KotlinLogging.logger("[Handler]")

diff --git a/gateway/src/commonMain/kotlin/ratelimit/IdentifyRateLimiter.kt b/gateway/src/commonMain/kotlin/ratelimit/IdentifyRateLimiter.kt
@@ -1,6 +1,7 @@
 package dev.kord.gateway.ratelimit
 
 import dev.kord.gateway.*
+import io.github.oshai.kotlinlogging.KotlinLogging
 import kotlinx.atomicfu.atomic
 import kotlinx.atomicfu.getAndUpdate
 import kotlinx.atomicfu.loop
@@ -11,7 +12,6 @@ import kotlinx.coroutines.channels.onSuccess
 import kotlinx.coroutines.flow.*
 import kotlinx.coroutines.selects.onTimeout
 import kotlinx.coroutines.selects.select
-import mu.KotlinLogging
 import kotlin.jvm.JvmField
 import kotlin.time.Duration.Companion.seconds
 

diff --git a/gateway/src/commonMain/kotlin/retry/LinearRetry.kt b/gateway/src/commonMain/kotlin/retry/LinearRetry.kt
@@ -1,9 +1,9 @@
 package dev.kord.gateway.retry
 
+import io.github.oshai.kotlinlogging.KotlinLogging
 import kotlinx.atomicfu.atomic
 import kotlinx.atomicfu.update
 import kotlinx.coroutines.delay
-import mu.KotlinLogging
 import kotlin.time.Duration
 import kotlin.time.times