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

//! Tired of your log lines and progress bars mixing up? indicatif_log_bridge to the rescue!
//!
//! Simply wrap your favourite logging implementation in [LogWrapper]
//!     and those worries are a thing of the past.
//!
//! Just remember add each [ProgressBar](indicatif::ProgressBar) to the [MultiProgress] you used
//!     , otherwise you are back to ghostly halves of progress bars everywhere.
//!
//! # Example
//! ```rust
//!     # use indicatif_log_bridge::LogWrapper;
//!     # use log::info;
//!     # use indicatif::{MultiProgress, ProgressBar};
//!     # use std::time::Duration;
//!     let logger =
//!         env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info"))
//!             .build();
//!     let level = logger.filter();
//!     let multi = MultiProgress::new();
//!
//!     LogWrapper::new(multi.clone(), logger)
//!         .try_init()
//!         .unwrap();
//!     log::set_max_level(level);
//!
//!     let pg = multi.add(ProgressBar::new(10));
//!     for i in (0..10) {
//!         std::thread::sleep(Duration::from_micros(100));
//!         info!("iteration {}", i);
//!         pg.inc(1);
//!     }
//!     pg.finish();
//!     multi.remove(&pg);
//! ```
//! The code of this crate is pretty simple, so feel free to check it out.
//!
//!
//! # Known Issues
//! ## Wrong Global Log Level
//! The log framework has a global minimum level, set using [log::set_max_level].
//! If that is set to Debug, the trace! macro will not fire at all.
//! The [Log] trait does not provide a standartized way of querying the expected level.
//! [LogWrapper::try_init] tries hard to find the correct level, but does not always get it right,
//!     especially if different levels are specified for different modules or crates,
//!         as is often the case with the `env_logger` crate.
//!
//! ### Workaround
//! For `env_logger` specifically you can use `logger.filter()` to query the level
//! before constructing and initializing the [LogWrapper] and then passit to [log::set_max_level]
//! afterwards.
//! If you copy the [example code](#example) you should be fine.

use indicatif::MultiProgress;
use log::Log;

/// Wraps a MultiProgress and a Log implementor,
/// calling .suspend on the MultiProgress while writing the log message,
/// thereby preventing progress bars and logs from getting mixed up.
///
/// You simply have to add every ProgressBar to the passed MultiProgress.
pub struct LogWrapper<L: Log> {
    bar: MultiProgress,
    log: L,
}

impl<L: Log + 'static> LogWrapper<L> {
    pub fn new(bar: MultiProgress, log: L) -> Self {
        Self { bar, log }
    }

    /// Installs this as the global logger.
    ///
    /// Tries to find the correct argument to log::set_max_level
    /// by reading the logger configuration,
    /// you may want to set it manually though.
    /// For more details read the [known issues](index.html#wrong-global-log-level).
    pub fn try_init(self) -> Result<(), log::SetLoggerError> {
        use log::LevelFilter::*;
        let levels = [Off, Error, Warn, Info, Debug, Trace];

        for level_filter in levels.iter().rev() {
            let level = if let Some(level) = level_filter.to_level() {
                level
            } else {
                // off is the last level, just do nothing in that case
                continue;
            };
            let meta = log::Metadata::builder().level(level).build();
            if self.enabled(&meta) {
                log::set_max_level(*level_filter);
                break;
            }
        }

        log::set_boxed_logger(Box::new(self))
    }
    pub fn multi(&self) -> MultiProgress {
        self.bar.clone()
    }
}

impl<L: Log> Log for LogWrapper<L> {
    fn enabled(&self, metadata: &log::Metadata) -> bool {
        self.log.enabled(metadata)
    }

    fn log(&self, record: &log::Record) {
        // do an early check for enabled to not cause unnescesary suspends
        if self.log.enabled(record.metadata()) {
            self.bar.suspend(|| self.log.log(record))
        }
    }

    fn flush(&self) {
        self.log.flush()
    }
}