Skip to content

kRPC client initialization is not single shot #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2025
Merged

kRPC client initialization is not single shot #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions krpc/krpc-client/src/commonMain/kotlin/kotlinx/rpc/krpc/client/KrpcClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.FlowCollector
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.flow.flow
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
import kotlinx.rpc.RpcCall
import kotlinx.rpc.RpcClient
import kotlinx.rpc.annotations.Rpc
Expand Down Expand Up @@ -47,7 +49,7 @@ import kotlin.properties.Delegates
public abstract class InitializedKrpcClient(
private val config: KrpcConfig.Client,
private val transport: KrpcTransport,
): KrpcClient() {
) : KrpcClient() {
final override suspend fun initializeTransport(): KrpcTransport {
return transport
}
Expand Down Expand Up @@ -179,18 +181,28 @@ public abstract class KrpcClient : RpcClient, KrpcEndpoint {
// callId to serviceTypeString
private val cancellingRequests = RpcInternalConcurrentHashMap<String, String>()

private val transportInitializationLock = Mutex()

/**
* Starts the handshake process and awaits for completion.
* If the handshake was completed before, nothing happens.
*/
private suspend fun initializeAndAwaitHandshakeCompletion() {
transport = initializeTransport()
isTransportReady = true
if (!isTransportReady) {
transportInitializationLock.withLock {
if (isTransportReady) {
return@withLock
}

connector.subscribeToGenericMessages(::handleGenericMessage)
connector.subscribeToProtocolMessages(::handleProtocolMessage)
transport = initializeTransport()
isTransportReady = true

connector.sendMessage(KrpcProtocolMessage.Handshake(KrpcPlugin.ALL))
connector.subscribeToGenericMessages(::handleGenericMessage)
connector.subscribeToProtocolMessages(::handleProtocolMessage)

connector.sendMessage(KrpcProtocolMessage.Handshake(KrpcPlugin.ALL))
}
}

serverSupportedPlugins.await()
}
Expand Down
45 changes: 42 additions & 3 deletions krpc/krpc-test/src/commonTest/kotlin/kotlinx/rpc/krpc/test/TransportTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ import kotlinx.coroutines.test.TestResult
import kotlinx.coroutines.test.TestScope
import kotlinx.rpc.*
import kotlinx.rpc.annotations.Rpc
import kotlinx.rpc.krpc.KrpcConfig
import kotlinx.rpc.krpc.KrpcConfigBuilder
import kotlinx.rpc.krpc.KrpcTransport
import kotlinx.rpc.krpc.client.KrpcClient
import kotlinx.rpc.krpc.internal.KrpcProtocolMessage
import kotlinx.rpc.krpc.internal.logging.RpcInternalCommonLogger
import kotlinx.rpc.krpc.internal.logging.RpcInternalDumpLogger
import kotlinx.rpc.krpc.internal.logging.RpcInternalDumpLoggerContainer
Expand Down Expand Up @@ -76,21 +80,24 @@ class TransportTest {
return KrpcTestServer(serverConfig, localTransport.server)
}

private fun runTest(block: suspend TestScope.() -> Unit): TestResult =
private fun runTest(block: suspend TestScope.(logs: List<String>) -> Unit): TestResult =
kotlinx.coroutines.test.runTest(timeout = 20.seconds) {
debugCoroutines()

val logger = RpcInternalCommonLogger.logger("TransportTest")

val logs = mutableListOf<String>()
RpcInternalDumpLoggerContainer.set(object : RpcInternalDumpLogger {
override val isEnabled: Boolean = true

override fun dump(vararg tags: String, message: () -> String) {
logger.info { "${tags.joinToString(" ") { "[$it]" }} ${message()}" }
val message = "${tags.joinToString(" ") { "[$it]" }} ${message()}"
logs.add(message)
logger.info { message }
}
})

block()
block(logs)

RpcInternalDumpLoggerContainer.set(null)
}
Expand Down Expand Up @@ -240,6 +247,38 @@ class TransportTest {
transports.cancel()
}

private val clientHandshake = ".*\\[Client] \\[Send] \\{\"type\":\"${KrpcProtocolMessage.Handshake.serializer().descriptor.serialName}\".*+".toRegex()

@Test
fun transportInitializedOnlyOnce() = runTest { logs ->
val localTransport = LocalTransport()
var transportInitialized = 0
var configInitialized = 0
val client = object : KrpcClient() {
override suspend fun initializeTransport(): KrpcTransport {
transportInitialized++
return localTransport.client
}

override fun initializeConfig(): KrpcConfig.Client {
configInitialized++
return clientConfig
}
}

val server = serverOf(localTransport)

server.registerServiceAndReturn<Echo, _> { EchoImpl() }
server.registerServiceAndReturn<Second, _> { SecondServer() }

client.withService<Echo>().apply { echo("foo"); echo("bar") }
client.withService<Second>().apply{ second("bar"); second("baz") }

assertEquals(1, transportInitialized)
assertEquals(1, configInitialized)
assertEquals(1, logs.count { it.matches(clientHandshake) })
}

private inline fun <@Rpc reified Service : Any, reified Impl : Service> RpcServer.registerServiceAndReturn(
crossinline body: () -> Impl,
): List<Impl> {
Expand Down