winston 0.5.0

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
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
//use std::collections::HashMap;
use logform::{Format, LogInfo};
use std::collections::HashMap;
use std::fs::{File, OpenOptions};
use std::io::{BufRead, BufReader, BufWriter, Write};
use std::path::PathBuf;
use std::sync::{Arc, Mutex};
use winston_proxy_transport::Proxy;
use winston_transport::{LogQuery, Transport};

pub struct FileTransportOptions {
    pub level: Option<String>,
    pub format: Option<Arc<dyn Format<Input = LogInfo> + Send + Sync>>,
    pub filename: Option<PathBuf>,
    /*
    unused yet
    pub dirname: Option<String>,
    pub options: Option<HashMap<String, String>>,
    pub maxsize: Option<u64>,
    pub stream: Option<Box<dyn Write + Send + Sync>>,
    pub rotation_format: Option<Box<dyn Fn() -> String + Send + Sync>>,
    pub zipped_archive: Option<bool>,
    pub max_files: Option<u64>,
    pub eol: Option<String>,
    pub tailable: Option<bool>,
    pub lazy: Option<bool>,
     */
}

pub struct FileTransport {
    file: Mutex<BufWriter<File>>,
    options: FileTransportOptions,
    proxy_lock: Mutex<()>,
}

impl FileTransport {
    pub fn new(options: FileTransportOptions) -> Self {
        let file_path = options
            .filename
            .clone()
            .expect("File path is required for FileTransport");
        let file = OpenOptions::new()
            .create(true)
            .append(true)
            .open(file_path)
            .expect("Failed to open log file");
        let writer = BufWriter::new(file);

        FileTransport {
            file: Mutex::new(writer),
            options,
            proxy_lock: Mutex::new(()),
        }
    }

    pub fn builder() -> FileTransportBuilder {
        FileTransportBuilder::new()
    }

    /*unused
    pub fn flush(&self) -> std::io::Result<()> {
           let mut file = self.file.lock().unwrap();
           file.flush()
       }
    */
}

impl FileTransport {
    fn parse_log_entry(&self, line: &str) -> Option<LogInfo> {
        let parsed: serde_json::Value = serde_json::from_str(line).ok()?;
        //println!("Parsed log entry: {:?}", parsed); // Debug print

        let level = parsed["level"].as_str()?;
        let message = parsed["message"].as_str()?;
        let meta = parsed
            .as_object()?
            .iter()
            //.map(|(k, v)| (k.clone(), v.clone()))
            .filter_map(|(k, v)| {
                if k != "level" && k != "message" {
                    Some((k.clone(), v.clone()))
                } else {
                    None
                }
            })
            .collect::<HashMap<_, _>>(); // Collect all metadata

        Some(LogInfo {
            level: level.to_string(),
            message: message.to_string(),
            meta,
        })
    }
}

impl Transport for FileTransport {
    /*fn log(&self, message: &str, _level: &str) {
        let mut file = self.file.lock().unwrap();

        writeln!(file, "{}", message).unwrap();
    } */

    fn log(&self, info: LogInfo) {
        let mut file = self.file.lock().unwrap();
        if let Err(e) = writeln!(file, "{}", info.message) {
            eprintln!("Failed to write to log file: {}", e);
        }
    }

    fn log_batch(&self, logs: Vec<LogInfo>) {
        let mut file = self.file.lock().unwrap();
        for info in logs {
            if let Err(e) = writeln!(file, "{}", info.message) {
                eprintln!("Failed to write to log file in batch: {}", e);
            }
        }
    }

    fn flush(&self) -> Result<(), String> {
        let mut file = self.file.lock().unwrap();
        //println!("Flushing file transport");

        file.flush()
            .map_err(|e| format!("Failed to flush file: {}", e))
    }

    fn get_level(&self) -> Option<&String> {
        self.options.level.as_ref()
    }

    fn get_format(&self) -> Option<Arc<dyn Format<Input = LogInfo> + Send + Sync + 'static>> {
        self.options.format.as_ref().cloned()
    }

    fn query(&self, query: &LogQuery) -> Result<Vec<LogInfo>, String> {
        let file = File::open(self.options.filename.as_ref().unwrap())
            .map_err(|e| format!("Failed to open log file: {}", e))?;
        let reader = BufReader::new(file);

        let mut results = Vec::new();

        // Determine the start and limit values
        let start = query.start.unwrap_or(0);
        let limit = query.limit.unwrap_or(usize::MAX);

        for (index, line) in reader.lines().enumerate() {
            let line = line.map_err(|e| format!("Failed to read line {}: {}", index, e))?;
            if let Some(entry) = self.parse_log_entry(&line) {
                if query.matches(&entry) {
                    // Skip lines until the start position
                    if index >= start {
                        results.push(entry);
                    }

                    // Stop reading if the limit is reached
                    if results.len() >= limit && limit != 0 {
                        break;
                    }
                }
            }
        }

        // Apply sorting to the results
        query.sort(&mut results);

        // Project fields if specified
        let results = if !query.fields.is_empty() {
            results
                .into_iter()
                .map(|entry| {
                    // Normalize fields to lowercase for case-insensitive matching
                    let normalized_fields: Vec<String> =
                        query.fields.iter().map(|f| f.to_lowercase()).collect();

                    LogInfo {
                        // Only include level if 'level' is in fields
                        level: if normalized_fields.contains(&"level".to_string()) {
                            entry.level
                        } else {
                            String::new()
                        },
                        // Only include message if 'message' is in fields
                        message: if normalized_fields.contains(&"message".to_string()) {
                            entry.message
                        } else {
                            String::new()
                        },
                        // Filter meta fields based on specified fields
                        meta: entry
                            .meta
                            .into_iter()
                            .filter(|(k, _)| normalized_fields.contains(&k.to_lowercase()))
                            .collect(),
                    }
                })
                .collect()
        } else {
            results
        };

        //println!("results: {:?}", results);
        Ok(results)
    }
}

impl Drop for FileTransport {
    fn drop(&mut self) {
        // Attempt to flush any remaining logs before dropping
        if let Ok(mut file) = self.file.lock() {
            if let Err(e) = file.flush() {
                eprintln!("Error flushing log file during drop: {}", e);
            }
        }
    }
}

impl Proxy for FileTransport {
    fn proxy(&self, target: &dyn Proxy) -> Result<usize, String> {
        let _lock = self
            .proxy_lock
            .lock()
            .map_err(|_| "Failed to acquire proxy lock")?;

        let log_file_path = self
            .options
            .filename
            .as_ref()
            .ok_or("No file path provided")?;

        // Generate backup path
        let mut counter = 0;
        let backup_path = loop {
            let candidate = log_file_path.with_extension(format!("bak{}", counter));
            if !candidate.exists() {
                break candidate;
            }
            counter += 1;
        };

        // Lock file and flush pending writes
        {
            let mut file_guard = self
                .file
                .lock()
                .map_err(|_| "Failed to acquire file lock")?;
            file_guard
                .flush()
                .map_err(|e| format!("Failed to flush pending writes: {}", e))?;
        } // Drop the lock to release the file handle

        // Rename file
        std::fs::rename(log_file_path, &backup_path)
            .map_err(|e| format!("Failed to rename file: {}", e))?;

        // Create new log file and update the BufWriter
        let new_log_file = File::create(log_file_path)
            .map_err(|e| format!("Failed to create new log file: {}", e))?;

        // Replace the old BufWriter with a new one pointing to the new file
        {
            let mut file_guard = self
                .file
                .lock()
                .map_err(|_| "Failed to acquire file lock")?;
            *file_guard = BufWriter::new(new_log_file);
        }

        // Open the backup log file for streaming
        let file =
            File::open(&backup_path).map_err(|e| format!("Failed to open backup log: {}", e))?;
        let mut reader = BufReader::new(file);
        let mut line = String::new();
        let mut log_count = 0;

        // Read line by line and send immediately
        while reader
            .read_line(&mut line)
            .map_err(|e| format!("Failed to read log line: {}", e))?
            > 0
        {
            if let Some(log) = self.parse_log_entry(&line) {
                target.ingest(vec![log])?; // Directly send each log
                log_count += 1;
            }
            line.clear(); // Clear buffer for next line
        }

        // Delete backup file after processing
        std::fs::remove_file(&backup_path)
            .map_err(|e| format!("Failed to delete backup file: {}", e))?;

        Ok(log_count)
    }

    fn ingest(&self, logs: Vec<LogInfo>) -> Result<(), String> {
        let mut file = self
            .file
            .lock()
            .map_err(|e| format!("Failed to acquire file lock for ingest: {}", e))?;

        for log in logs {
            let formatted_log = self
                .options
                .format
                .as_ref()
                .map(|format| format.transform(log.clone()))
                .unwrap_or(Some(log))
                .ok_or_else(|| "Transform failed".to_string())?;

            writeln!(file, "{}", formatted_log.message)
                .map_err(|e| format!("Failed to write log: {}", e))?;
        }

        // Flush after writing batch
        file.flush()
            .map_err(|e| format!("Failed to flush after ingest: {}", e))?;
        Ok(())
    }
}

pub struct FileTransportBuilder {
    level: Option<String>,
    format: Option<Arc<dyn Format<Input = LogInfo> + Send + Sync>>,
    filename: Option<PathBuf>,
}

impl FileTransportBuilder {
    pub fn new() -> Self {
        Self {
            level: None,
            format: None,
            filename: None,
        }
    }

    pub fn level<T: Into<String>>(mut self, level: T) -> Self {
        self.level = Some(level.into());
        self
    }

    pub fn format<F>(mut self, format: F) -> Self
    where
        F: Format<Input = LogInfo> + Send + Sync + 'static,
    {
        self.format = Some(Arc::new(format));
        self
    }

    pub fn filename<T: Into<PathBuf>>(mut self, filename: T) -> Self {
        self.filename = Some(filename.into());
        self
    }

    pub fn build(self) -> FileTransport {
        let options = FileTransportOptions {
            level: self.level,
            format: self.format,
            filename: self.filename,
            // Set other fields as needed
        };
        FileTransport::new(options)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use logform::{json, timestamp};
    use std::sync::Arc;
    use std::thread;
    use std::time::Duration;
    use winston_proxy_transport::ProxyTransport;

    #[test]
    fn test_file_transport_proxy() -> Result<(), String> {
        // Clean up any existing test files
        let _ = std::fs::remove_file("test_source.log");
        let _ = std::fs::remove_file("test_target.log");

        let source_transport =
            Arc::new(FileTransport::builder().filename("test_source.log").build());
        let target_transport = Arc::new(
            FileTransport::builder()
                .filename("test_target.log")
                .format(json())
                .build(),
        );

        let proxy_interval = Duration::from_secs(1);
        let proxy_transport = ProxyTransport::new(
            source_transport.clone(),
            target_transport.clone(),
            proxy_interval,
        );

        let log = LogInfo::new("info", "Test message");
        let log = timestamp().transform(log.clone()).unwrap();
        let log = json().transform(log.clone()).unwrap();

        proxy_transport.log(log);

        // Wait for the proxying to complete
        thread::sleep(proxy_interval * 2);

        let source_logs_after = source_transport.query(&LogQuery::new())?;
        let target_logs_after = target_transport.query(&LogQuery::new())?;

        assert!(
            source_logs_after.is_empty(),
            "Source log file should be empty after proxying"
        );
        assert_eq!(
            target_logs_after.len(),
            1,
            "Target log file should contain the proxied log"
        );

        // Clean up after test
        let _ = std::fs::remove_file("test_source.log");
        let _ = std::fs::remove_file("test_target.log");
        Ok(())
    }
}