tramli 3.2.0

Constrained flow engine — state machines that prevent invalid transitions at build time
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
use std::any::TypeId;
use std::collections::{HashMap, HashSet};
use std::time::Duration;

use crate::data_flow_graph::DataFlowGraph;
use crate::error::FlowError;
use crate::types::*;

pub struct FlowDefinition<S: FlowState> {
    pub name: String,
    pub ttl: Duration,
    pub max_guard_retries: usize,
    pub transitions: Vec<Transition<S>>,
    pub error_transitions: HashMap<S, S>,
    initial_state: Option<S>,
    terminal_states: HashSet<S>,
    data_flow_graph: DataFlowGraph<S>,
    enter_actions: HashMap<S, Box<dyn Fn(&mut crate::context::FlowContext) + Send + Sync>>,
    exit_actions: HashMap<S, Box<dyn Fn(&mut crate::context::FlowContext) + Send + Sync>>,
    pub exception_routes: HashMap<S, Vec<ExceptionRoute<S>>>,
    warnings: Vec<String>,
}

/// Route to a specific state based on error predicate.
pub struct ExceptionRoute<S: FlowState> {
    pub predicate: Box<dyn Fn(&FlowError) -> bool + Send + Sync>,
    pub label: String,
    pub target: S,
}

impl<S: FlowState> FlowDefinition<S> {
    pub fn initial_state(&self) -> Option<S> { self.initial_state }
    pub fn terminal_states(&self) -> &HashSet<S> { &self.terminal_states }
    pub fn data_flow_graph(&self) -> &DataFlowGraph<S> { &self.data_flow_graph }
    /// Structural warnings detected at build() time (e.g. liveness risks).
    pub fn warnings(&self) -> &[String] { &self.warnings }

    /// Get enter action for a state (or None).
    pub fn enter_action(&self, state: S) -> Option<&(dyn Fn(&mut crate::context::FlowContext) + Send + Sync)> {
        self.enter_actions.get(&state).map(|a| &**a)
    }
    /// Get exit action for a state (or None).
    pub fn exit_action(&self, state: S) -> Option<&(dyn Fn(&mut crate::context::FlowContext) + Send + Sync)> {
        self.exit_actions.get(&state).map(|a| &**a)
    }

    pub fn transitions_from(&self, state: S) -> Vec<&Transition<S>> {
        self.transitions.iter().filter(|t| t.from == state).collect()
    }

    pub fn external_from(&self, state: S) -> Option<&Transition<S>> {
        self.transitions.iter().find(|t| t.from == state && t.transition_type == TransitionType::External)
    }

    /// All external transitions from a state (for multi-external).
    pub fn externals_from(&self, state: S) -> Vec<&Transition<S>> {
        self.transitions.iter().filter(|t| t.from == state && t.transition_type == TransitionType::External).collect()
    }
}

// ─── Builder ─────────────────────────────────────────────

pub struct Builder<S: FlowState> {
    name: String,
    ttl: Duration,
    max_guard_retries: usize,
    transitions: Vec<Transition<S>>,
    error_transitions: HashMap<S, S>,
    initially_available: Vec<TypeId>,
    perpetual: bool,
    enter_actions: HashMap<S, Box<dyn Fn(&mut crate::context::FlowContext) + Send + Sync>>,
    exit_actions: HashMap<S, Box<dyn Fn(&mut crate::context::FlowContext) + Send + Sync>>,
    exception_routes: HashMap<S, Vec<(Box<dyn Fn(&FlowError) -> bool + Send + Sync>, String, S)>>,
}

impl<S: FlowState> Builder<S> {
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            name: name.into(), ttl: Duration::from_secs(300), max_guard_retries: 3,
            transitions: Vec::new(), error_transitions: HashMap::new(),
            initially_available: Vec::new(), perpetual: false,
            enter_actions: HashMap::new(), exit_actions: HashMap::new(),
            exception_routes: HashMap::new(),
        }
    }

    pub fn ttl(mut self, ttl: Duration) -> Self { self.ttl = ttl; self }
    pub fn max_guard_retries(mut self, max: usize) -> Self { self.max_guard_retries = max; self }
    pub fn initially_available(mut self, type_ids: Vec<TypeId>) -> Self {
        self.initially_available.extend(type_ids); self
    }
    pub fn allow_perpetual(mut self) -> Self { self.perpetual = true; self }

    pub fn from(self, state: S) -> FromBuilder<S> { FromBuilder { builder: self, from: state } }

    pub fn on_error(mut self, from: S, to: S) -> Self {
        self.error_transitions.insert(from, to); self
    }
    pub fn on_any_error(mut self, error_state: S) -> Self {
        for s in S::all_states() {
            if !s.is_terminal() { self.error_transitions.insert(*s, error_state); }
        }
        self
    }

    /// Callback when entering a state (pure data/metrics, no I/O).
    pub fn on_state_enter(mut self, state: S, action: impl Fn(&mut crate::context::FlowContext) + Send + Sync + 'static) -> Self {
        self.enter_actions.insert(state, Box::new(action));
        self
    }

    /// Callback when exiting a state (pure data/metrics, no I/O).
    pub fn on_state_exit(mut self, state: S, action: impl Fn(&mut crate::context::FlowContext) + Send + Sync + 'static) -> Self {
        self.exit_actions.insert(state, Box::new(action));
        self
    }

    /// Route specific error types to specific states. Checked before on_error.
    pub fn on_step_error(mut self, from: S, predicate: impl Fn(&FlowError) -> bool + Send + Sync + 'static, label: impl Into<String>, to: S) -> Self {
        self.exception_routes.entry(from).or_default().push((Box::new(predicate), label.into(), to));
        self
    }

    pub(crate) fn add_transition(&mut self, t: Transition<S>) { self.transitions.push(t); }

    pub fn build(self) -> Result<FlowDefinition<S>, FlowError> {
        let mut initial = None;
        let mut terminals = HashSet::new();
        for s in S::all_states() {
            if s.is_initial() { initial = Some(*s); }
            if s.is_terminal() { terminals.insert(*s); }
        }
        let perpetual = self.perpetual;
        let initially_available = self.initially_available;
        let name = self.name;
        let enter_actions = self.enter_actions;
        let exit_actions = self.exit_actions;
        let exception_routes: HashMap<S, Vec<ExceptionRoute<S>>> = self.exception_routes.into_iter()
            .map(|(s, routes)| (s, routes.into_iter().map(|(pred, label, target)| ExceptionRoute { predicate: pred, label, target }).collect()))
            .collect();
        let def = FlowDefinition {
            name: name.clone(), ttl: self.ttl, max_guard_retries: self.max_guard_retries,
            transitions: self.transitions, error_transitions: self.error_transitions,
            initial_state: initial, terminal_states: terminals,
            data_flow_graph: DataFlowGraph::empty(),
            enter_actions: HashMap::new(), exit_actions: HashMap::new(),
            exception_routes: HashMap::new(), warnings: Vec::new(),
        };
        validate::<S>(&def, &name, perpetual, &initially_available)?;
        let graph = DataFlowGraph::build(&def, &initially_available);

        // Build warnings
        let mut warnings = Vec::new();
        let is_perpetual = def.terminal_states.is_empty();
        let has_external = def.transitions.iter().any(|t| t.transition_type == TransitionType::External);
        if is_perpetual && has_external {
            warnings.push(format!("Perpetual flow '{}' has External transitions — ensure events are always delivered to avoid deadlock (liveness risk)", name));
        }
        // Dead data warning
        let dead = graph.dead_data();
        if !dead.is_empty() {
            warnings.push(format!("Dead data detected: {:?} — produced but never required by any downstream processor", dead));
        }
        // Exception route ordering warning (broader predicates before narrower ones)
        for (state, routes) in &exception_routes {
            if routes.len() > 1 {
                warnings.push(format!("onStepError at {:?}: {} routes registered — ensure broader predicates come after specific ones", state, routes.len()));
            }
        }

        Ok(FlowDefinition { data_flow_graph: graph, enter_actions, exit_actions, exception_routes, warnings, ..def })
    }
}

// ─── FromBuilder ─────────────────────────────────────────

pub struct FromBuilder<S: FlowState> { builder: Builder<S>, from: S }

impl<S: FlowState> FromBuilder<S> {
    pub fn auto(mut self, to: S, processor: impl StateProcessor<S> + 'static) -> Builder<S> {
        self.builder.add_transition(Transition {
            from: self.from, to, transition_type: TransitionType::Auto,
            processor: Some(Box::new(processor)), guard: None, branch: None,
            branch_targets: HashMap::new(), sub_flow: None, timeout: None,
        });
        self.builder
    }

    pub fn external(mut self, to: S, guard: impl TransitionGuard<S> + 'static) -> Builder<S> {
        self.builder.add_transition(Transition {
            from: self.from, to, transition_type: TransitionType::External,
            processor: None, guard: Some(Box::new(guard)), branch: None,
            branch_targets: HashMap::new(), sub_flow: None, timeout: None,
        });
        self.builder
    }

    pub fn external_with_processor(mut self, to: S, guard: impl TransitionGuard<S> + 'static, processor: impl StateProcessor<S> + 'static) -> Builder<S> {
        self.builder.add_transition(Transition {
            from: self.from, to, transition_type: TransitionType::External,
            processor: Some(Box::new(processor)), guard: Some(Box::new(guard)), branch: None,
            branch_targets: HashMap::new(), sub_flow: None, timeout: None,
        });
        self.builder
    }

    pub fn external_with_timeout(mut self, to: S, guard: impl TransitionGuard<S> + 'static, timeout: std::time::Duration) -> Builder<S> {
        self.builder.add_transition(Transition {
            from: self.from, to, transition_type: TransitionType::External,
            processor: None, guard: Some(Box::new(guard)), branch: None,
            branch_targets: HashMap::new(), sub_flow: None, timeout: Some(timeout),
        });
        self.builder
    }

    pub fn external_with_processor_and_timeout(mut self, to: S, guard: impl TransitionGuard<S> + 'static, processor: impl StateProcessor<S> + 'static, timeout: std::time::Duration) -> Builder<S> {
        self.builder.add_transition(Transition {
            from: self.from, to, transition_type: TransitionType::External,
            processor: Some(Box::new(processor)), guard: Some(Box::new(guard)), branch: None,
            branch_targets: HashMap::new(), sub_flow: None, timeout: Some(timeout),
        });
        self.builder
    }

    pub fn sub_flow(self, runner: Box<dyn crate::sub_flow::SubFlowRunner>) -> SubFlowBuilder<S> {
        SubFlowBuilder {
            builder: self.builder, from: self.from,
            runner, exit_mappings: HashMap::new(),
        }
    }

    pub fn branch(self, branch: impl BranchProcessor<S> + 'static) -> BranchBuilder<S> {
        BranchBuilder {
            builder: self.builder, from: self.from,
            branch: Some(Box::new(branch)),
            targets: HashMap::new(),
        }
    }
}

// ─── BranchBuilder ───────────────────────────────────────

pub struct BranchBuilder<S: FlowState> {
    builder: Builder<S>, from: S,
    branch: Option<Box<dyn BranchProcessor<S>>>,
    targets: HashMap<String, S>,
}

impl<S: FlowState> BranchBuilder<S> {
    pub fn to(mut self, state: S, label: impl Into<String>) -> Self {
        self.targets.insert(label.into(), state); self
    }

    pub fn end_branch(mut self) -> Builder<S> {
        let targets_clone = self.targets.clone();
        let mut first = true;
        for (_label, target) in &self.targets {
            self.builder.add_transition(Transition {
                from: self.from, to: *target, transition_type: TransitionType::Branch,
                processor: None, guard: None,
                branch: if first { self.branch.take() } else { None },
                branch_targets: targets_clone.clone(), sub_flow: None, timeout: None,
            });
            first = false;
        }
        self.builder
    }
}

// ─── SubFlowBuilder ───────────────────────────────────

pub struct SubFlowBuilder<S: FlowState> {
    builder: Builder<S>,
    from: S,
    runner: Box<dyn crate::sub_flow::SubFlowRunner>,
    exit_mappings: HashMap<String, S>,
}

impl<S: FlowState> SubFlowBuilder<S> {
    pub fn on_exit(mut self, terminal_name: &str, parent_state: S) -> Self {
        self.exit_mappings.insert(terminal_name.to_string(), parent_state);
        self
    }

    pub fn end_sub_flow(mut self) -> Builder<S> {
        self.builder.add_transition(Transition {
            from: self.from, to: self.from, transition_type: TransitionType::SubFlow,
            processor: None, guard: None, branch: None,
            branch_targets: HashMap::new(),
            sub_flow: Some(crate::sub_flow::SubFlowConfig {
                runner: self.runner,
                exit_mappings: self.exit_mappings,
            }),
            timeout: None,
        });
        self.builder
    }
}

// ─── Validation ─────────────────────────────────────────

fn validate<S: FlowState>(def: &FlowDefinition<S>, name: &str, perpetual: bool, initially_available: &[TypeId]) -> Result<(), FlowError> {
    let mut errors = Vec::new();
    if def.initial_state.is_none() { errors.push("No initial state found".into()); }

    check_reachability(def, &mut errors);
    if !perpetual { check_path_to_terminal(def, &mut errors); }
    check_dag(def, &mut errors);
    // check_external_uniqueness removed (DD-020: multi-external allowed)
    check_branch_completeness(def, &mut errors);
    check_requires_produces(def, initially_available, &mut errors);
    check_auto_external_conflict(def, &mut errors);
    check_sub_flow_nesting_depth(def, &mut errors, 0);
    check_sub_flow_circular_ref(def, &mut errors, &mut Vec::new());
    check_terminal_no_outgoing(def, &mut errors);

    if errors.is_empty() { Ok(()) } else {
        Err(FlowError::new("INVALID_FLOW_DEFINITION",
            format!("Flow '{}' has {} error(s):\n  - {}", name, errors.len(), errors.join("\n  - "))))
    }
}

fn check_reachability<S: FlowState>(def: &FlowDefinition<S>, errors: &mut Vec<String>) {
    let Some(initial) = def.initial_state else { return };
    let mut visited = HashSet::new();
    let mut queue = vec![initial];
    visited.insert(initial);
    while let Some(current) = queue.pop() {
        for t in def.transitions_from(current) {
            if t.transition_type == TransitionType::SubFlow {
                if let Some(ref sf) = t.sub_flow {
                    for target in sf.exit_mappings.values() {
                        if visited.insert(*target) { queue.push(*target); }
                    }
                }
                continue;
            }
            if visited.insert(t.to) { queue.push(t.to); }
        }
        if let Some(&e) = def.error_transitions.get(&current) { if visited.insert(e) { queue.push(e); } }
    }
    for s in S::all_states() {
        if !visited.contains(s) && !s.is_terminal() {
            errors.push(format!("State {:?} is not reachable from {:?}", s, initial));
        }
    }
}

fn check_path_to_terminal<S: FlowState>(def: &FlowDefinition<S>, errors: &mut Vec<String>) {
    let Some(initial) = def.initial_state else { return };
    let mut visited = HashSet::new();
    if !can_reach_terminal(def, initial, &mut visited) {
        errors.push(format!("No path from {:?} to any terminal state", initial));
    }
}

fn can_reach_terminal<S: FlowState>(def: &FlowDefinition<S>, state: S, visited: &mut HashSet<S>) -> bool {
    if state.is_terminal() { return true; }
    if !visited.insert(state) { return false; }
    for t in def.transitions_from(state) {
        if t.transition_type == TransitionType::SubFlow {
            if let Some(ref sf) = t.sub_flow {
                for target in sf.exit_mappings.values() {
                    if can_reach_terminal(def, *target, visited) { return true; }
                }
            }
            continue;
        }
        if can_reach_terminal(def, t.to, visited) { return true; }
    }
    if let Some(&e) = def.error_transitions.get(&state) { if can_reach_terminal(def, e, visited) { return true; } }
    false
}

fn check_dag<S: FlowState>(def: &FlowDefinition<S>, errors: &mut Vec<String>) {
    let mut graph: HashMap<S, Vec<S>> = HashMap::new();
    for t in &def.transitions {
        if t.transition_type == TransitionType::Auto || t.transition_type == TransitionType::Branch {
            graph.entry(t.from).or_default().push(t.to);
        }
    }
    let mut visited = HashSet::new();
    let mut in_stack = HashSet::new();
    for s in S::all_states() {
        if !visited.contains(s) && has_cycle(&graph, *s, &mut visited, &mut in_stack) {
            errors.push(format!("Auto/Branch transitions contain a cycle involving {:?}", s));
            break;
        }
    }
}

fn has_cycle<S: FlowState>(graph: &HashMap<S, Vec<S>>, node: S, visited: &mut HashSet<S>, in_stack: &mut HashSet<S>) -> bool {
    visited.insert(node); in_stack.insert(node);
    if let Some(ns) = graph.get(&node) {
        for &n in ns {
            if in_stack.contains(&n) { return true; }
            if !visited.contains(&n) && has_cycle(graph, n, visited, in_stack) { return true; }
        }
    }
    in_stack.remove(&node); false
}

fn check_branch_completeness<S: FlowState>(def: &FlowDefinition<S>, errors: &mut Vec<String>) {
    let all: HashSet<S> = S::all_states().iter().copied().collect();
    for t in &def.transitions {
        if t.transition_type == TransitionType::Branch {
            for (label, target) in &t.branch_targets {
                if !all.contains(target) { errors.push(format!("Branch target '{}' -> {:?} is not a valid state", label, target)); }
            }
        }
    }
}

fn check_requires_produces<S: FlowState>(def: &FlowDefinition<S>, initially_available: &[TypeId], errors: &mut Vec<String>) {
    let Some(initial) = def.initial_state else { return };
    let mut state_available: HashMap<S, HashSet<TypeId>> = HashMap::new();
    let init_set: HashSet<TypeId> = initially_available.iter().copied().collect();
    check_rp_from(def, initial, &init_set, &mut state_available, errors);
}

fn check_rp_from<S: FlowState>(def: &FlowDefinition<S>, state: S, available: &HashSet<TypeId>,
    state_available: &mut HashMap<S, HashSet<TypeId>>, errors: &mut Vec<String>) {
    if let Some(existing) = state_available.get_mut(&state) {
        if available.is_subset(existing) { return; }
        let new_set: HashSet<TypeId> = existing.intersection(available).copied().collect();
        if new_set == *existing { return; } // no change after intersection — stop
        *existing = new_set;
    } else {
        state_available.insert(state, available.clone());
    }
    for t in def.transitions_from(state) {
        let mut new_avail = state_available.get(&state).unwrap().clone();
        if let Some(g) = &t.guard {
            for r in g.requires() { if !new_avail.contains(&r) { errors.push(format!("Guard '{}' at {:?} requires a type that may not be available", g.name(), t.from)); } }
            new_avail.extend(g.produces());
        }
        if let Some(b) = &t.branch {
            for r in b.requires() { if !new_avail.contains(&r) { errors.push(format!("Branch '{}' at {:?} requires a type that may not be available", b.name(), t.from)); } }
        }
        if let Some(p) = &t.processor {
            for r in p.requires() { if !new_avail.contains(&r) { errors.push(format!("Processor '{}' at {:?}->{:?} requires a type that may not be available", p.name(), t.from, t.to)); } }
            new_avail.extend(p.produces());
        }
        check_rp_from(def, t.to, &new_avail, state_available, errors);

        // Error path analysis: if processor fails, its produces are NOT available
        if t.processor.is_some() {
            if let Some(&error_target) = def.error_transitions.get(&t.from) {
                let mut error_avail = state_available.get(&state).unwrap().clone();
                if let Some(g) = &t.guard { error_avail.extend(g.produces()); }
                check_rp_from(def, error_target, &error_avail, state_available, errors);
            }
        }
    }
}

fn check_auto_external_conflict<S: FlowState>(def: &FlowDefinition<S>, errors: &mut Vec<String>) {
    for s in S::all_states() {
        let trans = def.transitions_from(*s);
        let has_auto = trans.iter().any(|t| t.transition_type == TransitionType::Auto || t.transition_type == TransitionType::Branch);
        let has_ext = trans.iter().any(|t| t.transition_type == TransitionType::External);
        if has_auto && has_ext { errors.push(format!("State {:?} has both auto/branch and external transitions", s)); }
    }
}

fn check_sub_flow_nesting_depth<S: FlowState>(def: &FlowDefinition<S>, errors: &mut Vec<String>, depth: usize) {
    if depth > 3 {
        errors.push(format!("SubFlow nesting depth exceeds maximum of 3 (flow: {})", def.name));
        return;
    }
    for t in &def.transitions {
        if t.transition_type == TransitionType::SubFlow {
            if let Some(ref config) = t.sub_flow {
                let sub_depth = config.runner.nesting_depth();
                if depth + sub_depth > 3 {
                    errors.push(format!("SubFlow '{}' at {:?} would exceed max nesting depth 3 (current: {}, sub: {})",
                        config.runner.name(), t.from, depth, sub_depth));
                }
            }
        }
    }
}

fn check_sub_flow_circular_ref<S: FlowState>(def: &FlowDefinition<S>, errors: &mut Vec<String>, visited: &mut Vec<String>) {
    if visited.contains(&def.name) {
        errors.push(format!("Circular sub-flow reference detected: {} -> {}", visited.join(" -> "), def.name));
        return;
    }
    visited.push(def.name.clone());
    for t in &def.transitions {
        if t.transition_type == TransitionType::SubFlow {
            if let Some(ref config) = t.sub_flow {
                // Check by name (runner exposes name)
                let sub_name = config.runner.name().to_string();
                if visited.contains(&sub_name) {
                    errors.push(format!("Circular sub-flow reference detected: {} -> {}", visited.join(" -> "), sub_name));
                }
            }
        }
    }
    visited.pop();
}

fn check_terminal_no_outgoing<S: FlowState>(def: &FlowDefinition<S>, errors: &mut Vec<String>) {
    for t in &def.transitions {
        if t.from.is_terminal() && t.transition_type != TransitionType::SubFlow {
            errors.push(format!("Terminal state {:?} has outgoing transition to {:?}", t.from, t.to));
        }
    }
}