tandem-workflows 0.4.26

Workflow definitions and loading for Tandem
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
use anyhow::Context;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;
use std::fs;
use std::path::{Path, PathBuf};

use tandem_orchestrator::KnowledgeBinding;
use tandem_types::TenantContext;

mod mission_builder;
pub mod plan_package;

pub use mission_builder::{
    validate_mission_blueprint, ApprovalDecision, HumanApprovalGate, InputRefBlueprint,
    MissionBlueprint, MissionMilestoneBlueprint, MissionPhaseBlueprint, MissionPhaseExecutionMode,
    MissionTeamBlueprint, OutputContractBlueprint, ReviewStage, ReviewStageKind, ValidationMessage,
    ValidationSeverity, WorkstreamBlueprint,
};
pub use plan_package::{
    AutomationV2Schedule, AutomationV2ScheduleType, WorkflowPlan, WorkflowPlanChatMessage,
    WorkflowPlanConversation, WorkflowPlanDraftRecord, WorkflowPlanStep,
};

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum WorkflowSourceKind {
    BuiltIn,
    Pack,
    Workspace,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct WorkflowSourceRef {
    pub kind: WorkflowSourceKind,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pack_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub path: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct WorkflowActionSpec {
    pub action: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub with: Option<Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct WorkflowStepSpec {
    pub step_id: String,
    pub action: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub with: Option<Value>,
    #[serde(default)]
    pub knowledge: KnowledgeBinding,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct WorkflowHookBinding {
    pub binding_id: String,
    pub workflow_id: String,
    pub event: String,
    #[serde(default = "default_true")]
    pub enabled: bool,
    #[serde(default)]
    pub actions: Vec<WorkflowActionSpec>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<WorkflowSourceRef>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct WorkflowSpec {
    pub workflow_id: String,
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(default = "default_true")]
    pub enabled: bool,
    #[serde(default)]
    pub knowledge: KnowledgeBinding,
    #[serde(default)]
    pub steps: Vec<WorkflowStepSpec>,
    #[serde(default)]
    pub hooks: Vec<WorkflowHookBinding>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<WorkflowSourceRef>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq)]
pub struct WorkflowRegistry {
    #[serde(default)]
    pub workflows: HashMap<String, WorkflowSpec>,
    #[serde(default)]
    pub hooks: Vec<WorkflowHookBinding>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum WorkflowRunStatus {
    Queued,
    Running,
    Completed,
    Failed,
    DryRun,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum WorkflowActionRunStatus {
    Pending,
    Running,
    Completed,
    Failed,
    Skipped,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct WorkflowActionRunRecord {
    pub action_id: String,
    pub action: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub task_id: Option<String>,
    pub status: WorkflowActionRunStatus,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub detail: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub output: Option<Value>,
    pub updated_at_ms: u64,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct WorkflowRunRecord {
    pub run_id: String,
    pub workflow_id: String,
    #[serde(default = "default_tenant_context")]
    pub tenant_context: TenantContext,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub automation_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub automation_run_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub binding_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub trigger_event: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source_event_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub task_id: Option<String>,
    pub status: WorkflowRunStatus,
    pub created_at_ms: u64,
    pub updated_at_ms: u64,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub finished_at_ms: Option<u64>,
    #[serde(default)]
    pub actions: Vec<WorkflowActionRunRecord>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<WorkflowSourceRef>,
}

fn default_tenant_context() -> TenantContext {
    TenantContext::local_implicit()
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct WorkflowSimulationResult {
    #[serde(default)]
    pub matched_bindings: Vec<WorkflowHookBinding>,
    #[serde(default)]
    pub planned_actions: Vec<WorkflowActionSpec>,
    #[serde(default)]
    pub canonical_events: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum WorkflowValidationSeverity {
    Info,
    Warning,
    Error,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct WorkflowValidationMessage {
    pub severity: WorkflowValidationSeverity,
    pub message: String,
}

#[derive(Debug, Clone)]
pub struct WorkflowLoadSource {
    pub root: PathBuf,
    pub kind: WorkflowSourceKind,
    pub pack_id: Option<String>,
}

#[derive(Debug, Deserialize)]
struct WorkflowFileEnvelope {
    #[serde(default)]
    workflow: Option<WorkflowFileShape>,
    #[serde(default)]
    hooks: Option<Value>,
}

#[derive(Debug, Deserialize)]
struct WorkflowFileShape {
    #[serde(default)]
    id: Option<String>,
    #[serde(default)]
    workflow_id: Option<String>,
    #[serde(default)]
    name: Option<String>,
    #[serde(default)]
    description: Option<String>,
    #[serde(default)]
    enabled: Option<bool>,
    #[serde(default)]
    steps: Vec<WorkflowStepInput>,
    #[serde(default)]
    hooks: Option<Value>,
}

#[derive(Debug, Deserialize)]
#[serde(untagged)]
enum WorkflowStepInput {
    String(String),
    Object(WorkflowStepObjectInput),
}

#[derive(Debug, Deserialize)]
struct WorkflowStepObjectInput {
    #[serde(default)]
    id: Option<String>,
    #[serde(default)]
    step_id: Option<String>,
    action: String,
    #[serde(default)]
    with: Option<Value>,
}

#[derive(Debug, Deserialize)]
#[serde(untagged)]
enum HookFileShape {
    Map(HashMap<String, Vec<HookActionInput>>),
    List(Vec<HookBindingInput>),
}

#[derive(Debug, Deserialize)]
struct HookBindingInput {
    #[serde(default)]
    id: Option<String>,
    #[serde(default)]
    binding_id: Option<String>,
    #[serde(default)]
    workflow: Option<String>,
    #[serde(default)]
    workflow_id: Option<String>,
    event: String,
    #[serde(default)]
    enabled: Option<bool>,
    #[serde(default)]
    actions: Vec<HookActionInput>,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(untagged)]
enum HookActionInput {
    String(String),
    Object(WorkflowActionSpec),
}

pub fn load_registry(sources: &[WorkflowLoadSource]) -> anyhow::Result<WorkflowRegistry> {
    let mut registry = WorkflowRegistry::default();
    for source in sources {
        load_source_into(&mut registry, source)?;
    }
    Ok(registry)
}

pub fn validate_registry(registry: &WorkflowRegistry) -> Vec<WorkflowValidationMessage> {
    let mut messages = Vec::new();
    for workflow in registry.workflows.values() {
        if workflow.steps.is_empty()
            && registry
                .hooks
                .iter()
                .all(|hook| hook.workflow_id != workflow.workflow_id)
        {
            messages.push(WorkflowValidationMessage {
                severity: WorkflowValidationSeverity::Warning,
                message: format!(
                    "workflow `{}` has no steps and no hook bindings",
                    workflow.workflow_id
                ),
            });
        }
        for step in &workflow.steps {
            if step.action.trim().is_empty() {
                messages.push(WorkflowValidationMessage {
                    severity: WorkflowValidationSeverity::Error,
                    message: format!(
                        "workflow `{}` has step `{}` with empty action",
                        workflow.workflow_id, step.step_id
                    ),
                });
            }
        }
    }
    for hook in &registry.hooks {
        if !registry.workflows.contains_key(&hook.workflow_id) {
            messages.push(WorkflowValidationMessage {
                severity: WorkflowValidationSeverity::Error,
                message: format!(
                    "hook `{}` references unknown workflow `{}`",
                    hook.binding_id, hook.workflow_id
                ),
            });
        }
        if hook.actions.is_empty() {
            messages.push(WorkflowValidationMessage {
                severity: WorkflowValidationSeverity::Warning,
                message: format!("hook `{}` has no actions", hook.binding_id),
            });
        }
    }
    messages
}

fn load_source_into(
    registry: &mut WorkflowRegistry,
    source: &WorkflowLoadSource,
) -> anyhow::Result<()> {
    for entry in collect_yaml_files(&source.root.join("workflows"))? {
        let workflow = load_workflow_file(&entry, source)?;
        registry
            .workflows
            .insert(workflow.workflow_id.clone(), workflow.clone());
        registry.hooks.retain(|hook| hook.workflow_id != workflow.workflow_id || !matches!(hook.source.as_ref(), Some(src) if src.path.as_deref() == Some(&entry.to_string_lossy().to_string())));
        registry.hooks.extend(workflow.hooks.clone());
    }
    for entry in collect_yaml_files(&source.root.join("hooks"))? {
        registry.hooks.extend(load_hook_file(&entry, source)?);
    }
    Ok(())
}

fn collect_yaml_files(dir: &Path) -> anyhow::Result<Vec<PathBuf>> {
    let mut files = Vec::new();
    let entries = match fs::read_dir(dir) {
        Ok(entries) => entries,
        Err(err) if err.kind() == std::io::ErrorKind::NotFound => return Ok(files),
        Err(err) => return Err(err.into()),
    };
    for entry in entries {
        let path = entry?.path();
        if path.is_dir() {
            files.extend(collect_yaml_files(&path)?);
            continue;
        }
        let ext = path
            .extension()
            .and_then(|v| v.to_str())
            .unwrap_or_default();
        if matches!(ext, "yaml" | "yml") {
            files.push(path);
        }
    }
    files.sort();
    Ok(files)
}

fn load_workflow_file(path: &Path, source: &WorkflowLoadSource) -> anyhow::Result<WorkflowSpec> {
    let raw = fs::read_to_string(path).with_context(|| format!("read {}", path.display()))?;
    let parsed = serde_yaml::from_str::<WorkflowFileEnvelope>(&raw)
        .with_context(|| format!("parse workflow yaml {}", path.display()))?;
    let workflow = parsed
        .workflow
        .ok_or_else(|| anyhow::anyhow!("missing `workflow` key"))?;
    let workflow_id = workflow
        .workflow_id
        .or(workflow.id)
        .or_else(|| {
            path.file_stem()
                .and_then(|v| v.to_str())
                .map(ToString::to_string)
        })
        .ok_or_else(|| anyhow::anyhow!("workflow id missing"))?;
    let name = workflow.name.clone().unwrap_or_else(|| workflow_id.clone());
    let source_ref = source_ref(source, path);
    let steps = workflow
        .steps
        .into_iter()
        .enumerate()
        .map(|(idx, step)| match step {
            WorkflowStepInput::String(action) => WorkflowStepSpec {
                step_id: format!("step_{}", idx + 1),
                action,
                with: None,
                knowledge: KnowledgeBinding::default(),
            },
            WorkflowStepInput::Object(step) => WorkflowStepSpec {
                step_id: step
                    .step_id
                    .or(step.id)
                    .unwrap_or_else(|| format!("step_{}", idx + 1)),
                action: step.action,
                with: step.with,
                knowledge: KnowledgeBinding::default(),
            },
        })
        .collect::<Vec<_>>();
    let mut hooks = parse_hooks_value(
        workflow.hooks.as_ref().or(parsed.hooks.as_ref()),
        &workflow_id,
        &source_ref,
    )?;
    for hook in &mut hooks {
        if hook.workflow_id.is_empty() {
            hook.workflow_id = workflow_id.clone();
        }
    }
    Ok(WorkflowSpec {
        workflow_id,
        name,
        description: workflow.description,
        enabled: workflow.enabled.unwrap_or(true),
        knowledge: KnowledgeBinding::default(),
        steps,
        hooks,
        source: Some(source_ref),
    })
}

fn load_hook_file(
    path: &Path,
    source: &WorkflowLoadSource,
) -> anyhow::Result<Vec<WorkflowHookBinding>> {
    let raw = fs::read_to_string(path).with_context(|| format!("read {}", path.display()))?;
    let env = serde_yaml::from_str::<WorkflowFileEnvelope>(&raw)
        .with_context(|| format!("parse hook yaml {}", path.display()))?;
    parse_hooks_value(env.hooks.as_ref(), "", &source_ref(source, path))
}

fn parse_hooks_value(
    hooks_value: Option<&Value>,
    default_workflow_id: &str,
    source_ref: &WorkflowSourceRef,
) -> anyhow::Result<Vec<WorkflowHookBinding>> {
    let Some(hooks_value) = hooks_value else {
        return Ok(Vec::new());
    };
    let shape = serde_json::from_value::<HookFileShape>(hooks_value.clone())
        .or_else(|_| serde_yaml::from_value::<HookFileShape>(serde_yaml::to_value(hooks_value)?))
        .context("parse hooks")?;
    let mut out = Vec::new();
    match shape {
        HookFileShape::Map(map) => {
            for (event, actions) in map {
                out.push(WorkflowHookBinding {
                    binding_id: format!(
                        "{}.{}",
                        default_workflow_id_or_default(default_workflow_id),
                        normalize_ident(&event)
                    ),
                    workflow_id: default_workflow_id.to_string(),
                    event,
                    enabled: true,
                    actions: actions.into_iter().map(to_action_spec).collect(),
                    source: Some(source_ref.clone()),
                });
            }
        }
        HookFileShape::List(items) => {
            for item in items {
                out.push(WorkflowHookBinding {
                    binding_id: item.binding_id.or(item.id).unwrap_or_else(|| {
                        format!(
                            "{}.{}",
                            item.workflow_id
                                .clone()
                                .or(item.workflow.clone())
                                .unwrap_or_else(|| default_workflow_id_or_default(
                                    default_workflow_id
                                )),
                            normalize_ident(&item.event)
                        )
                    }),
                    workflow_id: item
                        .workflow_id
                        .or(item.workflow)
                        .unwrap_or_else(|| default_workflow_id.to_string()),
                    event: item.event,
                    enabled: item.enabled.unwrap_or(true),
                    actions: item.actions.into_iter().map(to_action_spec).collect(),
                    source: Some(source_ref.clone()),
                });
            }
        }
    }
    Ok(out)
}

fn default_workflow_id_or_default(workflow_id: &str) -> String {
    if workflow_id.trim().is_empty() {
        "workflow".to_string()
    } else {
        workflow_id.to_string()
    }
}

fn to_action_spec(input: HookActionInput) -> WorkflowActionSpec {
    match input {
        HookActionInput::String(action) => WorkflowActionSpec { action, with: None },
        HookActionInput::Object(spec) => spec,
    }
}

fn normalize_ident(input: &str) -> String {
    input
        .trim()
        .to_ascii_lowercase()
        .replace([' ', '/', '.'], "_")
}

fn source_ref(source: &WorkflowLoadSource, path: &Path) -> WorkflowSourceRef {
    WorkflowSourceRef {
        kind: source.kind.clone(),
        pack_id: source.pack_id.clone(),
        path: Some(path.to_string_lossy().to_string()),
    }
}

fn default_true() -> bool {
    true
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::tempdir;

    #[test]
    fn loads_workflow_with_embedded_hooks() {
        let dir = tempdir().expect("dir");
        let workflows_dir = dir.path().join("workflows");
        fs::create_dir_all(&workflows_dir).expect("mkdir");
        fs::write(
            workflows_dir.join("demo.yaml"),
            r#"
workflow:
  id: build_feature
  name: Build Feature
  steps:
    - planner
    - action: verifier.run
      with:
        strict: true
  hooks:
    task_created:
      - kanban.update
      - action: slack.notify
        with:
          channel: engineering
"#,
        )
        .expect("write");
        let registry = load_registry(&[WorkflowLoadSource {
            root: dir.path().to_path_buf(),
            kind: WorkflowSourceKind::Workspace,
            pack_id: None,
        }])
        .expect("registry");
        let workflow = registry.workflows.get("build_feature").expect("workflow");
        assert_eq!(workflow.steps.len(), 2);
        assert_eq!(registry.hooks.len(), 1);
        assert_eq!(registry.hooks[0].actions.len(), 2);
    }
}