fix: negotiate protocol version in handler (#930)
* fix: negotiate protocol version in handler (fixes #916) * fix: use server pinned version as fallback in default initialize handler
This commit is contained in:
parent
67a3085944
commit
80a74795e9
2 changed files with 247 additions and 6 deletions
83
crates/rmcp/tests/test_protocol_version_negotiation.rs
Normal file
83
crates/rmcp/tests/test_protocol_version_negotiation.rs
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
//! Tests for protocol version negotiation in the default ServerHandler::initialize impl.
|
||||
//!
|
||||
//! Known versions are echoed back; unknown versions fall back to LATEST.
|
||||
#![cfg(not(feature = "local"))]
|
||||
#![cfg(feature = "client")]
|
||||
|
||||
use rmcp::{
|
||||
ClientHandler, ServerHandler, ServiceExt,
|
||||
model::{ClientInfo, ProtocolVersion, ServerInfo},
|
||||
};
|
||||
|
||||
#[derive(Debug, Clone, Default)]
|
||||
struct EchoServer;
|
||||
|
||||
impl ServerHandler for EchoServer {
|
||||
fn get_info(&self) -> ServerInfo {
|
||||
ServerInfo::default()
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone)]
|
||||
struct VersionedClient {
|
||||
protocol_version: ProtocolVersion,
|
||||
}
|
||||
|
||||
impl ClientHandler for VersionedClient {
|
||||
fn get_info(&self) -> ClientInfo {
|
||||
let mut info = ClientInfo::default();
|
||||
info.protocol_version = self.protocol_version.clone();
|
||||
info
|
||||
}
|
||||
}
|
||||
|
||||
async fn negotiated_version(client_version: ProtocolVersion) -> ProtocolVersion {
|
||||
let (server_transport, client_transport) = tokio::io::duplex(4096);
|
||||
|
||||
tokio::spawn(async move {
|
||||
let _ = EchoServer
|
||||
.serve(server_transport)
|
||||
.await
|
||||
.expect("server should start")
|
||||
.waiting()
|
||||
.await;
|
||||
});
|
||||
|
||||
let client = VersionedClient {
|
||||
protocol_version: client_version,
|
||||
}
|
||||
.serve(client_transport)
|
||||
.await
|
||||
.expect("client should connect");
|
||||
|
||||
let version = client
|
||||
.peer_info()
|
||||
.expect("peer_info should be set")
|
||||
.protocol_version
|
||||
.clone();
|
||||
|
||||
client.cancel().await.expect("client should cancel");
|
||||
version
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn known_version_echoed_back() {
|
||||
for version in ProtocolVersion::KNOWN_VERSIONS {
|
||||
let negotiated = negotiated_version(version.clone()).await;
|
||||
assert_eq!(
|
||||
negotiated, *version,
|
||||
"known version {version} should be echoed back"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn unknown_version_falls_back_to_latest() {
|
||||
let unknown: ProtocolVersion = serde_json::from_str(r#""1999-01-01""#).unwrap();
|
||||
let negotiated = negotiated_version(unknown).await;
|
||||
assert_eq!(
|
||||
negotiated,
|
||||
ProtocolVersion::LATEST,
|
||||
"unknown version should fall back to LATEST"
|
||||
);
|
||||
}
|
||||
99
crates/rmcp/tests/test_stateless_protocol_version.rs
Normal file
99
crates/rmcp/tests/test_stateless_protocol_version.rs
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
//! Tests for protocol version negotiation in stateless HTTP mode.
|
||||
//!
|
||||
//! Known versions are echoed back; unknown versions fall back to LATEST.
|
||||
#![cfg(not(feature = "local"))]
|
||||
|
||||
use rmcp::{
|
||||
model::ProtocolVersion,
|
||||
transport::streamable_http_server::{
|
||||
StreamableHttpServerConfig, StreamableHttpService, session::local::LocalSessionManager,
|
||||
},
|
||||
};
|
||||
use tokio_util::sync::CancellationToken;
|
||||
|
||||
mod common;
|
||||
use common::calculator::Calculator;
|
||||
|
||||
fn stateless_json_config() -> StreamableHttpServerConfig {
|
||||
StreamableHttpServerConfig::default()
|
||||
.with_stateful_mode(false)
|
||||
.with_json_response(true)
|
||||
.with_sse_keep_alive(None)
|
||||
.with_cancellation_token(CancellationToken::new())
|
||||
}
|
||||
|
||||
async fn spawn_server(
|
||||
config: StreamableHttpServerConfig,
|
||||
) -> (reqwest::Client, String, CancellationToken) {
|
||||
let ct = config.cancellation_token.clone();
|
||||
let service: StreamableHttpService<Calculator, LocalSessionManager> =
|
||||
StreamableHttpService::new(|| Ok(Calculator::new()), Default::default(), config);
|
||||
|
||||
let router = axum::Router::new().nest_service("/mcp", service);
|
||||
let tcp_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
|
||||
let addr = tcp_listener.local_addr().unwrap();
|
||||
|
||||
tokio::spawn({
|
||||
let ct = ct.clone();
|
||||
async move {
|
||||
let _ = axum::serve(tcp_listener, router)
|
||||
.with_graceful_shutdown(async move { ct.cancelled_owned().await })
|
||||
.await;
|
||||
}
|
||||
});
|
||||
|
||||
(reqwest::Client::new(), format!("http://{addr}/mcp"), ct)
|
||||
}
|
||||
|
||||
async fn post_init(client: &reqwest::Client, url: &str, body_version: &str) -> serde_json::Value {
|
||||
let body = serde_json::json!({
|
||||
"jsonrpc": "2.0",
|
||||
"id": 1,
|
||||
"method": "initialize",
|
||||
"params": {
|
||||
"protocolVersion": body_version,
|
||||
"capabilities": {},
|
||||
"clientInfo": {"name": "test", "version": "0.0.1"}
|
||||
}
|
||||
});
|
||||
let resp = client
|
||||
.post(url)
|
||||
.header("Content-Type", "application/json")
|
||||
.header("Accept", "application/json, text/event-stream")
|
||||
.body(body.to_string())
|
||||
.send()
|
||||
.await
|
||||
.expect("send request");
|
||||
assert!(resp.status().is_success(), "HTTP {}", resp.status());
|
||||
resp.json().await.expect("parse JSON")
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn stateless_init_echoes_known_version() {
|
||||
let (client, url, ct) = spawn_server(stateless_json_config()).await;
|
||||
|
||||
for version in ProtocolVersion::KNOWN_VERSIONS {
|
||||
let resp = post_init(&client, &url, version.as_str()).await;
|
||||
assert_eq!(
|
||||
resp["result"]["protocolVersion"],
|
||||
version.as_str(),
|
||||
"known version {version} should be echoed back"
|
||||
);
|
||||
}
|
||||
|
||||
ct.cancel();
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn stateless_init_unknown_version_falls_back_to_latest() {
|
||||
let (client, url, ct) = spawn_server(stateless_json_config()).await;
|
||||
|
||||
let resp = post_init(&client, &url, "1999-01-01").await;
|
||||
assert_eq!(
|
||||
resp["result"]["protocolVersion"],
|
||||
ProtocolVersion::LATEST.as_str(),
|
||||
"unknown version should fall back to LATEST"
|
||||
);
|
||||
|
||||
ct.cancel();
|
||||
}
|
||||
Loading…
Reference in a new issue