Initial work on exposing async methods

Move message processors into their own package
Update ktor

CHANGELOG

@@ -1,5 +1,7 @@
 vNEXT (in development)
 
+ * (Internal) Moved message processors into their own package
+
 v0.10.0
 
  * Batch start and end events are no longer included in BatchReceived events

build.gradle.kts

@@ -37,8 +37,8 @@ repositories {
 dependencies {
     implementation(kotlin("stdlib-jdk8", "1.3.21"))
     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.1.1")
-    implementation("io.ktor:ktor-network:1.1.2")
-    implementation("io.ktor:ktor-network-tls:1.1.2")
+    implementation("io.ktor:ktor-network:1.1.3")
+    implementation("io.ktor:ktor-network-tls:1.1.3")
 
     testImplementation("org.junit.jupiter:junit-jupiter-api:5.4.0")
     testImplementation("org.junit.jupiter:junit-jupiter-params:5.4.0")

src/main/kotlin/com/dmdirc/ktirc/IrcClient.kt

@@ -5,6 +5,7 @@ import com.dmdirc.ktirc.io.CaseMapping
 import com.dmdirc.ktirc.messages.sendJoin
 import com.dmdirc.ktirc.model.*
 import com.dmdirc.ktirc.util.RemoveIn
+import kotlinx.coroutines.Deferred
 
 /**
  * Primary interface for interacting with KtIrc.
@@ -65,8 +66,11 @@ interface IrcClient {
      * This should only be needed to send raw/custom commands; standard messages can be sent using the
      * extension methods in [com.dmdirc.ktirc.messages] such as [sendJoin].
      *
+     * This method will return immediately; the message will be delivered by a coroutine. Messages
+     * are guaranteed to be delivered in order when this method is called multiple times.
+     *
      * @param tags The IRCv3 tags to prefix the message with, if any.
-     * @param command The command to be sent
+     * @param command The command to be sent.
      * @param arguments The arguments to the command.
      */
     fun send(tags: Map<MessageTag, String>, command: String, vararg arguments: String)
@@ -77,11 +81,47 @@ interface IrcClient {
      * This should only be needed to send raw/custom commands; standard messages can be sent using the
      * extension methods in [com.dmdirc.ktirc.messages] such as [sendJoin].
      *
-     * @param command The command to be sent
+     * This method will return immediately; the message will be delivered by a coroutine. Messages
+     * are guaranteed to be delivered in order when this method is called multiple times.
+     *
+     * @param command The command to be sent.
      * @param arguments The arguments to the command.
      */
     fun send(command: String, vararg arguments: String) = send(emptyMap(), command, *arguments)
 
+    /**
+     * Sends the given command to the IRC server, and waits for a response back.
+     *
+     * This should only be needed to send raw/custom commands; standard messages can be sent using the
+     * extension methods in [com.dmdirc.ktirc.messages] such as TODO: sendJoinAsync.
+     *
+     * This method will return immediately. If the server supports the labeled-responses capability,
+     * the returned [Deferred] will be eventually populated with the response from the server. If
+     * the server does not support the capability, or the response times out, `null` will be supplied.
+     *
+     * @param command The command to be sent.
+     * @param arguments The arguments to the command.
+     * @return A deferred [IrcEvent]? that contains the server's response to the command.
+     */
+    fun sendAsync(command: String, vararg arguments: String) = sendAsync(emptyMap(),  command, *arguments)
+
+    /**
+     * Sends the given command to the IRC server, and waits for a response back.
+     *
+     * This should only be needed to send raw/custom commands; standard messages can be sent using the
+     * extension methods in [com.dmdirc.ktirc.messages] such as TODO: sendJoinAsync.
+     *
+     * This method will return immediately. If the server supports the labeled-responses capability,
+     * the returned [Deferred] will be eventually populated with the response from the server. If
+     * the server does not support the capability, or the response times out, `null` will be supplied.
+     *
+     * @param tags The IRCv3 tags to prefix the message with, if any.
+     * @param command The command to be sent.
+     * @param arguments The arguments to the command.
+     * @return A deferred [IrcEvent]? that contains the server's response to the command.
+     */
+    fun sendAsync(tags: Map<MessageTag, String>, command: String, vararg arguments: String): Deferred<IrcEvent?>
+
     /**
      * Registers a new handler for all events on this connection.
      *

src/main/kotlin/com/dmdirc/ktirc/IrcClientImpl.kt

@@ -8,14 +8,19 @@ import com.dmdirc.ktirc.io.LineBufferedSocket
 import com.dmdirc.ktirc.io.MessageHandler
 import com.dmdirc.ktirc.io.MessageParser
 import com.dmdirc.ktirc.messages.*
+import com.dmdirc.ktirc.messages.processors.messageProcessors
 import com.dmdirc.ktirc.model.*
 import com.dmdirc.ktirc.util.currentTimeProvider
 import com.dmdirc.ktirc.util.generateLabel
 import com.dmdirc.ktirc.util.logger
 import io.ktor.util.KtorExperimentalAPI
 import kotlinx.coroutines.*
+import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.channels.map
+import kotlinx.coroutines.time.withTimeoutOrNull
+import java.time.Duration
 import java.util.concurrent.atomic.AtomicBoolean
+import java.util.logging.Level
 
 /**
  * Concrete implementation of an [IrcClient].
@@ -33,6 +38,8 @@ internal class IrcClientImpl(private val config: IrcClientConfig) : IrcClient, C
     @KtorExperimentalAPI
     internal var socketFactory: (CoroutineScope, String, Int, Boolean) -> LineBufferedSocket = ::KtorLineBufferedSocket
 
+    internal var asyncTimeout = Duration.ofSeconds(20)
+
     override var behaviour = config.behaviour
 
     override val serverState = ServerState(config.profile.nickname, config.server.host, config.sasl)
@@ -57,16 +64,17 @@ internal class IrcClientImpl(private val config: IrcClientConfig) : IrcClient, C
                 ?: log.warning { "No send channel for command: $command" }
     }
 
-    // TODO: This will become sendAsync and return a Deferred<IrcEvent>
-    internal fun sendWithLabel(tags: Map<MessageTag, String>, command: String, vararg arguments: String) {
-        maybeEchoMessage(command, arguments)
-        val tagseToSend = if (Capability.LabeledResponse in serverState.capabilities.enabledCapabilities) {
-            tags + (MessageTag.Label to generateLabel(this))
+    override fun sendAsync(tags: Map<MessageTag, String>, command: String, vararg arguments: String) = async {
+        if (serverState.supportsLabeledResponses) {
+            val label = generateLabel(this@IrcClientImpl)
+            val channel = Channel<IrcEvent>(1)
+            serverState.labelChannels[label] = channel
+            send(tags + (MessageTag.Label to label), command, *arguments)
+            withTimeoutOrNull(asyncTimeout) { channel.receive() }.also { serverState.labelChannels.remove(label) }
         } else {
-            tags
+            send(tags, command, *arguments)
+            null
         }
-        socket?.sendChannel?.offer(messageBuilder.build(tagseToSend, command, arguments))
-                ?: log.warning { "No send channel for command: $command" }
     }
 
     override fun connect() {
@@ -88,6 +96,7 @@ internal class IrcClientImpl(private val config: IrcClientConfig) : IrcClient, C
                     sendUser(config.profile.username, config.profile.realName)
                     messageHandler.processMessages(this@IrcClientImpl, receiveChannel.map { parser.parse(it) })
                 } catch (ex: Exception) {
+                    log.log(Level.SEVERE, ex) { "Error connecting to ${config.server.host}:${config.server.port}" }
                     emitEvent(ServerConnectionError(EventMetadata(currentTimeProvider()), ex.toConnectionError(), ex.localizedMessage))
                 }
 

src/main/kotlin/com/dmdirc/ktirc/events/handlers/EventHandler.kt

@@ -15,5 +15,6 @@ internal val eventHandlers = listOf(
         ChannelStateHandler(),
         PingHandler(),
         ServerStateHandler(),
-        UserStateHandler()
+        UserStateHandler(),
+        LabelledResponseHandler()
 )

src/main/kotlin/com/dmdirc/ktirc/events/handlers/LabelledResponseHandler.kt

@@ -0,0 +1,18 @@
+package com.dmdirc.ktirc.events.handlers
+
+import com.dmdirc.ktirc.IrcClient
+import com.dmdirc.ktirc.events.IrcEvent
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.launch
+
+class LabelledResponseHandler : EventHandler {
+
+    override fun processEvent(client: IrcClient, event: IrcEvent) {
+        event.metadata.label?.let {
+            GlobalScope.launch {
+                client.serverState.labelChannels[it]?.send(event)
+            }
+        }
+    }
+
+}

src/main/kotlin/com/dmdirc/ktirc/events/mutators/BatchMutator.kt

@@ -27,7 +27,7 @@ internal class BatchMutator : EventMutator {
 
     private fun finishBatch(client: IrcClient, event: BatchFinished): List<IrcEvent> {
         client.serverState.batches.remove(event.referenceId)?.let {
-            val batch = BatchReceived(it.events[0].metadata, it.type, it.arguments.toTypedArray(), it.events)
+            val batch = BatchReceived(it.metadata, it.type, it.arguments.toTypedArray(), it.events)
             if (it.metadata.batchId == null) {
                 return listOf(batch)
             } else {

src/main/kotlin/com/dmdirc/ktirc/io/MessageHandler.kt

@@ -4,7 +4,7 @@ import com.dmdirc.ktirc.IrcClient
 import com.dmdirc.ktirc.events.IrcEvent
 import com.dmdirc.ktirc.events.handlers.EventHandler
 import com.dmdirc.ktirc.events.mutators.EventMutator
-import com.dmdirc.ktirc.messages.MessageProcessor
+import com.dmdirc.ktirc.messages.processors.MessageProcessor
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.util.logger
 import kotlinx.coroutines.channels.ReceiveChannel

src/main/kotlin/com/dmdirc/ktirc/messages/AccountProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/AccountProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.UserAccountChanged
 import com.dmdirc.ktirc.model.IrcMessage

src/main/kotlin/com/dmdirc/ktirc/messages/AuthenticationProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/AuthenticationProcessor.kt

@@ -1,8 +1,11 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.AuthenticationMessage
 import com.dmdirc.ktirc.events.SaslFinished
 import com.dmdirc.ktirc.events.SaslMechanismNotAvailableError
+import com.dmdirc.ktirc.messages.ERR_SASLFAIL
+import com.dmdirc.ktirc.messages.RPL_SASLMECHS
+import com.dmdirc.ktirc.messages.RPL_SASLSUCCESS
 import com.dmdirc.ktirc.model.IrcMessage
 
 internal class AuthenticationProcessor : MessageProcessor {

src/main/kotlin/com/dmdirc/ktirc/messages/BatchProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/BatchProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.BatchFinished
 import com.dmdirc.ktirc.events.BatchStarted

src/main/kotlin/com/dmdirc/ktirc/messages/CapabilityProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/CapabilityProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.EventMetadata
 import com.dmdirc.ktirc.events.ServerCapabilitiesAcknowledged

src/main/kotlin/com/dmdirc/ktirc/messages/ChangeHostProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/ChangeHostProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.UserHostChanged
 import com.dmdirc.ktirc.model.IrcMessage

src/main/kotlin/com/dmdirc/ktirc/messages/ISupportProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/ISupportProcessor.kt

@@ -1,7 +1,8 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ServerFeaturesUpdated
 import com.dmdirc.ktirc.io.CaseMapping
+import com.dmdirc.ktirc.messages.RPL_ISUPPORT
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.model.ModePrefixMapping
 import com.dmdirc.ktirc.model.ServerFeatureMap

src/main/kotlin/com/dmdirc/ktirc/messages/JoinProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/JoinProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ChannelJoined
 import com.dmdirc.ktirc.model.IrcMessage

src/main/kotlin/com/dmdirc/ktirc/messages/KickProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/KickProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ChannelUserKicked
 import com.dmdirc.ktirc.model.IrcMessage

src/main/kotlin/com/dmdirc/ktirc/messages/MessageProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/MessageProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.IrcEvent
 import com.dmdirc.ktirc.model.IrcMessage

src/main/kotlin/com/dmdirc/ktirc/messages/ModeProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/ModeProcessor.kt

@@ -1,6 +1,8 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ModeChanged
+import com.dmdirc.ktirc.messages.RPL_CHANNELMODEIS
+import com.dmdirc.ktirc.messages.RPL_UMODEIS
 import com.dmdirc.ktirc.model.IrcMessage
 
 internal class ModeProcessor : MessageProcessor {

src/main/kotlin/com/dmdirc/ktirc/messages/MotdProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/MotdProcessor.kt

@@ -1,7 +1,11 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.MotdFinished
 import com.dmdirc.ktirc.events.MotdLineReceived
+import com.dmdirc.ktirc.messages.ERR_NOMOTD
+import com.dmdirc.ktirc.messages.RPL_ENDOFMOTD
+import com.dmdirc.ktirc.messages.RPL_MOTD
+import com.dmdirc.ktirc.messages.RPL_MOTDSTART
 import com.dmdirc.ktirc.model.IrcMessage
 
 internal class MotdProcessor : MessageProcessor {

src/main/kotlin/com/dmdirc/ktirc/messages/NamesProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/NamesProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ChannelNamesFinished
 import com.dmdirc.ktirc.events.ChannelNamesReceived

src/main/kotlin/com/dmdirc/ktirc/messages/NickProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/NickProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.UserNickChanged
 import com.dmdirc.ktirc.model.IrcMessage

src/main/kotlin/com/dmdirc/ktirc/messages/NoticeProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/NoticeProcessor.kt

@@ -1,8 +1,9 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.CtcpReplyReceived
 import com.dmdirc.ktirc.events.IrcEvent
 import com.dmdirc.ktirc.events.NoticeReceived
+import com.dmdirc.ktirc.messages.CTCP_BYTE
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.model.User
 

src/main/kotlin/com/dmdirc/ktirc/messages/PartProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/PartProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ChannelParted
 import com.dmdirc.ktirc.model.IrcMessage

src/main/kotlin/com/dmdirc/ktirc/messages/PingProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/PingProcessor.kt

@@ -1,6 +1,7 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.PingReceived
+import com.dmdirc.ktirc.messages.processors.MessageProcessor
 import com.dmdirc.ktirc.model.IrcMessage
 
 internal class PingProcessor : MessageProcessor {

src/main/kotlin/com/dmdirc/ktirc/messages/PrivmsgProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/PrivmsgProcessor.kt

@@ -1,9 +1,10 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ActionReceived
 import com.dmdirc.ktirc.events.CtcpReceived
 import com.dmdirc.ktirc.events.IrcEvent
 import com.dmdirc.ktirc.events.MessageReceived
+import com.dmdirc.ktirc.messages.CTCP_BYTE
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.model.User
 

src/main/kotlin/com/dmdirc/ktirc/messages/QuitProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/QuitProcessor.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.UserQuit
 import com.dmdirc.ktirc.model.IrcMessage

src/main/kotlin/com/dmdirc/ktirc/messages/TopicProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/TopicProcessor.kt

@@ -1,8 +1,11 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ChannelTopicChanged
 import com.dmdirc.ktirc.events.ChannelTopicDiscovered
 import com.dmdirc.ktirc.events.ChannelTopicMetadataDiscovered
+import com.dmdirc.ktirc.messages.RPL_NOTOPIC
+import com.dmdirc.ktirc.messages.RPL_TOPIC
+import com.dmdirc.ktirc.messages.RPL_TOPICWHOTIME
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.model.asUser
 import com.dmdirc.ktirc.util.currentTimeZoneProvider

src/main/kotlin/com/dmdirc/ktirc/messages/WelcomeProcessor.kt → src/main/kotlin/com/dmdirc/ktirc/messages/processors/WelcomeProcessor.kt

@@ -1,6 +1,7 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ServerWelcome
+import com.dmdirc.ktirc.messages.RPL_WELCOME
 import com.dmdirc.ktirc.model.IrcMessage
 
 internal class WelcomeProcessor : MessageProcessor {

src/main/kotlin/com/dmdirc/ktirc/model/ServerState.kt

@@ -5,6 +5,7 @@ import com.dmdirc.ktirc.events.EventMetadata
 import com.dmdirc.ktirc.events.IrcEvent
 import com.dmdirc.ktirc.io.CaseMapping
 import com.dmdirc.ktirc.util.logger
+import kotlinx.coroutines.channels.SendChannel
 import java.util.concurrent.atomic.AtomicLong
 import kotlin.reflect.KClass
 
@@ -76,6 +77,17 @@ class ServerState internal constructor(
      */
     internal val labelCounter = AtomicLong(0)
 
+    /**
+     * Whether or not the server supports labeled responses.
+     */
+    internal val supportsLabeledResponses: Boolean
+        get() = Capability.LabeledResponse in capabilities.enabledCapabilities
+
+    /**
+     * Channels waiting for a label to be received.
+     */
+    internal val labelChannels = mutableMapOf<String, SendChannel<IrcEvent>>()
+
     /**
      * Determines if the given mode is one applied to a user of a channel, such as 'o' for operator.
      */
@@ -107,6 +119,7 @@ class ServerState internal constructor(
         sasl.reset()
         batches.clear()
         labelCounter.set(0)
+        labelChannels.clear()
     }
 
 }
@@ -122,7 +135,8 @@ class ServerFeatureMap {
      * Gets the value, or the default value, of the given feature.
      */
     @Suppress("UNCHECKED_CAST")
-    operator fun <T : Any> get(feature: ServerFeature<T>) = features.getOrDefault(feature, feature.default) as? T? ?: feature.default
+    operator fun <T : Any> get(feature: ServerFeature<T>) = features.getOrDefault(feature, feature.default) as? T?
+            ?: feature.default
 
     internal operator fun set(feature: ServerFeature<*>, value: Any) {
         require(feature.type.isInstance(value)) {
@@ -146,10 +160,13 @@ data class ModePrefixMapping(val modes: String, val prefixes: String) {
 
     /** Determines whether the given character is a mode prefix (e.g. "@", "+"). */
     fun isPrefix(char: Char) = prefixes.contains(char)
+
     /** Determines whether the given character is a channel user mode (e.g. "o", "v"). */
     fun isMode(char: Char) = modes.contains(char)
+
     /** Gets the mode corresponding to the given prefix (e.g. "@" -> "o"). */
     fun getMode(prefix: Char) = modes[prefixes.indexOf(prefix)]
+
     /** Gets the modes corresponding to the given prefixes (e.g. "@+" -> "ov"). */
     fun getModes(prefixes: String) = String(prefixes.map(this::getMode).toCharArray())
 
@@ -161,18 +178,25 @@ data class ModePrefixMapping(val modes: String, val prefixes: String) {
 sealed class ServerFeature<T : Any>(val name: String, val type: KClass<T>, val default: T? = null) {
     /** The network the server says it belongs to. */
     object Network : ServerFeature<String>("NETWORK", String::class)
+
     /** The case mapping the server uses, defaulting to RFC. */
     object ServerCaseMapping : ServerFeature<CaseMapping>("CASEMAPPING", CaseMapping::class, CaseMapping.Rfc)
+
     /** The mode prefixes the server uses, defaulting to ov/@+. */
     object ModePrefixes : ServerFeature<ModePrefixMapping>("PREFIX", ModePrefixMapping::class, ModePrefixMapping("ov", "@+"))
+
     /** The maximum number of channels a client may join. */
     object MaximumChannels : ServerFeature<Int>("MAXCHANNELS", Int::class) // TODO: CHANLIMIT also exists
+
     /** The modes supported in channels. */
     object ChannelModes : ServerFeature<Array<String>>("CHANMODES", Array<String>::class)
+
     /** The types of channels supported. */
     object ChannelTypes : ServerFeature<String>("CHANTYPES", String::class, "#&")
+
     /** The maximum length of a channel name, defaulting to 200. */
     object MaximumChannelNameLength : ServerFeature<Int>("CHANNELLEN", Int::class, 200)
+
     /** Whether or not the server supports extended who. */
     object WhoxSupport : ServerFeature<Boolean>("WHOX", Boolean::class, false)
 }

src/test/kotlin/com/dmdirc/ktirc/IrcClientImplTest.kt

@@ -294,7 +294,7 @@ internal class IrcClientImplTest {
         client.socketFactory = mockSocketFactory
         client.connect()
 
-        client.sendWithLabel(tagMap(), "testing", "123")
+        client.sendAsync(tagMap(), "testing", "123")
 
         assertLineReceived("testing 123")
     }
@@ -307,7 +307,7 @@ internal class IrcClientImplTest {
         client.serverState.capabilities.enabledCapabilities[Capability.LabeledResponse] = ""
         client.connect()
 
-        client.sendWithLabel(tagMap(), "testing", "123")
+        client.sendAsync(tagMap(), "testing", "123")
 
         assertLineReceived("@draft/label=abc123 testing 123")
     }
@@ -320,7 +320,7 @@ internal class IrcClientImplTest {
         client.serverState.capabilities.enabledCapabilities[Capability.LabeledResponse] = ""
         client.connect()
 
-        client.sendWithLabel(tagMap(MessageTag.AccountName to "x"), "testing", "123")
+        client.sendAsync(tagMap(MessageTag.AccountName to "x"), "testing", "123")
 
         assertLineReceived("@account=x;draft/label=abc123 testing 123")
     }

src/test/kotlin/com/dmdirc/ktirc/events/mutators/BatchMutatorTest.kt

@@ -94,6 +94,19 @@ internal class BatchMutatorTest {
         assertTrue(event.events[0] is ServerConnected)
     }
 
+    @Test
+    fun `sends finished batch with correct metadata`() {
+        val metadata = EventMetadata(TestConstants.time, label = "1234")
+        fakeServerState.batches["abcdef"] = Batch("netsplit", listOf("p1", "p2"), metadata, events = mutableListOf(ServerConnected(EventMetadata(TestConstants.time, "abcdef"))))
+
+        val events = mutator.mutateEvent(ircClient, messageEmitter, BatchFinished(EventMetadata(TestConstants.time), "abcdef"))
+
+        assertEquals(1, events.size)
+        assertTrue(events[0] is BatchReceived)
+        val event = events[0] as BatchReceived
+        assertSame(metadata, event.metadata)
+    }
+
     @Test
     fun `adds a batch to its parent when it finishes`() {
         fakeServerState.batches["12345"] = Batch("history", emptyList(), EventMetadata(TestConstants.time))

src/test/kotlin/com/dmdirc/ktirc/io/MessageHandlerTest.kt

@@ -5,7 +5,7 @@ import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.events.*
 import com.dmdirc.ktirc.events.handlers.EventHandler
 import com.dmdirc.ktirc.events.mutators.EventMutator
-import com.dmdirc.ktirc.messages.MessageProcessor
+import com.dmdirc.ktirc.messages.processors.MessageProcessor
 import com.dmdirc.ktirc.model.IrcMessage
 import io.mockk.*
 import kotlinx.coroutines.channels.Channel

src/test/kotlin/com/dmdirc/ktirc/messages/AccountProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/AccountProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.model.IrcMessage

src/test/kotlin/com/dmdirc/ktirc/messages/AuthenticationProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/AuthenticationProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.events.AuthenticationMessage

src/test/kotlin/com/dmdirc/ktirc/messages/BatchProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/BatchProcessorTest.kt

@@ -1,8 +1,9 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.events.BatchFinished
 import com.dmdirc.ktirc.events.BatchStarted
+import com.dmdirc.ktirc.messages.processors.BatchProcessor
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.params
 import com.dmdirc.ktirc.util.currentTimeProvider

src/test/kotlin/com/dmdirc/ktirc/messages/CapabilityProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/CapabilityProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ServerCapabilitiesAcknowledged
 import com.dmdirc.ktirc.events.ServerCapabilitiesFinished

src/test/kotlin/com/dmdirc/ktirc/messages/ChangeHostProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/ChangeHostProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.model.User

src/test/kotlin/com/dmdirc/ktirc/messages/ISupportProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/ISupportProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.io.CaseMapping
 import com.dmdirc.ktirc.model.IrcMessage

src/test/kotlin/com/dmdirc/ktirc/messages/JoinProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/JoinProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.model.IrcMessage

src/test/kotlin/com/dmdirc/ktirc/messages/KickProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/KickProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.model.IrcMessage

src/test/kotlin/com/dmdirc/ktirc/messages/ModeProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/ModeProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.model.IrcMessage

src/test/kotlin/com/dmdirc/ktirc/messages/MotdProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/MotdProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.events.MotdFinished

src/test/kotlin/com/dmdirc/ktirc/messages/NamesProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/NamesProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.events.ChannelNamesFinished
 import com.dmdirc.ktirc.events.ChannelNamesReceived

src/test/kotlin/com/dmdirc/ktirc/messages/NickProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/NickProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.params

src/test/kotlin/com/dmdirc/ktirc/messages/NoticeProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/NoticeProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.events.CtcpReplyReceived

src/test/kotlin/com/dmdirc/ktirc/messages/PartProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/PartProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.model.IrcMessage

src/test/kotlin/com/dmdirc/ktirc/messages/PrivmsgProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/PrivmsgProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.events.ActionReceived

src/test/kotlin/com/dmdirc/ktirc/messages/QuitProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/QuitProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.model.IrcMessage

src/test/kotlin/com/dmdirc/ktirc/messages/TopicProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/TopicProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.events.ChannelTopicChanged

src/test/kotlin/com/dmdirc/ktirc/messages/WelcomeProcessorTest.kt → src/test/kotlin/com/dmdirc/ktirc/messages/processors/WelcomeProcessorTest.kt

@@ -1,4 +1,4 @@
-package com.dmdirc.ktirc.messages
+package com.dmdirc.ktirc.messages.processors
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.model.IrcMessage

src/test/kotlin/com/dmdirc/ktirc/model/ServerStateTest.kt

@@ -2,6 +2,7 @@ package com.dmdirc.ktirc.model
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.events.EventMetadata
+import kotlinx.coroutines.channels.Channel
 import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.Test
 
@@ -60,6 +61,19 @@ internal class ServerStateTest {
         assertEquals(ChannelModeType.NoParameter, serverState.channelModeType('b'))
     }
 
+    @Test
+    fun `indicates labels are enabled when cap is present`() {
+        val serverState = ServerState("acidBurn", "")
+        serverState.capabilities.enabledCapabilities[Capability.LabeledResponse] = ""
+        assertTrue(serverState.supportsLabeledResponses)
+    }
+
+    @Test
+    fun `indicates labels are not enabled when cap is absent`() {
+        val serverState = ServerState("acidBurn", "")
+        assertFalse(serverState.supportsLabeledResponses)
+    }
+
     @Test
     fun `reset clears all state`() = with(ServerState("acidBurn", "")) {
         receivedWelcome = true
@@ -71,6 +85,7 @@ internal class ServerStateTest {
         sasl.saslBuffer = "in progress"
         batches["batch"] = Batch("type", emptyList(), EventMetadata(TestConstants.time))
         labelCounter.set(100)
+        labelChannels["#thegibson"] = Channel(1)
 
         reset()
 
@@ -83,6 +98,7 @@ internal class ServerStateTest {
         assertEquals("", sasl.saslBuffer)
         assertTrue(batches.isEmpty())
         assertEquals(0, labelCounter.get())
+        assertTrue(labelChannels.isEmpty())
     }
 
 }