ll/
utils.rs

1use crate::level::Level;
2use std::collections::{BTreeSet, LinkedList};
3
4// Extract tags encoded in the key. we do it by using hashtags.
5// e.g. we can add them to the event like this:
6// `some.event#dont_print#trace` => wil result in the event called
7//  `some.event` and a set of tags ['dont_print', 'trace']
8pub(crate) fn extract_tags(string_with_tags: String) -> (String, BTreeSet<String>) {
9    let key_and_tags = string_with_tags
10        .split('#')
11        .map(|s| s.trim())
12        .filter(|s| !s.is_empty())
13        .collect::<Vec<_>>();
14
15    if key_and_tags.len() < 2 {
16        return (string_with_tags, BTreeSet::new());
17    }
18
19    let mut key_and_tags = key_and_tags
20        .iter()
21        .map(|&s| s.to_string())
22        .collect::<LinkedList<String>>();
23
24    if let Some(key) = key_and_tags.pop_front() {
25        // If that was the only element we'll make it a key
26        if key_and_tags.is_empty() {
27            return (key, BTreeSet::new());
28        }
29
30        return (key, key_and_tags.into_iter().collect());
31    }
32
33    // If something went wrong and we had an empty list after split we'll
34    // just return the key as it was given to us
35    (string_with_tags, BTreeSet::new())
36}
37
38pub(crate) fn extract_log_level_from_tags(tags: &BTreeSet<String>) -> Option<Level> {
39    let mut result_level = None;
40
41    for tag in tags {
42        let found_level = match tag.as_ref() {
43            "info" => Some(Level::Info),
44            "trace" => Some(Level::Trace),
45            "debug" => Some(Level::Debug),
46            _ => None,
47        };
48
49        if let Some(found_level) = found_level {
50            if let Some(entry_level_inner) = result_level {
51                // If more than one tag is present, we take the lowest
52                result_level = Some(std::cmp::min(found_level, entry_level_inner))
53            } else {
54                result_level = Some(found_level)
55            }
56        }
57    }
58
59    result_level
60}
61
62#[cfg(test)]
63mod tests {
64    use super::*;
65    use k9::*;
66
67    #[test]
68    fn test_tags_extraction() {
69        let mut result = String::new();
70
71        let events = vec![
72            "some.event#dont_print",
73            "#dont_print",
74            "another.event#dont_print#trace#dont_save",
75            "#blessed#goals",
76            "",
77            "event #hey    #another tag #hi",
78            "fancy.event#debug",
79            "fancy.event#info",
80            "many.levels #info #debug #trace",
81            "many.levels # #debug #trace",
82        ];
83
84        for event in events {
85            let (key, tags) = extract_tags(event.to_owned());
86            let level = extract_log_level_from_tags(&tags);
87            result.push_str(&format!(
88                "{:.<45}  {:.<15} => {:.<35} | {:?}\n",
89                event,
90                key,
91                tags.into_iter().collect::<Vec<_>>().join(", "),
92                level
93            ))
94        }
95
96        snapshot!(result, "
97some.event#dont_print........................  some.event..... => dont_print......................... | None
98#dont_print..................................  #dont_print.... => ................................... | None
99another.event#dont_print#trace#dont_save.....  another.event.. => dont_print, dont_save, trace....... | Some(Trace)
100#blessed#goals...............................  blessed........ => goals.............................. | None
101.............................................  ............... => ................................... | None
102event #hey    #another tag #hi...............  event.......... => another tag, hey, hi............... | None
103fancy.event#debug............................  fancy.event.... => debug.............................. | Some(Debug)
104fancy.event#info.............................  fancy.event.... => info............................... | Some(Info)
105many.levels #info #debug #trace..............  many.levels.... => debug, info, trace................. | Some(Info)
106many.levels # #debug #trace..................  many.levels.... => debug, trace....................... | Some(Debug)
107
108");
109    }
110}