swf-runtime 1.0.0-alpha9

Runtime engine for Serverless Workflow DSL — execute, validate, and orchestrate workflows
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
use super::*;

#[tokio::test]
async fn test_runner_call_function_http() {
    let get_pet = warp::path("pets")
        .and(warp::path::param::<i32>())
        .map(|id: i32| {
            warp::reply::json(&serde_json::json!({
                "id": id,
                "name": "Doggie"
            }))
        });

    let output = run_workflow_with_mock_server("call_function_http.yaml", get_pet, json!({})).await;
    assert_eq!(output["id"], json!(1));
    assert_eq!(output["name"], json!("Doggie"));
}

// === HTTP Call: Bearer Auth with $secret ===

#[tokio::test]
async fn test_runner_call_function_with_output_as() {
    let get_pet = warp::path!("pets" / i32).map(|id: i32| {
        warp::reply::json(&serde_json::json!({
            "id": id,
            "name": "Rex"
        }))
    });

    let output =
        run_workflow_with_mock_server("call_function_with_input.yaml", get_pet, json!({})).await;
    // output.as: .name should extract just the name
    assert_eq!(output, json!("Rex"));
}

// === Try-Catch: communication error ===

// Call function: with arguments via HTTP (use mock server)
#[tokio::test]
async fn test_runner_call_function_with_args() {
    let add_handler = warp::path("add")
        .and(warp::body::json())
        .map(|body: serde_json::Value| {
            let a = body.get("a").and_then(|v| v.as_i64()).unwrap_or(0);
            let b = body.get("b").and_then(|v| v.as_i64()).unwrap_or(0);
            warp::reply::json(&serde_json::json!({"result": a + b}))
        });

    let port = start_mock_server(add_handler);

    let yaml_str = format!(
        r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: call-function-args
  version: '0.1.0'
do:
  - compute:
      call: http
      with:
        method: POST
        endpoint: "http://127.0.0.1:{port}/add"
        body:
          a: "${{ .x }}"
          b: "${{ .y }}"
      output:
        as: "${{ .result }}"
"#
    );
    let output = run_workflow_yaml(&yaml_str, json!({"x": 3, "y": 7}))
        .await
        .unwrap();
    assert_eq!(output, json!(10));
}

#[tokio::test]
async fn test_runner_call_function_reference() {
    // Call function defined in use.functions - matches Go/Java SDK pattern
    let yaml_str = r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: call-func-ref
  version: '0.1.0'
use:
  functions:
    greet:
      call: http
      with:
        method: get
        endpoint:
          uri: http://localhost:PORT/hello
do:
  - callGreet:
      call: greet
"#;
    let hello = warp::path("hello").map(|| warp::reply::json(&json!({"greeting": "Hello!"})));
    let port = start_mock_server(hello);

    let yaml_str = yaml_str.replace("PORT", &port.to_string());
    let output = run_workflow_yaml(&yaml_str, json!({})).await.unwrap();
    assert_eq!(output["greeting"], json!("Hello!"));
}

// === Emit with event data and type ===

#[tokio::test]
async fn test_runner_call_grpc_with_custom_handler() {
    use crate::handler::CallHandler;

    struct MockGrpcHandler;

    #[async_trait::async_trait]
    impl CallHandler for MockGrpcHandler {
        fn call_type(&self) -> &str {
            "grpc"
        }

        async fn handle(
            &self,
            _task_name: &str,
            _call_config: &Value,
            input: &Value,
            _context: &crate::handler::HandlerContext,
        ) -> WorkflowResult<Value> {
            Ok(json!({"grpc_result": input["message"].as_str().unwrap_or("default")}))
        }
    }

    let yaml = r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: grpc-test
  version: '0.1.0'
do:
  - callGrpc:
      call: grpc
      with:
        proto:
          name: TestProto
          endpoint: http://example.com/proto
        service:
          name: TestService
          host: localhost
        method: GetData
"#;
    let workflow: WorkflowDefinition = serde_yaml::from_str(yaml).unwrap();
    let runner = WorkflowRunner::new(workflow)
        .unwrap()
        .with_call_handler(Box::new(MockGrpcHandler));

    let output = runner.run(json!({"message": "hello grpc"})).await.unwrap();
    assert_eq!(output["grpc_result"], json!("hello grpc"));
}

#[tokio::test]
async fn test_runner_call_openapi_with_custom_handler() {
    use crate::handler::CallHandler;

    struct MockOpenApiHandler;

    #[async_trait::async_trait]
    impl CallHandler for MockOpenApiHandler {
        fn call_type(&self) -> &str {
            "openapi"
        }

        async fn handle(
            &self,
            _task_name: &str,
            _call_config: &Value,
            _input: &Value,
            _context: &crate::handler::HandlerContext,
        ) -> WorkflowResult<Value> {
            Ok(json!({"openapi_status": "ok"}))
        }
    }

    let yaml = r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: openapi-test
  version: '0.1.0'
do:
  - callApi:
      call: openapi
      with:
        document:
          name: PetStore
          endpoint: http://example.com/openapi.json
        operationId: listPets
"#;
    let workflow: WorkflowDefinition = serde_yaml::from_str(yaml).unwrap();
    let runner = WorkflowRunner::new(workflow)
        .unwrap()
        .with_call_handler(Box::new(MockOpenApiHandler));

    let output = runner.run(json!({})).await.unwrap();
    assert_eq!(output["openapi_status"], json!("ok"));
}

#[tokio::test]
async fn test_runner_call_grpc_without_handler_returns_error() {
    let yaml = r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: grpc-no-handler
  version: '0.1.0'
do:
  - callGrpc:
      call: grpc
      with:
        proto:
          name: TestProto
          endpoint: http://example.com/proto
        service:
          name: TestService
          host: localhost
        method: GetData
"#;
    let workflow: WorkflowDefinition = serde_yaml::from_str(yaml).unwrap();
    let runner = WorkflowRunner::new(workflow).unwrap();

    let result = runner.run(json!({})).await;
    assert!(result.is_err());
    let err = result.unwrap_err().to_string();
    assert!(err.contains("grpc"), "error should mention 'grpc': {}", err);
    assert!(
        err.contains("CallHandler"),
        "error should mention 'CallHandler': {}",
        err
    );
}

#[tokio::test]
async fn test_runner_multiple_call_handlers() {
    use crate::handler::CallHandler;

    struct MockAsyncApiHandler;

    #[async_trait::async_trait]
    impl CallHandler for MockAsyncApiHandler {
        fn call_type(&self) -> &str {
            "asyncapi"
        }

        async fn handle(
            &self,
            _task_name: &str,
            _call_config: &Value,
            _input: &Value,
            _context: &crate::handler::HandlerContext,
        ) -> WorkflowResult<Value> {
            Ok(json!({"asyncapi_channel": "messages"}))
        }
    }

    struct MockA2AHandler;

    #[async_trait::async_trait]
    impl CallHandler for MockA2AHandler {
        fn call_type(&self) -> &str {
            "a2a"
        }

        async fn handle(
            &self,
            _task_name: &str,
            _call_config: &Value,
            _input: &Value,
            _context: &crate::handler::HandlerContext,
        ) -> WorkflowResult<Value> {
            Ok(json!({"a2a_agent": "response"}))
        }
    }

    let yaml = r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: multi-handler-test
  version: '0.1.0'
do:
  - callAsync:
      call: asyncapi
      with:
        document:
          name: MyApi
          endpoint: http://example.com/asyncapi.json
        channel: messages
  - callA2A:
      call: a2a
      with:
        method: tasks/get
        agentCard:
          name: MyAgent
          endpoint: http://example.com/agent.json
"#;
    let workflow: WorkflowDefinition = serde_yaml::from_str(yaml).unwrap();
    let runner = WorkflowRunner::new(workflow)
        .unwrap()
        .with_call_handler(Box::new(MockAsyncApiHandler))
        .with_call_handler(Box::new(MockA2AHandler));

    let output = runner.run(json!({})).await.unwrap();
    // Last task output is returned
    assert_eq!(output["a2a_agent"], json!("response"));
}

// ---- HTTP output.as Transform Test (Java SDK pattern) ----

/// Test custom task type with CustomTaskHandler
#[tokio::test]
async fn test_runner_custom_task_with_handler() {
    use crate::handler::CustomTaskHandler;

    struct MockGreetHandler;

    #[async_trait::async_trait]
    impl CustomTaskHandler for MockGreetHandler {
        fn task_type(&self) -> &str {
            "greet"
        }

        async fn handle(
            &self,
            task_name: &str,
            _task_type: &str,
            task_config: &Value,
            input: &Value,
            _context: &crate::handler::HandlerContext,
        ) -> WorkflowResult<Value> {
            let name = input
                .get("name")
                .and_then(|v| v.as_str())
                .unwrap_or("World");
            Ok(json!({
                "greeting": format!("Hello, {}!", name),
                "taskName": task_name,
                "customField": task_config.get("customField").and_then(|v| v.as_str()).unwrap_or("default")
            }))
        }
    }

    let yaml = r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: custom-task-test
  version: '1.0.0'
do:
  - greetUser:
      type: greet
      customField: myValue
"#;
    let workflow: WorkflowDefinition = serde_yaml::from_str(yaml).unwrap();
    let runner = WorkflowRunner::new(workflow)
        .unwrap()
        .with_custom_task_handler(Box::new(MockGreetHandler));

    let output = runner.run(json!({"name": "Alice"})).await.unwrap();
    assert_eq!(output["greeting"], json!("Hello, Alice!"));
    assert_eq!(output["taskName"], json!("greetUser"));
    assert_eq!(output["customField"], json!("myValue"));
}

/// Test custom task type without handler returns error
#[tokio::test]
async fn test_runner_custom_task_without_handler_returns_error() {
    let yaml = r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: custom-task-no-handler
  version: '1.0.0'
do:
  - myTask:
      type: unknownType
      someConfig: value
"#;
    let workflow: WorkflowDefinition = serde_yaml::from_str(yaml).unwrap();
    let runner = WorkflowRunner::new(workflow).unwrap();

    let result = runner.run(json!({})).await;
    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("CustomTaskHandler"),
        "Error should mention CustomTaskHandler, got: {}",
        err_msg
    );
    assert!(
        err_msg.contains("unknownType"),
        "Error should mention the task type, got: {}",
        err_msg
    );
}

/// Test call function with inline definition — Java SDK's call-custom-function-inline.yaml
/// use.functions defines a function inline with HTTP call
#[tokio::test]
async fn test_runner_call_function_inline_definition() {
    let greet = warp::path("api")
        .and(warp::path("greet"))
        .map(|| warp::reply::json(&serde_json::json!({"message": "Hello!"})));

    let port = start_mock_server(greet);

    let yaml = r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: call-function-inline
  version: '1.0.0'
use:
  functions:
    greet:
      call: http
      with:
        method: get
        endpoint: http://localhost:PORT/api/greet
do:
  - callGreet:
      call: greet
"#
    .replace("PORT", &port.to_string());
    let workflow: WorkflowDefinition = serde_yaml::from_str(&yaml).unwrap();
    let runner = WorkflowRunner::new(workflow).unwrap();

    let output = runner.run(json!({})).await.unwrap();
    assert_eq!(output["message"], json!("Hello!"));
}

#[tokio::test]
async fn test_call_function_with_catalog() {
    // Register a function that sets a value, then call it via call: function
    let mut set_map = HashMap::new();
    set_map.insert("greeting".to_string(), json!("hello from catalog"));
    let set_task = TaskDefinition::Set(swf_core::models::task::SetTaskDefinition {
        set: swf_core::models::task::SetValue::Map(set_map),
        common: swf_core::models::task::TaskDefinitionFields::new(),
    });
    let workflow: WorkflowDefinition = serde_yaml::from_str(
        r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: catalog-test
  version: '0.1.0'
do:
  - callCatalog:
      call: myFunction
"#,
    )
    .unwrap();

    let runner = WorkflowRunner::new(workflow)
        .unwrap()
        .with_function("myFunction", set_task);
    let output = runner.run(json!({})).await.unwrap();
    assert_eq!(output["greeting"], json!("hello from catalog"));
}

#[tokio::test]
async fn test_call_function_with_catalog_name() {
    // Test functionName@catalogName syntax — catalog name is ignored
    let mut set_map = HashMap::new();
    set_map.insert("source".to_string(), json!("cataloged"));
    let set_task = TaskDefinition::Set(swf_core::models::task::SetTaskDefinition {
        set: swf_core::models::task::SetValue::Map(set_map),
        common: swf_core::models::task::TaskDefinitionFields::new(),
    });
    let workflow: WorkflowDefinition = serde_yaml::from_str(
        r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: catalog-name-test
  version: '0.1.0'
do:
  - callWithCatalog:
      call: myFunc@myCatalog
"#,
    )
    .unwrap();

    let runner = WorkflowRunner::new(workflow)
        .unwrap()
        .with_function("myFunc", set_task);
    let output = runner.run(json!({})).await.unwrap();
    assert_eq!(output["source"], json!("cataloged"));
}

#[tokio::test]
async fn test_call_function_not_found_in_catalog() {
    let workflow: WorkflowDefinition = serde_yaml::from_str(
        r#"
document:
  dsl: '1.0.0'
  namespace: test
  name: catalog-missing
  version: '0.1.0'
do:
  - callMissing:
      call: nonexistentFunc
"#,
    )
    .unwrap();

    let runner = WorkflowRunner::new(workflow).unwrap();
    let result = runner.run(json!({})).await;
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("not found"));
}

// === Suspend / Resume ===