harn-vm 0.10.167

Async bytecode virtual machine for the Harn programming language
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
use super::*;
use std::sync::atomic::{AtomicUsize, Ordering};

use crate::agent_events::{
    emit_event, register_sink, AgentEvent, AgentEventSink, AgentEventTransport,
};
use crate::value::VmDictExt;

struct Count(Arc<AtomicUsize>);
impl AgentEventSink for Count {
    fn handle_event(&self, _: &AgentEvent) {
        self.0.fetch_add(1, Ordering::SeqCst);
    }
}

fn transport() -> (AgentEventTransport, Arc<AtomicUsize>) {
    let count = Arc::new(AtomicUsize::new(0));
    (
        AgentEventTransport::new(Arc::new(Count(count.clone()))),
        count,
    )
}

fn event(session: &str) -> AgentEvent {
    AgentEvent::IterationStart {
        session_id: session.into(),
        iteration: 1,
        provider: String::new(),
        model: String::new(),
    }
}

#[tokio::test(flavor = "current_thread")]
async fn never_executed_vm_cleanup_keeps_transport_explicitly_empty() {
    let (ambient, count) = transport();
    ambient
        .scope(async {
            let vm = crate::Vm::new();
            emit_event(&event("never-executed-cleanup"));
            assert_eq!(count.load(Ordering::SeqCst), 1);
            ScopedCleanup {
                runtimes: vm.agent_cleanup_runtimes(),
                inner: async {
                    emit_event(&event("never-executed-cleanup"));
                },
            }
            .await;
            assert_eq!(count.load(Ordering::SeqCst), 1);
            emit_event(&event("never-executed-cleanup"));
            assert_eq!(count.load(Ordering::SeqCst), 2);
        })
        .await;
}

#[tokio::test(flavor = "current_thread")]
async fn reused_vm_captures_current_runtimes_and_retains_them_for_children_and_cleanup() {
    let mut vm = crate::Vm::new();
    crate::register_vm_stdlib(&mut vm);
    let chunk = crate::compile_source("pipeline main() {}").unwrap();
    let (old, old_count) = transport();
    let (new, new_count) = transport();
    let first = old
        .scope(async {
            vm.execute(&chunk).await.unwrap();
            vm.agent_cleanup_runtimes()
        })
        .await;
    vm.session_runtime = crate::agent_sessions::fresh_session_runtime();
    vm.agent_host_session_runtime =
        crate::llm::agent_session_host::fresh_agent_host_session_runtime();
    let second = new
        .scope(async {
            vm.execute(&chunk).await.unwrap();
            vm.agent_cleanup_runtimes()
        })
        .await;
    let first_key = first.key();
    let second_key = second.key();
    assert_ne!(first_key.execution_id, second_key.execution_id);
    assert_ne!(first_key.session_runtime, second_key.session_runtime);
    assert_ne!(first_key.host_runtime, second_key.host_runtime);
    assert_eq!(
        second_key.session_runtime,
        Arc::as_ptr(&vm.session_runtime) as usize
    );
    assert_eq!(
        second_key.host_runtime,
        Arc::as_ptr(&vm.agent_host_session_runtime) as usize
    );
    assert_eq!(vm.child_vm().agent_cleanup_runtimes().key(), second_key);

    let retained = second.clone();
    assert_eq!(retained.key(), second_key);
    let old_before = old_count.load(Ordering::SeqCst);
    let new_before = new_count.load(Ordering::SeqCst);
    // Scheduling under OLD ambient state must use the complete retained NEW
    // snapshot, including its unchanged execution identity.
    old.scope(ScopedCleanup {
        runtimes: retained,
        inner: async {
            emit_event(&event("reused-vm-cleanup"));
        },
    })
    .await;
    assert_eq!(old_count.load(Ordering::SeqCst), old_before);
    assert_eq!(new_count.load(Ordering::SeqCst), new_before + 1);
}

#[tokio::test(flavor = "current_thread")]
async fn top_level_vm_drop_keeps_origin_after_execution_scope_has_unwound() {
    let root = tempfile::tempdir().unwrap();
    let session = format!("transport-drop-{}", uuid::Uuid::now_v7());
    let (old, old_count) = transport();
    let (new, new_count) = transport();
    let vm = old
        .scope(async {
            let mut vm = crate::Vm::new();
            crate::register_vm_stdlib(&mut vm);
            let chunk = crate::compile_source("pipeline main() {}").unwrap();
            vm.execute(&chunk).await.unwrap();
            vm
        })
        .await;
    let old_before_cleanup = old_count.load(Ordering::SeqCst);
    let mut options = crate::value::DictMap::new();
    options.put_str("root", root.path().to_string_lossy().as_ref());
    let prepared = crate::agent_session_journal::prepare(
        &session,
        &options,
        format!("run-{session}"),
        format!("turn-{session}"),
    )
    .await
    .unwrap();
    crate::agent_sessions::open_or_create_for_test(Some(session.clone()));
    crate::agent_sessions::install_journal(&session, prepared.state).unwrap();
    crate::agent_sessions::claim_journal_task(
        &session,
        vm.execution_id(),
        "task_root".into(),
        true,
    )
    .unwrap();
    crate::llm::agent_session_host::seed_host_session_provider_model(&session, "mock", "fixture");
    let durable = Arc::new(AtomicUsize::new(0));
    register_sink(session.clone(), Arc::new(Count(durable.clone())));
    assert_eq!(
        crate::agent_events::session_external_sink_count(&session),
        1,
        "the observer census reaches a known nonzero registration"
    );
    let mut progress = crate::agent_lifecycle_cleanup::subscribe_cleanup_progress();
    let before = crate::vm::subtask::lifecycle_cleanup_spawn_count();
    new.scope(async {
        emit_event(&event(&session));
        // Drop happens under NEW ambient ownership, after OLD execution unwound.
        drop(vm);
        assert!(crate::vm::subtask::lifecycle_cleanup_spawn_count() > before);
        crate::agent_lifecycle_cleanup::settle_cleanup(
            &mut progress,
            || {
                !crate::agent_sessions::has_journal(&session)
                    && !crate::agent_sessions::exists(&session)
                    && crate::agent_events::session_external_sink_count(&session) == 0
                    && old_count.load(Ordering::SeqCst) > old_before_cleanup
            },
            "originating top-level cleanup must emit and release both session owners",
        )
        .await;
        let cleanup_events = old_count.load(Ordering::SeqCst) - old_before_cleanup;
        assert!(
            cleanup_events > 0,
            "actual terminal cleanup reaches OLD transport"
        );
        let observed_at_close = durable.load(Ordering::SeqCst);
        assert_eq!(
            observed_at_close,
            cleanup_events + 1,
            "session observer receives every cleanup event and the pre-close current anchor"
        );
        assert_eq!(
            crate::agent_events::session_external_sink_count(&session),
            0,
            "settled session close releases its dynamic observers"
        );
        // This post-close positive proves the caller's NEW transport was
        // restored; a closed session no longer owns a registry subscription.
        emit_event(&event(&session));
        assert_eq!(
            durable.load(Ordering::SeqCst),
            observed_at_close,
            "post-close transport observation cannot revive session subscribers"
        );
    })
    .await;
    crate::agent_events::clear_session_sinks(&session);
    assert_eq!(
        new_count.load(Ordering::SeqCst),
        2,
        "cleanup never uses NEW transport"
    );
    // The Count fixture measures observation, not durability. Read the owning
    // journal independently after close to prove its terminal really committed.
    let store = crate::stdlib::session_store::open_canonical_agent_session(
        &crate::stdlib::session_store::SessionStoreDir::under_root(root.path()),
        &session,
        None,
        harn_session_store::SessionType::User,
    )
    .await
    .expect("open canonical session after cleanup");
    let events = crate::stdlib::session_store::read_all_events(&store, &session)
        .await
        .expect("read committed journal after cleanup");
    let terminals: Vec<_> = events
        .iter()
        .filter(|event| {
            event
                .payload
                .pointer("/transcript_event/kind")
                .and_then(serde_json::Value::as_str)
                == Some("agent_run_terminal")
        })
        .collect();
    assert_eq!(
        terminals.len(),
        1,
        "cleanup commits exactly one durable terminal"
    );
    let metadata = terminals[0]
        .payload
        .pointer("/transcript_event/metadata")
        .unwrap();
    assert_eq!(metadata["final_status"], "cancelled");
    assert_eq!(metadata["stop_reason"], "cancelled");
    let phase = crate::agent_events::AgentTurnPhase::from_terminal_record(metadata)
        .expect("persisted terminal decodes through owning typed projection");
    assert!(
        matches!(phase, crate::agent_events::AgentTurnPhase::Terminal { outcome, .. }
        if outcome.kind == crate::agent_events::AgentTerminalKind::UserCancelled)
    );
}

async fn pending_cleanup_after_vm_reuse(drop_instead_of_retry: bool) {
    let root = tempfile::tempdir().expect("temp root");
    let session = format!("pending-reuse-{}", uuid::Uuid::now_v7());
    let task_id = "task_pending_reuse";
    let public_id = "public-pending-reuse";
    let (old, old_count) = transport();
    let (new, new_count) = transport();
    let mut vm = crate::Vm::new();
    crate::register_vm_stdlib(&mut vm);
    let chunk = crate::compile_source("pipeline main() {}").unwrap();
    old.scope(vm.execute(&chunk)).await.unwrap();
    let original = vm.agent_cleanup_runtimes();
    let original_execution = vm.execution_id().to_string();
    let store = ScopedCleanup {
        runtimes: original.clone(),
        inner: async {
            let mut options = crate::value::DictMap::new();
            options.put_str("root", root.path().to_string_lossy().as_ref());
            let prepared = crate::agent_session_journal::prepare(
                &session,
                &options,
                format!("run-{session}"),
                format!("turn-{session}"),
            )
            .await
            .unwrap();
            let store = prepared.state.store();
            crate::agent_sessions::open_or_create_for_test(Some(session.clone()));
            crate::agent_sessions::install_journal(&session, prepared.state).unwrap();
            crate::agent_sessions::claim_journal_task(
                &session,
                &original_execution,
                task_id.into(),
                true,
            )
            .unwrap();
            // Fail a real canonical append without permanently closing the session.
            // This private database's removable trigger injects only the write fault.
            let fault = rusqlite::Connection::open(store.path()).unwrap();
            fault
                .execute_batch(
                    "CREATE TRIGGER fail_pending_cleanup BEFORE INSERT ON session_events
                 BEGIN SELECT RAISE(FAIL, 'pending cleanup append fault'); END;",
                )
                .unwrap();
            vm.register_spawned_task(
                public_id.into(),
                crate::value::VmTaskHandle {
                    handle: tokio::spawn(std::future::pending()),
                    cancel_token: Arc::new(std::sync::atomic::AtomicBool::new(false)),
                    wait_task_id: task_id.into(),
                },
            );
            let error = vm
                .cancel_task_for_test(public_id)
                .await
                .expect_err("actual cancel must observe the canonical append failure");
            assert!(error.to_string().contains("pending cleanup append fault"));
            assert!(!vm.spawned_tasks.contains_key(public_id));
            assert!(vm.pending_task_cleanups.contains_key(public_id));
            assert!(crate::agent_sessions::has_journal(&session));
            assert!(crate::agent_sessions::next_journal_event(&session)
                .unwrap()
                .is_some());
            fault
                .execute_batch("DROP TRIGGER fail_pending_cleanup;")
                .unwrap();
            store
        },
    }
    .await;

    let old_before = old_count.load(Ordering::SeqCst);
    vm.session_runtime = crate::agent_sessions::fresh_session_runtime();
    vm.agent_host_session_runtime =
        crate::llm::agent_session_host::fresh_agent_host_session_runtime();
    new.scope(vm.execute(&chunk)).await.unwrap();
    assert_ne!(vm.execution_id().to_string(), original_execution);
    assert!(vm.pending_task_cleanups.contains_key(public_id));
    let current = vm.agent_cleanup_runtimes();
    let new_before = new_count.load(Ordering::SeqCst);
    let mut progress = subscribe_cleanup_progress();
    ScopedCleanup {
        runtimes: current,
        inner: async {
            if drop_instead_of_retry {
                drop(vm);
            } else {
                assert!(vm.cancel_task_for_test(public_id).await
                    .expect("retry commits the original pending terminal"));
                assert!(!vm.pending_task_cleanups.contains_key(public_id));
                ScopedCleanup {
                    runtimes: original.clone(),
                    inner: async {
                        assert!(
                            !crate::agent_sessions::has_journal(&session),
                            "a successful retry must discharge the original journal, not find zero sessions in the new runtime"
                        );
                        assert!(old_count.load(Ordering::SeqCst) > old_before);
                    },
                }.await;
                drop(vm);
            }
            ScopedCleanup {
                runtimes: original,
                inner: async {
                    settle_cleanup(
                        &mut progress,
                        || {
                            !crate::agent_sessions::has_journal(&session)
                                && !crate::agent_sessions::exists(&session)
                                && old_count.load(Ordering::SeqCst) > old_before
                        },
                        "pending cleanup after reuse must commit and emit through its original owner",
                    ).await;
                },
            }.await;
            emit_event(&event(&session));
        },
    }.await;
    assert!(old_count.load(Ordering::SeqCst) > old_before);
    assert_eq!(new_count.load(Ordering::SeqCst), new_before + 1);
    let events = crate::stdlib::session_store::read_all_events(&store, &session)
        .await
        .unwrap();
    let terminals: Vec<_> = events
        .iter()
        .filter(|event| event.payload["transcript_event"]["kind"] == "agent_run_terminal")
        .collect();
    assert_eq!(terminals.len(), 1);
    assert_eq!(
        terminals[0].payload["transcript_event"]["metadata"]["final_status"],
        "cancelled"
    );
    assert_eq!(
        terminals[0].payload["transcript_event"]["metadata"]["stop_reason"],
        "cancelled"
    );
}

#[tokio::test(flavor = "current_thread")]
async fn pending_cancel_retry_after_vm_reuse_retains_original_owner() {
    pending_cleanup_after_vm_reuse(false).await;
}

#[tokio::test(flavor = "current_thread")]
async fn pending_cancel_drop_after_vm_reuse_retains_original_owner() {
    pending_cleanup_after_vm_reuse(true).await;
}

#[tokio::test(flavor = "current_thread")]
async fn active_child_cancel_after_same_runtime_vm_reuse_retains_original_owner() {
    let root = tempfile::tempdir().unwrap();
    let session = format!("active-reuse-{}", uuid::Uuid::now_v7());
    let task_id = "task_active_reuse";
    let public_id = "public-active-reuse";
    let (old, old_count) = transport();
    let (new, new_count) = transport();
    let mut vm = crate::Vm::new();
    crate::register_vm_stdlib(&mut vm);
    let chunk = crate::compile_source("pipeline main() {}").unwrap();
    old.scope(vm.execute(&chunk)).await.unwrap();
    let original = vm.agent_cleanup_runtimes();
    let original_key = original.key();
    let cancelled = Arc::new(std::sync::atomic::AtomicBool::new(false));
    let store = ScopedCleanup {
        runtimes: original.clone(),
        inner: async {
            let mut options = crate::value::DictMap::new();
            options.put_str("root", root.path().to_string_lossy().as_ref());
            let prepared = crate::agent_session_journal::prepare(
                &session,
                &options,
                format!("run-{session}"),
                format!("turn-{session}"),
            )
            .await
            .unwrap();
            let store = prepared.state.store();
            crate::agent_sessions::open_or_create_for_test(Some(session.clone()));
            crate::agent_sessions::install_journal(&session, prepared.state).unwrap();
            crate::agent_sessions::claim_journal_task(
                &session,
                &original_key.execution_id,
                task_id.into(),
                true,
            )
            .unwrap();
            let (started_tx, started_rx) = tokio::sync::oneshot::channel();
            vm.register_spawned_task(
                public_id.into(),
                crate::value::VmTaskHandle {
                    handle: tokio::spawn(async move {
                        started_tx.send(()).unwrap();
                        std::future::pending().await
                    }),
                    cancel_token: cancelled.clone(),
                    wait_task_id: task_id.into(),
                },
            );
            started_rx
                .await
                .expect("the original child actually started");
            assert!(crate::agent_sessions::has_journal(&session));
            assert!(!vm.spawned_tasks[public_id].task.handle.is_finished());
            store
        },
    }
    .await;
    let old_before = old_count.load(Ordering::SeqCst);
    // Keep BOTH runtime handles unchanged: only top-level execution identity
    // and transport advance, unlike the pending-write-failure controls.
    new.scope(vm.execute(&chunk)).await.unwrap();
    let current = vm.agent_cleanup_runtimes();
    let current_key = current.key();
    assert_ne!(current_key.execution_id, original_key.execution_id);
    assert_eq!(current_key.session_runtime, original_key.session_runtime);
    assert_eq!(current_key.host_runtime, original_key.host_runtime);
    assert!(vm.spawned_tasks.contains_key(public_id));
    assert!(!cancelled.load(Ordering::SeqCst));
    let new_before = new_count.load(Ordering::SeqCst);
    ScopedCleanup {
        runtimes: current,
        inner: async {
            emit_event(&event(&session));
            assert_eq!(new_count.load(Ordering::SeqCst), new_before + 1);
            assert!(vm.cancel_task_for_test(public_id).await.unwrap());
            assert!(cancelled.load(Ordering::SeqCst));
            assert!(!vm.spawned_tasks.contains_key(public_id));
            assert!(!vm.pending_task_cleanups.contains_key(public_id));
            ScopedCleanup {
                runtimes: original,
                inner: async {
                    assert!(
                        !crate::agent_sessions::has_journal(&session),
                        "cancelling an active old child after reuse must commit its original terminal"
                    );
                    assert!(!crate::agent_sessions::exists(&session));
                    assert!(old_count.load(Ordering::SeqCst) > old_before);
                },
            }.await;
            emit_event(&event(&session));
            assert_eq!(new_count.load(Ordering::SeqCst), new_before + 2);
        },
    }.await;
    let events = crate::stdlib::session_store::read_all_events(&store, &session)
        .await
        .unwrap();
    let terminals: Vec<_> = events
        .iter()
        .filter(|event| event.payload["transcript_event"]["kind"] == "agent_run_terminal")
        .collect();
    assert_eq!(terminals.len(), 1);
    assert_eq!(
        terminals[0].payload["transcript_event"]["metadata"]["final_status"],
        "cancelled"
    );
    assert_eq!(
        terminals[0].payload["transcript_event"]["metadata"]["stop_reason"],
        "cancelled"
    );
}