forked from rust-mcp-stack/rust-mcp-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsse.rs
More file actions
305 lines (277 loc) · 10.6 KB
/
sse.rs
File metadata and controls
305 lines (277 loc) · 10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
use crate::event_store::EventStore;
use crate::schema::schema_utils::{
ClientMessage, ClientMessages, MessageFromServer, SdkError, ServerMessage, ServerMessages,
};
use crate::schema::RequestId;
use async_trait::async_trait;
use serde::de::DeserializeOwned;
use std::collections::HashMap;
use std::pin::Pin;
use std::sync::Arc;
use std::time::Duration;
use tokio::io::{AsyncWriteExt, DuplexStream};
use tokio::sync::oneshot::Sender;
use tokio::sync::{oneshot, Mutex};
use tokio::task::JoinHandle;
use tokio::time::{self, Interval};
use crate::error::{TransportError, TransportResult};
use crate::mcp_stream::MCPStream;
use crate::message_dispatcher::MessageDispatcher;
use crate::transport::Transport;
use crate::utils::{endpoint_with_session_id, CancellationTokenSource};
use crate::{IoStream, McpDispatch, SessionId, StreamId, TransportDispatcher, TransportOptions};
pub struct SseTransport<R>
where
R: Clone + Send + Sync + DeserializeOwned + 'static,
{
shutdown_source: tokio::sync::RwLock<Option<CancellationTokenSource>>,
is_shut_down: Mutex<bool>,
read_write_streams: Mutex<Option<(DuplexStream, DuplexStream)>>,
receiver_tx: Mutex<DuplexStream>, // receiving string payload
options: Arc<TransportOptions>,
message_sender: Arc<tokio::sync::RwLock<Option<MessageDispatcher<R>>>>,
error_stream: tokio::sync::RwLock<Option<IoStream>>,
pending_requests: Arc<Mutex<HashMap<RequestId, tokio::sync::oneshot::Sender<R>>>>,
// resumability support
session_id: Option<SessionId>,
stream_id: Option<StreamId>,
event_store: Option<Arc<dyn EventStore>>,
}
/// Server-Sent Events (SSE) transport implementation
impl<R> SseTransport<R>
where
R: Clone + Send + Sync + DeserializeOwned + 'static,
{
/// Creates a new SseTransport instance
///
/// Initializes the transport with provided read and write duplex streams and options.
///
/// # Arguments
/// * `read_rx` - Duplex stream for receiving messages
/// * `write_tx` - Duplex stream for sending messages
/// * `receiver_tx` - Duplex stream for receiving string payload
/// * `options` - Shared transport configuration options
///
/// # Returns
/// * `TransportResult<Self>` - The initialized transport or an error
pub fn new(
read_rx: DuplexStream,
write_tx: DuplexStream,
receiver_tx: DuplexStream,
options: Arc<TransportOptions>,
) -> TransportResult<Self> {
Ok(Self {
read_write_streams: Mutex::new(Some((read_rx, write_tx))),
options,
shutdown_source: tokio::sync::RwLock::new(None),
is_shut_down: Mutex::new(false),
receiver_tx: Mutex::new(receiver_tx),
message_sender: Arc::new(tokio::sync::RwLock::new(None)),
error_stream: tokio::sync::RwLock::new(None),
pending_requests: Arc::new(Mutex::new(HashMap::new())),
session_id: None,
stream_id: None,
event_store: None,
})
}
pub fn message_endpoint(endpoint: &str, session_id: &SessionId) -> String {
endpoint_with_session_id(endpoint, session_id)
}
pub(crate) async fn set_message_sender(&self, sender: MessageDispatcher<R>) {
let mut lock = self.message_sender.write().await;
*lock = Some(sender);
}
pub(crate) async fn set_error_stream(
&self,
error_stream: Pin<Box<dyn tokio::io::AsyncWrite + Send + Sync>>,
) {
let mut lock = self.error_stream.write().await;
*lock = Some(IoStream::Writable(error_stream));
}
/// Supports resumability for streamable HTTP transports by setting the session ID,
/// stream ID, and event store.
pub fn make_resumable(
&mut self,
session_id: SessionId,
stream_id: StreamId,
event_store: Arc<dyn EventStore>,
) {
self.session_id = Some(session_id);
self.stream_id = Some(stream_id);
self.event_store = Some(event_store);
}
}
#[async_trait]
impl McpDispatch<ClientMessages, ServerMessages, ClientMessage, ServerMessage>
for SseTransport<ClientMessage>
{
async fn send_message(
&self,
message: ServerMessages,
request_timeout: Option<Duration>,
) -> TransportResult<Option<ClientMessages>> {
let sender = self.message_sender.read().await;
let sender = sender.as_ref().ok_or(SdkError::connection_closed())?;
sender.send_message(message, request_timeout).await
}
async fn send(
&self,
message: ServerMessage,
request_timeout: Option<Duration>,
) -> TransportResult<Option<ClientMessage>> {
let sender = self.message_sender.read().await;
let sender = sender.as_ref().ok_or(SdkError::connection_closed())?;
sender.send(message, request_timeout).await
}
async fn send_batch(
&self,
message: Vec<ServerMessage>,
request_timeout: Option<Duration>,
) -> TransportResult<Option<Vec<ClientMessage>>> {
let sender = self.message_sender.read().await;
let sender = sender.as_ref().ok_or(SdkError::connection_closed())?;
sender.send_batch(message, request_timeout).await
}
async fn write_str(&self, payload: &str, skip_store: bool) -> TransportResult<()> {
let sender = self.message_sender.read().await;
let sender = sender.as_ref().ok_or(SdkError::connection_closed())?;
sender.write_str(payload, skip_store).await
}
}
#[async_trait] //RSMX
impl Transport<ClientMessages, MessageFromServer, ClientMessage, ServerMessages, ServerMessage>
for SseTransport<ClientMessage>
{
/// Starts the transport, initializing streams and message dispatcher
///
/// Sets up the MCP stream and dispatcher using the provided duplex streams.
///
/// # Returns
/// * `TransportResult<(Pin<Box<dyn Stream<Item = R> + Send>>, MessageDispatcher<R>, IoStream)>`
/// - The message stream, dispatcher, and error stream
///
/// # Errors
/// * Returns `TransportError` if streams are already taken or not initialized
async fn start(&self) -> TransportResult<tokio_stream::wrappers::ReceiverStream<ClientMessages>>
where
MessageDispatcher<ClientMessage>:
McpDispatch<ClientMessages, ServerMessages, ClientMessage, ServerMessage>,
{
// Create CancellationTokenSource and token
let (cancellation_source, cancellation_token) = CancellationTokenSource::new();
let mut lock = self.shutdown_source.write().await;
*lock = Some(cancellation_source);
let mut lock = self.read_write_streams.lock().await;
let (read_rx, write_tx) = lock.take().ok_or_else(|| {
TransportError::Internal(
"SSE streams already taken or transport not initialized".to_string(),
)
})?;
let (stream, mut sender, error_stream) = MCPStream::create::<ClientMessages, ClientMessage>(
Box::pin(read_rx),
Mutex::new(Box::pin(write_tx)),
IoStream::Writable(Box::pin(tokio::io::stderr())),
self.pending_requests.clone(),
self.options.timeout,
cancellation_token,
);
if let (Some(session_id), Some(stream_id), Some(event_store)) = (
self.session_id.as_ref(),
self.stream_id.as_ref(),
self.event_store.as_ref(),
) {
sender.make_resumable(
session_id.to_owned(),
stream_id.to_owned(),
event_store.clone(),
);
}
self.set_message_sender(sender).await;
if let IoStream::Writable(error_stream) = error_stream {
self.set_error_stream(error_stream).await;
}
Ok(stream)
}
/// Checks if the transport has been shut down
///
/// # Returns
/// * `bool` - True if the transport is shut down, false otherwise
async fn is_shut_down(&self) -> bool {
let result = self.is_shut_down.lock().await;
*result
}
fn message_sender(&self) -> Arc<tokio::sync::RwLock<Option<MessageDispatcher<ClientMessage>>>> {
self.message_sender.clone() as _
}
fn error_stream(&self) -> &tokio::sync::RwLock<Option<IoStream>> {
&self.error_stream as _
}
async fn consume_string_payload(&self, payload: &str) -> TransportResult<()> {
let mut transmit = self.receiver_tx.lock().await;
transmit
.write_all(format!("{payload}\n").as_bytes())
.await?;
transmit.flush().await?;
Ok(())
}
/// Shuts down the transport, terminating tasks and signaling closure
///
/// Cancels any running tasks and clears the cancellation source.
///
/// # Returns
/// * `TransportResult<()>` - Ok if shutdown is successful, Err if cancellation fails
async fn shut_down(&self) -> TransportResult<()> {
// Trigger cancellation
let mut cancellation_lock = self.shutdown_source.write().await;
if let Some(source) = cancellation_lock.as_ref() {
source.cancel()?;
}
*cancellation_lock = None; // Clear cancellation_source
// Mark as shut down
let mut is_shut_down_lock = self.is_shut_down.lock().await;
*is_shut_down_lock = true;
Ok(())
}
async fn keep_alive(
&self,
interval: Duration,
disconnect_tx: oneshot::Sender<()>,
) -> TransportResult<JoinHandle<()>> {
let sender = self.message_sender();
let handle = tokio::spawn(async move {
let mut interval: Interval = time::interval(interval);
interval.tick().await; // Skip the first immediate tick
loop {
interval.tick().await;
let sender = sender.read().await;
if let Some(sender) = sender.as_ref() {
match sender.write_str("\n", true).await {
Ok(_) => {}
Err(TransportError::Io(error))
if error.kind() == std::io::ErrorKind::BrokenPipe =>
{
let _ = disconnect_tx.send(());
break;
}
_ => {}
}
}
}
});
Ok(handle)
}
async fn pending_request_tx(&self, request_id: &RequestId) -> Option<Sender<ClientMessage>> {
let mut pending_requests = self.pending_requests.lock().await;
pending_requests.remove(request_id)
}
}
impl
TransportDispatcher<
ClientMessages,
MessageFromServer,
ClientMessage,
ServerMessages,
ServerMessage,
> for SseTransport<ClientMessage>
{
}