rust-sdk/crates/rmcp/tests/test_client_initialization.rs
ip2a 22be2cc5ad
fix(client): classify discover outcome at source, not at the error type (#1133)
`ClientLifecycleMode::Auto` only fell back from `server/discover` on
`-32601`, so legacy servers that reject the probe with other codes
(`-32600`, `-32602`, implementation-defined errors) failed to connect
even though `initialize` would have succeeded.

The previous attempt (indicates_legacy_server) classified the failure
after the fact by reverse-engineering the error type. This rewrite moves
the classification into `discover_startup` itself, where the full context
(request id, response correlation, transport state) is still available.

`discover_startup` now returns `DiscoverOutcome`: `Modern` on success,
`Legacy(error)` when the probe received a complete, correlated JSON-RPC
error whose code is not a modern-era rejection. Every other failure
becomes `Err`, so `Auto` simply matches the outcome — no methods on
`ClientInitializeError`, no downcast, no transport-specific types
leaking into the generic lifecycle layer.

Additional fixes that fall out naturally:

- Response correlation is now checked in `expect_response` for both
  success and error branches. Previously error responses skipped id
  correlation entirely. A new `UncorrelatedErrorResponse` variant
  surfaces responses that cannot be tied to the request.

- When both discover and the legacy fallback fail, a
  `LegacyFallbackFailed` compound error preserves both phases instead
  of discarding the discover error.

Fixes #1040.
2026-08-09 14:07:50 -04:00

159 lines
5.5 KiB
Rust

// cargo test --features "server client" --package rmcp test_client_initialization
#![cfg(all(feature = "client", not(feature = "local")))]
mod common;
use std::borrow::Cow;
use common::handlers::TestClientHandler;
use rmcp::{
ServiceExt,
model::{
ClientJsonRpcMessage, ErrorCode, ErrorData, InitializeResult, JsonRpcError,
JsonRpcVersion2_0, RequestId, ServerCapabilities, ServerJsonRpcMessage, ServerResult,
},
transport::{IntoTransport, Transport},
};
fn stringify_numeric_id(id: RequestId) -> RequestId {
let RequestId::Number(id) = id else {
panic!("expected a numeric request ID");
};
RequestId::String(id.to_string().into())
}
#[tokio::test]
async fn client_initialization_accepts_stringified_numeric_response_id() {
let (server_transport, client_transport) = tokio::io::duplex(1024);
let mut server = IntoTransport::<rmcp::RoleServer, _, _>::into_transport(server_transport);
let server_task = tokio::spawn(async move {
let ClientJsonRpcMessage::Request(request) =
server.receive().await.expect("expected initialize request")
else {
panic!("expected initialize request");
};
server
.send(ServerJsonRpcMessage::response(
ServerResult::InitializeResult(
InitializeResult::new(ServerCapabilities::default()),
),
stringify_numeric_id(request.id),
))
.await
.expect("send initialize response");
assert!(matches!(
server.receive().await,
Some(ClientJsonRpcMessage::Notification(_))
));
});
let client = TestClientHandler::new(true, true)
.serve(client_transport)
.await
.expect("client should accept stringified initialize response ID");
assert!(
client
.peer_info()
.expect("peer info should be retained")
.server_info
.is_some(),
"initialize always provides a server implementation identity"
);
client.cancel().await.expect("cancel client");
server_task.await.expect("server task");
}
#[tokio::test]
async fn client_correlates_stringified_numeric_response_id() {
let (server_transport, client_transport) = tokio::io::duplex(1024);
let mut server = IntoTransport::<rmcp::RoleServer, _, _>::into_transport(server_transport);
let server_task = tokio::spawn(async move {
let ClientJsonRpcMessage::Request(initialize) =
server.receive().await.expect("expected initialize request")
else {
panic!("expected initialize request");
};
server
.send(ServerJsonRpcMessage::response(
ServerResult::InitializeResult(
InitializeResult::new(ServerCapabilities::default()),
),
initialize.id,
))
.await
.expect("send initialize response");
assert!(matches!(
server.receive().await,
Some(ClientJsonRpcMessage::Notification(_))
));
let ClientJsonRpcMessage::Request(request) =
server.receive().await.expect("expected tools/list request")
else {
panic!("expected tools/list request");
};
server
.send(ServerJsonRpcMessage::response(
ServerResult::ListToolsResult(Default::default()),
stringify_numeric_id(request.id),
))
.await
.expect("send tools/list response");
});
let client = TestClientHandler::new(true, true)
.serve(client_transport)
.await
.expect("initialize client");
client
.list_tools(None)
.await
.expect("client should correlate stringified response ID");
client.cancel().await.expect("cancel client");
server_task.await.expect("server task");
}
#[tokio::test]
async fn test_client_init_handles_jsonrpc_error() {
let (server_transport, client_transport) = tokio::io::duplex(1024);
let mut server = IntoTransport::<rmcp::RoleServer, _, _>::into_transport(server_transport);
let client_handle = tokio::spawn(async move {
TestClientHandler::new(true, true)
.serve(client_transport)
.await
});
tokio::spawn(async move {
let request = server.receive().await;
// Echo the request's own id back on the error so it correlates: an
// uncorrelated id would surface as `UncorrelatedErrorResponse`
// instead of the `JsonRpcError` this test exercises.
let request_id = request
.and_then(|message| message.into_request())
.map(|(_, id)| id)
.expect("client sent an initialize request");
let error_msg = ServerJsonRpcMessage::Error(JsonRpcError {
jsonrpc: JsonRpcVersion2_0,
id: Some(request_id),
error: ErrorData {
code: ErrorCode(-32600),
message: Cow::Borrowed("Invalid Request"),
data: None,
},
});
let _: Result<(), _> = server.send(error_msg).await;
});
let result = client_handle.await.unwrap();
assert!(result.is_err());
match result {
Err(rmcp::service::ClientInitializeError::JsonRpcError(error_data)) => {
assert_eq!(error_data.code, ErrorCode(-32600));
assert_eq!(error_data.message, "Invalid Request");
}
_ => panic!("Expected ClientInitializeError::JsonRpcError"),
}
}