unified-agent-api 0.3.5

Agent-agnostic facade and registry for wrapper backends
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
use std::{collections::BTreeMap, path::PathBuf, time::Duration};

use tempfile::tempdir;

use super::support::*;

const BUFFERED_COMPLETION_TIMEOUT: Duration = Duration::from_secs(5);
const BACKPRESSURE_ASSERT_TIMEOUT: Duration = Duration::from_millis(200);
const POST_DROP_PENDING_TIMEOUT: Duration = Duration::from_millis(50);

fn fake_codex_binary() -> PathBuf {
    if let Some(path) = std::env::var_os("CARGO_BIN_EXE_fake_codex_stream_exec_scenarios_agent_api")
    {
        return PathBuf::from(path);
    }

    let current_exe = std::env::current_exe().expect("resolve current test binary path");
    let target_dir = current_exe
        .parent()
        .and_then(|dir| dir.parent())
        .expect("resolve target dir from current test binary");
    let mut binary = target_dir.join("fake_codex_stream_exec_scenarios_agent_api");
    if cfg!(windows) {
        binary.set_extension("exe");
    }
    binary
}

fn buffered_env() -> [(String, String); 2] {
    [
        (
            "FAKE_CODEX_BUFFERED_EVENT_COUNT".to_string(),
            "1024".to_string(),
        ),
        (
            "FAKE_CODEX_BUFFERED_EVENT_PADDING_BYTES".to_string(),
            "1024".to_string(),
        ),
    ]
}

fn slow_drain_buffered_env() -> [(String, String); 2] {
    [
        (
            "FAKE_CODEX_BUFFERED_EVENT_COUNT".to_string(),
            "4096".to_string(),
        ),
        (
            "FAKE_CODEX_BUFFERED_EVENT_PADDING_BYTES".to_string(),
            "2048".to_string(),
        ),
    ]
}

fn add_dir_env(dirs: &[PathBuf]) -> BTreeMap<String, String> {
    let mut env = BTreeMap::from([(
        "FAKE_CODEX_EXPECT_ADD_DIR_COUNT".to_string(),
        dirs.len().to_string(),
    )]);
    for (index, dir) in dirs.iter().enumerate() {
        env.insert(
            format!("FAKE_CODEX_EXPECT_ADD_DIR_{index}"),
            dir.display().to_string(),
        );
    }
    env
}

fn add_dirs_fixture() -> (tempfile::TempDir, Vec<PathBuf>) {
    let temp = tempdir().expect("tempdir");
    let dir_a = temp.path().join("alpha");
    let dir_b = temp.path().join("beta");
    std::fs::create_dir_all(&dir_a).expect("alpha dir");
    std::fs::create_dir_all(&dir_b).expect("beta dir");
    (temp, vec![dir_a, dir_b])
}

async fn assert_buffered_add_dirs_runtime_rejection(
    scenario: &str,
    selector: SessionSelectorV1,
    expected_message: &'static str,
    extra_env: impl IntoIterator<Item = (String, String)>,
) {
    let run_start = tempdir().expect("tempdir");
    let (_temp, add_dirs) = add_dirs_fixture();
    let env = add_dir_env(&add_dirs)
        .into_iter()
        .chain([
            ("FAKE_CODEX_SCENARIO".to_string(), scenario.to_string()),
            (
                "FAKE_CODEX_EXPECT_PROMPT".to_string(),
                "hello world".to_string(),
            ),
        ])
        .chain(buffered_env())
        .chain(extra_env)
        .collect::<BTreeMap<_, _>>();

    let adapter = test_adapter_with_config_and_run_start_cwd(
        CodexBackendConfig {
            binary: Some(fake_codex_binary()),
            ..Default::default()
        },
        Some(run_start.path().to_path_buf()),
    );

    let spawned = adapter
        .spawn(crate::backend_harness::NormalizedRequest {
            agent_kind: adapter.kind(),
            prompt: "hello world".to_string(),
            model_id: None,
            working_dir: Some(PathBuf::from(".")),
            effective_timeout: None,
            env,
            policy: CodexExecPolicy {
                add_dirs,
                non_interactive: true,
                external_sandbox: false,
                approval_policy: None,
                sandbox_mode: CodexSandboxMode::WorkspaceWrite,
                resume: Some(selector),
                fork: None,
            },
        })
        .await
        .expect("spawn succeeds");

    let mut completion = spawned.completion;
    assert!(
        tokio::time::timeout(BACKPRESSURE_ASSERT_TIMEOUT, &mut completion)
            .await
            .is_err(),
        "completion should remain pending while buffered events are not drained"
    );

    let backend_events: Vec<_> = spawned
        .events
        .map(|result| result.expect("backend event stream is infallible for fake codex"))
        .collect()
        .await;

    let completion = tokio::time::timeout(BUFFERED_COMPLETION_TIMEOUT, completion)
        .await
        .expect("completion resolves")
        .expect("completion is Ok for fake codex");
    let err = adapter
        .map_completion(completion)
        .expect_err("add-dir runtime rejection must map to Backend error");
    match err {
        AgentWrapperError::Backend { message } => assert_eq!(message, expected_message),
        other => panic!("expected Backend error, got: {other:?}"),
    }

    let mapped_events: Vec<_> = backend_events
        .into_iter()
        .flat_map(|event| adapter.map_event(event))
        .collect();

    let handle_idx = mapped_events
        .iter()
        .position(|event| {
            event.kind == AgentWrapperEventKind::Status
                && handle_schema(event) == Some(CAP_SESSION_HANDLE_V1)
        })
        .expect("expected session handle facet");
    let error_idx = mapped_events
        .iter()
        .position(|event| event.kind == AgentWrapperEventKind::Error)
        .expect("expected terminal error event");
    assert!(handle_idx < error_idx);
    assert_eq!(
        mapped_events[error_idx].message.as_deref(),
        Some(expected_message)
    );
    assert_eq!(
        mapped_events.last().map(|event| event.kind.clone()),
        Some(AgentWrapperEventKind::Error)
    );
}

async fn assert_buffered_selection_failure(
    scenario: &str,
    selector: SessionSelectorV1,
    expected_message: &'static str,
    extra_env: impl IntoIterator<Item = (String, String)>,
) {
    let run_start = tempdir().expect("tempdir");
    let env = [
        ("FAKE_CODEX_SCENARIO".to_string(), scenario.to_string()),
        (
            "FAKE_CODEX_EXPECT_PROMPT".to_string(),
            "hello world".to_string(),
        ),
    ]
    .into_iter()
    .chain(buffered_env())
    .chain(extra_env)
    .collect::<BTreeMap<_, _>>();

    let adapter = test_adapter_with_config_and_run_start_cwd(
        CodexBackendConfig {
            binary: Some(fake_codex_binary()),
            ..Default::default()
        },
        Some(run_start.path().to_path_buf()),
    );

    let spawned = adapter
        .spawn(crate::backend_harness::NormalizedRequest {
            agent_kind: adapter.kind(),
            prompt: "hello world".to_string(),
            model_id: None,
            working_dir: Some(PathBuf::from(".")),
            effective_timeout: None,
            env,
            policy: CodexExecPolicy {
                add_dirs: Vec::new(),
                non_interactive: true,
                external_sandbox: false,
                approval_policy: None,
                sandbox_mode: CodexSandboxMode::WorkspaceWrite,
                resume: Some(selector),
                fork: None,
            },
        })
        .await
        .expect("spawn succeeds");

    let backend_events: Vec<_> = spawned
        .events
        .map(|result| result.expect("backend event stream is infallible for fake codex"))
        .collect()
        .await;

    let completion = tokio::time::timeout(BUFFERED_COMPLETION_TIMEOUT, spawned.completion)
        .await
        .expect("completion resolves")
        .expect("completion is Ok for fake codex");
    let err = adapter
        .map_completion(completion)
        .expect_err("selection failure must map to Backend error");
    match err {
        AgentWrapperError::Backend { message } => assert_eq!(message, expected_message),
        other => panic!("expected Backend error, got: {other:?}"),
    }

    let mapped_events: Vec<_> = backend_events
        .into_iter()
        .flat_map(|event| adapter.map_event(event))
        .collect();

    let error_messages: Vec<_> = mapped_events
        .iter()
        .filter(|event| event.kind == AgentWrapperEventKind::Error)
        .filter_map(|event| event.message.as_deref())
        .collect();
    assert_eq!(error_messages, vec![expected_message]);
    assert_eq!(
        mapped_events.last().map(|event| event.kind.clone()),
        Some(AgentWrapperEventKind::Error)
    );
}

async fn assert_dropping_events_waits_for_add_dirs_classification(
    scenario: &str,
    selector: SessionSelectorV1,
    expected_message: &'static str,
    extra_env: impl IntoIterator<Item = (String, String)>,
) {
    let run_start = tempdir().expect("tempdir");
    let (_temp, add_dirs) = add_dirs_fixture();
    let env = add_dir_env(&add_dirs)
        .into_iter()
        .chain([
            ("FAKE_CODEX_SCENARIO".to_string(), scenario.to_string()),
            (
                "FAKE_CODEX_EXPECT_PROMPT".to_string(),
                "hello world".to_string(),
            ),
        ])
        .chain(slow_drain_buffered_env())
        .chain(extra_env)
        .collect::<BTreeMap<_, _>>();

    let adapter = test_adapter_with_config_and_run_start_cwd(
        CodexBackendConfig {
            binary: Some(fake_codex_binary()),
            ..Default::default()
        },
        Some(run_start.path().to_path_buf()),
    );

    let spawned = adapter
        .spawn(crate::backend_harness::NormalizedRequest {
            agent_kind: adapter.kind(),
            prompt: "hello world".to_string(),
            model_id: None,
            working_dir: Some(PathBuf::from(".")),
            effective_timeout: None,
            env,
            policy: CodexExecPolicy {
                add_dirs,
                non_interactive: true,
                external_sandbox: false,
                approval_policy: None,
                sandbox_mode: CodexSandboxMode::WorkspaceWrite,
                resume: Some(selector),
                fork: None,
            },
        })
        .await
        .expect("spawn succeeds");

    let mut events = spawned.events;
    let mut completion = spawned.completion;

    let first = tokio::time::timeout(
        BUFFERED_COMPLETION_TIMEOUT,
        std::future::poll_fn(|cx| events.as_mut().poll_next(cx)),
    )
    .await
    .expect("first event arrives")
    .expect("expected a live event before drop")
    .expect("backend event stream is infallible for fake codex");
    let _ = first;

    assert!(
        tokio::time::timeout(BACKPRESSURE_ASSERT_TIMEOUT, &mut completion)
            .await
            .is_err(),
        "completion should remain pending while buffered events are still attached"
    );

    drop(events);

    assert!(
        tokio::time::timeout(POST_DROP_PENDING_TIMEOUT, &mut completion)
            .await
            .is_err(),
        "completion should remain pending until the event task drains buffered suppressed errors"
    );

    let completion = tokio::time::timeout(BUFFERED_COMPLETION_TIMEOUT, completion)
        .await
        .expect("completion resolves")
        .expect("completion is Ok for fake codex");
    let err = adapter
        .map_completion(completion)
        .expect_err("selection failure must map to Backend error");
    match err {
        AgentWrapperError::Backend { message } => assert_eq!(message, expected_message),
        other => panic!("expected Backend error, got: {other:?}"),
    }
}

#[tokio::test]
async fn buffered_resume_last_add_dirs_runtime_rejection_stays_pinned_before_events_are_drained() {
    assert_buffered_add_dirs_runtime_rejection(
        "add_dirs_runtime_rejection_resume_last_buffered_tail",
        SessionSelectorV1::Last,
        PINNED_ADD_DIRS_RUNTIME_REJECTION,
        std::iter::empty(),
    )
    .await;
}

#[tokio::test]
async fn buffered_resume_id_add_dirs_runtime_rejection_stays_pinned_before_events_are_drained() {
    let resume_id = "thread-123";
    assert_buffered_add_dirs_runtime_rejection(
        "add_dirs_runtime_rejection_resume_id_buffered_tail",
        SessionSelectorV1::Id {
            id: resume_id.to_string(),
        },
        PINNED_ADD_DIRS_RUNTIME_REJECTION,
        [(
            "FAKE_CODEX_EXPECT_RESUME_ID".to_string(),
            resume_id.to_string(),
        )],
    )
    .await;
}

#[tokio::test]
async fn buffered_resume_last_selection_failure_stays_pinned_before_events_are_drained() {
    assert_buffered_selection_failure(
        "resume_last_not_found_buffered_transport_errors",
        SessionSelectorV1::Last,
        super::super::pinned_selection_failure_message(&SessionSelectorV1::Last),
        std::iter::empty(),
    )
    .await;
}

#[tokio::test]
async fn buffered_resume_id_selection_failure_stays_pinned_before_events_are_drained() {
    let resume_id = "thread-123";
    assert_buffered_selection_failure(
        "resume_id_not_found_buffered_transport_errors",
        SessionSelectorV1::Id {
            id: resume_id.to_string(),
        },
        super::super::pinned_selection_failure_message(&SessionSelectorV1::Id {
            id: resume_id.to_string(),
        }),
        [(
            "FAKE_CODEX_EXPECT_RESUME_ID".to_string(),
            resume_id.to_string(),
        )],
    )
    .await;
}

#[tokio::test]
async fn dropping_events_does_not_bypass_buffered_resume_add_dirs_classification() {
    assert_dropping_events_waits_for_add_dirs_classification(
        "add_dirs_runtime_rejection_resume_last_buffered_tail",
        SessionSelectorV1::Last,
        PINNED_ADD_DIRS_RUNTIME_REJECTION,
        std::iter::empty(),
    )
    .await;
}