swf-runtime 1.0.0-alpha11

Runtime engine for Serverless Workflow DSL — execute, validate, and orchestrate workflows
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
use crate::events::CloudEvent;
use serde_json::Value;
use std::sync::Arc;

/// Events emitted during workflow execution
#[derive(Debug, Clone)]
pub enum WorkflowEvent {
    /// Workflow started
    WorkflowStarted { instance_id: String, input: Value },
    /// Workflow completed successfully
    WorkflowCompleted { instance_id: String, output: Value },
    /// Workflow failed with an error
    WorkflowFailed { instance_id: String, error: String },
    /// Workflow suspended
    WorkflowSuspended { instance_id: String },
    /// Workflow resumed after suspension
    WorkflowResumed { instance_id: String },
    /// Workflow cancelled
    WorkflowCancelled { instance_id: String },
    /// Task started
    TaskStarted {
        instance_id: String,
        task_name: String,
    },
    /// Task completed successfully
    TaskCompleted {
        instance_id: String,
        task_name: String,
        output: Value,
    },
    /// Task failed
    TaskFailed {
        instance_id: String,
        task_name: String,
        error: String,
    },
    /// Task retried
    TaskRetried {
        instance_id: String,
        task_name: String,
        attempt: u32,
    },
    /// Task suspended
    TaskSuspended {
        instance_id: String,
        task_name: String,
    },
    /// Task resumed after suspension
    TaskResumed {
        instance_id: String,
        task_name: String,
    },
    /// Task cancelled
    TaskCancelled {
        instance_id: String,
        task_name: String,
    },
    /// Workflow status changed
    WorkflowStatusChanged { instance_id: String, status: String },
    /// Task created (before execution starts)
    TaskCreated {
        instance_id: String,
        task_name: String,
    },
    /// Task status changed
    TaskStatusChanged {
        instance_id: String,
        task_name: String,
        status: String,
    },
}

impl WorkflowEvent {
    /// CloudEvent type constants matching Java SDK's lifecycle event types
    pub const WORKFLOW_STARTED_TYPE: &'static str = "io.serverlessworkflow.workflow.started.v1";
    pub const WORKFLOW_COMPLETED_TYPE: &'static str = "io.serverlessworkflow.workflow.completed.v1";
    pub const WORKFLOW_FAILED_TYPE: &'static str = "io.serverlessworkflow.workflow.faulted.v1";
    pub const WORKFLOW_SUSPENDED_TYPE: &'static str = "io.serverlessworkflow.workflow.suspended.v1";
    pub const WORKFLOW_RESUMED_TYPE: &'static str = "io.serverlessworkflow.workflow.resumed.v1";
    pub const WORKFLOW_CANCELLED_TYPE: &'static str = "io.serverlessworkflow.workflow.cancelled.v1";
    pub const TASK_STARTED_TYPE: &'static str = "io.serverlessworkflow.task.started.v1";
    pub const TASK_COMPLETED_TYPE: &'static str = "io.serverlessworkflow.task.completed.v1";
    pub const TASK_FAILED_TYPE: &'static str = "io.serverlessworkflow.task.faulted.v1";
    pub const TASK_RETRIED_TYPE: &'static str = "io.serverlessworkflow.task.retried.v1";
    pub const TASK_SUSPENDED_TYPE: &'static str = "io.serverlessworkflow.task.suspended.v1";
    pub const TASK_RESUMED_TYPE: &'static str = "io.serverlessworkflow.task.resumed.v1";
    pub const TASK_CANCELLED_TYPE: &'static str = "io.serverlessworkflow.task.cancelled.v1";
    pub const WORKFLOW_STATUS_CHANGED_TYPE: &'static str =
        "io.serverlessworkflow.workflow.status-changed.v1";
    pub const TASK_CREATED_TYPE: &'static str = "io.serverlessworkflow.task.created.v1";
    pub const TASK_STATUS_CHANGED_TYPE: &'static str =
        "io.serverlessworkflow.task.status-changed.v1";

    /// Converts this WorkflowEvent to a CloudEvent for publishing to the EventBus
    pub fn to_cloud_event(&self) -> CloudEvent {
        match self {
            WorkflowEvent::WorkflowStarted { instance_id, input } => CloudEvent::new(
                Self::WORKFLOW_STARTED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "startedAt": now_millis(),
                    "input": input,
                }),
            ),
            WorkflowEvent::WorkflowCompleted {
                instance_id,
                output,
            } => CloudEvent::new(
                Self::WORKFLOW_COMPLETED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "completedAt": now_millis(),
                    "output": output,
                }),
            ),
            WorkflowEvent::WorkflowFailed { instance_id, error } => CloudEvent::new(
                Self::WORKFLOW_FAILED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "failedAt": now_millis(),
                    "error": { "detail": error },
                }),
            ),
            WorkflowEvent::WorkflowSuspended { instance_id } => CloudEvent::new(
                Self::WORKFLOW_SUSPENDED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "suspendedAt": now_millis(),
                }),
            ),
            WorkflowEvent::WorkflowResumed { instance_id } => CloudEvent::new(
                Self::WORKFLOW_RESUMED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "resumedAt": now_millis(),
                }),
            ),
            WorkflowEvent::WorkflowCancelled { instance_id } => CloudEvent::new(
                Self::WORKFLOW_CANCELLED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "cancelledAt": now_millis(),
                }),
            ),
            WorkflowEvent::TaskStarted {
                instance_id,
                task_name,
            } => CloudEvent::new(
                Self::TASK_STARTED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "taskName": task_name,
                    "startedAt": now_millis(),
                }),
            ),
            WorkflowEvent::TaskCompleted {
                instance_id,
                task_name,
                output,
            } => CloudEvent::new(
                Self::TASK_COMPLETED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "taskName": task_name,
                    "completedAt": now_millis(),
                    "output": output,
                }),
            ),
            WorkflowEvent::TaskFailed {
                instance_id,
                task_name,
                error,
            } => CloudEvent::new(
                Self::TASK_FAILED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "taskName": task_name,
                    "failedAt": now_millis(),
                    "error": { "detail": error },
                }),
            ),
            WorkflowEvent::TaskRetried {
                instance_id,
                task_name,
                attempt,
            } => CloudEvent::new(
                Self::TASK_RETRIED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "taskName": task_name,
                    "attempt": attempt,
                    "retriedAt": now_millis(),
                }),
            ),
            WorkflowEvent::TaskSuspended {
                instance_id,
                task_name,
            } => CloudEvent::new(
                Self::TASK_SUSPENDED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "taskName": task_name,
                    "suspendedAt": now_millis(),
                }),
            ),
            WorkflowEvent::TaskResumed {
                instance_id,
                task_name,
            } => CloudEvent::new(
                Self::TASK_RESUMED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "taskName": task_name,
                    "resumedAt": now_millis(),
                }),
            ),
            WorkflowEvent::TaskCancelled {
                instance_id,
                task_name,
            } => CloudEvent::new(
                Self::TASK_CANCELLED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "taskName": task_name,
                    "cancelledAt": now_millis(),
                }),
            ),
            WorkflowEvent::WorkflowStatusChanged {
                instance_id,
                status,
            } => CloudEvent::new(
                Self::WORKFLOW_STATUS_CHANGED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "changedAt": now_millis(),
                    "status": status,
                }),
            ),
            WorkflowEvent::TaskCreated {
                instance_id,
                task_name,
            } => CloudEvent::new(
                Self::TASK_CREATED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "taskName": task_name,
                    "createdAt": now_millis(),
                }),
            ),
            WorkflowEvent::TaskStatusChanged {
                instance_id,
                task_name,
                status,
            } => CloudEvent::new(
                Self::TASK_STATUS_CHANGED_TYPE,
                serde_json::json!({
                    "instanceId": instance_id,
                    "taskName": task_name,
                    "changedAt": now_millis(),
                    "status": status,
                }),
            ),
        }
    }
}

/// Returns current time as milliseconds since epoch
pub fn now_millis() -> u64 {
    std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)
        .unwrap_or_default()
        .as_millis() as u64
}

/// Trait for listening to workflow execution events
///
/// Implement this trait to observe workflow execution lifecycle events.
/// This is useful for logging, metrics, tracing, and debugging.
///
/// # Example
///
/// ```
/// use swf_runtime::listener::{WorkflowExecutionListener, WorkflowEvent};
///
/// struct LoggingListener;
///
/// impl WorkflowExecutionListener for LoggingListener {
///     fn on_event(&self, event: &WorkflowEvent) {
///         match event {
///             WorkflowEvent::WorkflowStarted { instance_id, .. } => {
///                 println!("Workflow {} started", instance_id);
///             }
///             WorkflowEvent::TaskCompleted { task_name, .. } => {
///                 println!("Task {} completed", task_name);
///             }
///             _ => {}
///         }
///     }
/// }
/// ```
pub trait WorkflowExecutionListener: Send + Sync {
    /// Called when a workflow execution event occurs
    fn on_event(&self, event: &WorkflowEvent);
}

/// A listener that collects events in a thread-safe Vec
#[derive(Debug, Default)]
pub struct CollectingListener {
    events: std::sync::Mutex<Vec<WorkflowEvent>>,
}

impl CollectingListener {
    /// Creates a new empty CollectingListener
    pub fn new() -> Self {
        Self::default()
    }

    /// Returns all collected events
    pub fn events(&self) -> Vec<WorkflowEvent> {
        self.events
            .lock()
            .unwrap_or_else(|e| e.into_inner())
            .clone()
    }

    /// Returns the number of collected events
    pub fn len(&self) -> usize {
        self.events.lock().unwrap_or_else(|e| e.into_inner()).len()
    }

    /// Returns true if no events have been collected
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Clears all collected events
    pub fn clear(&self) {
        self.events
            .lock()
            .unwrap_or_else(|e| e.into_inner())
            .clear();
    }
}

impl WorkflowExecutionListener for CollectingListener {
    fn on_event(&self, event: &WorkflowEvent) {
        self.events
            .lock()
            .unwrap_or_else(|e| e.into_inner())
            .push(event.clone());
    }
}

/// A no-op listener that does nothing
#[derive(Debug, Default)]
pub struct NoOpListener;

impl WorkflowExecutionListener for NoOpListener {
    fn on_event(&self, _event: &WorkflowEvent) {}
}

/// Multi-listener that delegates to multiple listeners
pub struct MultiListener {
    listeners: Vec<Arc<dyn WorkflowExecutionListener>>,
}

impl MultiListener {
    /// Creates a new MultiListener
    pub fn new(listeners: Vec<Arc<dyn WorkflowExecutionListener>>) -> Self {
        Self { listeners }
    }
}

impl WorkflowExecutionListener for MultiListener {
    fn on_event(&self, event: &WorkflowEvent) {
        for listener in &self.listeners {
            listener.on_event(event);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn test_collecting_listener() {
        let listener = CollectingListener::new();
        assert!(listener.is_empty());

        listener.on_event(&WorkflowEvent::WorkflowStarted {
            instance_id: "test-1".to_string(),
            input: json!({}),
        });
        listener.on_event(&WorkflowEvent::TaskStarted {
            instance_id: "test-1".to_string(),
            task_name: "task1".to_string(),
        });
        assert_eq!(listener.len(), 2);

        let events = listener.events();
        assert!(
            matches!(&events[0], WorkflowEvent::WorkflowStarted { instance_id, .. } if instance_id == "test-1")
        );
        assert!(
            matches!(&events[1], WorkflowEvent::TaskStarted { task_name, .. } if task_name == "task1")
        );
    }

    #[test]
    fn test_multi_listener() {
        let l1 = Arc::new(CollectingListener::new());
        let l2 = Arc::new(CollectingListener::new());

        let multi = MultiListener::new(vec![l1.clone(), l2.clone()]);
        multi.on_event(&WorkflowEvent::WorkflowStarted {
            instance_id: "test".to_string(),
            input: json!({}),
        });

        assert_eq!(l1.len(), 1);
        assert_eq!(l2.len(), 1);
    }
}