beam-core 0.8.0

Shared core types and workflow/session logic for beam
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
use std::collections::BTreeMap;
use std::fs;
use std::sync::Arc;
use tokio::sync::Mutex;

use async_trait::async_trait;
use serde_json::Value;

use crate::workflow_definition::SubagentNode;
use crate::{EventDraft, EventLog, RunChatBinding, WorkflowActor};

use super::test_common::temp_run_dir;
use super::*;

/// fields so that $ref bindings (implement.output.code,
/// review.output.preview) work.
#[derive(Clone)]
struct RichFakeHooks;

#[async_trait]
impl WorkflowExecutionHooks for RichFakeHooks {
    async fn execute_subagent(
        &mut self,
        _ctx: WorkflowDispatchRun<'_>,
        _node: &SubagentNode,
        _resolved_prompt: String,
    ) -> Result<WorkflowDispatchOutcome> {
        Ok(WorkflowDispatchOutcome::Succeeded {
            output: serde_json::json!({"code": "mock-code", "summary": "mock-summary", "preview": "looks good"}),
            session: None,
        })
    }

    async fn execute_host_executor(
        &mut self,
        _ctx: WorkflowDispatchRun<'_>,
        _node: &HostExecutorNode,
        resolved_input: Value,
    ) -> Result<WorkflowDispatchOutcome> {
        Ok(WorkflowDispatchOutcome::Succeeded {
            output: resolved_input,
            session: None,
        })
    }
}

/// Hook that records resolved subagent prompts for verification.
#[derive(Clone)]
struct RecordingHooks {
    prompts: Arc<Mutex<Vec<(String, String)>>>, // (node_id, resolved_prompt)
}

#[async_trait]
impl WorkflowExecutionHooks for RecordingHooks {
    async fn execute_subagent(
        &mut self,
        _ctx: WorkflowDispatchRun<'_>,
        _node: &SubagentNode,
        resolved_prompt: String,
    ) -> Result<WorkflowDispatchOutcome> {
        self.prompts
            .lock()
            .await
            .push((_ctx.node_id.to_string(), resolved_prompt.clone()));
        // Produce a JSON object with common workflow output fields so
        // that $ref bindings (implement.output.code,
        // review.output.preview) resolve correctly.
        let out = serde_json::json!({"code": "mock-code", "summary": "mock-summary", "preview": "looks good"});
        Ok(WorkflowDispatchOutcome::Succeeded {
            output: out,
            session: None,
        })
    }

    async fn execute_host_executor(
        &mut self,
        _ctx: WorkflowDispatchRun<'_>,
        _node: &HostExecutorNode,
        resolved_input: Value,
    ) -> Result<WorkflowDispatchOutcome> {
        Ok(WorkflowDispatchOutcome::Succeeded {
            output: resolved_input,
            session: None,
        })
    }
}

#[tokio::test]
async fn real_code_review_loop_iter1_reaches_awaiting_wait() {
    // Load the real workflow JSON, bootstrap with task param,
    // and verify iteration 1 reaches AwaitingWait without errors
    // from ${reviewDecision.previous.comment}.
    let raw = include_str!("../../../../workflows/code-review-loop.workflow.json");
    let def = crate::parse_workflow_definition(raw).expect("parse real code-review-loop");
    let workflow_json = serde_json::to_string(&def).unwrap();

    let run_dir = temp_run_dir("real-crl-iter1");
    let _ = fs::remove_dir_all(&run_dir);
    fs::create_dir_all(run_dir.join("blobs")).unwrap();
    let paths = crate::BeamPaths::from_root(run_dir.clone());
    let run_id = "run-real-crl-1";
    let params: BTreeMap<String, Value> = BTreeMap::from([(
        String::from("task"),
        Value::String("add CLI echo command".to_string()),
    )]);
    crate::bootstrap_workflow_run(
        &paths,
        crate::BootstrapWorkflowRunInput {
            run_id,
            workflow_json: &workflow_json,
            expected_workflow_id: Some("code-review-loop"),
            params: &params,
            initiator: "cli",
            chat_binding: Some(RunChatBinding {
                chat_id: "chat-1".to_string(),
                lark_app_id: "app-1".to_string(),
            }),
        },
    )
    .unwrap();

    let prompts = Arc::new(Mutex::new(Vec::new()));
    let mut hooks = RecordingHooks {
        prompts: prompts.clone(),
    };

    let mut rt = WorkflowRuntimeContext {
        log: EventLog::new(run_id, paths.workflow_runs_dir()).unwrap(),
        def,
        runs_base_dir: paths.workflow_runs_dir(),
    };
    let result = run_loop(&mut rt, &mut hooks, 10, 1).await.unwrap();

    assert_eq!(
        result.reason,
        RunLoopStopReason::AwaitingWait,
        "expected AwaitingWait for open human gate"
    );

    // Verify implement's resolved prompt contains the task and does NOT
    // error on ${reviewDecision.previous.comment} (iteration 1 → empty).
    let recorded = prompts.lock().await;
    let implement_prompt = recorded
        .iter()
        .find(|(node_id, _)| node_id == "implement")
        .map(|(_, p)| p.clone())
        .expect("implement must have been dispatched");
    eprintln!("implement prompt iter1: {implement_prompt}");
    assert!(
        implement_prompt.contains("add CLI echo command"),
        "implement prompt should contain the task param"
    );
    // In iteration 1, .previous.comment resolves to empty string.
    assert!(
        !implement_prompt.contains("ERROR") && !implement_prompt.contains("no previous iteration"),
        "implement prompt should not contain binding errors: {implement_prompt}"
    );

    // Verify loop-scoped activity IDs exist
    let events = rt.log.read_all().unwrap();
    let decision_gate_id = format!("{}::loop::review-loop.1::gate::reviewDecision", run_id);
    let has_gate_wait = events.iter().any(|e| {
        e.event_type == "waitCreated"
            && e.payload.get("activityId").and_then(Value::as_str) == Some(&decision_gate_id)
    });
    assert!(has_gate_wait, "expected gate wait for {}", decision_gate_id);

    let _ = fs::remove_dir_all(&run_dir);
}

#[tokio::test]
async fn real_code_review_loop_reject_enters_iter2_with_comment() {
    // Iteration 1: drive to gate, reject with comment.
    // Iteration 2: verify implement's resolved prompt contains the
    // reject comment from the previous iteration.
    let raw = include_str!("../../../../workflows/code-review-loop.workflow.json");
    let def = crate::parse_workflow_definition(raw).expect("parse real code-review-loop");
    let workflow_json = serde_json::to_string(&def).unwrap();

    let run_dir = temp_run_dir("real-crl-reject");
    let _ = fs::remove_dir_all(&run_dir);
    fs::create_dir_all(run_dir.join("blobs")).unwrap();
    let paths = crate::BeamPaths::from_root(run_dir.clone());
    let run_id = "run-real-crl-rej";
    let params: BTreeMap<String, Value> =
        BTreeMap::from([(String::from("task"), Value::String("add test".to_string()))]);
    crate::bootstrap_workflow_run(
        &paths,
        crate::BootstrapWorkflowRunInput {
            run_id,
            workflow_json: &workflow_json,
            expected_workflow_id: Some("code-review-loop"),
            params: &params,
            initiator: "cli",
            chat_binding: Some(RunChatBinding {
                chat_id: "chat-1".to_string(),
                lark_app_id: "app-1".to_string(),
            }),
        },
    )
    .unwrap();

    let prompts = Arc::new(Mutex::new(Vec::new()));

    // Iteration 1: drive to AwaitingWait.
    {
        let mut hooks = RecordingHooks {
            prompts: prompts.clone(),
        };
        let mut rt = WorkflowRuntimeContext {
            log: EventLog::new(run_id, paths.workflow_runs_dir()).unwrap(),
            def: def.clone(),
            runs_base_dir: paths.workflow_runs_dir(),
        };
        let result = run_loop(&mut rt, &mut hooks, 10, 1).await.unwrap();
        assert_eq!(result.reason, RunLoopStopReason::AwaitingWait);
    }

    // Reject iteration 1 with a comment.
    let decision_gate_id = format!("{}::loop::review-loop.1::gate::reviewDecision", run_id);
    {
        let mut log = EventLog::new(run_id, paths.workflow_runs_dir()).unwrap();
        let _ = log
            .append(EventDraft {
                event_type: "waitResolved".to_string(),
                actor: WorkflowActor::Human,
                payload: serde_json::json!({
                    "activityId": &decision_gate_id,
                    "resolution": "rejected",
                    "by": "reviewer",
                    "comment": "needs more tests",
                }),
                timestamp: None,
                payload_hash: None,
            })
            .unwrap();
    }

    // Process rejection → iteration 2 should start.
    {
        let mut hooks = RecordingHooks {
            prompts: prompts.clone(),
        };
        let mut rt = WorkflowRuntimeContext {
            log: EventLog::new(run_id, paths.workflow_runs_dir()).unwrap(),
            def: def.clone(),
            runs_base_dir: paths.workflow_runs_dir(),
        };
        let _result = run_loop(&mut rt, &mut hooks, 10, 1).await.unwrap();

        // Verify loopIterationFinished metadata
        let events = rt.log.read_all().unwrap();
        let iter1_finished = events.iter().find(|e| {
            e.event_type == "loopIterationFinished"
                && e.payload.get("iteration").and_then(Value::as_u64) == Some(1)
        });
        assert!(
            iter1_finished.is_some(),
            "expected loopIterationFinished for iteration 1"
        );
        let payload = &iter1_finished.unwrap().payload;
        assert_eq!(
            payload.get("resolution").and_then(Value::as_str),
            Some("rejected"),
            "resolution should be rejected"
        );
        assert_eq!(
            payload.get("by").and_then(Value::as_str),
            Some("reviewer"),
            "by should be reviewer"
        );
        assert_eq!(
            payload.get("comment").and_then(Value::as_str),
            Some("needs more tests"),
            "comment should be preserved"
        );
        assert_eq!(
            payload.get("decisionActivityId").and_then(Value::as_str),
            Some(decision_gate_id.as_str()),
            "decisionActivityId should be the gate id"
        );

        let iter2_started = events.iter().any(|e| {
            e.event_type == "loopIterationStarted"
                && e.payload.get("iteration").and_then(Value::as_u64) == Some(2)
        });
        assert!(iter2_started, "expected iteration 2 started");
    }

    // Now verify iteration 2 implement prompt contains the reject comment.
    // The runtime already dispatched implement in iteration 2 during the
    // above run_loop call.
    let recorded = prompts.lock().await;
    let iter2_implement = recorded
        .iter()
        .filter(|(node_id, _)| node_id == "implement")
        .last()
        .map(|(_, p)| p.clone())
        .expect("implement iter2 must have been dispatched");
    eprintln!("implement prompt iter2: {iter2_implement}");
    assert!(
        iter2_implement.contains("needs more tests"),
        "iter2 implement prompt should contain reject comment 'needs more tests': {iter2_implement}"
    );

    let _ = fs::remove_dir_all(&run_dir);
}

#[tokio::test]
async fn real_code_review_loop_approve_succeeds() {
    // Load real workflow, drive to gate, approve, verify loop/run succeeded.
    let raw = include_str!("../../../../workflows/code-review-loop.workflow.json");
    let def = crate::parse_workflow_definition(raw).expect("parse real code-review-loop");
    let workflow_json = serde_json::to_string(&def).unwrap();

    let run_dir = temp_run_dir("real-crl-approve");
    let _ = fs::remove_dir_all(&run_dir);
    fs::create_dir_all(run_dir.join("blobs")).unwrap();
    let paths = crate::BeamPaths::from_root(run_dir.clone());
    let run_id = "run-real-crl-app";
    let params: BTreeMap<String, Value> = BTreeMap::from([(
        String::from("task"),
        Value::String("add feature".to_string()),
    )]);
    crate::bootstrap_workflow_run(
        &paths,
        crate::BootstrapWorkflowRunInput {
            run_id,
            workflow_json: &workflow_json,
            expected_workflow_id: Some("code-review-loop"),
            params: &params,
            initiator: "cli",
            chat_binding: Some(RunChatBinding {
                chat_id: "chat-1".to_string(),
                lark_app_id: "app-1".to_string(),
            }),
        },
    )
    .unwrap();

    // Iteration 1: drive to AwaitingWait.
    {
        let mut hooks = RichFakeHooks;
        let mut rt = WorkflowRuntimeContext {
            log: EventLog::new(run_id, paths.workflow_runs_dir()).unwrap(),
            def: def.clone(),
            runs_base_dir: paths.workflow_runs_dir(),
        };
        let result = run_loop(&mut rt, &mut hooks, 10, 1).await.unwrap();
        assert_eq!(result.reason, RunLoopStopReason::AwaitingWait);
    }

    // Approve.
    let decision_gate_id = format!("{}::loop::review-loop.1::gate::reviewDecision", run_id);
    {
        let mut log = EventLog::new(run_id, paths.workflow_runs_dir()).unwrap();
        let _ = log
            .append(EventDraft {
                event_type: "waitResolved".to_string(),
                actor: WorkflowActor::Human,
                payload: serde_json::json!({
                    "activityId": &decision_gate_id,
                    "resolution": "approved",
                    "by": "approver",
                    "comment": "lgtm",
                }),
                timestamp: None,
                payload_hash: None,
            })
            .unwrap();
    }

    // Process approval → loop and run succeed.
    {
        let mut hooks = RichFakeHooks;
        let mut rt = WorkflowRuntimeContext {
            log: EventLog::new(run_id, paths.workflow_runs_dir()).unwrap(),
            def,
            runs_base_dir: paths.workflow_runs_dir(),
        };
        let result = run_loop(&mut rt, &mut hooks, 10, 1).await.unwrap();

        let events = rt.log.read_all().unwrap();

        let loop_finished = events.iter().find(|e| {
            e.event_type == "loopFinished"
                && e.payload.get("loopId").and_then(Value::as_str) == Some("review-loop")
        });
        assert!(loop_finished.is_some(), "expected loopFinished");
        let payload = &loop_finished.unwrap().payload;
        assert_eq!(
            payload.get("resolution").and_then(Value::as_str),
            Some("approved")
        );

        let run_succeeded = events.iter().any(|e| e.event_type == "runSucceeded");
        assert!(run_succeeded, "expected run to succeed after loop approval");

        assert!(matches!(result.reason, RunLoopStopReason::Terminal));

        // Verify loop output exists.
        let snap = read_snapshot(&rt).await.unwrap();
        let loop_output_key = format!("{}::work::review-loop", run_id);
        assert!(
            snap.outputs.contains_key(&loop_output_key),
            "expected loop output"
        );
    }

    let _ = fs::remove_dir_all(&run_dir);
}