basis 0.12.1

The basis SDK: workspace discovery, run lifecycle, one event stream, and the two seams. No protocol, no transport, no TTY.
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
//! Lossless in-process observation through Basis's public run surface.
//!
//! Basis must not translate this stream: hosts use it precisely when the
//! bounded, UI-shaped [`basis::Event`] stream is too lossy for durable evidence.

use std::sync::{
    Arc, Mutex,
    atomic::{AtomicUsize, Ordering},
};

use async_trait::async_trait;
use basis::{
    AgentEvent, AgentEventTapGuard, AllowAll, CollectingSink, ContentBlock, PreparedRun,
    RunFailure, TurnOptions, provider_core::ToolResultContent, run::prepare_with_session,
};
use mentra::{
    RuntimePolicy,
    test::{MockRuntime, MockToolCall},
    tool::{
        ParallelToolContext, ToolContext, ToolDefinition, ToolDurability, ToolExecutionCategory,
        ToolExecutor, ToolOutput, ToolSideEffectLevel, ToolSpec,
    },
};
use serde_json::{Value, json};
use tokio::{
    sync::Notify,
    time::{Duration, timeout},
};

const FAILED_RESULT: &str = "evidence tool failed with its complete diagnostic";
const CANCELLED_PARALLEL_TAIL: &str = "completed-before-sibling-cancellation";

struct StructuredEvidenceTool;

#[async_trait]
impl ToolDefinition for StructuredEvidenceTool {
    fn descriptor(&self) -> ToolSpec {
        ToolSpec::builder("structured_evidence")
            .description("Return a structured evidence payload")
            .input_schema(json!({ "type": "object" }))
            .side_effect_level(ToolSideEffectLevel::LocalState)
            .durability(ToolDurability::Ephemeral)
            .execution_category(ToolExecutionCategory::ExclusiveLocalMutation)
            .build()
    }
}

#[async_trait]
impl ToolExecutor for StructuredEvidenceTool {
    async fn execute_mut_output(
        &self,
        _ctx: ToolContext<'_>,
        _input: Value,
    ) -> Result<ToolOutput, String> {
        Ok(ToolOutput::structured(structured_result()))
    }
}

struct FailedEvidenceTool;

#[async_trait]
impl ToolDefinition for FailedEvidenceTool {
    fn descriptor(&self) -> ToolSpec {
        ToolSpec::builder("failed_evidence")
            .description("Return a complete tool-level failure")
            .input_schema(json!({ "type": "object" }))
            .side_effect_level(ToolSideEffectLevel::LocalState)
            .durability(ToolDurability::Ephemeral)
            .execution_category(ToolExecutionCategory::ExclusiveLocalMutation)
            .build()
    }
}

struct CompletedParallelEvidenceTool {
    blocking_started: Arc<Notify>,
}

#[async_trait]
impl ToolDefinition for CompletedParallelEvidenceTool {
    fn descriptor(&self) -> ToolSpec {
        ToolSpec::builder("completed_parallel_evidence")
            .description("Complete while a sibling parallel tool remains pending")
            .input_schema(json!({ "type": "object" }))
            .side_effect_level(ToolSideEffectLevel::None)
            .durability(ToolDurability::ReplaySafe)
            .execution_category(ToolExecutionCategory::ReadOnlyParallel)
            .build()
    }
}

#[async_trait]
impl ToolExecutor for CompletedParallelEvidenceTool {
    async fn execute_output(
        &self,
        _ctx: ParallelToolContext,
        _input: Value,
    ) -> Result<ToolOutput, String> {
        self.blocking_started.notified().await;
        Ok(ToolOutput::structured(cancelled_parallel_result()))
    }
}

struct BlockingParallelEvidenceTool {
    started: Arc<Notify>,
}

#[async_trait]
impl ToolDefinition for BlockingParallelEvidenceTool {
    fn descriptor(&self) -> ToolSpec {
        ToolSpec::builder("blocking_parallel_evidence")
            .description("Remain pending until the parallel batch is cancelled")
            .input_schema(json!({ "type": "object" }))
            .side_effect_level(ToolSideEffectLevel::None)
            .durability(ToolDurability::ReplaySafe)
            .execution_category(ToolExecutionCategory::ReadOnlyParallel)
            .build()
    }
}

#[async_trait]
impl ToolExecutor for BlockingParallelEvidenceTool {
    async fn execute_output(
        &self,
        _ctx: ParallelToolContext,
        _input: Value,
    ) -> Result<ToolOutput, String> {
        self.started.notify_one();
        std::future::pending().await
    }
}

#[async_trait]
impl ToolExecutor for FailedEvidenceTool {
    async fn execute_mut_output(
        &self,
        _ctx: ToolContext<'_>,
        _input: Value,
    ) -> Result<ToolOutput, String> {
        Err(FAILED_RESULT.to_string())
    }
}

fn workspace() -> tempfile::TempDir {
    let dir = tempfile::tempdir().expect("tempdir");
    std::fs::write(dir.path().join("AGENTS.md"), "preserve evidence").expect("write context");
    dir
}

fn context() -> basis::ContextConfig {
    basis::ContextConfig {
        file_name: "AGENTS.md".to_string(),
        global_dir: None,
        walk_parents: false,
    }
}

fn prepared(mock: &MockRuntime, workspace: &tempfile::TempDir) -> PreparedRun {
    let session = mock
        .runtime()
        .create_session("observer", mock.model())
        .expect("session");
    prepare_with_session(
        session,
        workspace.path(),
        "collect the evidence",
        &context(),
        "openai",
        "mock-model",
    )
    .expect("prepared run")
}

fn observed_events() -> (
    Arc<Mutex<Vec<AgentEvent>>>,
    impl Fn(&AgentEvent) + Send + Sync + 'static,
) {
    let observed = Arc::new(Mutex::new(Vec::new()));
    let observed_for_tap = Arc::clone(&observed);
    let tap = move |event: &AgentEvent| {
        observed_for_tap
            .lock()
            .unwrap_or_else(|error| error.into_inner())
            .push(event.clone());
    };
    (observed, tap)
}

#[tokio::test]
async fn observer_preserves_complete_tool_payloads_and_occurrence_order() {
    let structured_input = json!({
        "query": "why did the invariant fail?",
        "filters": { "scope": ["docs", "code"], "exact": true }
    });
    let failed_input = json!({ "evidence_id": "ev-2" });
    let mock = MockRuntime::builder()
        .model("mock-model", "openai")
        .with_policy(RuntimePolicy::permissive())
        .tool_calls([
            MockToolCall::new("structured_evidence", structured_input.clone())
                .with_id("call-structured"),
            MockToolCall::new("failed_evidence", failed_input.clone()).with_id("call-failed"),
        ])
        .text("done")
        .build()
        .expect("mock runtime builds");
    mock.runtime().register_tool(StructuredEvidenceTool);
    mock.runtime().register_tool(FailedEvidenceTool);

    let dir = workspace();
    let mut run = prepared(&mock, &dir);
    let (observed, tap) = observed_events();
    let _guard: AgentEventTapGuard = run.register_agent_event_tap(tap);

    let report = run
        .execute_with_approver(CollectingSink::new(), AllowAll)
        .await
        .expect("run completes");
    assert!(report.succeeded());

    let events = observed
        .lock()
        .unwrap_or_else(|error| error.into_inner())
        .clone();
    let lifecycle = events
        .iter()
        .filter_map(tool_lifecycle_label)
        .collect::<Vec<_>>();
    assert_eq!(
        lifecycle,
        [
            "ready:call-structured",
            "ready:call-failed",
            "started:call-structured",
            "finished:call-structured",
            "started:call-failed",
            "finished:call-failed",
        ],
        "the Basis observer must preserve Mentra's occurrence order"
    );

    assert!(events.iter().any(|event| matches!(
        event,
        AgentEvent::ToolUseReady { call, .. }
            if call.id == "call-structured"
                && call.name == "structured_evidence"
                && call.input == structured_input
    )));
    assert!(events.iter().any(|event| matches!(
        event,
        AgentEvent::ToolUseReady { call, .. }
            if call.id == "call-failed"
                && call.name == "failed_evidence"
                && call.input == failed_input
    )));
    assert!(events.iter().any(|event| matches!(
        event,
        AgentEvent::ToolExecutionFinished {
            result: ContentBlock::ToolResult {
                tool_use_id,
                content: ToolResultContent::Structured(content),
                is_error: false,
            },
        } if tool_use_id == "call-structured" && content == &structured_result()
    )));
    assert!(events.iter().any(|event| matches!(
        event,
        AgentEvent::ToolExecutionFinished {
            result: ContentBlock::ToolResult {
                tool_use_id,
                content: ToolResultContent::Text(content),
                is_error: true,
            },
        } if tool_use_id == "call-failed" && content == FAILED_RESULT
    )));
}

fn structured_result() -> Value {
    json!({
        "payload": ["x".repeat(300), "observer-only-structured-tail"],
        "source_refs": ["doc:alpha#L1", "code:beta.rs#L2"]
    })
}

fn tool_lifecycle_label(event: &AgentEvent) -> Option<String> {
    match event {
        AgentEvent::ToolUseReady { call, .. } => Some(format!("ready:{}", call.id)),
        AgentEvent::ToolExecutionStarted { call } => Some(format!("started:{}", call.id)),
        AgentEvent::ToolExecutionFinished {
            result: ContentBlock::ToolResult { tool_use_id, .. },
        } => Some(format!("finished:{tool_use_id}")),
        _ => None,
    }
}

fn cancelled_parallel_result() -> Value {
    json!({
        "evidence": ["complete", CANCELLED_PARALLEL_TAIL],
        "source": "parallel-sibling"
    })
}

#[tokio::test]
async fn parallel_result_is_retained_before_sibling_cancellation() {
    let blocking_tool_started = Arc::new(Notify::new());
    let mock = MockRuntime::builder()
        .model("mock-model", "openai")
        .with_policy(RuntimePolicy::permissive())
        .tool_calls([
            MockToolCall::new("completed_parallel_evidence", json!({ "id": 1 }))
                .with_id("call-completed"),
            MockToolCall::new("blocking_parallel_evidence", json!({ "id": 2 }))
                .with_id("call-blocking"),
        ])
        .build()
        .expect("mock runtime builds");
    mock.runtime().register_tool(CompletedParallelEvidenceTool {
        blocking_started: Arc::clone(&blocking_tool_started),
    });
    mock.runtime().register_tool(BlockingParallelEvidenceTool {
        started: blocking_tool_started,
    });

    let dir = workspace();
    let mut run = prepared(&mock, &dir);
    let (options, cancellation) = TurnOptions::cancellable();
    let cancellation_for_tap = cancellation.clone();
    let (observed, tap) = observed_events();
    let _guard = run.register_agent_event_tap(move |event| {
        tap(event);
        if matches!(
            event,
            AgentEvent::ToolExecutionFinished {
                result: ContentBlock::ToolResult {
                    tool_use_id,
                    is_error: false,
                    ..
                },
            } if tool_use_id == "call-completed"
        ) {
            cancellation_for_tap.cancel();
        }
    });

    let report = timeout(
        Duration::from_secs(5),
        run.execute_with_approver_and_options(CollectingSink::new(), AllowAll, options),
    )
    .await
    .expect("parallel cancellation must not leave the sibling pending")
    .expect("Basis reports the cancelled turn");
    assert!(matches!(report.failure, Some(RunFailure::Cancelled)));

    let events = observed
        .lock()
        .unwrap_or_else(|error| error.into_inner())
        .clone();
    let blocking_started = events
        .iter()
        .position(|event| {
            matches!(
                event,
                AgentEvent::ToolExecutionStarted { call } if call.id == "call-blocking"
            )
        })
        .expect("the pending sibling started");
    let completed = events
        .iter()
        .position(|event| {
            matches!(
                event,
                AgentEvent::ToolExecutionFinished {
                    result: ContentBlock::ToolResult {
                        tool_use_id,
                        content: ToolResultContent::Structured(content),
                        is_error: false,
                    },
                } if tool_use_id == "call-completed" && content == &cancelled_parallel_result()
            )
        })
        .expect("the completed sibling's full result was retained");
    let failed = events
        .iter()
        .position(|event| {
            matches!(
                event,
                AgentEvent::RunFailed { error } if error == "operation cancelled"
            )
        })
        .expect("cancellation remains observable");
    assert!(blocking_started < completed && completed < failed);
    assert!(events.iter().all(|event| !matches!(
        event,
        AgentEvent::ToolExecutionFinished {
            result: ContentBlock::ToolResult { tool_use_id, .. },
        } if tool_use_id == "call-blocking"
    )));
    assert_eq!(failed, events.len() - 1);
}

#[tokio::test]
async fn cancellation_is_the_terminal_observer_event() {
    let mock = MockRuntime::builder()
        .model("mock-model", "openai")
        .with_policy(RuntimePolicy::permissive())
        .text("not reached")
        .build()
        .expect("mock runtime builds");
    let dir = workspace();
    let mut run = prepared(&mock, &dir);
    let (observed, tap) = observed_events();
    let _guard = run.register_agent_event_tap(tap);
    let (options, cancellation) = TurnOptions::cancellable();
    cancellation.cancel();

    let report = run
        .execute_with_approver_and_options(CollectingSink::new(), AllowAll, options)
        .await
        .expect("Basis reports the cancelled turn");
    assert!(matches!(report.failure, Some(RunFailure::Cancelled)));

    let events = observed.lock().unwrap_or_else(|error| error.into_inner());
    assert!(matches!(events.first(), Some(AgentEvent::RunStarted)));
    assert!(matches!(
        events.last(),
        Some(AgentEvent::RunFailed { error }) if error == "operation cancelled"
    ));
}

#[tokio::test]
async fn dropping_the_basis_guard_unregisters_the_observer() {
    let mock = MockRuntime::builder()
        .model("mock-model", "openai")
        .with_policy(RuntimePolicy::permissive())
        .text("first")
        .text("second")
        .build()
        .expect("mock runtime builds");
    let dir = workspace();
    let mut run = prepared(&mock, &dir);
    let observed = Arc::new(AtomicUsize::new(0));
    let observed_for_tap = Arc::clone(&observed);
    let guard: AgentEventTapGuard = run.register_agent_event_tap(move |_| {
        observed_for_tap.fetch_add(1, Ordering::SeqCst);
    });

    run.execute_with_approver(CollectingSink::new(), AllowAll)
        .await
        .expect("first turn completes");
    let after_first_turn = observed.load(Ordering::SeqCst);
    assert!(after_first_turn > 0);

    drop(guard);
    run.send_with_options(
        "second",
        CollectingSink::new(),
        AllowAll,
        TurnOptions::default(),
    )
    .await
    .expect("second turn completes");
    assert_eq!(observed.load(Ordering::SeqCst), after_first_turn);
}