rust-rule-engine 1.20.1

A blazing-fast Rust rule engine with RETE algorithm, backward chaining inference, and GRL (Grule Rule Language) syntax. Features: forward/backward chaining, pattern matching, unification, O(1) rule indexing, TMS, expression evaluation, method calls, streaming with Redis state backend, watermarking, and custom functions. Production-ready for business rules, expert systems, real-time stream processing, and decision automation.
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
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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
#![allow(deprecated)]

use crate::engine::rule::Rule;
use std::collections::{HashMap, HashSet};

/// Dependency analysis for safe parallel execution
#[derive(Debug, Clone)]
pub struct DependencyAnalyzer {
    /// Rules that read from specific fields
    readers: HashMap<String, Vec<String>>, // field -> rule_names
    /// Rules that write to specific fields  
    writers: HashMap<String, Vec<String>>, // field -> rule_names
    /// Dependency graph: rule -> rules it depends on
    dependencies: HashMap<String, HashSet<String>>,
}

impl Default for DependencyAnalyzer {
    fn default() -> Self {
        Self::new()
    }
}

impl DependencyAnalyzer {
    /// Create new dependency analyzer
    pub fn new() -> Self {
        Self {
            readers: HashMap::new(),
            writers: HashMap::new(),
            dependencies: HashMap::new(),
        }
    }

    /// Analyze dependencies in a set of rules
    pub fn analyze(&mut self, rules: &[Rule]) -> DependencyAnalysisResult {
        self.clear();

        // First pass: identify all reads and writes
        for rule in rules {
            self.analyze_rule_io(rule);
        }

        // Second pass: build dependency graph
        self.build_dependency_graph();

        // Third pass: identify conflicts
        let conflicts = self.find_conflicts(rules);

        // Fourth pass: group rules for safe parallel execution
        let execution_groups = self.create_execution_groups(rules);
        let conflicts_len = conflicts.len();

        DependencyAnalysisResult {
            total_rules: rules.len(),
            conflicts: conflicts_len,
            conflict_details: conflicts,
            execution_groups,
            can_parallelize_safely: conflicts_len == 0,
        }
    }

    /// Clear previous analysis
    fn clear(&mut self) {
        self.readers.clear();
        self.writers.clear();
        self.dependencies.clear();
    }

    /// Analyze what fields a rule reads from and writes to
    fn analyze_rule_io(&mut self, rule: &Rule) {
        // Analyze condition reads
        let condition_reads = self.extract_condition_reads(rule);
        for field in condition_reads {
            self.readers
                .entry(field)
                .or_default()
                .push(rule.name.clone());
        }

        // Analyze action writes
        let action_writes = self.extract_action_writes(rule);
        for field in action_writes {
            self.writers
                .entry(field)
                .or_default()
                .push(rule.name.clone());
        }
    }

    /// Extract field reads from rule conditions (proper implementation)
    fn extract_condition_reads(&self, rule: &Rule) -> Vec<String> {
        let mut reads = Vec::new();

        // Extract from actual condition structure
        Self::extract_fields_from_condition_group(&rule.conditions, &mut reads);

        reads
    }

    /// Recursively extract fields from condition groups
    fn extract_fields_from_condition_group(
        condition_group: &crate::engine::rule::ConditionGroup,
        reads: &mut Vec<String>,
    ) {
        match condition_group {
            crate::engine::rule::ConditionGroup::Single(condition) => {
                reads.push(condition.field.clone());
            }
            crate::engine::rule::ConditionGroup::Compound { left, right, .. } => {
                Self::extract_fields_from_condition_group(left, reads);
                Self::extract_fields_from_condition_group(right, reads);
            }
            crate::engine::rule::ConditionGroup::Not(inner) => {
                Self::extract_fields_from_condition_group(inner, reads);
            }
            crate::engine::rule::ConditionGroup::Exists(inner) => {
                // For EXISTS, we're reading the fields to check existence
                Self::extract_fields_from_condition_group(inner, reads);
            }
            crate::engine::rule::ConditionGroup::Forall(inner) => {
                // For FORALL, we're reading the fields to check all match
                Self::extract_fields_from_condition_group(inner, reads);
            }
            crate::engine::rule::ConditionGroup::Accumulate {
                source_pattern,
                extract_field,
                ..
            } => {
                // For ACCUMULATE, we're reading the source pattern and extract field
                reads.push(format!("{}.{}", source_pattern, extract_field));
            }

            #[cfg(feature = "streaming")]
            crate::engine::rule::ConditionGroup::StreamPattern {
                stream_name,
                event_type,
                ..
            } => {
                // For STREAM patterns, we're reading from the stream
                if let Some(event_type) = event_type {
                    reads.push(format!("{}.{}", stream_name, event_type));
                } else {
                    reads.push(stream_name.clone());
                }
            }
        }
    }

    /// Extract field writes from rule actions (proper implementation)
    fn extract_action_writes(&self, rule: &Rule) -> Vec<String> {
        let mut writes = Vec::new();

        // Analyze actual actions to find field writes
        for action in &rule.actions {
            match action {
                crate::types::ActionType::Set { field, .. } => {
                    writes.push(field.clone());
                }
                crate::types::ActionType::Append { field, .. } => {
                    writes.push(field.clone());
                }
                crate::types::ActionType::Retract { object } => {
                    // Retract removes a fact, mark it as a write
                    writes.push(format!("_retracted_{}", object));
                }
                crate::types::ActionType::MethodCall { object, method, .. } => {
                    // Method calls might modify the object
                    writes.push(object.clone());

                    // Some methods have predictable side effects
                    if method.contains("set")
                        || method.contains("update")
                        || method.contains("modify")
                        || method.contains("change")
                    {
                        writes.push(format!("{}.{}", object, method));
                    }
                }
                crate::types::ActionType::Custom {
                    action_type,
                    params,
                } => {
                    // Check if custom action has a target field parameter
                    if let Some(crate::types::Value::String(field)) = params.get("target_field") {
                        writes.push(field.clone());
                    }

                    // Analyze custom action type for side effects
                    writes.extend(self.analyze_custom_action_side_effects(action_type, params));
                }
                // Log doesn't modify fields
                crate::types::ActionType::Log { .. } => {}
                // Workflow actions don't modify facts directly
                crate::types::ActionType::ActivateAgendaGroup { .. } => {}
                crate::types::ActionType::ScheduleRule { .. } => {}
                crate::types::ActionType::CompleteWorkflow { .. } => {}
                crate::types::ActionType::SetWorkflowData { .. } => {}
            }
        }

        writes
    }

    /// Analyze function calls for potential field writes
    #[allow(dead_code)]
    fn analyze_function_side_effects(&self, function_name: &str) -> Vec<String> {
        let mut side_effects = Vec::new();

        // Pattern matching for common function naming conventions
        if function_name.starts_with("set") || function_name.starts_with("update") {
            // setUserScore, updateOrderTotal, etc.
            if let Some(field) = self.extract_field_from_function_name(function_name) {
                side_effects.push(field);
            }
        } else if function_name.starts_with("calculate") || function_name.starts_with("compute") {
            // calculateScore, computeTotal, etc.
            if let Some(field) = self.extract_field_from_function_name(function_name) {
                side_effects.push(field);
            }
        } else if function_name.contains("modify") || function_name.contains("change") {
            // modifyUser, changeStatus, etc.
            if let Some(field) = self.extract_field_from_function_name(function_name) {
                side_effects.push(field);
            }
        }

        side_effects
    }

    /// Analyze custom actions for potential field writes
    fn analyze_custom_action_side_effects(
        &self,
        action_type: &str,
        params: &std::collections::HashMap<String, crate::types::Value>,
    ) -> Vec<String> {
        let mut side_effects = Vec::new();

        // Check for common parameter names that indicate field modification
        for (key, value) in params {
            if key == "field" || key == "target" || key == "output_field" {
                if let crate::types::Value::String(field_name) = value {
                    side_effects.push(field_name.clone());
                }
            }
        }

        // Pattern matching on action type
        if action_type.contains("set")
            || action_type.contains("update")
            || action_type.contains("modify")
            || action_type.contains("calculate")
        {
            // Extract potential field from action type name
            if let Some(field) = self.extract_field_from_function_name(action_type) {
                side_effects.push(field);
            }
        }

        side_effects
    }

    /// Extract field name from function/action name using common patterns
    fn extract_field_from_function_name(&self, name: &str) -> Option<String> {
        // Convert camelCase/PascalCase to dot notation
        // setUserScore -> User.Score
        // calculateOrderTotal -> Order.Total
        // updateVIPStatus -> VIP.Status

        let name = name
            .trim_start_matches("set")
            .trim_start_matches("update")
            .trim_start_matches("calculate")
            .trim_start_matches("compute")
            .trim_start_matches("modify")
            .trim_start_matches("change");

        // Simple pattern matching for common field patterns
        if name.contains("User") && name.contains("Score") {
            Some("User.Score".to_string())
        } else if name.contains("User") && name.contains("VIP") {
            Some("User.IsVIP".to_string())
        } else if name.contains("Order") && name.contains("Total") {
            Some("Order.Total".to_string())
        } else if name.contains("Order") && name.contains("Amount") {
            Some("Order.Amount".to_string())
        } else if name.contains("Discount") {
            Some("Order.DiscountRate".to_string())
        } else {
            // Generic field extraction from camelCase
            self.convert_camel_case_to_field(name)
        }
    }

    /// Convert camelCase to potential field name
    fn convert_camel_case_to_field(&self, name: &str) -> Option<String> {
        if name.is_empty() {
            return None;
        }

        let mut result = String::new();
        let chars = name.chars().peekable();

        for c in chars {
            if c.is_uppercase() && !result.is_empty() {
                result.push('.');
            }
            result.push(c);
        }

        if result.contains('.') {
            Some(result)
        } else {
            None
        }
    }

    /// Build dependency graph based on read/write analysis
    fn build_dependency_graph(&mut self) {
        for (field, readers) in &self.readers {
            if let Some(writers) = self.writers.get(field) {
                // If rule A writes to field X and rule B reads from field X,
                // then rule B depends on rule A
                for reader in readers {
                    for writer in writers {
                        if reader != writer {
                            self.dependencies
                                .entry(reader.clone())
                                .or_default()
                                .insert(writer.clone());
                        }
                    }
                }
            }
        }
    }

    /// Find rules that have conflicts (read/write or write/write to same field)
    fn find_conflicts(&self, rules: &[Rule]) -> Vec<DependencyConflict> {
        let mut conflicts = Vec::new();

        // Group rules by salience
        let mut salience_groups: HashMap<i32, Vec<&Rule>> = HashMap::new();
        for rule in rules {
            salience_groups.entry(rule.salience).or_default().push(rule);
        }

        // Check for conflicts within each salience group
        for (salience, group_rules) in salience_groups {
            if group_rules.len() <= 1 {
                continue; // No conflicts possible with single rule
            }

            // Check for write-write conflicts
            let mut field_writers: HashMap<String, Vec<String>> = HashMap::new();
            for rule in &group_rules {
                let writes = self.extract_action_writes(rule);
                for field in writes {
                    field_writers
                        .entry(field)
                        .or_default()
                        .push(rule.name.clone());
                }
            }

            for (field, writers) in field_writers {
                if writers.len() > 1 {
                    conflicts.push(DependencyConflict {
                        conflict_type: ConflictType::WriteWrite,
                        field: field.clone(),
                        rules: writers,
                        salience,
                        description: format!("Multiple rules write to {}", field),
                    });
                }
            }

            // Check for read-write conflicts
            for rule in &group_rules {
                let reads = self.extract_condition_reads(rule);
                for field in &reads {
                    if let Some(writers) = self.writers.get(field) {
                        let conflicting_writers: Vec<String> = writers
                            .iter()
                            .filter(|writer| {
                                group_rules
                                    .iter()
                                    .any(|r| r.name == **writer && r.name != rule.name)
                            })
                            .cloned()
                            .collect();

                        if !conflicting_writers.is_empty() {
                            let mut involved_rules = conflicting_writers.clone();
                            involved_rules.push(rule.name.clone());

                            conflicts.push(DependencyConflict {
                                conflict_type: ConflictType::ReadWrite,
                                field: field.clone(),
                                rules: involved_rules,
                                salience,
                                description: format!(
                                    "Rule {} reads {} while others write to it",
                                    rule.name, field
                                ),
                            });
                        }
                    }
                }
            }
        }

        conflicts
    }

    /// Create execution groups for safe parallel execution
    fn create_execution_groups(&self, rules: &[Rule]) -> Vec<ExecutionGroup> {
        let mut groups = Vec::new();

        // Group by salience first
        let mut salience_groups: HashMap<i32, Vec<Rule>> = HashMap::new();
        for rule in rules {
            salience_groups
                .entry(rule.salience)
                .or_default()
                .push(rule.clone());
        }

        // Process each salience level
        let mut salience_levels: Vec<_> = salience_groups.keys().copied().collect();
        salience_levels.sort_by(|a, b| b.cmp(a)); // Descending order

        for salience in salience_levels {
            let rules_at_level = &salience_groups[&salience];

            if rules_at_level.len() == 1 {
                // Single rule - always safe
                groups.push(ExecutionGroup {
                    rules: rules_at_level.clone(),
                    execution_mode: ExecutionMode::Sequential,
                    salience,
                    can_parallelize: false,
                    conflicts: Vec::new(),
                });
            } else {
                // Multiple rules - check for conflicts
                let conflicts = self.find_conflicts(rules_at_level);
                let can_parallelize = conflicts.is_empty();

                groups.push(ExecutionGroup {
                    rules: rules_at_level.clone(),
                    execution_mode: if can_parallelize {
                        ExecutionMode::Parallel
                    } else {
                        ExecutionMode::Sequential
                    },
                    salience,
                    can_parallelize,
                    conflicts,
                });
            }
        }

        groups
    }
}

/// Result of dependency analysis
#[derive(Debug, Clone)]
pub struct DependencyAnalysisResult {
    /// Total number of rules analyzed
    pub total_rules: usize,
    /// Number of conflicts found
    pub conflicts: usize,
    /// Detailed conflict information
    pub conflict_details: Vec<DependencyConflict>,
    /// Recommended execution groups
    pub execution_groups: Vec<ExecutionGroup>,
    /// Whether rules can be safely parallelized
    pub can_parallelize_safely: bool,
}

/// A conflict between rules
#[derive(Debug, Clone)]
pub struct DependencyConflict {
    /// Type of conflict
    pub conflict_type: ConflictType,
    /// Field that causes the conflict
    pub field: String,
    /// Rules involved in the conflict
    pub rules: Vec<String>,
    /// Salience level where conflict occurs
    pub salience: i32,
    /// Human-readable description
    pub description: String,
}

/// Type of dependency conflict
#[derive(Debug, Clone, PartialEq)]
pub enum ConflictType {
    /// Multiple rules write to the same field
    WriteWrite,
    /// One rule reads while another writes to the same field
    ReadWrite,
    /// Circular dependency
    Circular,
}

/// Execution group with parallelization recommendation
#[derive(Debug, Clone)]
pub struct ExecutionGroup {
    /// Rules in this group
    pub rules: Vec<Rule>,
    /// Recommended execution mode
    pub execution_mode: ExecutionMode,
    /// Salience level
    pub salience: i32,
    /// Whether this group can be safely parallelized
    pub can_parallelize: bool,
    /// Conflicts preventing parallelization
    pub conflicts: Vec<DependencyConflict>,
}

/// Execution mode recommendation
#[derive(Debug, Clone, PartialEq)]
pub enum ExecutionMode {
    /// Safe to run in parallel
    Parallel,
    /// Must run sequentially due to dependencies
    Sequential,
}

/// Strategy used for execution
#[derive(Debug, Clone, PartialEq)]
pub enum ExecutionStrategy {
    /// All rules executed sequentially (due to dependencies)
    FullSequential,
    /// All rules executed in parallel (no dependencies)
    FullParallel,
    /// Mixed execution (some parallel, some sequential)
    Hybrid,
    /// Forced sequential due to configuration
    ForcedSequential,
}

impl DependencyAnalysisResult {
    /// Get a summary report
    pub fn get_summary(&self) -> String {
        format!(
            "📊 Dependency Analysis Summary:\n   Total rules: {}\n   Conflicts found: {}\n   Safe for parallel: {}\n   Execution groups: {}",
            self.total_rules,
            self.conflicts,
            if self.can_parallelize_safely { "✅ Yes" } else { "❌ No" },
            self.execution_groups.len()
        )
    }

    /// Get detailed report
    pub fn get_detailed_report(&self) -> String {
        let mut report = self.get_summary();
        report.push_str("\n\n🔍 Detailed Analysis:");

        for (i, group) in self.execution_groups.iter().enumerate() {
            report.push_str(&format!(
                "\n\n📋 Group {} (Salience {}):",
                i + 1,
                group.salience
            ));
            report.push_str(&format!(
                "\n   Mode: {:?} | Can parallelize: {}",
                group.execution_mode,
                if group.can_parallelize { "" } else { "" }
            ));
            report.push_str(&format!(
                "\n   Rules: {}",
                group
                    .rules
                    .iter()
                    .map(|r| r.name.as_str())
                    .collect::<Vec<_>>()
                    .join(", ")
            ));

            if !group.conflicts.is_empty() {
                report.push_str("\n   🚨 Conflicts:");
                for conflict in &group.conflicts {
                    report.push_str(&format!(
                        "\n      - {}: {} (rules: {})",
                        match conflict.conflict_type {
                            ConflictType::WriteWrite => "Write-Write",
                            ConflictType::ReadWrite => "Read-Write",
                            ConflictType::Circular => "Circular",
                        },
                        conflict.field,
                        conflict.rules.join(", ")
                    ));
                }
            }
        }

        report
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::engine::rule::{Condition, ConditionGroup};

    #[test]
    fn test_dependency_analyzer_creation() {
        let analyzer = DependencyAnalyzer::new();
        assert!(analyzer.readers.is_empty());
        assert!(analyzer.writers.is_empty());
        assert!(analyzer.dependencies.is_empty());
    }

    #[test]
    fn test_safe_rules_analysis() {
        let mut analyzer = DependencyAnalyzer::new();

        let rules = vec![
            Rule::new(
                "AgeValidation".to_string(),
                ConditionGroup::Single(Condition::new(
                    "User.Age".to_string(),
                    crate::types::Operator::GreaterThan,
                    crate::types::Value::Integer(18),
                )),
                vec![],
            ),
            Rule::new(
                "CountryCheck".to_string(),
                ConditionGroup::Single(Condition::new(
                    "User.Country".to_string(),
                    crate::types::Operator::Equal,
                    crate::types::Value::String("US".to_string()),
                )),
                vec![],
            ),
        ];

        let result = analyzer.analyze(&rules);
        assert_eq!(result.total_rules, 2);
        assert_eq!(result.conflicts, 0);
        assert!(result.can_parallelize_safely);
    }

    #[test]
    fn test_conflicting_rules_analysis() {
        let mut analyzer = DependencyAnalyzer::new();

        let rules = vec![
            Rule::new(
                "CalculateScore".to_string(),
                ConditionGroup::Single(Condition::new(
                    "User.Data".to_string(),
                    crate::types::Operator::Equal,
                    crate::types::Value::String("valid".to_string()),
                )),
                vec![crate::types::ActionType::Set {
                    field: "User.Score".to_string(),
                    value: crate::types::Value::Integer(85),
                }],
            ),
            Rule::new(
                "CheckVIPStatus".to_string(),
                ConditionGroup::Single(Condition::new(
                    "User.Score".to_string(),
                    crate::types::Operator::GreaterThan,
                    crate::types::Value::Integer(80),
                )),
                vec![crate::types::ActionType::Set {
                    field: "User.IsVIP".to_string(),
                    value: crate::types::Value::Boolean(true),
                }],
            ),
        ];

        let result = analyzer.analyze(&rules);
        assert_eq!(result.total_rules, 2);
        // Should detect conflicts between score calculation and VIP check
        assert!(!result.can_parallelize_safely);
    }
}