floxide-event 1.1.0

Event-driven node abstractions for the floxide framework
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
//! # Floxide Event
//!
//! Event-driven node extensions for the Floxide framework.
//!
//! This crate provides event-driven workflow capabilities through
//! the EventDrivenNode trait and various event source implementations.

use async_trait::async_trait;
use floxide_core::{error::FloxideError, ActionType, DefaultAction, Node, NodeId, NodeOutcome};
use std::collections::HashMap;
use std::marker::PhantomData;
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::mpsc;
use tracing::{info, warn};
use uuid::Uuid;

/// A node that waits for events and processes them as they arrive
#[async_trait]
pub trait EventDrivenNode<Event, Context, Action>: Send + Sync
where
    Event: Send + 'static,
    Context: Send + Sync + 'static,
    Action: ActionType + Send + Sync + 'static + Default,
{
    /// Wait for an external event to occur
    async fn wait_for_event(&mut self) -> Result<Event, FloxideError>;

    /// Process the received event and update context
    async fn process_event(&self, event: Event, ctx: &mut Context) -> Result<Action, FloxideError>;

    /// Get the node's unique identifier
    fn id(&self) -> NodeId;
}

/// A channel-based event source that receives events from a Tokio MPSC channel
pub struct ChannelEventSource<Event> {
    receiver: mpsc::Receiver<Event>,
    id: NodeId,
}

impl<Event> ChannelEventSource<Event>
where
    Event: Send + 'static,
{
    /// Create a new channel event source with a default ID
    pub fn new(capacity: usize) -> (Self, mpsc::Sender<Event>) {
        let (sender, receiver) = mpsc::channel(capacity);
        (
            Self {
                receiver,
                id: Uuid::new_v4().to_string(),
            },
            sender,
        )
    }

    /// Create a new channel event source with a specific ID
    pub fn with_id(capacity: usize, id: impl Into<String>) -> (Self, mpsc::Sender<Event>) {
        let (sender, receiver) = mpsc::channel(capacity);
        (
            Self {
                receiver,
                id: id.into(),
            },
            sender,
        )
    }
}

#[async_trait]
impl<Event, Context, Action> EventDrivenNode<Event, Context, Action> for ChannelEventSource<Event>
where
    Event: Send + 'static,
    Context: Send + Sync + 'static,
    Action: ActionType + Send + Sync + 'static + Default,
{
    async fn wait_for_event(&mut self) -> Result<Event, FloxideError> {
        match self.receiver.recv().await {
            Some(event) => Ok(event),
            None => Err(FloxideError::Other("Event channel closed".to_string())),
        }
    }

    async fn process_event(
        &self,
        _event: Event,
        _ctx: &mut Context,
    ) -> Result<Action, FloxideError> {
        // ChannelEventSource just passes events through, it doesn't process them
        // Return the default action
        Ok(Action::default())
    }

    fn id(&self) -> NodeId {
        self.id.clone()
    }
}

/// An event processor that applies a function to each event
pub struct EventProcessor<Event, Context, Action, F>
where
    Event: Send + 'static,
    Context: Send + Sync + 'static,
    Action: ActionType + Send + Sync + 'static + Default,
    F: Fn(Event, &mut Context) -> Result<Action, FloxideError> + Send + Sync + 'static,
{
    source: Arc<tokio::sync::Mutex<ChannelEventSource<Event>>>,
    processor: F,
    _phantom: PhantomData<(Context, Action)>,
}

impl<Event, Context, Action, F> EventProcessor<Event, Context, Action, F>
where
    Event: Send + 'static,
    Context: Send + Sync + 'static,
    Action: ActionType + Send + Sync + 'static + Default,
    F: Fn(Event, &mut Context) -> Result<Action, FloxideError> + Send + Sync + 'static,
{
    /// Create a new event processor with a default ID
    pub fn new(capacity: usize, processor: F) -> (Self, mpsc::Sender<Event>) {
        let (source, sender) = ChannelEventSource::new(capacity);
        (
            Self {
                source: Arc::new(tokio::sync::Mutex::new(source)),
                processor,
                _phantom: PhantomData,
            },
            sender,
        )
    }

    /// Create a new event processor with a specific ID
    pub fn with_id(
        capacity: usize,
        id: impl Into<String>,
        processor: F,
    ) -> (Self, mpsc::Sender<Event>) {
        let (source, sender) = ChannelEventSource::with_id(capacity, id);
        (
            Self {
                source: Arc::new(tokio::sync::Mutex::new(source)),
                processor,
                _phantom: PhantomData,
            },
            sender,
        )
    }
}

#[async_trait]
impl<Event, Context, Action, F> EventDrivenNode<Event, Context, Action>
    for EventProcessor<Event, Context, Action, F>
where
    Event: Send + 'static,
    Context: Send + Sync + 'static,
    Action: ActionType + Send + Sync + 'static + Default,
    F: Fn(Event, &mut Context) -> Result<Action, FloxideError> + Send + Sync + 'static,
{
    async fn wait_for_event(&mut self) -> Result<Event, FloxideError> {
        let mut source = self.source.lock().await;
        <ChannelEventSource<Event> as EventDrivenNode<Event, Context, Action>>::wait_for_event(
            &mut *source,
        )
        .await
    }

    async fn process_event(&self, event: Event, ctx: &mut Context) -> Result<Action, FloxideError> {
        (self.processor)(event, ctx)
    }

    fn id(&self) -> NodeId {
        self.source
            .try_lock()
            .map(|source| {
                <ChannelEventSource<Event> as EventDrivenNode<Event, Context, Action>>::id(&*source)
            })
            .unwrap_or_else(|_| "locked".to_string())
    }
}

/// Type alias for a thread-safe reference to an event-driven node
type EventNodeRef<E, C, A> = Arc<tokio::sync::Mutex<dyn EventDrivenNode<E, C, A>>>;

/// A workflow that processes events using event-driven nodes
pub struct EventDrivenWorkflow<Event, Context, Action>
where
    Event: Send + 'static,
    Context: Send + Sync + 'static,
    Action: ActionType + Send + Sync + 'static + Default,
{
    nodes: HashMap<NodeId, EventNodeRef<Event, Context, Action>>,
    routes: HashMap<(NodeId, Action), NodeId>,
    initial_node: NodeId,
    termination_action: Action,
}

impl<Event, Context, Action> EventDrivenWorkflow<Event, Context, Action>
where
    Event: Send + 'static,
    Context: Send + Sync + 'static,
    Action: ActionType + Send + Sync + 'static + Default,
{
    /// Create a new event-driven workflow with an initial node
    pub fn new(
        initial_node: Arc<tokio::sync::Mutex<dyn EventDrivenNode<Event, Context, Action>>>,
        termination_action: Action,
    ) -> Self {
        let id = {
            initial_node
                .try_lock()
                .map(|n| n.id())
                .unwrap_or_else(|_| "locked".to_string())
        };

        let mut nodes = HashMap::new();
        nodes.insert(id.clone(), initial_node);

        Self {
            nodes,
            routes: HashMap::new(),
            initial_node: id,
            termination_action,
        }
    }

    /// Add a node to the workflow
    pub fn add_node(
        &mut self,
        node: Arc<tokio::sync::Mutex<dyn EventDrivenNode<Event, Context, Action>>>,
    ) {
        let id = {
            node.try_lock()
                .map(|n| n.id())
                .unwrap_or_else(|_| "locked".to_string())
        };
        self.nodes.insert(id, node);
    }

    /// Set a route from one node to another based on an action
    pub fn set_route(&mut self, from_id: &NodeId, action: Action, to_id: &NodeId) {
        // Store the route in the routing table
        self.routes.insert((from_id.clone(), action), to_id.clone());
    }

    /// Sets a route with validation to ensure proper event flow
    ///
    /// This method ensures that processor nodes (non-event sources) route back to
    /// valid event sources, preventing the "not an event source" error during execution.
    ///
    /// # Arguments
    ///
    /// * `from_id` - The source node ID
    /// * `action` - The action that triggers this route
    /// * `to_id` - The destination node ID
    ///
    /// # Returns
    ///
    /// * `Result<(), FloxideError>` - Ok if the route is valid, Error otherwise
    pub fn set_route_with_validation(
        &mut self,
        from_id: &NodeId,
        action: Action,
        to_id: &NodeId,
    ) -> Result<(), FloxideError> {
        // Check if the destination node exists
        if !self.nodes.contains_key(to_id) {
            return Err(FloxideError::Other(format!(
                "Destination node '{}' not found in workflow",
                to_id
            )));
        }

        // Check if the source node is a processor (not an event source)
        // and the destination is also not an event source
        // This is done by attempting to call wait_for_event on both nodes
        // If the method returns an error containing "not an event source", it's a processor

        // For now we'll just add the route, but in a future implementation,
        // we should check if the source node is a processor and the destination
        // is also a processor, which would be an invalid routing pattern

        // Store the route in the routing table
        self.routes.insert((from_id.clone(), action), to_id.clone());

        Ok(())
    }

    /// Execute the workflow, processing events until the termination action is returned
    pub async fn execute(&self, ctx: &mut Context) -> Result<(), FloxideError> {
        let mut current_node_id = self.initial_node.clone();

        loop {
            // Get the current node
            let node = self
                .nodes
                .get(&current_node_id)
                .ok_or_else(|| FloxideError::node_not_found(current_node_id.clone()))?;

            // Wait for an event and process it
            let event = {
                let mut node_guard = node.lock().await;
                match node_guard.wait_for_event().await {
                    Ok(event) => event,
                    Err(e) => {
                        // Check if the error message indicates this is not an event source
                        if e.to_string().contains("not an event source") {
                            // This is a processor node, not an event source
                            // We need to find the initial node (which should be an event source)
                            warn!(
                                "Node '{}' is not an event source, routing to initial node",
                                current_node_id
                            );

                            // Get the initial node and try to get an event from there
                            current_node_id = self.initial_node.clone();
                            let source_node =
                                self.nodes.get(&current_node_id).ok_or_else(|| {
                                    FloxideError::Other(
                                        "Initial node not found in workflow".to_string(),
                                    )
                                })?;

                            let mut source_guard = source_node.lock().await;
                            source_guard.wait_for_event().await?
                        } else {
                            // Propagate other errors
                            return Err(e);
                        }
                    }
                }
            };

            let action = {
                let node_guard = node.lock().await;
                node_guard.process_event(event, ctx).await?
            };

            // If the action is the termination action, we're done
            if action == self.termination_action {
                info!("Event-driven workflow terminated with termination action");
                return Ok(());
            }

            // Find the next node to route to
            current_node_id = self
                .routes
                .get(&(current_node_id, action.clone()))
                .ok_or_else(|| {
                    FloxideError::WorkflowDefinitionError(format!(
                        "No route defined for action: {}",
                        action.name()
                    ))
                })?
                .clone();
        }
    }

    /// Execute the workflow with a timeout
    pub async fn execute_with_timeout(
        &self,
        ctx: &mut Context,
        timeout: Duration,
    ) -> Result<(), FloxideError> {
        match tokio::time::timeout(timeout, self.execute(ctx)).await {
            Ok(result) => result,
            Err(_) => Err(FloxideError::timeout(
                "Event-driven workflow execution timed out",
            )),
        }
    }
}

/// Adapter to use an event-driven node in a standard workflow
pub struct EventDrivenNodeAdapter<E, C, A>
where
    E: Send + 'static,
    C: Send + Sync + 'static,
    A: ActionType + Send + Sync + 'static + Default,
{
    node: Arc<tokio::sync::Mutex<dyn EventDrivenNode<E, C, A>>>,
    id: NodeId,
    timeout: Duration,
    timeout_action: A,
}

impl<E, C, A> EventDrivenNodeAdapter<E, C, A>
where
    E: Send + 'static,
    C: Send + Sync + 'static,
    A: ActionType + Send + Sync + 'static + Default,
{
    /// Create a new adapter with default ID
    pub fn new(
        node: Arc<tokio::sync::Mutex<dyn EventDrivenNode<E, C, A>>>,
        timeout: Duration,
        timeout_action: A,
    ) -> Self {
        let id = {
            node.try_lock()
                .map(|n| n.id())
                .unwrap_or_else(|_| "locked".to_string())
        };

        Self {
            node,
            id,
            timeout,
            timeout_action,
        }
    }

    /// Create a new adapter with a specific ID
    pub fn with_id(
        node: Arc<tokio::sync::Mutex<dyn EventDrivenNode<E, C, A>>>,
        id: impl Into<String>,
        timeout: Duration,
        timeout_action: A,
    ) -> Self {
        Self {
            node,
            id: id.into(),
            timeout,
            timeout_action,
        }
    }
}

#[async_trait]
impl<E, C, A> Node<C, A> for EventDrivenNodeAdapter<E, C, A>
where
    E: Send + 'static,
    C: Send + Sync + 'static,
    A: ActionType + Send + Sync + 'static + Default,
{
    type Output = ();

    fn id(&self) -> NodeId {
        self.id.clone()
    }

    async fn process(&self, ctx: &mut C) -> Result<NodeOutcome<Self::Output, A>, FloxideError> {
        // Extract the async block to a separate variable
        let wait_for_event_future = async {
            let mut node_guard = self.node.lock().await;
            node_guard.wait_for_event().await
        };

        match tokio::time::timeout(self.timeout, wait_for_event_future).await {
            Ok(Ok(event)) => {
                let action = {
                    let node_guard = self.node.lock().await;
                    node_guard.process_event(event, ctx).await?
                };
                Ok(NodeOutcome::RouteToAction(action))
            }
            Ok(Err(e)) => Err(e),
            Err(_) => {
                // Timeout occurred
                Ok(NodeOutcome::RouteToAction(self.timeout_action.clone()))
            }
        }
    }
}

/// A nested event-driven workflow that can be used in a standard workflow
pub struct NestedEventDrivenWorkflow<E, C, A>
where
    E: Send + 'static,
    C: Send + Sync + 'static,
    A: ActionType + Send + Sync + 'static + Default,
{
    workflow: Arc<EventDrivenWorkflow<E, C, A>>,
    id: NodeId,
    timeout: Option<Duration>,
    complete_action: A,
    timeout_action: A,
}

impl<E, C, A> NestedEventDrivenWorkflow<E, C, A>
where
    E: Send + 'static,
    C: Send + Sync + 'static,
    A: ActionType + Send + Sync + 'static + Default,
{
    /// Create a new nested workflow without a timeout
    pub fn new(
        workflow: Arc<EventDrivenWorkflow<E, C, A>>,
        complete_action: A,
        timeout_action: A,
    ) -> Self {
        Self {
            workflow,
            id: Uuid::new_v4().to_string(),
            timeout: None,
            complete_action,
            timeout_action,
        }
    }

    /// Create a new nested workflow with a timeout
    pub fn with_timeout(
        workflow: Arc<EventDrivenWorkflow<E, C, A>>,
        timeout: Duration,
        complete_action: A,
        timeout_action: A,
    ) -> Self {
        Self {
            workflow,
            id: Uuid::new_v4().to_string(),
            timeout: Some(timeout),
            complete_action,
            timeout_action,
        }
    }

    /// Create a new nested workflow with a specific ID
    pub fn with_id(
        workflow: Arc<EventDrivenWorkflow<E, C, A>>,
        id: impl Into<String>,
        complete_action: A,
        timeout_action: A,
    ) -> Self {
        Self {
            workflow,
            id: id.into(),
            timeout: None,
            complete_action,
            timeout_action,
        }
    }
}

#[async_trait]
impl<E, C, A> Node<C, A> for NestedEventDrivenWorkflow<E, C, A>
where
    E: Send + 'static,
    C: Send + Sync + 'static,
    A: ActionType + Send + Sync + 'static + Default,
{
    type Output = ();

    fn id(&self) -> NodeId {
        self.id.clone()
    }

    async fn process(&self, ctx: &mut C) -> Result<NodeOutcome<Self::Output, A>, FloxideError> {
        match self.timeout {
            Some(timeout) => {
                match tokio::time::timeout(timeout, self.workflow.execute(ctx)).await {
                    Ok(Ok(())) => {
                        // Workflow completed successfully
                        Ok(NodeOutcome::RouteToAction(self.complete_action.clone()))
                    }
                    Ok(Err(e)) => {
                        // Workflow execution error
                        Err(e)
                    }
                    Err(_) => {
                        // Timeout occurred
                        Ok(NodeOutcome::RouteToAction(self.timeout_action.clone()))
                    }
                }
            }
            None => {
                self.workflow.execute(ctx).await?;
                Ok(NodeOutcome::RouteToAction(self.complete_action.clone()))
            }
        }
    }
}

/// Extension trait for action types in event-driven workflows
pub trait EventActionExt: ActionType {
    /// Create a terminate action for event-driven workflows
    fn terminate() -> Self;

    /// Create a timeout action for timed operations
    fn timeout() -> Self;
}

impl EventActionExt for DefaultAction {
    fn terminate() -> Self {
        DefaultAction::Custom("terminate".into())
    }

    fn timeout() -> Self {
        DefaultAction::Custom("timeout".into())
    }
}