swink-agent 0.8.0

Core scaffolding for running LLM-powered agentic loops
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
#![cfg(feature = "testkit")]
//! End-to-end integration tests verifying that context compaction actually
//! happens after overflow, not just that the overflow flag is passed.

mod common;

use std::pin::Pin;
use std::sync::{Arc, Mutex};
use std::time::Duration;

use common::{
    MockContextCapturingStreamFn, MockTool, default_exhausted_fallback, default_model,
    next_response, text_only_events, tool_call_events, user_msg,
};
use futures::Stream;
use futures::stream::StreamExt;
use tokio_util::sync::CancellationToken;

use swink_agent::{
    AgentContext, AgentEvent, AgentLoopConfig, AgentMessage, AssistantMessageEvent, ContentBlock,
    ContextTransformer, DefaultRetryStrategy, LlmMessage, ModelSpec, SlidingWindowTransformer,
    StopReason, StreamFn, StreamOptions, UserMessage, agent_loop,
};

// ─── MockMessageCapturingStreamFn ────────────────────────────────────────────

/// A `StreamFn` that captures the full LLM messages on each call.
struct MockMessageCapturingStreamFn {
    responses: Mutex<Vec<Vec<AssistantMessageEvent>>>,
    captured_messages: Arc<Mutex<Vec<Vec<LlmMessage>>>>,
}

impl StreamFn for MockMessageCapturingStreamFn {
    fn stream<'a>(
        &'a self,
        _model: &'a ModelSpec,
        context: &'a AgentContext,
        _options: &'a StreamOptions,
        _cancellation_token: CancellationToken,
    ) -> Pin<Box<dyn Stream<Item = AssistantMessageEvent> + Send + 'a>> {
        let llm_msgs: Vec<LlmMessage> = context
            .messages
            .iter()
            .filter_map(|m| match m {
                AgentMessage::Llm(llm) => Some(llm.clone()),
                AgentMessage::Custom(_) => None,
            })
            .collect();
        self.captured_messages.lock().unwrap().push(llm_msgs);

        let events = next_response(&self.responses, default_exhausted_fallback());
        Box::pin(futures::stream::iter(events))
    }
}

// ─── Helpers ─────────────────────────────────────────────────────────────

fn overflow_error_events() -> Vec<AssistantMessageEvent> {
    vec![AssistantMessageEvent::Error {
        stop_reason: StopReason::Error,
        error_message: "context_length_exceeded: too many tokens".to_string(),
        error_kind: None,
        usage: None,
    }]
}

type ConvertToLlmBoxed = Box<dyn Fn(&AgentMessage) -> Option<LlmMessage> + Send + Sync>;

fn default_convert_to_llm() -> ConvertToLlmBoxed {
    Box::new(|msg: &AgentMessage| match msg {
        AgentMessage::Llm(llm) => Some(llm.clone()),
        AgentMessage::Custom(_) => None,
    })
}

fn default_config(stream_fn: Arc<dyn StreamFn>) -> AgentLoopConfig {
    AgentLoopConfig {
        agent_name: None,
        transfer_chain: None,
        model: default_model(),
        stream_options: StreamOptions::default(),
        retry_strategy: Box::new(
            DefaultRetryStrategy::default()
                .with_jitter(false)
                .with_base_delay(Duration::from_millis(1)),
        ),
        stream_fn,
        tools: vec![],
        convert_to_llm: default_convert_to_llm(),
        transform_context: None,
        get_api_key: None,
        message_provider: None,
        pending_message_snapshot: Arc::default(),
        loop_context_snapshot: Arc::default(),
        approve_tool: None,
        approval_mode: swink_agent::ApprovalMode::default(),
        pre_turn_policies: vec![],
        pre_dispatch_policies: vec![],
        post_turn_policies: vec![],
        post_loop_policies: vec![],
        async_transform_context: None,
        metrics_collector: None,
        fallback: None,
        tool_execution_policy: swink_agent::ToolExecutionPolicy::default(),
        session_state: std::sync::Arc::new(
            std::sync::RwLock::new(swink_agent::SessionState::new()),
        ),
        credential_resolver: None,
        cache_config: None,
        cache_state: std::sync::Mutex::new(swink_agent::CacheState::default()),
        dynamic_system_prompt: None,
    }
}

/// Create a large user message (~`token_count` estimated tokens).
/// Token estimation is chars / 4, so we create 4 * `token_count` chars.
fn large_user_msg(label: &str, token_count: usize) -> AgentMessage {
    let padding = "x".repeat(token_count * 4);
    let text = format!("{label}:{padding}");
    AgentMessage::Llm(LlmMessage::User(UserMessage {
        content: vec![ContentBlock::Text { text }],
        timestamp: 0,
        cache_hint: None,
    }))
}

/// Collect all events from a loop stream.
async fn collect_events(stream: Pin<Box<dyn Stream<Item = AgentEvent> + Send>>) -> Vec<AgentEvent> {
    stream.collect().await
}

/// Check if events contain a specific variant by name.
fn has_event(events: &[AgentEvent], name: &str) -> bool {
    events.iter().any(|e| common::event_variant_name(e) == name)
}

// ═══════════════════════════════════════════════════════════════════════════
// Test a: overflow_triggers_compaction
// ═══════════════════════════════════════════════════════════════════════════

#[tokio::test]
async fn overflow_triggers_compaction() {
    // Set up a MockContextCapturingStreamFn:
    //   Call 1: returns overflow error (context_length_exceeded)
    //   Call 2: succeeds with text
    let capturing_fn = Arc::new(MockContextCapturingStreamFn::new(vec![
        overflow_error_events(),
        text_only_events("recovered"),
    ]));
    let stream_fn: Arc<dyn StreamFn> = Arc::clone(&capturing_fn) as Arc<dyn StreamFn>;

    // Track overflow flags passed to transform_context
    let overflow_flags: Arc<Mutex<Vec<bool>>> = Arc::new(Mutex::new(Vec::new()));
    let flags_clone = Arc::clone(&overflow_flags);

    let mut config = default_config(stream_fn);
    // Use sliding_window with a budget that forces compaction on overflow.
    // Normal budget: 10000 (generous), overflow budget: 200 (tight).
    let compact = SlidingWindowTransformer::new(10_000, 200, 1);
    config.transform_context = Some(Arc::new(
        move |msgs: &mut Vec<AgentMessage>, overflow: bool| {
            flags_clone.lock().unwrap().push(overflow);
            compact.transform(msgs, overflow);
        },
    ));

    // Provide many large messages so that overflow compaction has work to do.
    // Each message is ~100 tokens (400 chars / 4).
    let mut initial_messages = Vec::new();
    for i in 0..10 {
        initial_messages.push(large_user_msg(&format!("msg{i}"), 100));
    }

    let events = collect_events(agent_loop(
        initial_messages,
        "system".to_string(),
        config,
        CancellationToken::new(),
    ))
    .await;

    assert!(has_event(&events, "AgentEnd"), "loop should complete");

    // Verify overflow flag was set on the second call
    let flags: Vec<bool> = overflow_flags.lock().unwrap().clone();
    assert!(flags.len() >= 2, "transform_context called at least twice");
    assert!(!flags[0], "first call should not have overflow");
    assert!(flags[1], "second call should have overflow=true");

    // Verify context was actually smaller on the second stream call
    let counts: Vec<usize> = capturing_fn.captured_message_counts.lock().unwrap().clone();
    assert!(
        counts.len() >= 2,
        "stream should be called at least twice, got {}",
        counts.len()
    );
    assert!(
        counts[1] < counts[0],
        "context should be smaller after compaction: first={}, second={}",
        counts[0],
        counts[1]
    );
}

// ═══════════════════════════════════════════════════════════════════════════
// Test b: compacted_context_preserves_anchors
// ═══════════════════════════════════════════════════════════════════════════

#[tokio::test]
async fn compacted_context_preserves_anchors() {
    let captured_messages: Arc<Mutex<Vec<Vec<LlmMessage>>>> = Arc::new(Mutex::new(Vec::new()));

    let stream_fn = Arc::new(MockMessageCapturingStreamFn {
        responses: Mutex::new(vec![overflow_error_events(), text_only_events("ok")]),
        captured_messages: Arc::clone(&captured_messages),
    });

    let anchor_count = 2;
    let compact = SlidingWindowTransformer::new(10_000, 300, anchor_count);

    let mut config = default_config(stream_fn as Arc<dyn StreamFn>);
    config.transform_context = Some(Arc::new(
        move |msgs: &mut Vec<AgentMessage>, overflow: bool| {
            compact.transform(msgs, overflow);
        },
    ));

    // Create messages: first two are anchors, rest are filler.
    let mut initial_messages = vec![user_msg("ANCHOR_ONE"), user_msg("ANCHOR_TWO")];
    for i in 0..8 {
        initial_messages.push(large_user_msg(&format!("filler{i}"), 100));
    }

    let events = collect_events(agent_loop(
        initial_messages,
        "system".to_string(),
        config,
        CancellationToken::new(),
    ))
    .await;

    assert!(has_event(&events, "AgentEnd"));

    let all_captured: Vec<Vec<LlmMessage>> = captured_messages.lock().unwrap().clone();
    assert!(
        all_captured.len() >= 2,
        "should have at least 2 stream calls"
    );

    // After overflow compaction (second call), the first two messages should
    // still be the anchors.
    let post_overflow = &all_captured[1];
    assert!(
        post_overflow.len() >= anchor_count,
        "post-overflow context should have at least {anchor_count} messages, got {}",
        post_overflow.len()
    );

    // Verify anchor messages survived
    let first_text = match &post_overflow[0] {
        LlmMessage::User(u) => ContentBlock::extract_text(&u.content),
        LlmMessage::Assistant(_) | LlmMessage::ToolResult(_) => String::new(),
    };
    let second_text = match &post_overflow[1] {
        LlmMessage::User(u) => ContentBlock::extract_text(&u.content),
        LlmMessage::Assistant(_) | LlmMessage::ToolResult(_) => String::new(),
    };
    assert!(
        first_text.contains("ANCHOR_ONE"),
        "first anchor should survive compaction, got: {first_text}"
    );
    assert!(
        second_text.contains("ANCHOR_TWO"),
        "second anchor should survive compaction, got: {second_text}"
    );

    // Context should be smaller than original
    assert!(
        post_overflow.len() < 10,
        "context should be compacted, got {} messages",
        post_overflow.len()
    );
}

// ═══════════════════════════════════════════════════════════════════════════
// Test c: compacted_context_preserves_tool_pairs
// ═══════════════════════════════════════════════════════════════════════════

#[tokio::test]
async fn compacted_context_preserves_tool_pairs() {
    let captured_messages: Arc<Mutex<Vec<Vec<LlmMessage>>>> = Arc::new(Mutex::new(Vec::new()));

    // First call: returns a tool call. Second call: overflow. Third call: success.
    let stream_fn = Arc::new(MockMessageCapturingStreamFn {
        responses: Mutex::new(vec![
            tool_call_events("tc_1", "mock_tool", "{}"),
            overflow_error_events(),
            text_only_events("done"),
        ]),
        captured_messages: Arc::clone(&captured_messages),
    });

    let tool = Arc::new(MockTool::new("mock_tool"));
    // Budget: overflow_budget tight enough to trigger compaction but large enough
    // to keep the tool pair (tool call + result are relatively small).
    let compact = SlidingWindowTransformer::new(10_000, 500, 1);

    let mut config = default_config(stream_fn as Arc<dyn StreamFn>);
    config.tools = vec![tool];
    config.transform_context = Some(Arc::new(
        move |msgs: &mut Vec<AgentMessage>, overflow: bool| {
            compact.transform(msgs, overflow);
        },
    ));

    // Start with filler + the prompt. The loop will add an assistant (tool call)
    // and a tool result, then on the second turn, trigger overflow.
    let mut initial_messages = Vec::new();
    for i in 0..6 {
        initial_messages.push(large_user_msg(&format!("filler{i}"), 100));
    }

    let events = collect_events(agent_loop(
        initial_messages,
        "system".to_string(),
        config,
        CancellationToken::new(),
    ))
    .await;

    assert!(has_event(&events, "AgentEnd"));

    let post_overflow = {
        let captured = captured_messages.lock().unwrap();
        // After the overflow (third stream call), check that tool pairs survive.
        assert!(
            captured.len() >= 3,
            "should have at least 3 stream calls, got {}",
            captured.len()
        );
        captured[2].clone()
    };

    // Check that if a ToolResult is present, its corresponding Assistant with
    // ToolCall is also present.
    let has_tool_result = post_overflow
        .iter()
        .any(|m| matches!(m, LlmMessage::ToolResult(_)));
    let has_tool_call = post_overflow.iter().any(|m| {
        matches!(m, LlmMessage::Assistant(a)
            if a.content.iter().any(|b| matches!(b, ContentBlock::ToolCall { .. })))
    });

    if has_tool_result {
        assert!(
            has_tool_call,
            "tool result survived compaction but its tool call did not"
        );
    }
}

// ═══════════════════════════════════════════════════════════════════════════
// Test d: multiple_overflows_progressively_shrink
// ═══════════════════════════════════════════════════════════════════════════

/// With in-place overflow recovery, a double overflow in the same turn is fatal.
/// The first overflow triggers recovery (compact + retry), but when the retry
/// also overflows, the loop surfaces a `ContextWindowOverflow` error.
#[tokio::test]
async fn double_overflow_surfaces_error() {
    let capturing_fn = Arc::new(MockContextCapturingStreamFn::new(vec![
        overflow_error_events(),
        overflow_error_events(),
        text_only_events("should not reach this"),
    ]));
    let stream_fn: Arc<dyn StreamFn> = Arc::clone(&capturing_fn) as Arc<dyn StreamFn>;

    let overflow_count: Arc<Mutex<usize>> = Arc::new(Mutex::new(0));
    let overflow_clone = Arc::clone(&overflow_count);

    let mut config = default_config(stream_fn);
    config.transform_context = Some(Arc::new(
        move |msgs: &mut Vec<AgentMessage>, overflow: bool| {
            if overflow {
                {
                    let mut count = overflow_clone.lock().unwrap();
                    *count += 1;
                }
                // Remove some messages to report compaction.
                let keep = msgs.len().saturating_sub(2).max(1);
                if keep < msgs.len() {
                    let tail: Vec<AgentMessage> = msgs.drain(keep..).collect();
                    msgs.clear();
                    msgs.extend(tail);
                }
            }
        },
    ));

    let mut initial_messages = Vec::new();
    for i in 0..10 {
        initial_messages.push(large_user_msg(&format!("msg{i}"), 50));
    }

    let events = collect_events(agent_loop(
        initial_messages,
        "system".to_string(),
        config,
        CancellationToken::new(),
    ))
    .await;

    // Loop should still terminate with AgentEnd.
    assert!(has_event(&events, "AgentEnd"));

    // The retry (2nd call) also overflowed, so the error is surfaced.
    // There should be exactly 2 stream calls, not 3.
    let counts: Vec<usize> = capturing_fn.captured_message_counts.lock().unwrap().clone();
    assert_eq!(
        counts.len(),
        2,
        "should have exactly 2 stream calls (initial + retry), got {}",
        counts.len()
    );

    // The second call should have fewer messages (compaction worked).
    assert!(
        counts[1] < counts[0],
        "second call should have fewer messages than first: {} vs {}",
        counts[1],
        counts[0]
    );
}

// ═══════════════════════════════════════════════════════════════════════════
// Test e: overflow_with_single_large_message
// ═══════════════════════════════════════════════════════════════════════════

/// When a single message exceeds the budget and the transformer cannot compact
/// (returns None), the loop surfaces a `ContextWindowOverflow` error immediately
/// without retrying the LLM call (FR-013d: no-compaction-skip).
#[tokio::test]
async fn overflow_with_no_compaction_surfaces_error() {
    let capturing_fn = Arc::new(MockContextCapturingStreamFn::new(vec![
        overflow_error_events(),
        text_only_events("should not reach this"),
    ]));
    let stream_fn: Arc<dyn StreamFn> = Arc::clone(&capturing_fn) as Arc<dyn StreamFn>;

    // Very tight overflow budget that a single large message exceeds.
    // sliding_window with anchor=1 and budget=10 on a single message cannot
    // remove anything (the anchor IS the only message), so it returns None.
    let compact = SlidingWindowTransformer::new(10_000, 10, 1);

    let mut config = default_config(stream_fn);
    config.transform_context = Some(Arc::new(
        move |msgs: &mut Vec<AgentMessage>, overflow: bool| {
            compact.transform(msgs, overflow);
        },
    ));

    // One large message (~500 tokens, well above the 10-token overflow budget).
    let initial_messages = vec![large_user_msg("huge", 500)];

    let events = collect_events(agent_loop(
        initial_messages,
        "system".to_string(),
        config,
        CancellationToken::new(),
    ))
    .await;

    // The loop should terminate with AgentEnd (no infinite retry).
    assert!(
        has_event(&events, "AgentEnd"),
        "loop should complete even when compaction cannot help"
    );

    // Only 1 stream call — no retry when compaction produces no effect.
    let counts = capturing_fn.captured_message_counts.lock().unwrap().clone();
    assert_eq!(
        counts.len(),
        1,
        "should have exactly 1 stream call (no retry when no compaction), got {}",
        counts.len()
    );
}