## refactor: Introduce AbstractClientTransport and simplify client transport lifecycle This PR unifies state management logic across client transports, except for the websocket transport, as it needs more refactoring first and is not the primary transport. - Introduce `AbstractClientTransport` as base class for other client transports. - Migrate to `ClientTransportState` states with state machine, streamline state management. - Ensure proper cleanup and error handling consistency across transport implementations. - Add unit tests to validate `AbstractClientTransport` behavior and state transitions. - Update related documentation and API contract. - Make sure `onClose` callback is called at most once - fix [StreamableHttpClientTransportTest.kt](https://github.com/modelcontextprotocol/kotlin-sdk/pull/516/changes#diff-b9fe8891d08a492448a7ed2dc782151c6a915ae1403a4d70c2034c6062c84cb5) to throw `McpException` on connect when received invalid Json ## Motivation and Context Unify lifecycle handling and eliminate duplication in client Transport implementations. ## How Has This Been Tested? Unit test, regression tests ## Breaking Changes - `onClose` callback is now called only once - send(...) will throw McpException with message "Transport is not ready" when `ClientTransportState != Operational` ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue) - [x] Refactoring - [ ] New feature (non-breaking change which adds functionality) - [x] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context See #517
143 lines
4.2 KiB
Kotlin
143 lines
4.2 KiB
Kotlin
@file:OptIn(ExperimentalWasmDsl::class)
|
|
|
|
import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
|
|
|
|
plugins {
|
|
id("mcp.multiplatform")
|
|
id("mcp.publishing")
|
|
id("mcp.dokka")
|
|
alias(libs.plugins.kotlinx.binary.compatibility.validator)
|
|
alias(libs.plugins.openapi.generator)
|
|
}
|
|
|
|
/*
|
|
tasks.withType<KotlinCompilationTask<*>>().configureEach {
|
|
dependsOn(tasks.openApiGenerate)
|
|
}
|
|
|
|
tasks.named("runKtlintCheckOverCommonMainSourceSet") {
|
|
dependsOn(tasks.openApiGenerate)
|
|
}
|
|
|
|
// Also ensure it runs before other relevant tasks
|
|
tasks.withType<DokkaGenerateTask>().configureEach {
|
|
dependsOn(tasks.openApiGenerate)
|
|
}
|
|
|
|
tasks.withType<Task>().configureEach {
|
|
if (name.lowercase().contains("sourcesjar")) {
|
|
dependsOn(tasks.openApiGenerate)
|
|
}
|
|
}
|
|
*/
|
|
|
|
openApiGenerate {
|
|
val schemaVersion = "2025-03-26" // or "2025-06-18" or "draft"
|
|
val schemaUrl =
|
|
// "https://raw.githubusercontent.com/modelcontextprotocol/modelcontextprotocol/refs/heads/main/schema/$schemaVersion/schema.json"
|
|
"https://raw.githubusercontent.com/modelcontextprotocol/modelcontextprotocol/refs/tags/$schemaVersion/schema/$schemaVersion/schema.json"
|
|
generatorName = "kotlin"
|
|
remoteInputSpec = schemaUrl
|
|
outputDir = layout.buildDirectory.dir("generated-sources/openapi").get().asFile.absolutePath
|
|
packageName = "io.modelcontextprotocol.kotlin.sdk.models"
|
|
modelPackage = "io.modelcontextprotocol.kotlin.sdk.models"
|
|
apiPackage = "io.modelcontextprotocol.kotlin.sdk.api"
|
|
generateModelTests = false
|
|
generateModelDocumentation = false
|
|
cleanupOutput = false
|
|
skipValidateSpec = true // do not validate spec
|
|
library.set("multiplatform")
|
|
ignoreFileOverride.set("${layout.projectDirectory}/.openapi-generator-ignore")
|
|
globalProperties.set(
|
|
mapOf(
|
|
"supportingFiles" to "",
|
|
"models" to "", // or generate all models
|
|
),
|
|
)
|
|
configOptions.set(
|
|
mapOf(
|
|
"omitGradleWrapper" to "true",
|
|
"enumPropertyNaming" to "UPPERCASE",
|
|
"dateLibrary" to "kotlinx-datetime",
|
|
"explicitApi" to "true",
|
|
"modelMutable" to "false",
|
|
),
|
|
)
|
|
}
|
|
|
|
// Generation library versions
|
|
val generateLibVersion by tasks.registering {
|
|
val outputDir = layout.buildDirectory.dir("generated-sources/libVersion")
|
|
outputs.dir(outputDir)
|
|
|
|
// Capture version at configuration time to avoid configuration cache issues
|
|
val projectVersion = project.version.toString()
|
|
|
|
doLast {
|
|
val sourceFile = outputDir.get().file("io/modelcontextprotocol/kotlin/sdk/LibVersion.kt").asFile
|
|
sourceFile.parentFile.mkdirs()
|
|
sourceFile.writeText(
|
|
"""
|
|
package io.modelcontextprotocol.kotlin.sdk
|
|
|
|
public const val LIB_VERSION: String = "$projectVersion"
|
|
|
|
""".trimIndent(),
|
|
)
|
|
}
|
|
}
|
|
|
|
kotlin {
|
|
iosArm64()
|
|
iosX64()
|
|
iosSimulatorArm64()
|
|
watchosX64()
|
|
watchosArm64()
|
|
watchosSimulatorArm64()
|
|
tvosX64()
|
|
tvosArm64()
|
|
tvosSimulatorArm64()
|
|
js {
|
|
browser()
|
|
nodejs()
|
|
}
|
|
wasmJs {
|
|
browser()
|
|
nodejs()
|
|
}
|
|
|
|
sourceSets {
|
|
commonMain {
|
|
kotlin.srcDir(generateLibVersion)
|
|
dependencies {
|
|
api(libs.kotlinx.serialization.json)
|
|
api(libs.kotlinx.coroutines.core)
|
|
api(libs.kotlinx.io.core)
|
|
api(libs.kotlinx.collections.immutable)
|
|
implementation(libs.ktor.server.websockets)
|
|
implementation(libs.kotlin.logging)
|
|
}
|
|
}
|
|
|
|
commonTest {
|
|
dependencies {
|
|
implementation(kotlin("test"))
|
|
implementation(libs.kotlinx.coroutines.test)
|
|
implementation(libs.kotest.assertions.core)
|
|
implementation(libs.kotest.assertions.json)
|
|
}
|
|
}
|
|
|
|
jvmTest {
|
|
dependencies {
|
|
implementation(libs.junit.jupiter.params)
|
|
implementation(libs.mockk)
|
|
runtimeOnly(libs.slf4j.simple)
|
|
}
|
|
}
|
|
|
|
wasmJsMain.dependencies {
|
|
api(libs.kotlinx.coroutines.core.wasm) // workaround for wasm server
|
|
}
|
|
}
|
|
}
|