fastmcp-console 0.3.0

Rich console output for FastMCP servers
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
//! Rich-formatted log output to stderr.
//!
//! Provides a `log` crate compatible logger that uses [`RichLogFormatter`]
//! for styled output.
//!
//! # Usage
//!
//! The simplest way to use the rich logger:
//!
//! ```ignore
//! use fastmcp_console::logging::RichLogger;
//! use log::Level;
//!
//! // Simple initialization
//! RichLogger::init(Level::Info);
//!
//! // Or use the builder for more control
//! RichLoggerBuilder::new()
//!     .level(Level::Debug)
//!     .with_timestamps(true)
//!     .with_targets(true)
//!     .init();
//! ```

use log::{Level, LevelFilter, Log, Metadata, Record};
use time::{OffsetDateTime, format_description};

use super::{LogEvent, LogLevel, RichLogFormatter};
use crate::console::FastMcpConsole;
use crate::detection::DisplayContext;

/// Rich-formatted logger that writes to stderr.
///
/// This logger uses the [`RichLogFormatter`] to produce styled output
/// when running in human context, and plain text when running in agent context.
pub struct RichLogger {
    console: &'static FastMcpConsole,
    formatter: RichLogFormatter,
    min_level: Level,
    show_timestamps: bool,
}

impl RichLogger {
    /// Create a new rich logger with the given minimum level.
    #[must_use]
    pub fn new(min_level: Level) -> Self {
        Self {
            console: crate::console::console(),
            formatter: RichLogFormatter::detect(),
            min_level,
            show_timestamps: true,
        }
    }

    /// Create a logger using the builder pattern.
    #[must_use]
    pub fn builder() -> RichLoggerBuilder {
        RichLoggerBuilder::new()
    }

    /// Initialize as the global logger.
    ///
    /// Returns an error if a logger has already been set.
    pub fn init(min_level: Level) -> Result<(), log::SetLoggerError> {
        let logger = Box::new(Self::new(min_level));
        log::set_boxed_logger(logger)?;
        log::set_max_level(min_level.to_level_filter());
        Ok(())
    }

    /// Initialize as the global logger, ignoring errors if already set.
    pub fn try_init(min_level: Level) {
        let _ = Self::init(min_level);
    }

    /// Convert a log::Record to a LogEvent.
    fn record_to_event(&self, record: &Record) -> LogEvent {
        let level = LogLevel::from(record.level());
        let message = format!("{}", record.args());

        let mut event = LogEvent::new(level, message).with_target(record.target());

        // Add timestamp if enabled
        if self.show_timestamps {
            let now = OffsetDateTime::now_utc();
            // Format: HH:MM:SS
            if let Ok(fmt) = format_description::parse("[hour]:[minute]:[second]") {
                if let Ok(ts) = now.format(&fmt) {
                    event = event.with_timestamp(ts);
                }
            }
        }

        if let Some(file) = record.file() {
            event = event.with_file(file);
        }
        if let Some(line) = record.line() {
            event = event.with_line(line);
        }

        event
    }
}

/// Builder for configuring the rich logger.
///
/// # Example
///
/// ```ignore
/// use fastmcp_console::logging::RichLoggerBuilder;
/// use log::Level;
///
/// RichLoggerBuilder::new()
///     .level(Level::Debug)
///     .with_timestamps(true)
///     .with_targets(true)
///     .init()
///     .expect("Failed to initialize logger");
/// ```
#[derive(Debug)]
pub struct RichLoggerBuilder {
    min_level: Level,
    show_timestamps: bool,
    show_targets: bool,
    show_file_line: bool,
    max_width: Option<usize>,
}

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

impl RichLoggerBuilder {
    /// Create a new builder with default settings.
    #[must_use]
    pub fn new() -> Self {
        Self {
            min_level: Level::Info,
            show_timestamps: true,
            show_targets: true,
            show_file_line: false,
            max_width: None,
        }
    }

    /// Set the minimum log level.
    #[must_use]
    pub fn level(mut self, level: Level) -> Self {
        self.min_level = level;
        self
    }

    /// Set the minimum log level from a LevelFilter.
    #[must_use]
    pub fn level_filter(mut self, filter: LevelFilter) -> Self {
        self.min_level = filter.to_level().unwrap_or(Level::Trace);
        self
    }

    /// Set whether to show timestamps.
    #[must_use]
    pub fn with_timestamps(mut self, show: bool) -> Self {
        self.show_timestamps = show;
        self
    }

    /// Set whether to show target/module paths.
    #[must_use]
    pub fn with_targets(mut self, show: bool) -> Self {
        self.show_targets = show;
        self
    }

    /// Set whether to show file:line information.
    #[must_use]
    pub fn with_file_line(mut self, show: bool) -> Self {
        self.show_file_line = show;
        self
    }

    /// Set maximum width for message/target truncation.
    #[must_use]
    pub fn with_max_width(mut self, width: Option<usize>) -> Self {
        self.max_width = width;
        self
    }

    /// Build the logger without installing it.
    #[must_use]
    pub fn build(self) -> RichLogger {
        let context = DisplayContext::detect();
        let theme = crate::theme::theme();

        let formatter = RichLogFormatter::new(theme, context)
            .with_timestamp(self.show_timestamps)
            .with_target(self.show_targets)
            .with_file_line(self.show_file_line)
            .with_max_width(self.max_width);

        RichLogger {
            console: crate::console::console(),
            formatter,
            min_level: self.min_level,
            show_timestamps: self.show_timestamps,
        }
    }

    /// Build and install as the global logger.
    ///
    /// Returns an error if a logger has already been set.
    pub fn init(self) -> Result<(), log::SetLoggerError> {
        let level = self.min_level;
        let logger = Box::new(self.build());
        log::set_boxed_logger(logger)?;
        log::set_max_level(level.to_level_filter());
        Ok(())
    }

    /// Build and install, ignoring errors if already set.
    pub fn try_init(self) {
        let _ = self.init();
    }
}

impl Log for RichLogger {
    fn enabled(&self, metadata: &Metadata) -> bool {
        metadata.level() <= self.min_level
    }

    fn log(&self, record: &Record) {
        if !self.enabled(record.metadata()) {
            return;
        }

        let event = self.record_to_event(record);
        let line = self.formatter.format_line(&event);

        if self.console.is_rich() {
            self.console.print(&line);
        } else {
            eprintln!("{}", crate::console::strip_markup(&line));
        }
    }

    fn flush(&self) {}
}

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

    #[test]
    fn test_rich_logger_enabled() {
        let logger = RichLogger::new(Level::Info);

        // Info and above should be enabled
        assert!(
            logger.enabled(
                &log::Metadata::builder()
                    .level(Level::Error)
                    .target("test")
                    .build()
            )
        );
        assert!(
            logger.enabled(
                &log::Metadata::builder()
                    .level(Level::Warn)
                    .target("test")
                    .build()
            )
        );
        assert!(
            logger.enabled(
                &log::Metadata::builder()
                    .level(Level::Info)
                    .target("test")
                    .build()
            )
        );

        // Debug and Trace should be disabled
        assert!(
            !logger.enabled(
                &log::Metadata::builder()
                    .level(Level::Debug)
                    .target("test")
                    .build()
            )
        );
        assert!(
            !logger.enabled(
                &log::Metadata::builder()
                    .level(Level::Trace)
                    .target("test")
                    .build()
            )
        );
    }

    #[test]
    fn test_rich_logger_new() {
        let logger = RichLogger::new(Level::Debug);
        // Should not panic
        assert!(
            logger.enabled(
                &log::Metadata::builder()
                    .level(Level::Debug)
                    .target("test")
                    .build()
            )
        );
    }

    #[test]
    fn test_builder_default() {
        let builder = RichLoggerBuilder::default();
        // Default level should be Info
        assert_eq!(builder.min_level, Level::Info);
        assert!(builder.show_timestamps);
        assert!(builder.show_targets);
        assert!(!builder.show_file_line);
    }

    #[test]
    fn test_builder_level() {
        let builder = RichLoggerBuilder::new().level(Level::Debug);
        assert_eq!(builder.min_level, Level::Debug);
    }

    #[test]
    fn test_builder_level_filter() {
        let builder = RichLoggerBuilder::new().level_filter(LevelFilter::Warn);
        assert_eq!(builder.min_level, Level::Warn);
    }

    #[test]
    fn test_builder_level_filter_off_falls_back_to_trace() {
        let builder = RichLoggerBuilder::new().level_filter(LevelFilter::Off);
        assert_eq!(builder.min_level, Level::Trace);
    }

    #[test]
    fn test_builder_timestamps() {
        let builder = RichLoggerBuilder::new().with_timestamps(false);
        assert!(!builder.show_timestamps);
    }

    #[test]
    fn test_builder_targets() {
        let builder = RichLoggerBuilder::new().with_targets(false);
        assert!(!builder.show_targets);
    }

    #[test]
    fn test_builder_file_line() {
        let builder = RichLoggerBuilder::new().with_file_line(true);
        assert!(builder.show_file_line);
    }

    #[test]
    fn test_builder_max_width() {
        let builder = RichLoggerBuilder::new().with_max_width(Some(80));
        assert_eq!(builder.max_width, Some(80));
    }

    #[test]
    fn test_builder_build() {
        let logger = RichLoggerBuilder::new()
            .level(Level::Debug)
            .with_timestamps(false)
            .build();

        // Logger should be configured
        assert!(
            logger.enabled(
                &log::Metadata::builder()
                    .level(Level::Debug)
                    .target("test")
                    .build()
            )
        );
        assert!(!logger.show_timestamps);
    }

    #[test]
    fn test_logger_builder_method() {
        let builder = RichLogger::builder();
        // Should create a default builder
        assert_eq!(builder.min_level, Level::Info);
    }

    #[test]
    fn test_record_to_event_with_timestamp_and_location() {
        let logger = RichLogger::new(Level::Trace);

        let record = log::Record::builder()
            .args(format_args!("hello world"))
            .level(Level::Warn)
            .target("fastmcp_rust::logger")
            .file(Some("src/logger.rs"))
            .line(Some(77))
            .build();

        let event = logger.record_to_event(&record);
        assert_eq!(event.level, LogLevel::Warn);
        assert_eq!(event.message, "hello world");
        assert_eq!(event.target.as_deref(), Some("fastmcp_rust::logger"));
        assert_eq!(event.file.as_deref(), Some("src/logger.rs"));
        assert_eq!(event.line, Some(77));
        assert!(event.timestamp.is_some());
    }

    #[test]
    fn test_record_to_event_without_timestamp_or_location() {
        let logger = RichLoggerBuilder::new().with_timestamps(false).build();

        let record = log::Record::builder()
            .args(format_args!("no timestamp"))
            .level(Level::Info)
            .target("fastmcp_rust::logger")
            .build();

        let event = logger.record_to_event(&record);
        assert_eq!(event.level, LogLevel::Info);
        assert_eq!(event.message, "no timestamp");
        assert_eq!(event.timestamp, None);
        assert_eq!(event.file, None);
        assert_eq!(event.line, None);
    }

    #[test]
    fn test_log_and_flush_paths() {
        let logger = RichLoggerBuilder::new()
            .level(Level::Info)
            .with_timestamps(false)
            .build();

        let debug_record = log::Record::builder()
            .args(format_args!("ignored debug"))
            .level(Level::Debug)
            .target("fastmcp_rust::logger")
            .build();
        logger.log(&debug_record);

        let error_record = log::Record::builder()
            .args(format_args!("emitted error"))
            .level(Level::Error)
            .target("fastmcp_rust::logger")
            .build();
        logger.log(&error_record);

        logger.flush();
    }
}