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
use crate::error::{WorkflowError, WorkflowResult};
use crate::task_runner::{TaskRunner, TaskSupport};
use crate::tasks::task_name_impl;

use serde_json::Value;
use swf_core::models::error::OneOfErrorDefinitionOrReference;
use swf_core::models::expression::is_strict_expr;
use swf_core::models::task::RaiseTaskDefinition;
use swf_core::models::workflow::WorkflowDefinition;

/// Evaluates an optional strict expression string, returning the evaluated string result.
/// If the expression is a strict JQ expression (`${...}`), it is evaluated via `eval_jq_expr`;
/// on evaluation failure, falls back to the raw string. Non-strict strings are returned as-is.
fn eval_strict_expr(s: &str, input: &Value, support: &TaskSupport<'_>, task_name: &str) -> String {
    if is_strict_expr(s) {
        let val = support
            .eval_jq_expr(s, input, task_name)
            .unwrap_or_else(|_| Value::String(s.to_string()));
        val.as_str()
            .map(|v| v.to_string())
            .unwrap_or_else(|| format!("{}", val))
    } else {
        s.to_string()
    }
}

/// Runner for Raise tasks - raises structured errors
pub struct RaiseTaskRunner {
    name: String,
    error_def: OneOfErrorDefinitionOrReference,
}

impl RaiseTaskRunner {
    pub fn new(
        name: &str,
        task: &RaiseTaskDefinition,
        workflow: &WorkflowDefinition,
    ) -> WorkflowResult<Self> {
        let error_def = resolve_error_definition(&task.raise.error, workflow);
        Ok(Self {
            name: name.to_string(),
            error_def,
        })
    }
}

/// Resolves error references from workflow's use.errors collection
fn resolve_error_definition(
    error: &OneOfErrorDefinitionOrReference,
    workflow: &WorkflowDefinition,
) -> OneOfErrorDefinitionOrReference {
    match error {
        OneOfErrorDefinitionOrReference::Reference(ref_name) => {
            if let Some(ref use_) = workflow.use_ {
                if let Some(ref errors) = use_.errors {
                    if let Some(definition) = errors.get(ref_name) {
                        return OneOfErrorDefinitionOrReference::Error(definition.clone());
                    }
                }
            }
            error.clone()
        }
        _ => error.clone(),
    }
}

#[async_trait::async_trait]
impl TaskRunner for RaiseTaskRunner {
    async fn run(&self, input: Value, support: &mut TaskSupport<'_>) -> WorkflowResult<Value> {
        let instance = support.get_task_reference().unwrap_or("/").to_string();

        match &self.error_def {
            OneOfErrorDefinitionOrReference::Reference(ref_name) => Err(WorkflowError::typed(
                "validation",
                format!("error definition '{}' not found in 'use.errors'", ref_name),
                self.name.clone(),
                instance,
                Some(Value::from(400)),
                Some("Validation Error".to_string()),
            )),
            OneOfErrorDefinitionOrReference::Error(def) => {
                // Evaluate detail expression if present
                let detail_str = def
                    .detail
                    .as_deref()
                    .map(|d| eval_strict_expr(d, &input, support, &self.name))
                    .unwrap_or_default();

                // Evaluate title expression if present
                let title_str = def
                    .title
                    .as_deref()
                    .map(|t| eval_strict_expr(t, &input, support, &self.name));

                // Use error definition's instance if set, otherwise task reference.
                // Instance can be a runtime expression per spec.
                let instance = def
                    .instance
                    .as_deref()
                    .map(|i| eval_strict_expr(i, &input, support, &self.name))
                    .unwrap_or_else(|| support.get_task_reference().unwrap_or("/").to_string());

                let err = WorkflowError::typed(
                    def.type_.as_str(),
                    detail_str,
                    self.name.clone(),
                    instance,
                    Some(serde_json::json!(def.status)),
                    title_str,
                );

                Err(err)
            }
        }
    }

    task_name_impl!();
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::context::WorkflowContext;
    use crate::default_support;
    use serde_json::json;
    use swf_core::models::error::{ErrorDefinition, ErrorTypes};
    use swf_core::models::task::{RaiseErrorDefinition, TaskDefinitionFields};
    use swf_core::models::workflow::WorkflowDefinitionMetadata;

    async fn run_raise(task: RaiseTaskDefinition) -> WorkflowResult<Value> {
        let workflow = WorkflowDefinition::default();
        let mut context = WorkflowContext::new(&workflow)?;
        let mut support = TaskSupport::new(&workflow, &mut context);
        let runner = RaiseTaskRunner::new("test_raise", &task, &workflow)?;
        runner.run(json!({}), &mut support).await
    }

    #[tokio::test]
    async fn test_raise_with_defined_validation_error() {
        let error_def = ErrorDefinition::new(
            ErrorTypes::VALIDATION,
            "Validation Error",
            400,
            Some("Invalid input data".to_string()),
            None,
        );
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Error(error_def)),
            common: TaskDefinitionFields::new(),
        };

        let result = run_raise(task).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert_eq!(err.error_type_short(), "validation");
        assert!(err.to_string().contains("Invalid input data"));
    }

    #[tokio::test]
    async fn test_raise_with_timeout_error_and_expression() {
        let error_def = ErrorDefinition::new(
            ErrorTypes::TIMEOUT,
            "Timeout Error",
            408,
            Some("${ .timeoutMessage }".to_string()),
            None,
        );
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Error(error_def)),
            common: TaskDefinitionFields::new(),
        };

        let workflow = WorkflowDefinition::default();
        default_support!(workflow, context, support);
        let runner = RaiseTaskRunner::new("test_raise_timeout", &task, &workflow).unwrap();

        let input = json!({"timeoutMessage": "Request took too long"});
        let result = runner.run(input, &mut support).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert_eq!(err.error_type_short(), "timeout");
        assert!(err.to_string().contains("Request took too long"));
    }

    #[tokio::test]
    async fn test_raise_with_referenced_error_not_found() {
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Reference(
                "someErrorRef".to_string(),
            )),
            common: TaskDefinitionFields::new(),
        };

        let workflow = WorkflowDefinition::default();
        default_support!(workflow, context, support);
        let runner = RaiseTaskRunner::new("test_raise_ref", &task, &workflow).unwrap();

        let result = runner.run(json!({}), &mut support).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.to_string().contains("someErrorRef"));
    }

    #[tokio::test]
    async fn test_raise_with_communication_error() {
        let error_def = ErrorDefinition::new(
            ErrorTypes::COMMUNICATION,
            "Communication Error",
            500,
            Some("Service unavailable".to_string()),
            None,
        );
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Error(error_def)),
            common: TaskDefinitionFields::new(),
        };

        let result = run_raise(task).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert_eq!(err.error_type_short(), "communication");
    }

    #[tokio::test]
    async fn test_raise_with_runtime_error() {
        let error_def = ErrorDefinition::new(
            ErrorTypes::RUNTIME,
            "Runtime Error",
            500,
            Some("Unexpected failure".to_string()),
            Some("/task_runtime".to_string()),
        );
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Error(error_def)),
            common: TaskDefinitionFields::new(),
        };

        let result = run_raise(task).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert_eq!(err.error_type_short(), "runtime");
        assert_eq!(err.instance(), Some("/task_runtime"));
    }

    #[tokio::test]
    async fn test_raise_reusable_error_reference() {
        // Matches Java SDK's raise-reusable.yaml - error defined in use.errors, referenced by name
        let error_def = ErrorDefinition::new(
            "https://serverlessworkflow.io/errors/not-implemented",
            "Not Implemented",
            500,
            Some("Feature not available".to_string()),
            None,
        );

        let mut errors = std::collections::HashMap::new();
        errors.insert("notImplemented".to_string(), error_def);
        let use_def = swf_core::models::workflow::ComponentDefinitionCollection {
            errors: Some(errors),
            ..Default::default()
        };
        let workflow = WorkflowDefinition {
            use_: Some(use_def),
            ..Default::default()
        };

        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Reference(
                "notImplemented".to_string(),
            )),
            common: TaskDefinitionFields::new(),
        };

        default_support!(workflow, context, support);
        let runner = RaiseTaskRunner::new("testRaiseRef", &task, &workflow).unwrap();

        let result = runner.run(json!({}), &mut support).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.error_type().contains("not-implemented"));
        assert!(err.to_string().contains("Feature not available"));
    }

    #[tokio::test]
    async fn test_raise_inline_full_error() {
        // Matches Java SDK's raise-inline.yaml - full inline error with all fields
        let error_def = ErrorDefinition::new(
            "https://serverlessworkflow.io/errors/not-implemented",
            "Not Implemented",
            500,
            Some("The workflow is a work in progress".to_string()),
            None,
        );
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Error(error_def)),
            common: TaskDefinitionFields::new(),
        };

        let result = run_raise(task).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.error_type().contains("not-implemented"));
        assert_eq!(err.status(), Some(&json!(500)));
        assert!(err.title().is_some());
    }

    #[tokio::test]
    async fn test_raise_error_with_dynamic_detail() {
        // Matches Go SDK's raise_error_with_input.yaml
        // Raise error with string interpolation in detail using \() syntax
        let error_def = ErrorDefinition::new(
            "https://serverlessworkflow.io/spec/1.0.0/errors/authentication",
            "Authentication Error",
            401,
            Some("${ \"User authentication failed: \\(.reason)\" }".to_string()),
            None,
        );
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Error(error_def)),
            common: TaskDefinitionFields::new(),
        };

        let workflow = WorkflowDefinition::default();
        default_support!(workflow, context, support);
        let runner = RaiseTaskRunner::new("dynamicError", &task, &workflow).unwrap();

        let input = json!({"reason": "User token expired"});
        let result = runner.run(input, &mut support).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.error_type().contains("authentication"));
        assert!(err
            .to_string()
            .contains("User authentication failed: User token expired"));
    }

    #[tokio::test]
    async fn test_raise_undefined_reference_returns_validation_error() {
        // Matches Go SDK's raise_undefined_reference.yaml
        // When referencing an undefined error, should return a validation error
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Reference(
                "UndefinedError".to_string(),
            )),
            common: TaskDefinitionFields::new(),
        };

        let workflow = WorkflowDefinition::default();
        default_support!(workflow, context, support);
        let runner = RaiseTaskRunner::new("missingError", &task, &workflow).unwrap();

        let result = runner.run(json!({}), &mut support).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        // Go SDK returns validation error type for undefined references
        assert!(
            err.error_type().contains("validation") || err.to_string().contains("UndefinedError")
        );
    }

    #[tokio::test]
    async fn test_raise_with_workflow_context_in_detail() {
        // Matches Go SDK's raise_inline.yaml
        // Raise error with $workflow.definition.document.name in detail
        let error_def = ErrorDefinition::new(
            "https://serverlessworkflow.io/spec/1.0.0/errors/validation",
            "Validation Error",
            400,
            Some("${ \"Invalid input provided to workflow \\($workflow.definition.document.name)\" }".to_string()),
            None,
        );
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Error(error_def)),
            common: TaskDefinitionFields::new(),
        };

        let workflow = WorkflowDefinition {
            document: WorkflowDefinitionMetadata {
                name: "raise-inline".to_string(),
                ..Default::default()
            },
            ..Default::default()
        };

        default_support!(workflow, context, support);
        let runner = RaiseTaskRunner::new("inlineError", &task, &workflow).unwrap();

        let result = runner.run(json!({}), &mut support).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.error_type().contains("validation"));
        // The detail should contain the workflow name
        assert!(err.to_string().contains("raise-inline"));
    }

    #[tokio::test]
    async fn test_raise_instance_as_runtime_expression() {
        // Spec 1.0.3: instance can be a runtime expression that should be evaluated
        let error_def = ErrorDefinition::new(
            ErrorTypes::VALIDATION,
            "Validation Error",
            400,
            Some("Invalid input".to_string()),
            Some("${ .errorPath }".to_string()),
        );
        let task = RaiseTaskDefinition {
            raise: RaiseErrorDefinition::new(OneOfErrorDefinitionOrReference::Error(error_def)),
            common: TaskDefinitionFields::new(),
        };

        let workflow = WorkflowDefinition::default();
        default_support!(workflow, context, support);
        let runner = RaiseTaskRunner::new("testInstanceExpr", &task, &workflow).unwrap();

        let input = json!({"errorPath": "/api/users/123"});
        let result = runner.run(input, &mut support).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert_eq!(err.instance(), Some("/api/users/123"));
    }
}