turul-mcp-client 0.4.2

Comprehensive MCP client library with multi-transport support
Documentation
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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
//! Session management for MCP client
//!
//! Everything here is the **2025-11-25 handshake**: `initialize`,
//! `Mcp-Session-Id`, negotiated-version validation. The 2026-07-28 lane is
//! stateless and reaches none of it — `McpClient::negotiate_protocol` only
//! calls into this module on the legacy arm.
//!
//! The wire string for that lane has one owner, [`McpVersion::V2025_11_25`];
//! this module consumes it rather than redeclaring it.

use serde_json::Value;
use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::sync::RwLock;
use tracing::{debug, info, warn};

use crate::config::ClientConfig;
use crate::error::{McpClientResult, SessionError};
use crate::version::McpVersion;
use turul_mcp_protocol_2025_11_25::{
    ClientCapabilities, Implementation, InitializeRequest, ServerCapabilities,
};

/// Session state enumeration
#[derive(Debug, Clone, PartialEq)]
pub enum SessionState {
    /// Session is not initialized
    Uninitialized,
    /// Session is being initialized
    Initializing,
    /// Session is active and ready for operations
    Active,
    /// Session is reconnecting
    Reconnecting,
    /// Session has been terminated
    Terminated,
    /// Session encountered an error
    Error(String),
}

impl std::fmt::Display for SessionState {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            SessionState::Uninitialized => write!(f, "uninitialized"),
            SessionState::Initializing => write!(f, "initializing"),
            SessionState::Active => write!(f, "active"),
            SessionState::Reconnecting => write!(f, "reconnecting"),
            SessionState::Terminated => write!(f, "terminated"),
            SessionState::Error(err) => write!(f, "error: {}", err),
        }
    }
}

/// Session information and metadata
#[derive(Debug, Clone)]
pub struct SessionInfo {
    /// Session identifier from server (None until server provides it)
    pub session_id: Option<String>,

    /// Session state
    pub state: SessionState,

    /// Client capabilities sent during initialization
    pub client_capabilities: Option<ClientCapabilities>,

    /// Server capabilities received during initialization
    pub server_capabilities: Option<ServerCapabilities>,

    /// Protocol version negotiated
    pub protocol_version: Option<String>,

    /// Session creation timestamp
    pub created_at: Instant,

    /// Last activity timestamp
    pub last_activity: Instant,

    /// Connection attempt count
    pub connection_attempts: u32,

    /// Session metadata
    pub metadata: Value,
}

impl SessionInfo {
    /// Create a new session info
    pub fn new() -> Self {
        let now = Instant::now();
        Self {
            session_id: None,
            state: SessionState::Uninitialized,
            client_capabilities: None,
            server_capabilities: None,
            protocol_version: None,
            created_at: now,
            last_activity: now,
            connection_attempts: 0,
            metadata: Value::Null,
        }
    }

    /// Update last activity timestamp
    pub fn update_activity(&mut self) {
        self.last_activity = Instant::now();
    }

    /// Get session duration
    pub fn duration(&self) -> Duration {
        self.last_activity.duration_since(self.created_at)
    }

    /// Get time since last activity
    pub fn idle_time(&self) -> Duration {
        Instant::now().duration_since(self.last_activity)
    }

    /// Check if session is active
    pub fn is_active(&self) -> bool {
        self.state == SessionState::Active
    }

    /// Check if session can be used for operations
    pub fn is_ready(&self) -> bool {
        matches!(self.state, SessionState::Active)
    }

    /// Check if session needs initialization
    pub fn needs_initialization(&self) -> bool {
        matches!(self.state, SessionState::Uninitialized)
    }
}

impl Default for SessionInfo {
    fn default() -> Self {
        Self::new()
    }
}

/// Session manager handles session lifecycle and state
#[derive(Debug)]
pub struct SessionManager {
    /// Current session information
    session: Arc<RwLock<SessionInfo>>,

    /// Client configuration
    config: ClientConfig,
}

impl SessionManager {
    /// Create a new session manager
    pub fn new(config: ClientConfig) -> Self {
        Self {
            session: Arc::new(RwLock::new(SessionInfo::new())),
            config,
        }
    }

    /// Get current session information
    pub async fn session_info(&self) -> SessionInfo {
        self.session.read().await.clone()
    }

    /// Get session ID (returns error if not yet initialized by server)
    pub async fn session_id(&self) -> McpClientResult<String> {
        let session = self.session.read().await;
        session
            .session_id
            .clone()
            .ok_or_else(|| SessionError::NotInitialized.into())
    }

    /// Get session ID if available (returns None if not initialized)
    pub async fn session_id_optional(&self) -> Option<String> {
        self.session.read().await.session_id.clone()
    }

    /// Set session ID (called when server provides it during initialization)
    pub async fn set_session_id(&self, session_id: String) -> McpClientResult<()> {
        let mut session = self.session.write().await;
        session.session_id = Some(session_id);
        Ok(())
    }

    /// Get current session state
    pub async fn state(&self) -> SessionState {
        self.session.read().await.state.clone()
    }

    /// Update session state
    pub async fn set_state(&self, state: SessionState) {
        let mut session = self.session.write().await;
        debug!("Session state transition: {} -> {}", session.state, state);
        session.state = state;
        session.update_activity();
    }

    /// Check if session is ready for operations
    pub async fn is_ready(&self) -> bool {
        self.session.read().await.is_ready()
    }

    /// Initialize session with server capabilities
    pub async fn initialize(
        &self,
        client_capabilities: ClientCapabilities,
        server_capabilities: ServerCapabilities,
        protocol_version: String,
    ) -> McpClientResult<()> {
        let mut session = self.session.write().await;

        if !matches!(
            session.state,
            SessionState::Uninitialized | SessionState::Initializing
        ) {
            return Err(SessionError::AlreadyInitialized.into());
        }

        session.client_capabilities = Some(client_capabilities);
        session.server_capabilities = Some(server_capabilities);
        session.protocol_version = Some(protocol_version.clone());
        session.state = SessionState::Active;
        session.update_activity();

        info!(
            session_id = %session.session_id.as_deref().unwrap_or("None"),
            protocol_version = %protocol_version,
            "Session initialized successfully"
        );

        Ok(())
    }

    /// Mark session as initializing
    pub async fn mark_initializing(&self) -> McpClientResult<()> {
        let mut session = self.session.write().await;

        if !session.needs_initialization() {
            return Err(SessionError::AlreadyInitialized.into());
        }

        session.state = SessionState::Initializing;
        session.connection_attempts += 1;
        session.update_activity();

        debug!(
            session_id = %session.session_id.as_deref().unwrap_or("None"),
            attempt = session.connection_attempts,
            "Session initialization started"
        );

        Ok(())
    }

    /// Terminate session.
    ///
    /// Flips state to `Terminated` and clears `session_id`. After this returns,
    /// `session_id_optional()` yields `None`, which makes a subsequent `Drop`
    /// cleanup pass a no-op (it has no ID to DELETE against). This is the
    /// idempotency contract that lets callers explicitly `disconnect()` and
    /// then let the client drop without a second doomed DELETE landing on
    /// the server (often with an already-expired bearer).
    pub async fn terminate(&self, reason: Option<String>) {
        let mut session = self.session.write().await;

        let previous_state = session.state.clone();
        let session_id_for_log = session.session_id.as_deref().unwrap_or("None").to_string();

        session.state = SessionState::Terminated;
        session.session_id = None;
        session.update_activity();

        info!(
            session_id = %session_id_for_log,
            previous_state = %previous_state,
            reason = reason.as_deref().unwrap_or("user requested"),
            "Session terminated"
        );
    }

    /// Handle session error
    pub async fn handle_error(&self, error: String) {
        let mut session = self.session.write().await;

        let previous_state = session.state.clone();
        session.state = SessionState::Error(error.clone());
        session.update_activity();

        warn!(
            session_id = %session.session_id.as_deref().unwrap_or("None"),
            previous_state = %previous_state,
            error = %error,
            "Session encountered error"
        );
    }

    /// Start reconnection process
    pub async fn start_reconnection(&self) {
        let mut session = self.session.write().await;

        if matches!(session.state, SessionState::Terminated) {
            return; // Cannot reconnect terminated sessions
        }

        session.state = SessionState::Reconnecting;
        session.connection_attempts += 1;
        session.update_activity();

        info!(
            session_id = %session.session_id.as_deref().unwrap_or("None"),
            attempt = session.connection_attempts,
            "Session reconnection started"
        );
    }

    /// Reset session for new connection
    pub async fn reset(&self) {
        let mut session = self.session.write().await;
        *session = SessionInfo::new();

        debug!(
            session_id = %session.session_id.as_deref().unwrap_or("None"),
            "Session reset for new connection"
        );
    }

    /// Update activity timestamp
    pub async fn update_activity(&self) {
        self.session.write().await.update_activity();
    }

    /// Get client capabilities for initialization, from the config-level
    /// declarations (all absent unless the application opted in).
    pub fn create_client_capabilities(&self) -> ClientCapabilities {
        let declared = &self.config.declared_capabilities;
        ClientCapabilities {
            experimental: None,
            sampling: declared.sampling.then(Default::default),
            elicitation: declared.elicitation.then(Default::default),
            roots: declared.roots.then(Default::default),
            tasks: None,
        }
    }

    /// Create initialization request
    pub async fn create_initialize_request(&self) -> InitializeRequest {
        let client_info = &self.config.client_info;

        InitializeRequest {
            protocol_version: McpVersion::V2025_11_25.as_str().to_string(),
            capabilities: self.create_client_capabilities(),
            client_info: Implementation {
                name: client_info.name.clone(),
                version: client_info.version.clone(),
                title: None,
                description: None,
                website_url: None,
                icons: None,
            },
        }
    }

    /// Validate the version the server negotiated in its `initialize` reply.
    ///
    /// Only 2025-11-25 is accepted, and that is not a narrowing: `initialize`
    /// exists solely on that lane, so a reply naming any other version means
    /// the server answered a handshake it should have rejected.
    pub fn validate_protocol_version(version: &str) -> McpClientResult<()> {
        let expected = McpVersion::V2025_11_25.as_str();
        if version == expected {
            Ok(())
        } else {
            Err(crate::error::ProtocolError::UnsupportedVersion(format!(
                "Server negotiated '{}', the initialize handshake is '{}' only",
                version, expected
            ))
            .into())
        }
    }

    /// Validate server capabilities
    pub async fn validate_server_capabilities(
        &self,
        server_capabilities: &ServerCapabilities,
    ) -> McpClientResult<()> {
        // Basic validation - ensure server supports required capabilities
        debug!(
            tools = ?server_capabilities.tools,
            resources = ?server_capabilities.resources,
            prompts = ?server_capabilities.prompts,
            "Validating server capabilities"
        );

        // For now, we accept any server capabilities
        // In the future, we might want to check for required features
        Ok(())
    }

    /// Get session statistics
    pub async fn statistics(&self) -> SessionStatistics {
        let session = self.session.read().await;

        SessionStatistics {
            session_id: session.session_id.clone(),
            state: session.state.clone(),
            duration: session.duration(),
            idle_time: session.idle_time(),
            connection_attempts: session.connection_attempts,
            protocol_version: session.protocol_version.clone(),
        }
    }
}

/// Session statistics for monitoring and debugging
#[derive(Debug, Clone)]
pub struct SessionStatistics {
    pub session_id: Option<String>,
    pub state: SessionState,
    pub duration: Duration,
    pub idle_time: Duration,
    pub connection_attempts: u32,
    pub protocol_version: Option<String>,
}

impl SessionStatistics {
    /// Check if session is healthy
    pub fn is_healthy(&self) -> bool {
        matches!(self.state, SessionState::Active) && self.idle_time < Duration::from_secs(300)
    }

    /// Get human-readable session status
    pub fn status_summary(&self) -> String {
        let session_display = match &self.session_id {
            Some(id) => &id[..id.len().min(8)],
            None => "None",
        };
        format!(
            "Session {} ({}) - Duration: {:?}, Idle: {:?}, Attempts: {}",
            session_display, self.state, self.duration, self.idle_time, self.connection_attempts
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::ClientConfig;

    #[test]
    fn test_validate_protocol_version_accepted() {
        assert!(SessionManager::validate_protocol_version("2025-11-25").is_ok());
    }

    #[test]
    fn test_validate_protocol_version_rejected() {
        let result = SessionManager::validate_protocol_version("2099-01-01");
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.to_string().contains("2099-01-01"));
    }

    /// The old version of this test asserted `PROTOCOL_VERSION == "2025-11-25"`
    /// under a name claiming it checked the init request — it never built one.
    /// Build the request and read the version off it.
    #[tokio::test]
    async fn init_request_advertises_the_legacy_wire_version() {
        let manager = SessionManager::new(ClientConfig::default());
        let request = manager.create_initialize_request().await;
        assert_eq!(request.protocol_version, "2025-11-25");
        assert_eq!(request.protocol_version, McpVersion::V2025_11_25.as_str());
    }

    /// `initialize` does not exist on 2026-07-28, so a server naming it in an
    /// initialize reply is answering a handshake it should have rejected.
    #[test]
    fn init_reply_naming_the_stateless_spec_is_rejected() {
        let result = SessionManager::validate_protocol_version(McpVersion::V2026_07_28.as_str());
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("2026-07-28"));
    }

    #[tokio::test]
    async fn test_session_lifecycle() {
        let config = ClientConfig::default();
        let manager = SessionManager::new(config);

        // Initial state should be uninitialized
        assert_eq!(manager.state().await, SessionState::Uninitialized);
        assert!(!manager.is_ready().await);

        // Mark as initializing
        manager.mark_initializing().await.unwrap();
        assert_eq!(manager.state().await, SessionState::Initializing);

        // Initialize session
        let client_caps = manager.create_client_capabilities();
        let server_caps = ServerCapabilities {
            experimental: None,
            logging: None,
            prompts: None,
            resources: None,
            tools: None,
            completions: None,
            tasks: None,
        };

        manager
            .initialize(client_caps, server_caps, "2025-11-25".to_string())
            .await
            .unwrap();
        assert_eq!(manager.state().await, SessionState::Active);
        assert!(manager.is_ready().await);

        // Simulate the server having assigned a session ID at initialize.
        manager
            .set_session_id("session-XYZ".to_string())
            .await
            .unwrap();
        assert_eq!(
            manager.session_id_optional().await.as_deref(),
            Some("session-XYZ")
        );

        // Terminate session — must clear both state AND session_id so the
        // Drop-fallback in McpClient sees no ID and skips its DELETE.
        manager.terminate(Some("test completed".to_string())).await;
        assert_eq!(manager.state().await, SessionState::Terminated);
        assert!(!manager.is_ready().await);
        assert!(
            manager.session_id_optional().await.is_none(),
            "terminate() must clear session_id so subsequent Drop is a no-op"
        );
    }

    #[tokio::test]
    async fn test_session_error_handling() {
        let config = ClientConfig::default();
        let manager = SessionManager::new(config);

        manager.handle_error("test error".to_string()).await;

        let SessionState::Error(msg) = manager.state().await else {
            panic!("Expected error state, got: {:?}", manager.state().await);
        };
        assert_eq!(msg, "test error");
    }

    #[tokio::test]
    async fn test_session_reset() {
        let config = ClientConfig::default();
        let manager = SessionManager::new(config);

        // Set a mock session ID to simulate server initialization
        manager
            .set_session_id("test-session-id".to_string())
            .await
            .unwrap();
        let _original_id = manager.session_id().await.unwrap();

        manager.reset().await;

        // After reset, session_id should return NotInitialized error
        assert!(manager.session_id().await.is_err());
        assert_eq!(manager.state().await, SessionState::Uninitialized);

        // Verify the session ID was actually cleared
        assert!(manager.session_id_optional().await.is_none());
    }
}