actiondb 0.3.0

A safe and efficient unstructured text (log) parsing library.
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
use parsers::{Parser, ParseResult};
use utils::{SortedVec, CommonPrefix};
use matcher::trie::node::LiteralNode;
use matcher::trie::node::ParserNode;
use matcher::trie::{HasPattern, TrieOperations};
use matcher::result::MatchResult;

pub type CompiledPattern = Vec<TokenType>;

#[derive(Debug)]
pub enum TokenType {
    Parser(Box<Parser>),
    Literal(String)
}

impl Clone for TokenType {
    fn clone(&self) -> TokenType {
        match self {
            &TokenType::Parser(ref parser) => {
                TokenType::Parser(parser.boxed_clone())
            },
            &TokenType::Literal(ref literal) => {
                TokenType::Literal(literal.clone())
            }
        }
    }
}

#[derive(Debug, Clone)]
pub struct Node {
    literal_children: SortedVec<LiteralNode>,
    parser_children: Vec<ParserNode>
}

enum LiteralLookupResult<'a> {
    Found(usize),
    NotFound,
    GoDown(usize, &'a str)
}

impl Node {
    pub fn new() -> Node {
        Node{ literal_children: SortedVec::new(),
              parser_children: Vec::new() }
    }

    pub fn add_literal_node(&mut self, lnode: LiteralNode) {
        self.literal_children.push(lnode);
    }

    pub fn is_leaf(&self) -> bool {
        self.literal_children.is_empty() &&
            self.parser_children.is_empty()
    }


    // If a literal isn't found the last Node instance and the remaining length of the literal will be returned
    // if the literal is in the trie, we return the last Node instance and the index of the LiteralNode which contains the literal
    pub fn lookup_literal_mut(&mut self, literal: &str) -> Result<(&mut Node, usize), (&mut Node, usize)> {
        match self.search(literal) {
            LiteralLookupResult::Found(pos) => {
                Ok((self, pos))
            },
            LiteralLookupResult::NotFound => {
                Err((self, literal.len()))
            },
            LiteralLookupResult::GoDown(pos, truncated_literal) => {
                self.literal_children.get_mut(pos).unwrap().node_mut().unwrap().lookup_literal_mut(truncated_literal)
            },
        }
    }

    // It's the same as lookup_literal_mut() without the muts
    pub fn lookup_literal(&self, literal: &str) -> Result<(&Node, usize), (&Node, usize)> {
        match self.search(literal) {
            LiteralLookupResult::Found(pos) => {
                Ok((self, pos))
            },
            LiteralLookupResult::NotFound => {
                Err((self, literal.len()))
            },
            LiteralLookupResult::GoDown(pos, truncated_literal) => {
                self.literal_children.get(pos).unwrap().node().unwrap().lookup_literal(truncated_literal)
            },
        }
    }

    fn search<'a, 'b>(&'a self, literal: &'b str) -> LiteralLookupResult<'b> {
        trace!("search(): stepped in");
        trace!("search(): #children = {}", self.literal_children.len());
        trace!("search(): #pchildren = {}", self.parser_children.len());
        let cmp_str = |probe: &LiteralNode| {
            probe.cmp_str(literal)
        };

        match self.literal_children.binary_search_by(&cmp_str) {
            Ok(pos) => {
                self.search_prefix_is_found(literal, pos)
            },
            Err(_) => {
                trace!("search(): there is no common prefix with this literal");
                trace!("search(): literal = {}", literal);
                trace!("search(): #children = {}", self.literal_children.len());
                trace!("search(): #pchildren = {}", self.parser_children.len());
                LiteralLookupResult::NotFound
            }
        }
    }

    fn search_prefix_is_found<'a, 'b>(&'a self, literal: &'b str, pos: usize) -> LiteralLookupResult<'b> {
        if !self.literal_children.get(pos).unwrap().is_leaf() {
            self.search_prefix_is_found_and_node_is_not_leaf(literal, pos)
        } else {
            self.search_prefix_is_found_and_node_is_leaf(literal, pos)
        }
    }

    fn search_prefix_is_found_and_node_is_leaf<'a, 'b>(&'a self, literal: &'b str, pos: usize) -> LiteralLookupResult<'b> {
        trace!("search(): we found a prefix, but it's a leaf");
        if self.literal_children.get(pos).unwrap().literal() == literal {
            trace!("search(): we got it");
            LiteralLookupResult::Found(pos)
        } else {
            trace!("search(): we didn't get it");
            LiteralLookupResult::NotFound
        }
    }

    fn search_prefix_is_found_and_node_is_not_leaf<'a, 'b>(&'a self, literal: &'b str, pos: usize) -> LiteralLookupResult<'b> {
        let literal_node = self.literal_children.get(pos).unwrap();
        let common_prefix_len = literal_node.literal().common_prefix_len(literal);

        if common_prefix_len < literal_node.literal().len() {
            return LiteralLookupResult::NotFound;
        }

        if literal_node.has_value() && (literal.is_empty() || common_prefix_len == literal.len()) {
            trace!("search(): we got it");
            return LiteralLookupResult::Found(pos);
        }

        if let Some(_) = literal_node.node() {
            trace!("search(): literal len = {}", literal.len());
            trace!("search(): common_prefix_len = {}", common_prefix_len);
            trace!("search(): going deeper");
            return LiteralLookupResult::GoDown(pos, literal.ltrunc(common_prefix_len));
        } else {
            unreachable!();
        }
    }

    pub fn parse<'a, 'b>(&'a self, text: &'b str) -> Option<MatchResult<'a, 'b>> {
        trace!("parse(): text = {}", text);
        match self.lookup_literal(text) {
            Ok((node, pos)) => {
                trace!("{:?}", node);
                let pattern = node.literal_children.get(pos).unwrap().pattern().unwrap();
                let result = MatchResult::new(pattern);
                Some(result)
            },
            Err((node, remaining_len)) => {
                let text = text.ltrunc(text.len() - remaining_len);
                trace!("parse(): text = {}", text);
                trace!("parse(): #parser_children = {}", node.parser_children.len());
                node.parse_with_parsers(text)
            }
        }
    }

    fn parse_with_parsers<'a, 'b>(&'a self, text: &'b str) -> Option<MatchResult<'a, 'b>> {
        for i in self.parser_children.iter() {
            trace!("parse(): testing parser");

            if let Some(result) = i.parse(text) {
                return Some(result);
            }
        }
        None
    }

    pub fn parse_then_push_kvpair<'a, 'b>(&'a self, text: &'b str, kvpair: ParseResult<'a, 'b>) -> Option<MatchResult<'a, 'b>> {
        if let Some(mut result) = self.parse(text) {
            result.insert(kvpair);
            Some(result)
        } else {
            None
        }
    }

    fn lookup_parser(&mut self, parser: &Parser<>) -> Option<usize> {
        self.parser_children.iter().position(|ref x| x.parser().hash_os() == parser.hash_os())
    }

    fn insert_literal_tail(&mut self, tail: &str) -> &mut LiteralNode {
        trace!("insert_literal_tail(): tail = {}", tail);
        let cmp_str = |probe: &LiteralNode| {
            probe.cmp_str(tail)
        };

        match self.literal_children.binary_search_by(&cmp_str) {
            Ok(pos) => {
                if let Some(common_prefix_len) = self.literal_children.get(pos).unwrap().literal().has_common_prefix(&tail) {
                    trace!("insert_literal_tail(): common_prefix_len = {}", common_prefix_len);
                    let hit = self.literal_children.remove(pos);
                    trace!("insert_literal_tail(): to_be_split = {}", hit.literal());
                    trace!("insert_literal_tail(): tail = {}", tail);
                    let new_node = hit.split(common_prefix_len, tail);
                    trace!("insert_literal_tail(): new_node = {:?}", &new_node);
                    self.add_literal_node(new_node);

                    let suffix = tail.ltrunc(common_prefix_len);
                    self.lookup_freshly_inserted_literal(pos, suffix)
                } else {
                    unreachable!()
                }
            },
            Err(pos) => {
                trace!("insert_literal_tail(): creating new literal node from tail = {}", tail);
                let mut new_node = LiteralNode::from_str(tail);
                new_node.set_has_value(true);
                self.add_literal_node(new_node);
                self.literal_children.get_mut(pos).unwrap()
            }
        }
    }

    fn lookup_freshly_inserted_literal(&mut self, pos: usize, literal: &str) -> &mut LiteralNode {
        let branching_node = self.literal_children.get_mut(pos).unwrap();
        let (node, pos) = branching_node.node_mut().unwrap().lookup_literal_mut(literal).ok().unwrap();
        node.literal_children.get_mut(pos).unwrap()
    }
}

impl TrieOperations for Node {
    fn insert_literal(&mut self, literal: &str) -> &mut LiteralNode {
        trace!("inserting literal: '{}'", literal);

        match self.lookup_literal_mut(literal) {
            Ok((node, index)) => {
                trace!("insert_literal(): it was already inserted");
                node.literal_children.get_mut(index).unwrap()
            },
            Err((node, rem_len)) => {
                trace!("INSERTING({}), remaining len: {}", literal, rem_len);
                let tail = literal.ltrunc(literal.len() - rem_len);
                node.insert_literal_tail(tail)
            }
        }
    }

    fn insert_parser(&mut self, parser: Box<Parser>) -> &mut ParserNode {
        if let Some(item) = self.lookup_parser(&*parser) {
            self.parser_children.get_mut(item).unwrap()
        } else {
            let pnode = ParserNode::new(parser);
            self.parser_children.push(pnode);
            self.parser_children.last_mut().unwrap()
        }
    }
}

#[cfg(test)]
mod test {
    use matcher::trie::{ParserTrie, TrieOperations};
    use parsers::{Parser, SetParser};
    use matcher::trie::node::{CompiledPattern, Node, TokenType};
    use matcher::pattern::Pattern;

    #[test]
    fn given_empty_trie_when_literals_are_inserted_then_they_can_be_looked_up() {
        let mut node = Node::new();

        let _ = node.insert_literal("alma");
        assert_eq!(node.lookup_literal("alma").is_ok(), true);
        assert_eq!(node.lookup_literal("alm").is_err(), true);
        let _ = node.insert_literal("alm");
        assert_eq!(node.lookup_literal("alm").is_ok(), true);
        assert_eq!(node.literal_children.len(), 1);
    }

    #[test]
    fn test_given_empty_trie_when_literals_are_inserted_the_child_counts_are_right() {
        let mut node = Node::new();

        let _ = node.insert_literal("alma");
        let _ = node.insert_literal("alm");
        assert_eq!(node.literal_children.len(), 1);
        assert_eq!(node.lookup_literal("alma").is_ok(), true);
        assert_eq!(node.lookup_literal("alm").ok().unwrap().0.literal_children.len(), 2);
    }

    #[test]
    fn test_given_empty_trie_when_literals_are_inserted_the_nodes_are_split_on_the_right_place() {
        let mut node = Node::new();

        let _ = node.insert_literal("alm");
        let _ = node.insert_literal("alma");
        let _ = node.insert_literal("ai");
        assert_eq!(node.literal_children.len(), 1);
        assert_eq!(node.lookup_literal("alma").is_ok(), true);
        assert_eq!(node.lookup_literal("alm").ok().unwrap().0.literal_children.len(), 2);
        assert_eq!(node.lookup_literal("ai").ok().unwrap().0.literal_children.len(), 2);
    }

    #[test]
    fn test_given_trie_when_literals_are_looked_up_then_the_edges_in_the_trie_are_not_counted_as_literals() {
        let mut node = Node::new();

        let _ = node.insert_literal("alm");
        let _ = node.insert_literal("ala");
        assert_eq!(node.lookup_literal("al").is_err(), true);
    }

    #[test]
    fn test_given_node_when_the_same_parsers_are_inserted_then_they_are_merged_into_one_parsernode() {
        let mut node = Node::new();

        let _ = node.insert_parser(Box::new(SetParser::from_str("test", "ab")));
        let _ = node.insert_parser(Box::new(SetParser::from_str("test", "ab")));

        assert_eq!(node.parser_children.len(), 1);
    }

    #[test]
    fn test_given_node_when_different_parsers_are_inserted_then_they_are_not_merged() {
        let mut node = Node::new();

        let _ = node.insert_parser(Box::new(SetParser::from_str("test", "ab")));
        let _ = node.insert_parser(Box::new(SetParser::from_str("test", "a")));

        assert_eq!(node.parser_children.len(), 2);
    }

    fn create_parser_trie() -> ParserTrie {
        let mut root = ParserTrie::new();
        let mut cp1 = CompiledPattern::new();
        let mut cp2 = CompiledPattern::new();
        let mut cp3 = CompiledPattern::new();
        cp1.push(TokenType::Literal("app".to_string()));
        cp1.push(TokenType::Parser(Box::new(SetParser::from_str("test", "01234"))));
        cp1.push(TokenType::Literal("le".to_string()));
        cp2.push(TokenType::Literal("appletree".to_string()));
        cp3.push(TokenType::Literal("apple".to_string()));

        let mut pattern1 = Pattern::with_random_uuid();
        pattern1.set_pattern(cp1);
        let mut pattern2 = Pattern::with_random_uuid();
        pattern2.set_pattern(cp2);
        let mut pattern3 = Pattern::with_random_uuid();
        pattern3.set_pattern(cp3);

        root.insert(pattern1);
        root.insert(pattern2);
        root.insert(pattern3);

        root
    }

    #[test]
    fn test_given_parser_trie_when_some_patterns_are_inserted_then_texts_can_be_parsed() {
        let root = create_parser_trie();

        println!("root: {:?}", &root);
        {
            let result = root.parse("bamboo");
            assert_eq!(result.is_none(), true);
        }
        {
            let result = root.parse("app42le");
            assert_eq!(result.is_some(), true);
        }
    }

    #[test]
    fn test_given_parser_trie_when_some_patterns_are_inserted_then_fully_matching_literals_are_returned_as_empty_vectors() {
        let root = create_parser_trie();
        println!("root: {:?}", &root);
        {
            let result = root.parse("appletree");
            assert_eq!(result.unwrap().values().is_empty(), true);
        }
    }

    #[test]
    fn test_given_parser_trie_when_some_patterns_are_inserted_then_literal_matches_have_precedence_over_parser_matches() {
        let root = create_parser_trie();
        println!("root: {:?}", &root);
        {
            let result = root.parse("apple");
            assert_eq!(result.unwrap().values().is_empty(), true);
        }
    }

    fn create_complex_parser_trie() -> ParserTrie {
        let mut root = ParserTrie::new();
        let mut cp1 = CompiledPattern::new();
        let mut cp2 = CompiledPattern::new();
        let mut cp3 = CompiledPattern::new();
        let mut cp4 = CompiledPattern::new();
        cp1.push(TokenType::Literal("app".to_string()));
        cp1.push(TokenType::Parser(Box::new(SetParser::from_str("middle", "01234"))));
        cp1.push(TokenType::Literal("letree".to_string()));
        cp1.push(TokenType::Parser(Box::new(SetParser::from_str("end", "012"))));

        cp2.push(TokenType::Literal("app".to_string()));
        cp2.push(TokenType::Parser(Box::new(SetParser::from_str("middle", "01234"))));
        cp2.push(TokenType::Literal("letree".to_string()));
        cp2.push(TokenType::Parser(Box::new(SetParser::from_str("end", "0123"))));

        cp3.push(TokenType::Literal("bamboo".to_string()));

        cp4.push(TokenType::Literal("bamba".to_string()));

        let mut pattern1 = Pattern::with_random_uuid();
        pattern1.set_pattern(cp1);
        let mut pattern2 = Pattern::with_random_uuid();
        pattern2.set_pattern(cp2);
        let mut pattern3 = Pattern::with_random_uuid();
        pattern3.set_pattern(cp3);
        let mut pattern4 = Pattern::with_random_uuid();
        pattern4.set_pattern(cp4);

        root.insert(pattern1);
        root.insert(pattern2);
        root.insert(pattern3);
        root.insert(pattern4);

        root
    }

    #[test]
    fn test_given_parser_trie_when_a_parser_is_not_matched_then_the_parser_stack_is_unwind_so_an_untried_parser_is_tried() {
        let root = create_complex_parser_trie();
        println!("root: {:?}", &root);
        {
            let result = root.parse("app42letree123");
            assert_eq!(result.unwrap().values(), &btreemap!["end" => "123", "middle" => "42"]);
        }
    }

    #[test]
    fn test_given_parser_trie_when_the_to_be_parsed_literal_is_not_matched_then_the_parse_result_is_none() {
        let root = create_complex_parser_trie();
        println!("root: {:?}", &root);
        {
            let kvpairs = root.parse("lorem ipsum");
            assert_eq!(kvpairs.is_none(), true);
        }
    }

    #[test]
    fn test_given_parser_trie_when_the_to_be_parsed_literal_is_a_prefix_in_the_tree_then_the_parse_result_is_none() {
        let root = create_complex_parser_trie();
        println!("root: {:?}", &root);
        {
            let kvpairs = root.parse("bamb");
            assert_eq!(kvpairs.is_none(), true);
        }
    }

    #[test]
    fn test_given_empty_parser_node_when_it_is_used_for_parsing_then_it_returns_none() {
        let root = Node::new();
        println!("root: {:?}", &root);
        {
            let kvpairs = root.parse("bamb");
            assert_eq!(kvpairs.is_none(), true);
        }
        {
            let kvpairs = root.parse("");
            assert_eq!(kvpairs.is_none(), true);
        }
    }
}