polaris_graph 0.3.0

Graph execution primitives for Polaris (Layer 2).
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
//! Unified event enum for graph execution hooks.
//!
//! All hooks receive `&GraphEvent` and can match on variants for typed access.
//!
//! # Example
//!
//! ```
//! use polaris_graph::hooks::events::GraphEvent;
//!
//! fn handle_event(event: &GraphEvent) {
//!     match event {
//!         GraphEvent::SystemStart { node_id, node_name } => {
//!             println!("System {} starting at {:?}", node_name, node_id);
//!         }
//!         GraphEvent::SystemComplete { duration, .. } => {
//!             println!("Completed in {:?}", duration);
//!         }
//!         _ => {}
//!     }
//! }
//! ```

use crate::ExecutionError;
use crate::node::{ContextMode, NodeId};
use std::sync::Arc;
use std::time::Duration;

/// Unified event enum for all graph execution hooks.
///
/// All hooks receive `&GraphEvent` and can match on variants for typed access.
/// This design provides:
/// - Simple multi-schedule registration (all hooks receive the same type)
/// - Typed access via pattern matching
#[derive(Debug, Clone)]
#[non_exhaustive]
pub enum GraphEvent {
    // ─────────────────────────────────────────────────────────────────────────
    // Graph-Level Events
    // ─────────────────────────────────────────────────────────────────────────
    /// Event fired before graph execution begins.
    GraphStart {
        /// Number of nodes in the graph.
        node_count: usize,
        /// Node ID to name mapping for all nodes in the graph.
        node_map: Vec<(NodeId, &'static str)>,
    },

    /// Event fired after graph execution completes.
    GraphComplete {
        /// Number of nodes executed.
        nodes_executed: usize,
        /// Total execution duration.
        duration: Duration,
    },

    /// Event fired when graph execution fails with an error.
    GraphFailure {
        /// Error details, if available (e.g., stack trace).
        error: ExecutionError,
    },

    // ─────────────────────────────────────────────────────────────────────────
    // System Events
    // ─────────────────────────────────────────────────────────────────────────
    /// Event emitted before a system starts execution.
    SystemStart {
        /// The node ID of the executing system.
        node_id: NodeId,
        /// The system's name.
        node_name: &'static str,
    },

    /// Event emitted after a system completes successfully.
    SystemComplete {
        /// The node ID of the completed system.
        node_id: NodeId,
        /// The system's name.
        node_name: &'static str,
        /// How long the system took to execute.
        duration: Duration,
    },

    /// Event emitted when a system fails.
    SystemError {
        /// The node ID of the failed system.
        node_id: NodeId,
        /// The system's name.
        node_name: &'static str,
        /// The error message.
        error: Arc<str>,
    },

    // ─────────────────────────────────────────────────────────────────────────
    // Decision Events
    // ─────────────────────────────────────────────────────────────────────────
    /// Event emitted before a decision node evaluates its predicate.
    DecisionStart {
        /// The node ID of the decision node.
        node_id: NodeId,
        /// The decision node's name.
        node_name: &'static str,
    },

    /// Event emitted after a decision branch is selected and executed.
    DecisionComplete {
        /// The node ID of the decision node.
        node_id: NodeId,
        /// The decision node's name.
        node_name: &'static str,
        /// The branch that was selected ("true" or "false").
        selected_branch: &'static str,
    },

    // ─────────────────────────────────────────────────────────────────────────
    // Switch Events
    // ─────────────────────────────────────────────────────────────────────────
    /// Event emitted before a switch node evaluates its discriminator.
    SwitchStart {
        /// The node ID of the switch node.
        node_id: NodeId,
        /// The switch node's name.
        node_name: &'static str,
        /// Number of cases in the switch.
        case_count: usize,
        /// Whether a default case exists.
        has_default: bool,
    },

    /// Event emitted after a switch case is selected and executed.
    SwitchComplete {
        /// The node ID of the switch node.
        node_id: NodeId,
        /// The switch node's name.
        node_name: &'static str,
        /// The case key that was selected.
        selected_case: &'static str,
        /// Whether the default case was used.
        used_default: bool,
    },

    // ─────────────────────────────────────────────────────────────────────────
    // Loop Events
    // ─────────────────────────────────────────────────────────────────────────
    /// Event emitted before a loop begins execution.
    LoopStart {
        /// The node ID of the loop node.
        node_id: NodeId,
        /// The loop's name.
        node_name: &'static str,
        /// The maximum iterations allowed.
        max_iterations: usize,
    },

    /// Event emitted at the start of each loop iteration.
    LoopIteration {
        /// The node ID of the loop node.
        node_id: NodeId,
        /// The loop's name.
        node_name: &'static str,
        /// The current iteration number (0-indexed).
        iteration: usize,
    },

    /// Event emitted after a loop completes all iterations.
    LoopEnd {
        /// The node ID of the loop node.
        node_id: NodeId,
        /// The loop's name.
        node_name: &'static str,
        /// The total number of iterations executed.
        iterations: usize,
        /// Total nodes executed across all iterations.
        nodes_executed: usize,
        /// Total duration for the loop.
        duration: Duration,
    },

    // ─────────────────────────────────────────────────────────────────────────
    // Parallel Events
    // ─────────────────────────────────────────────────────────────────────────
    /// Event emitted before parallel branches start execution.
    ParallelStart {
        /// The node ID of the parallel node.
        node_id: NodeId,
        /// The parallel node's name.
        node_name: &'static str,
        /// The number of parallel branches.
        branch_count: usize,
    },

    /// Event emitted after all parallel branches complete.
    ParallelComplete {
        /// The node ID of the parallel node.
        node_id: NodeId,
        /// The parallel node's name.
        node_name: &'static str,
        /// The number of parallel branches.
        branch_count: usize,
        /// Total nodes executed across all branches.
        total_nodes_executed: usize,
        /// Total duration for parallel execution.
        duration: Duration,
    },

    // ─────────────────────────────────────────────────────────────────────────
    // Scope Events
    // ─────────────────────────────────────────────────────────────────────────
    /// Event emitted before a scope node begins execution.
    ScopeStart {
        /// The node ID of the scope node.
        node_id: NodeId,
        /// The scope node's name.
        node_name: &'static str,
        /// The context mode for the scope (e.g., "Shared", "Inherit", "Isolated").
        context_mode: ContextMode,
        /// Number of nodes in the embedded graph.
        inner_node_count: usize,
    },

    /// Event emitted after a scope node completes execution.
    ScopeComplete {
        /// The node ID of the scope node.
        node_id: NodeId,
        /// The scope node's name.
        node_name: &'static str,
        /// The context mode for the scope.
        context_mode: ContextMode,
        /// Total nodes executed inside the scope.
        nodes_executed: usize,
        /// Total duration for scope execution.
        duration: Duration,
    },
}

impl GraphEvent {
    /// Returns the schedule name for this event variant.
    ///
    /// This corresponds to the schedule marker type name (e.g., `OnSystemStart`).
    #[must_use]
    pub fn schedule_name(&self) -> &'static str {
        match self {
            GraphEvent::GraphStart { .. } => "OnGraphStart",
            GraphEvent::GraphComplete { .. } => "OnGraphComplete",
            GraphEvent::GraphFailure { .. } => "OnGraphFailure",
            GraphEvent::SystemStart { .. } => "OnSystemStart",
            GraphEvent::SystemComplete { .. } => "OnSystemComplete",
            GraphEvent::SystemError { .. } => "OnSystemError",
            GraphEvent::DecisionStart { .. } => "OnDecisionStart",
            GraphEvent::DecisionComplete { .. } => "OnDecisionComplete",
            GraphEvent::SwitchStart { .. } => "OnSwitchStart",
            GraphEvent::SwitchComplete { .. } => "OnSwitchComplete",
            GraphEvent::LoopStart { .. } => "OnLoopStart",
            GraphEvent::LoopIteration { .. } => "OnLoopIteration",
            GraphEvent::LoopEnd { .. } => "OnLoopEnd",
            GraphEvent::ParallelStart { .. } => "OnParallelStart",
            GraphEvent::ParallelComplete { .. } => "OnParallelComplete",
            GraphEvent::ScopeStart { .. } => "OnScopeStart",
            GraphEvent::ScopeComplete { .. } => "OnScopeComplete",
        }
    }

    /// Returns the node ID if this is a node-level event.
    ///
    /// Graph-level events (like `GraphStart`, `GraphComplete`) return `None`.
    /// Node-specific events return `Some(node_id)`.
    #[must_use]
    pub fn node_id(&self) -> Option<NodeId> {
        match self {
            GraphEvent::GraphStart { .. }
            | GraphEvent::GraphComplete { .. }
            | GraphEvent::GraphFailure { .. } => None,
            GraphEvent::SystemStart { node_id, .. }
            | GraphEvent::SystemComplete { node_id, .. }
            | GraphEvent::SystemError { node_id, .. }
            | GraphEvent::DecisionStart { node_id, .. }
            | GraphEvent::DecisionComplete { node_id, .. }
            | GraphEvent::SwitchStart { node_id, .. }
            | GraphEvent::SwitchComplete { node_id, .. }
            | GraphEvent::LoopStart { node_id, .. }
            | GraphEvent::LoopIteration { node_id, .. }
            | GraphEvent::LoopEnd { node_id, .. }
            | GraphEvent::ParallelStart { node_id, .. }
            | GraphEvent::ParallelComplete { node_id, .. }
            | GraphEvent::ScopeStart { node_id, .. }
            | GraphEvent::ScopeComplete { node_id, .. } => Some(node_id.clone()),
        }
    }
}

impl std::fmt::Display for GraphEvent {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            GraphEvent::GraphStart {
                node_count,
                node_map,
            } => {
                write!(f, "GraphStart(nodes: {})", node_count)?;
                if !node_map.is_empty() {
                    writeln!(f, ", node_map:")?;
                    for (id, name) in node_map {
                        writeln!(f, "  {:20} {}", name, id)?;
                    }
                };
                Ok(())
            }
            GraphEvent::GraphComplete {
                nodes_executed,
                duration,
            } => {
                write!(
                    f,
                    "GraphComplete(executed: {}, duration: {:?})",
                    nodes_executed, duration
                )
            }
            GraphEvent::GraphFailure { error } => {
                write!(f, "GraphFailure(error: {})", error)
            }
            GraphEvent::SystemStart {
                node_id,
                node_name: system_name,
            } => {
                write!(f, "SystemStart({} @ {:?})", system_name, node_id)
            }
            GraphEvent::SystemComplete {
                node_id,
                node_name: system_name,
                duration,
            } => {
                write!(
                    f,
                    "SystemComplete({} @ {:?}, duration: {:?})",
                    system_name, node_id, duration
                )
            }
            GraphEvent::SystemError {
                node_id,
                node_name: system_name,
                error,
            } => {
                write!(
                    f,
                    "SystemError({} @ {:?}, error: {})",
                    system_name, node_id, error
                )
            }
            GraphEvent::DecisionStart { node_id, node_name } => {
                write!(f, "DecisionStart({} @ {:?})", node_name, node_id)
            }
            GraphEvent::DecisionComplete {
                node_id,
                node_name,
                selected_branch,
            } => {
                write!(
                    f,
                    "DecisionComplete({} @ {:?}, branch: {})",
                    node_name, node_id, selected_branch
                )
            }
            GraphEvent::SwitchStart {
                node_id,
                node_name,
                case_count,
                has_default,
            } => {
                write!(
                    f,
                    "SwitchStart({} @ {:?}, cases: {}, default: {})",
                    node_name, node_id, case_count, has_default
                )
            }
            GraphEvent::SwitchComplete {
                node_id,
                node_name,
                selected_case,
                used_default,
            } => {
                write!(
                    f,
                    "SwitchComplete({} @ {:?}, case: {}, used_default: {})",
                    node_name, node_id, selected_case, used_default
                )
            }
            GraphEvent::LoopStart {
                node_id,
                node_name: loop_name,
                max_iterations,
            } => {
                write!(
                    f,
                    "LoopStart({} @ {:?}, max_iterations: {})",
                    loop_name, node_id, max_iterations
                )
            }
            GraphEvent::LoopIteration {
                node_id,
                node_name: loop_name,
                iteration,
            } => {
                write!(
                    f,
                    "LoopIteration({} @ {:?}, iteration: {})",
                    loop_name, node_id, iteration
                )
            }
            GraphEvent::LoopEnd {
                node_id,
                node_name: loop_name,
                iterations,
                nodes_executed,
                duration,
            } => {
                write!(
                    f,
                    "LoopEnd({} @ {:?}, iterations: {}, executed: {}, duration: {:?})",
                    loop_name, node_id, iterations, nodes_executed, duration
                )
            }
            GraphEvent::ParallelStart {
                node_id,
                node_name,
                branch_count,
            } => {
                write!(
                    f,
                    "ParallelStart({} @ {:?}, branches: {})",
                    node_name, node_id, branch_count
                )
            }
            GraphEvent::ParallelComplete {
                node_id,
                node_name,
                branch_count,
                total_nodes_executed,
                duration,
            } => {
                write!(
                    f,
                    "ParallelComplete({} @ {:?}, branches: {}, executed: {}, duration: {:?})",
                    node_name, node_id, branch_count, total_nodes_executed, duration
                )
            }
            GraphEvent::ScopeStart {
                node_id,
                node_name,
                context_mode,
                inner_node_count,
            } => {
                write!(
                    f,
                    "ScopeStart({} @ {:?}, mode: {}, inner_nodes: {})",
                    node_name, node_id, context_mode, inner_node_count
                )
            }
            GraphEvent::ScopeComplete {
                node_id,
                node_name,
                context_mode,
                nodes_executed,
                duration,
            } => {
                write!(
                    f,
                    "ScopeComplete({} @ {:?}, mode: {}, executed: {}, duration: {:?})",
                    node_name, node_id, context_mode, nodes_executed, duration
                )
            }
        }
    }
}