basis 0.8.2

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
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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
//! A customized provider-core instance through basis's supported runtime seam.
//!
//! This test deliberately uses only `basis` exports. Besides proving that a
//! customized Responses definition reaches a prepared run, it keeps the
//! caller's clone and proves that clone shares the registered provider's
//! session state. That is the property a host needs to prewarm the connection
//! the real run will use instead of an unrelated session.

use std::{
    borrow::Cow,
    collections::BTreeMap,
    io::{self, ErrorKind, Read, Write},
    net::{TcpListener, TcpStream},
    path::{Path, PathBuf},
    sync::{
        Arc, Mutex,
        atomic::{AtomicBool, Ordering},
    },
    thread,
    time::Duration,
};

use basis::{
    CollectingSink, ContextConfig, MemoryConfig, ModelInfo, ModelSelector, RunOutcome, Runtime,
    ToolRoster, Workspace, WorkspaceBuilder, hooks::HooksConfig, provider_core,
    skills::SkillsConfig, templates::TemplatesConfig, tools::declared::ToolsConfig,
};
#[cfg(feature = "responses-websocket")]
use futures::{SinkExt, StreamExt};
#[cfg(feature = "responses-websocket")]
use tokio_tungstenite::{accept_async, tungstenite::Message as WebSocketMessage};

fn pinned(workspace: &Path, runtime: Arc<Runtime>) -> WorkspaceBuilder {
    Workspace::builder(workspace)
        .with_runtime(runtime)
        .with_model(ModelSelector::Id("test-model".to_string()))
        .with_context(ContextConfig {
            file_name: "AGENTS.md".to_string(),
            global_dir: None,
            walk_parents: false,
        })
        .with_skills(SkillsConfig {
            workspace_subdir: Some(PathBuf::from(".basis/skills")),
            shared_workspace_dir: true,
            global_dir: None,
            shared_home_dir: false,
        })
        .with_templates(TemplatesConfig {
            workspace_subdir: PathBuf::from(".basis/templates"),
            global_dir: None,
        })
        .with_hooks(HooksConfig {
            workspace_file: PathBuf::from(".basis/hooks.json"),
            global_dir: None,
        })
        .with_tools(ToolsConfig {
            workspace_file: PathBuf::from(".basis/tools.json"),
            global_dir: None,
        })
        .with_memory(MemoryConfig::disabled())
}

#[tokio::test]
async fn a_retained_clone_shares_the_registered_responses_session() {
    let endpoint = ScriptedEndpoint::start();
    let provider_id = provider_core::ProviderId::new("custom-responses");
    let mut definition = provider_core::responses::openai_definition();
    definition.descriptor.id = provider_id;
    definition.base_url = Some(endpoint.base_url.clone());
    let provider = provider_core::responses::ResponsesProvider::new(
        definition,
        provider_core::StaticCredentialSource::new("test-key"),
    );

    let runtime = Arc::new(
        Runtime::builder()
            .with_registered_provider(provider.clone())
            .with_ephemeral_history()
            .build()
            .expect("a registered provider builds without basis resolving another one"),
    );
    assert_eq!(runtime.provider(), "custom-responses");

    let request = provider_core::Request {
        model: Cow::Borrowed("test-model"),
        system: None,
        messages: Cow::Owned(vec![provider_core::Message::user(
            provider_core::ContentBlock::text("prewarm the retained session"),
        )]),
        tools: Cow::Owned(Vec::new()),
        tool_choice: None,
        temperature: None,
        max_output_tokens: None,
        metadata: Cow::Owned(BTreeMap::new()),
        provider_request_options: Default::default(),
    };
    let mut stream = provider
        .session()
        .stream_response(request)
        .await
        .expect("the retained session reaches the scripted endpoint");
    while let Some(event) = stream.recv().await {
        event.expect("the retained session decodes its response");
    }
    assert_eq!(
        provider.session().latest_response_id().as_deref(),
        Some("resp_1")
    );

    let dir = tempfile::tempdir().expect("tempdir");
    std::fs::write(dir.path().join("AGENTS.md"), "house rules").expect("write context");
    let workspace = pinned(dir.path(), runtime).open().await.expect("opens");
    let report = workspace
        .prepare("use the registered provider")
        .expect("mints")
        .execute(CollectingSink::default())
        .await
        .expect("the prepared run completes");

    assert!(matches!(report.outcome, RunOutcome::Ok));
    assert_eq!(report.provider, "custom-responses");
    assert_eq!(report.final_message.as_deref(), Some("reply-2"));
    assert_eq!(
        provider.session().latest_response_id().as_deref(),
        Some("resp_2"),
        "the retained clone must observe state written by the actual run"
    );

    let post_payloads = endpoint
        .requests()
        .into_iter()
        .filter(|request| request.starts_with("POST "))
        .map(|request| {
            let body = request.split("\r\n\r\n").nth(1).unwrap_or_default();
            serde_json::from_str::<serde_json::Value>(body).expect("request body is JSON")
        })
        .collect::<Vec<_>>();
    assert_eq!(post_payloads.len(), 2);
    assert!(post_payloads[0].get("previous_response_id").is_none());
    assert_eq!(post_payloads[1]["previous_response_id"], "resp_1");
}

type TestResponsesProvider =
    provider_core::responses::ResponsesProvider<provider_core::StaticCredentialSource>;

async fn send_direct(provider: &TestResponsesProvider, message: &str) {
    let request = provider_core::Request {
        model: Cow::Borrowed("test-model"),
        system: None,
        messages: Cow::Owned(vec![provider_core::Message::user(
            provider_core::ContentBlock::text(message.to_string()),
        )]),
        tools: Cow::Owned(Vec::new()),
        tool_choice: None,
        temperature: None,
        max_output_tokens: None,
        metadata: Cow::Owned(BTreeMap::new()),
        provider_request_options: Default::default(),
    };
    let mut stream = provider
        .session()
        .stream_response(request)
        .await
        .expect("the retained seed reaches the scripted endpoint");
    while let Some(event) = stream.recv().await {
        event.expect("the retained seed decodes its response");
    }
}

async fn assert_rebuilt_responses_scopes_do_not_chain(first: &str, second: &str) {
    let endpoint = ScriptedEndpoint::start();
    let mut definition = provider_core::responses::openai_definition();
    definition.descriptor.id = provider_core::ProviderId::new("custom-responses");
    definition.base_url = Some(endpoint.base_url.clone());
    let seed = provider_core::responses::ResponsesProvider::new(
        definition,
        provider_core::StaticCredentialSource::new("test-key"),
    );

    // Deliberately dirty the never-registered seed. A recipe that used an
    // ordinary clone would now leak `resp_1` into generation A.
    send_direct(&seed, "seed state that must not enter a generation").await;
    assert_eq!(
        seed.session().latest_response_id().as_deref(),
        Some("resp_1")
    );

    let generated = Arc::new(Mutex::new(Vec::<TestResponsesProvider>::new()));
    let seed_for_factory = seed.clone();
    let generated_for_warm = Arc::clone(&generated);
    let recipe = Runtime::builder()
        .with_reusable_registered_provider(
            "custom-responses",
            move || Ok::<_, io::Error>(seed_for_factory.fresh_session_scope()),
            move |provider: TestResponsesProvider| {
                generated_for_warm
                    .lock()
                    .expect("generated scopes")
                    .push(provider);
                async { Ok::<_, io::Error>(()) }
            },
        )
        .with_ephemeral_history()
        .into_reusable_recipe()
        .expect("fresh Responses scopes form a runtime recipe");

    let dir = tempfile::tempdir().expect("tempdir");
    let workspace = Workspace::builder(dir.path())
        .with_runtime_recipe(recipe)
        .without_discovery()
        .fresh_only()
        .with_resolved_model(ModelInfo::new("test-model", "custom-responses"))
        .with_tool_roster(ToolRoster::only(std::iter::empty::<String>()))
        .open()
        .await
        .expect("generation A opens")
        .bind_host_tools(Vec::new())
        .expect("generation A binds as tool-free");
    let report = workspace
        .prepare(first)
        .expect("generation A mints")
        .execute(CollectingSink::default())
        .await
        .expect("generation A completes");
    assert!(matches!(report.outcome, RunOutcome::Ok));

    let workspace = workspace
        .rebuild_for_reuse()
        .await
        .expect("generation B rebuilds")
        .bind_host_tools(Vec::new())
        .expect("generation B binds as tool-free");
    let report = workspace
        .prepare(second)
        .expect("generation B mints")
        .execute(CollectingSink::default())
        .await
        .expect("generation B completes");
    assert!(matches!(report.outcome, RunOutcome::Ok));

    let generated = generated.lock().expect("generated scopes");
    assert_eq!(generated.len(), 2);
    assert_eq!(
        generated[0].session().latest_response_id().as_deref(),
        Some("resp_2")
    );
    assert_eq!(
        generated[1].session().latest_response_id().as_deref(),
        Some("resp_3")
    );
    assert_eq!(
        seed.session().latest_response_id().as_deref(),
        Some("resp_1"),
        "the never-registered seed remains isolated from every generation"
    );

    let payloads = endpoint
        .requests()
        .into_iter()
        .filter(|request| request.starts_with("POST "))
        .map(|request| {
            let body = request.split("\r\n\r\n").nth(1).unwrap_or_default();
            serde_json::from_str::<serde_json::Value>(body).expect("request body is JSON")
        })
        .collect::<Vec<_>>();
    assert_eq!(payloads.len(), 3);
    assert!(
        payloads
            .iter()
            .all(|payload| payload.get("previous_response_id").is_none()),
        "seed, generation A, and generation B must each begin a fresh chain"
    );
    assert!(payloads[1].to_string().contains(first));
    assert!(payloads[2].to_string().contains(second));
}

#[tokio::test]
async fn reusable_responses_isolates_a_then_b() {
    assert_rebuilt_responses_scopes_do_not_chain("contradiction A", "contradiction B").await;
}

#[tokio::test]
async fn reusable_responses_isolates_b_then_a() {
    assert_rebuilt_responses_scopes_do_not_chain("contradiction B", "contradiction A").await;
}

#[cfg(feature = "responses-websocket")]
#[tokio::test]
async fn reusable_websocket_prewarm_targets_each_installed_scope() {
    use basis::runtime::ResponsesTransport;

    let endpoint = WebSocketEndpoint::start().await;
    let mut definition = provider_core::responses::openai_definition();
    definition.descriptor.id = provider_core::ProviderId::new("custom-responses");
    definition.base_url = Some(endpoint.base_url.clone());
    let seed = provider_core::responses::ResponsesProvider::new(
        definition,
        provider_core::StaticCredentialSource::new("test-key"),
    );
    let sibling = seed.fresh_session_scope();
    let factory_seed = seed.clone();

    let recipe = Runtime::builder()
        .with_responses_transport(ResponsesTransport::WebSocket)
        .with_reusable_registered_provider(
            "custom-responses",
            move || Ok::<_, io::Error>(factory_seed.fresh_session_scope()),
            move |provider: TestResponsesProvider| async move {
                provider
                    .session()
                    .connect_websocket(Default::default(), Default::default(), None, None)
                    .await
            },
        )
        .with_ephemeral_history()
        .into_reusable_recipe()
        .expect("websocket provider forms a runtime recipe");

    let dir = tempfile::tempdir().expect("tempdir");
    let workspace = Workspace::builder(dir.path())
        .with_runtime_recipe(recipe)
        .without_discovery()
        .fresh_only()
        .with_resolved_model(ModelInfo::new("test-model", "custom-responses"))
        .with_tool_roster(ToolRoster::only(std::iter::empty::<String>()))
        .open()
        .await
        .expect("generation A opens and prewarms")
        .bind_host_tools(Vec::new())
        .expect("generation A binds as tool-free");
    assert_eq!(endpoint.accepted(), 1);
    assert!(seed.session().websocket_connection_is_closed().await);
    assert!(sibling.session().websocket_connection_is_closed().await);

    workspace
        .prepare("tenant-a")
        .expect("generation A mints")
        .execute(CollectingSink::default())
        .await
        .expect("generation A reuses its prewarmed websocket");
    assert_eq!(endpoint.accepted(), 1);

    let workspace = workspace
        .rebuild_for_reuse()
        .await
        .expect("generation B rebuilds and prewarms")
        .bind_host_tools(Vec::new())
        .expect("generation B binds as tool-free");
    assert_eq!(endpoint.accepted(), 2);
    assert!(seed.session().websocket_connection_is_closed().await);
    assert!(sibling.session().websocket_connection_is_closed().await);

    workspace
        .prepare("tenant-b")
        .expect("generation B mints")
        .execute(CollectingSink::default())
        .await
        .expect("generation B reuses its prewarmed websocket");
    assert_eq!(endpoint.accepted(), 2);

    let frames = endpoint.frames();
    assert_eq!(frames.len(), 2);
    assert!(frames[0].to_string().contains("tenant-a"));
    assert!(frames[1].to_string().contains("tenant-b"));
}

#[test]
fn a_customized_anthropic_definition_uses_the_registered_provider_seam() {
    let mut definition = provider_core::anthropic::definition();
    definition.descriptor.id = provider_core::ProviderId::new("custom-anthropic");
    definition.base_url = Some("http://127.0.0.1:1/".to_string());
    let provider =
        provider_core::anthropic::AnthropicProvider::with_definition_and_credential_source(
            definition,
            provider_core::StaticCredentialSource::new("test-key"),
        );

    let runtime = Runtime::builder()
        .with_registered_provider(provider)
        .with_ephemeral_history()
        .build()
        .expect("a customized Anthropic provider builds without network access");

    assert_eq!(runtime.provider(), "custom-anthropic");
}

struct ScriptedEndpoint {
    base_url: String,
    requests: Arc<Mutex<Vec<String>>>,
    stop: Arc<AtomicBool>,
    worker: Option<thread::JoinHandle<()>>,
}

impl ScriptedEndpoint {
    fn start() -> Self {
        let listener = TcpListener::bind("127.0.0.1:0").expect("bind test endpoint");
        listener
            .set_nonblocking(true)
            .expect("make test endpoint nonblocking");
        let address = listener.local_addr().expect("read endpoint address");
        let requests = Arc::new(Mutex::new(Vec::new()));
        let stop = Arc::new(AtomicBool::new(false));

        let recorded = Arc::clone(&requests);
        let stopped = Arc::clone(&stop);
        let worker = thread::spawn(move || {
            let mut turns = 0_usize;
            while !stopped.load(Ordering::SeqCst) {
                match listener.accept() {
                    Ok((mut stream, _)) => {
                        stream
                            .set_nonblocking(false)
                            .expect("accepted request stream should be blocking");
                        stream
                            .set_read_timeout(Some(Duration::from_secs(5)))
                            .expect("accepted request stream should have a read timeout");
                        let request = read_http_request(&mut stream);
                        recorded.lock().expect("requests").push(request.clone());
                        if request.starts_with("GET ") {
                            answer_models(&mut stream);
                        } else {
                            turns += 1;
                            answer_turn(&mut stream, turns);
                        }
                    }
                    Err(error) if error.kind() == ErrorKind::WouldBlock => {
                        thread::sleep(Duration::from_millis(1));
                    }
                    Err(error) => panic!("accept test request: {error}"),
                }
            }
        });

        Self {
            base_url: format!("http://{address}/"),
            requests,
            stop,
            worker: Some(worker),
        }
    }

    fn requests(&self) -> Vec<String> {
        self.requests.lock().expect("requests").clone()
    }
}

impl Drop for ScriptedEndpoint {
    fn drop(&mut self) {
        self.stop.store(true, Ordering::SeqCst);
        if let Some(worker) = self.worker.take() {
            worker.join().expect("test endpoint stops");
        }
    }
}

#[cfg(feature = "responses-websocket")]
struct WebSocketEndpoint {
    base_url: String,
    accepted: Arc<std::sync::atomic::AtomicUsize>,
    frames: Arc<Mutex<Vec<serde_json::Value>>>,
    acceptor: tokio::task::JoinHandle<()>,
}

#[cfg(feature = "responses-websocket")]
impl WebSocketEndpoint {
    async fn start() -> Self {
        let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
            .await
            .expect("bind websocket endpoint");
        let address = listener.local_addr().expect("read websocket address");
        let accepted = Arc::new(std::sync::atomic::AtomicUsize::new(0));
        let frames = Arc::new(Mutex::new(Vec::new()));
        let accepted_for_task = Arc::clone(&accepted);
        let frames_for_task = Arc::clone(&frames);
        let acceptor = tokio::spawn(async move {
            loop {
                let Ok((stream, _)) = listener.accept().await else {
                    return;
                };
                let index = accepted_for_task.fetch_add(1, Ordering::SeqCst) + 1;
                let frames = Arc::clone(&frames_for_task);
                tokio::spawn(serve_websocket(stream, index, frames));
            }
        });

        Self {
            base_url: format!("http://{address}/v1"),
            accepted,
            frames,
            acceptor,
        }
    }

    fn accepted(&self) -> usize {
        self.accepted.load(Ordering::SeqCst)
    }

    fn frames(&self) -> Vec<serde_json::Value> {
        self.frames.lock().expect("websocket frames").clone()
    }
}

#[cfg(feature = "responses-websocket")]
impl Drop for WebSocketEndpoint {
    fn drop(&mut self) {
        self.acceptor.abort();
    }
}

#[cfg(feature = "responses-websocket")]
async fn serve_websocket(
    stream: tokio::net::TcpStream,
    index: usize,
    frames: Arc<Mutex<Vec<serde_json::Value>>>,
) {
    let mut websocket = accept_async(stream).await.expect("upgrade websocket");
    while let Some(message) = websocket.next().await {
        let message = message.expect("read websocket frame");
        let WebSocketMessage::Text(text) = message else {
            continue;
        };
        let frame: serde_json::Value =
            serde_json::from_str(&text).expect("response.create frame is JSON");
        if frame["type"] != "response.create" {
            continue;
        }
        frames.lock().expect("websocket frames").push(frame);

        for event in [
            serde_json::json!({
                "type": "response.created",
                "response": {
                    "id": format!("resp_ws_{index}"),
                    "model": "test-model",
                    "status": "in_progress"
                }
            }),
            serde_json::json!({
                "type": "response.output_item.added",
                "output_index": 0,
                "item": { "type": "message", "content": [] }
            }),
            serde_json::json!({
                "type": "response.output_item.done",
                "output_index": 0,
                "item": {
                    "type": "message",
                    "content": [{
                        "type": "output_text",
                        "text": format!("reply-{index}")
                    }]
                }
            }),
            serde_json::json!({
                "type": "response.completed",
                "response": {
                    "id": format!("resp_ws_{index}"),
                    "model": "test-model",
                    "status": "completed"
                }
            }),
        ] {
            websocket
                .send(WebSocketMessage::Text(event.to_string().into()))
                .await
                .expect("send websocket response event");
        }
    }
}

fn read_http_request(stream: &mut TcpStream) -> String {
    let mut bytes = Vec::new();
    let mut buffer = [0_u8; 4096];
    let mut header_end = None;
    let mut content_length = 0_usize;

    loop {
        let read = stream.read(&mut buffer).expect("read request");
        if read == 0 {
            break;
        }
        bytes.extend_from_slice(&buffer[..read]);
        if header_end.is_none()
            && let Some(index) = bytes.windows(4).position(|window| window == b"\r\n\r\n")
        {
            let end = index + 4;
            header_end = Some(end);
            let headers = String::from_utf8_lossy(&bytes[..end]);
            content_length = headers
                .lines()
                .find_map(|line| {
                    let (name, value) = line.split_once(':')?;
                    name.eq_ignore_ascii_case("content-length")
                        .then(|| value.trim().parse::<usize>().expect("content length"))
                })
                .unwrap_or_default();
        }
        if header_end.is_some_and(|end| bytes.len() >= end + content_length) {
            break;
        }
    }

    String::from_utf8(bytes).expect("request should be utf8")
}

fn answer_models(stream: &mut TcpStream) {
    let body = r#"{"object":"list","data":[{"id":"test-model","object":"model"}]}"#;
    answer(stream, "application/json", body);
}

fn answer_turn(stream: &mut TcpStream, index: usize) {
    let body = [
        format!(
            r#"{{"type":"response.created","response":{{"id":"resp_{index}","model":"test-model","status":"in_progress"}}}}"#
        ),
        r#"{"type":"response.output_item.added","output_index":0,"item":{"type":"message","content":[]}}"#.to_string(),
        format!(
            r#"{{"type":"response.output_item.done","output_index":0,"item":{{"type":"message","content":[{{"type":"output_text","text":"reply-{index}"}}]}}}}"#
        ),
        format!(
            r#"{{"type":"response.completed","response":{{"id":"resp_{index}","model":"test-model","status":"completed"}}}}"#
        ),
    ]
    .iter()
    .map(|event| format!("data: {event}\n\n"))
    .collect::<String>();
    answer(stream, "text/event-stream", &body);
}

fn answer(stream: &mut TcpStream, content_type: &str, body: &str) {
    let response = format!(
        "HTTP/1.1 200 OK\r\nconnection: close\r\ncontent-type: {content_type}\r\ncontent-length: {}\r\n\r\n{body}",
        body.len()
    );
    stream
        .write_all(response.as_bytes())
        .expect("write response");
}