winston 0.8.2

winston for rust
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

#![cfg(feature = "log-backend")]

mod common;

use common::MockTransport;
use serial_test::serial;
use winston::Logger;

#[test]
#[serial]
fn test_log_backend_basic_integration() {
    let transport = MockTransport::new();

    if !winston::is_initialized() {
        let logger = Logger::builder()
            .transport(transport.clone())
            .format(logform::passthrough())
            .build();
        winston::init(logger);
        winston::register_with_log().expect("Failed to register with log crate");
    } else {
        winston::configure(Some(
            winston::LoggerOptions::new()
                .level("info")
                .format(logform::passthrough()),
        ));
        winston::add_transport(transport.clone());
    }

    log::info!("Info from log crate");
    log::warn!("Warning from log crate");
    log::error!("Error from log crate");

    winston::flush().unwrap();

    assert_eq!(transport.log_count(), 3);
    assert!(transport.has_level("info"));
    assert!(transport.has_level("warn"));
    assert!(transport.has_level("error"));
}

#[test]
#[serial]
fn test_log_backend_level_filtering() {
    let transport = MockTransport::new();

    if !winston::is_initialized() {
        let logger = Logger::builder()
            .level("warn")
            .transport(transport.clone())
            .format(logform::passthrough())
            .build();
        winston::init(logger);
        winston::register_with_log().expect("Failed to register");
    } else {
        winston::configure(Some(
            winston::LoggerOptions::new()
                .level("warn")
                .format(logform::passthrough()),
        ));
        winston::add_transport(transport.clone());
    }

    log::trace!("Should be filtered");
    log::debug!("Should be filtered");
    log::info!("Should be filtered");
    log::warn!("Should pass");
    log::error!("Should pass");

    winston::flush().unwrap();

    assert_eq!(transport.log_count(), 2);
    let logs = transport.get_logs();
    assert_eq!(logs[0].level, "warn");
    assert_eq!(logs[1].level, "error");
}

#[test]
#[serial]
fn test_log_backend_metadata_capture() {
    let transport = MockTransport::new();

    if !winston::is_initialized() {
        let logger = Logger::builder()
            .transport(transport.clone())
            .format(logform::passthrough()) // Use passthrough to preserve metadata
            .build();
        winston::init(logger);
        winston::register_with_log().expect("Failed to register");
    } else {
        winston::configure(Some(
            winston::LoggerOptions::new()
                .level("info")
                .format(logform::passthrough()), // Use passthrough to preserve metadata
        ));
        winston::add_transport(transport.clone());
    }

    log::info!("Test message");

    winston::flush().unwrap();

    let logs = transport.get_logs();
    assert_eq!(logs.len(), 1);

    // Should capture timestamp and target metadata
    assert!(logs[0].meta.contains_key("timestamp"));
    assert!(logs[0].meta.contains_key("target"));
}

#[test]
#[serial]
fn test_log_backend_with_format() {
    let transport = MockTransport::new();

    if !winston::is_initialized() {
        let logger = Logger::builder()
            .transport(transport.clone())
            .format(winston::format::json())
            .build();
        winston::init(logger);
        winston::register_with_log().expect("Failed to register");
    } else {
        winston::configure(Some(
            winston::LoggerOptions::new()
                .level("info")
                .format(winston::format::json()),
        ));
        winston::add_transport(transport.clone());
    }

    log::info!("Formatted message");

    winston::flush().unwrap();

    assert_eq!(transport.log_count(), 1);
}

#[test]
#[serial]
fn test_log_backend_enabled_check() {
    let transport = MockTransport::new();

    if !winston::is_initialized() {
        let logger = Logger::builder()
            .level("error")
            .transport(transport.clone())
            .format(logform::passthrough())
            .build();
        winston::init(logger);
        winston::register_with_log().expect("Failed to register");
    } else {
        winston::configure(Some(
            winston::LoggerOptions::new()
                .level("error")
                .format(logform::passthrough()),
        ));
        winston::add_transport(transport.clone());
    }

    // These should be filtered before reaching winston
    if log::log_enabled!(log::Level::Info) {
        log::info!("Should be filtered");
    }

    if log::log_enabled!(log::Level::Error) {
        log::error!("Should pass");
    }

    winston::flush().unwrap();

    // Only error should pass
    assert_eq!(transport.log_count(), 1);
}

#[test]
#[serial]
fn test_log_backend_concurrent_logging() {
    let transport = MockTransport::new();

    if !winston::is_initialized() {
        let logger = Logger::builder()
            .transport(transport.clone())
            .format(logform::passthrough())
            .build();
        winston::init(logger);
        winston::register_with_log().expect("Failed to register");
    } else {
        winston::configure(Some(
            winston::LoggerOptions::new()
                .level("info")
                .format(logform::passthrough()),
        ));
        winston::add_transport(transport.clone());
    }

    let handles: Vec<_> = (0..5)
        .map(|thread_id| {
            std::thread::spawn(move || {
                for i in 0..10 {
                    log::info!("Thread {} - Message {}", thread_id, i);
                }
            })
        })
        .collect();

    for handle in handles {
        handle.join().unwrap();
    }

    winston::flush().unwrap();

    assert_eq!(transport.log_count(), 50);
}

#[test]
#[serial]
fn test_log_backend_mixed_with_winston() {
    let transport = MockTransport::new();

    if !winston::is_initialized() {
        let logger = Logger::builder()
            .transport(transport.clone())
            .format(logform::passthrough())
            .build();
        winston::init(logger);
        winston::register_with_log().expect("Failed to register");
    } else {
        winston::configure(Some(
            winston::LoggerOptions::new()
                .level("info")
                .format(logform::passthrough()),
        ));
        winston::add_transport(transport.clone());
    }

    // Use both log crate and winston
    log::info!("From log crate");
    winston::log!(info, "From winston macro");

    winston::flush().unwrap();

    assert_eq!(transport.log_count(), 2);
}

#[test]
#[serial]
#[cfg(feature = "log-backend-kv")]
fn test_log_backend_with_key_values() {
    let transport = MockTransport::new();

    if !winston::is_initialized() {
        let logger = Logger::builder()
            .transport(transport.clone())
            .format(logform::passthrough()) // Use passthrough to preserve metadata
            .build();
        winston::init(logger);
        winston::register_with_log().expect("Failed to register");
    } else {
        winston::configure(Some(
            winston::LoggerOptions::new()
                .level("info")
                .format(logform::passthrough()), // Use passthrough to preserve metadata
        ));
        winston::add_transport(transport.clone());
    }

    log::info!(target: "test", user_id = 123; "User logged in");

    winston::flush().unwrap();

    let logs = transport.get_logs();
    assert_eq!(logs.len(), 1);

    // Should capture key-value pairs
    assert!(logs[0].meta.contains_key("user_id"));
}

#[test]
#[serial]
fn test_log_backend_flush() {
    let transport = MockTransport::new();

    if !winston::is_initialized() {
        let logger = Logger::builder()
            .transport(transport.clone())
            .format(logform::passthrough())
            .build();
        winston::init(logger);
        winston::register_with_log().expect("Failed to register");
    } else {
        winston::configure(Some(
            winston::LoggerOptions::new()
                .level("info")
                .format(logform::passthrough()),
        ));
        winston::add_transport(transport.clone());
    }

    log::info!("Test flush");

    // Call log's flush
    log::logger().flush();

    assert_eq!(transport.log_count(), 1);
}