Add coroutines support

Author: yttrian

README.md

@@ -26,7 +26,7 @@ dependencies {
     implementation("net.dv8tion:JDA:4.2.0_227") {
         exclude(module = "opus-java") // optional, for if you don't plan to use voice chat
     }
-    implementation("org.yttr:koncorda:0.1.2")
+    implementation("org.yttr:koncorda:0.2.0")
 }
 ```
 

build.gradle.kts

@@ -1,12 +1,12 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 group = "org.yttr"
-version = "0.1.2"
+version = "0.2.0"
 
 plugins {
     id("tanvd.kosogor") version "1.0.10" apply true
     id("io.gitlab.arturbosch.detekt") version "1.15.0" apply true
-    kotlin("jvm") version "1.4.21" apply false
+    kotlin("jvm") version "1.4.30" apply false
 }
 
 subprojects {

gradle.properties

@@ -1,2 +1,6 @@
 # suppress inspection "UnusedProperty" for whole file
 kotlin.code.style=official
+jdaVersion=4.2.0_227
+hoconVersion=1.4.1
+coroutinesVersion=1.4.2
+logbackVersion=1.2.3

koncorda/build.gradle.kts

@@ -3,12 +3,19 @@ import tanvd.kosogor.proxy.publishJar
 group = rootProject.group
 version = rootProject.version
 
+val jdaVersion: String by project
+val hoconVersion: String by project
+val coroutinesVersion: String by project
+val logbackVersion: String by project
+
 dependencies {
-    implementation("net.dv8tion:JDA:4.2.0_227") {
+    implementation("net.dv8tion:JDA:$jdaVersion") {
         exclude(module = "opus-java")
     }
-    api("com.typesafe:config:1.4.1")
-    testImplementation("ch.qos.logback:logback-classic:1.2.3")
+    api("com.typesafe:config:$hoconVersion")
+    api("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutinesVersion")
+    api("org.jetbrains.kotlinx:kotlinx-coroutines-jdk8:$coroutinesVersion")
+    testImplementation("ch.qos.logback:logback-classic:$logbackVersion")
 }
 
 publishJar {

koncorda/src/main/kotlin/Koncorda.kt

@@ -2,6 +2,10 @@ package org.yttr.koncorda
 
 import com.typesafe.config.Config
 import com.typesafe.config.ConfigFactory
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.launch
 import net.dv8tion.jda.api.JDABuilder
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent
 import net.dv8tion.jda.api.hooks.ListenerAdapter
@@ -15,6 +19,9 @@ class Koncorda : ListenerAdapter() {
     private val discordToken = conf.getString("koncorda.discord-token")
     private val baseCommands = mutableListOf<Command.Branch>()
 
+    private val job = SupervisorJob()
+    private val scope = CoroutineScope(Dispatchers.Default + job)
+
     /**
      * Explicitly listed gateways intents, defaults to JDA defaults
      */
@@ -36,17 +43,20 @@ class Koncorda : ListenerAdapter() {
         // ignore improper messages
         if (event.isIgnorable) return
 
-        // split the args
-        val args = event.message.contentStripped.trim().split(" ")
+        scope.launch {
+            // split the args
+            val args = event.message.contentStripped.trim().split(" ")
 
-        // find the command handler, if it exists
-        when (val baseCommand = allBaseCommands()[args.first()]) {
-            is Command.Leaf -> baseCommand
-            is Command.Branch -> baseCommand[args.drop(1)]
-            else -> null
-        }?.let {
-            if (it.check(event)) it(event, args) else {
-                event.channel.sendMessage("You are not allowed to use that command.").queue()
+            // find the command handler, if it exists
+            when (val baseCommand = allBaseCommands()[args.first()]) {
+                is Command.Leaf -> baseCommand
+                is Command.Branch -> baseCommand[args.drop(1)]
+                else -> null
+            }?.let {
+                val call = it.createCall(event, args)
+                if (it.check(call)) it.handle(call) else {
+                    event.channel.sendMessage("You are not allowed to use that command.").queue()
+                }
             }
         }
     }

koncorda/src/main/kotlin/command/Command.kt

@@ -24,7 +24,7 @@ sealed class Command(
         private val fallback by lazy {
             if (handler != null) Leaf(depth, handler) else {
                 val autoHelpCommandHandler = object : CommandHandler {
-                    override fun CommandCall.handle() {
+                    override suspend fun CommandCall.handle() {
                         val path = args.joinToString(" ")
                         val validSubcommands = routes.keys.joinToString { "`$it`" }
                         event.respond("Valid subcommands for `$path` are $validSubcommands.")
@@ -62,8 +62,11 @@ sealed class Command(
         private val handler: CommandHandler,
         private val help: Boolean = false
     ) : Command(depth) {
-        operator fun invoke(event: MessageReceivedEvent, args: List<String>) = with(handler) {
-            CommandCall(event, if (help) args.take(depth) else args.drop(depth)).handle()
+        fun createCall(event: MessageReceivedEvent, args: List<String>) =
+            CommandCall(event, if (help) args.take(depth) else args.drop(depth))
+
+        suspend fun handle(call: CommandCall) = with(handler) {
+            call.handle()
         }
 
         override fun addCheck(addedCheck: CommandCheck) {
@@ -91,9 +94,9 @@ sealed class Command(
      * Set the handler.
      */
     @CreationDsl
-    fun Branch.leaf(arg: String, handler: CommandCall.() -> Unit) {
+    fun Branch.leaf(arg: String, handler: suspend CommandCall.() -> Unit) {
         routes["$prefix$arg"] = Leaf(nextDepth, object : CommandHandler {
-            override fun CommandCall.handle() = handler()
+            override suspend fun CommandCall.handle() = handler()
         })
     }
 
@@ -108,5 +111,5 @@ sealed class Command(
 
     abstract fun addCheck(addedCheck: CommandCheck)
 
-    fun check(event: MessageReceivedEvent) = checks.all { it.check(event) }
+    suspend fun check(call: CommandCall) = checks.all { it.check(call) }
 }

koncorda/src/main/kotlin/command/CommandCall.kt

@@ -1,12 +1,13 @@
 package org.yttr.koncorda.command
 
+import kotlinx.coroutines.future.await
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent
 
 data class CommandCall(val event: MessageReceivedEvent, val args: List<String>) {
     /**
      * Respond to the event.
      */
-    fun MessageReceivedEvent.respond(content: String) {
-        if (content.isNotBlank()) channel.sendMessage(content).queue()
+    suspend fun MessageReceivedEvent.respond(content: String) {
+        if (content.isNotBlank()) channel.sendMessage(content).submit().await()
     }
 }

koncorda/src/main/kotlin/command/CommandHandler.kt

@@ -7,5 +7,5 @@ interface CommandHandler {
     /**
      * Handle the message event for a command invocation.
      */
-    fun CommandCall.handle()
+    suspend fun CommandCall.handle()
 }

koncorda/src/main/kotlin/command/check/CommandCheck.kt

@@ -1,7 +1,7 @@
 package org.yttr.koncorda.command.check
 
-import net.dv8tion.jda.api.events.message.MessageReceivedEvent
+import org.yttr.koncorda.command.CommandCall
 
 interface CommandCheck {
-    fun check(event: MessageReceivedEvent): Boolean
+    suspend fun check(call: CommandCall): Boolean
 }

koncorda/src/main/kotlin/command/check/Impossible.kt

@@ -1,7 +1,7 @@
 package org.yttr.koncorda.command.check
 
-import net.dv8tion.jda.api.events.message.MessageReceivedEvent
+import org.yttr.koncorda.command.CommandCall
 
 object Impossible : CommandCheck {
-    override fun check(event: MessageReceivedEvent): Boolean = false
+    override suspend fun check(call: CommandCall): Boolean = false
 }