starweaver-runtime 0.4.0

Agent-loop graph and runtime executor primitives for Starweaver
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
#![allow(missing_docs, clippy::unwrap_used)]

use std::sync::Arc;

use async_trait::async_trait;
use starweaver_context::AgentContext;
use starweaver_core::{AgentId, TraceContext};
use starweaver_model::{
    FinishReason, ModelResponse, ModelResponsePart, ToolCallPart, tool_call_response,
};
use starweaver_runtime::{
    AdapterTraceRecorder, Agent, AgentCapability, AgentRunState, CapabilityError, CapabilityResult,
    InMemoryTraceRecorder, OtelGenAiSpan, SpanKind, SpanStatus, TraceLevel,
    export_otel_gen_ai_spans,
};
use starweaver_tools::{FunctionTool, ToolContext, ToolRegistry, ToolResult};
use starweaver_usage::Usage;

#[tokio::test]
#[allow(clippy::too_many_lines)]
async fn runtime_records_nested_agent_step_model_and_tool_spans() {
    let recorder = Arc::new(InMemoryTraceRecorder::new());
    let tool = FunctionTool::new(
        "echo",
        Some("Echo".to_string()),
        serde_json::json!({"type": "object"}),
        |_context: ToolContext, args: serde_json::Value| async move { Ok(ToolResult::new(args)) },
    );
    let tools = ToolRegistry::new().with_tool(Arc::new(tool));
    let model = starweaver_model::TestModel::with_responses(vec![
        tool_call_response("call-1", "echo", serde_json::json!({"text": "hello"})),
        ModelResponse::text("done"),
    ]);

    let result = Agent::new(Arc::new(model))
        .with_tools(tools)
        .with_trace_recorder(recorder.clone())
        .run("hello")
        .await
        .unwrap();

    assert_eq!(result.output, "done");
    let spans = recorder.spans();
    assert!(spans.iter().all(|span| span.status == SpanStatus::Ok));
    let agent_span = spans
        .iter()
        .find(|span| span.name == "gen_ai.invoke_agent")
        .unwrap();
    let step_spans = spans
        .iter()
        .filter(|span| span.name == "starweaver.loop.step")
        .collect::<Vec<_>>();
    let model_spans = spans
        .iter()
        .filter(|span| span.name == "gen_ai.inference")
        .collect::<Vec<_>>();
    let tool_span = spans
        .iter()
        .find(|span| span.name == "gen_ai.execute_tool")
        .unwrap();
    assert_eq!(step_spans.len(), 2);
    assert_eq!(model_spans.len(), 2);
    assert!(model_spans.iter().all(|span| span.kind == SpanKind::Client));
    assert!(model_spans.iter().all(|span| {
        span.events
            .iter()
            .any(|event| event.name == "starweaver.model.request")
            && span
                .events
                .iter()
                .any(|event| event.name == "starweaver.model.response")
    }));
    assert!(
        tool_span
            .events
            .iter()
            .any(|event| event.name == "starweaver.tool.call")
    );
    assert!(
        tool_span
            .events
            .iter()
            .any(|event| event.name == "starweaver.tool.return")
    );
    let tool_call_event = tool_span
        .events
        .iter()
        .find(|event| event.name == "starweaver.tool.call")
        .unwrap();
    assert_eq!(
        tool_call_event.attributes["gen_ai.tool.call.arguments"]["redacted"],
        serde_json::json!(true)
    );
    let tool_return_event = tool_span
        .events
        .iter()
        .find(|event| event.name == "starweaver.tool.return")
        .unwrap();
    assert_eq!(
        tool_return_event.attributes["gen_ai.tool.call.result"]["redacted"],
        serde_json::json!(true)
    );
    assert!(
        step_spans
            .iter()
            .all(|span| span.parent_span_id.as_deref() == Some(agent_span.span_id.as_str()))
    );
    assert!(model_spans.iter().all(|span| {
        step_spans
            .iter()
            .any(|step| span.parent_span_id.as_deref() == Some(step.span_id.as_str()))
    }));
    assert!(
        step_spans
            .iter()
            .any(|step| tool_span.parent_span_id.as_deref() == Some(step.span_id.as_str()))
    );
    assert!(
        spans
            .iter()
            .filter(|span| span.name == "starweaver.checkpoint")
            .count()
            >= 4
    );
}

#[tokio::test]
async fn otel_gen_ai_export_maps_agent_model_tool_and_usage_fields() {
    let recorder = Arc::new(InMemoryTraceRecorder::new());
    let tool = FunctionTool::new(
        "echo",
        Some("Echo".to_string()),
        serde_json::json!({"type": "object"}),
        |_context: ToolContext, args: serde_json::Value| async move { Ok(ToolResult::new(args)) },
    );
    let tools = ToolRegistry::new().with_tool(Arc::new(tool));
    let mut final_response = ModelResponse::text("done");
    final_response.model_name = Some("gpt-test-actual".to_string());
    final_response.finish_reason = Some(FinishReason::Stop);
    final_response.usage = Usage {
        requests: 1,
        input_tokens: 10,
        cache_write_tokens: 2,
        cache_read_tokens: 3,
        output_tokens: 4,
        total_tokens: 17,
        tool_calls: 0,
    };
    let model = starweaver_model::TestModel::with_responses(vec![
        tool_call_response("call-1", "echo", serde_json::json!({"text": "hello"})),
        final_response,
    ])
    .with_model_name("gpt-test-request");

    let result = Agent::new(Arc::new(model))
        .with_agent_identity(AgentId::from_string("agent-main"), "Main Agent")
        .with_tools(tools)
        .with_trace_recorder(recorder.clone())
        .run("hello")
        .await
        .unwrap();

    assert_eq!(result.output, "done");
    let export = export_otel_gen_ai_spans(&recorder.spans());
    assert_agent_otel_export(&export);
    assert_model_otel_export(&export);
    assert_tool_otel_export(&export);
}

fn assert_agent_otel_export(export: &[OtelGenAiSpan]) {
    let agent_span = export
        .iter()
        .find(|span| span.name == "gen_ai.invoke_agent")
        .unwrap();
    assert_eq!(
        agent_span.attributes["gen_ai.operation.name"],
        serde_json::json!("invoke_agent")
    );
    assert_eq!(
        agent_span.attributes["gen_ai.agent.id"],
        serde_json::json!("agent-main")
    );
    assert_eq!(
        agent_span.attributes["gen_ai.agent.name"],
        serde_json::json!("Main Agent")
    );
    assert!(
        agent_span
            .attributes
            .get("gen_ai.conversation.id")
            .and_then(serde_json::Value::as_str)
            .is_some_and(|value| !value.is_empty())
    );
}

fn assert_model_otel_export(export: &[OtelGenAiSpan]) {
    let model_span = export
        .iter()
        .find(|span| span.name == "gen_ai.inference")
        .unwrap();
    assert_eq!(model_span.kind, SpanKind::Client);
    assert_eq!(
        model_span.attributes["gen_ai.operation.name"],
        serde_json::json!("chat")
    );
    assert_eq!(
        model_span.attributes["gen_ai.provider.name"],
        serde_json::json!("test")
    );
    assert_eq!(
        model_span.attributes["gen_ai.request.model"],
        serde_json::json!("gpt-test-request")
    );
    assert_eq!(
        model_span.attributes["gen_ai.agent.id"],
        serde_json::json!("agent-main")
    );

    let response_model_span = export
        .iter()
        .filter(|span| span.name == "gen_ai.inference")
        .find(|span| {
            span.attributes.get("gen_ai.usage.input_tokens") == Some(&serde_json::json!(10))
        })
        .unwrap();
    assert_eq!(
        response_model_span.attributes["gen_ai.response.model"],
        serde_json::json!("gpt-test-actual")
    );
    assert_eq!(
        response_model_span.attributes["gen_ai.response.finish_reasons"],
        serde_json::json!(["stop"])
    );
    assert_eq!(
        response_model_span.attributes["gen_ai.usage.input_tokens"],
        serde_json::json!(10)
    );
    assert_eq!(
        response_model_span.attributes["gen_ai.usage.output_tokens"],
        serde_json::json!(4)
    );
    assert_eq!(
        response_model_span.attributes["gen_ai.usage.cache_read.input_tokens"],
        serde_json::json!(3)
    );
    assert_eq!(
        response_model_span.attributes["gen_ai.usage.cache_creation.input_tokens"],
        serde_json::json!(2)
    );
}

fn assert_tool_otel_export(export: &[OtelGenAiSpan]) {
    let tool_span = export
        .iter()
        .find(|span| span.name == "gen_ai.execute_tool")
        .unwrap();
    assert_eq!(
        tool_span.attributes["gen_ai.tool.name"],
        serde_json::json!("echo")
    );
    assert!(
        tool_span.attributes["gen_ai.tool.call.id"]
            .as_str()
            .is_some_and(|value| value.starts_with("sw-tool-"))
    );
    assert_eq!(
        tool_span.attributes["gen_ai.agent.id"],
        serde_json::json!("agent-main")
    );
}

#[test]
fn adapter_trace_recorder_provides_exporter_seam() {
    let recorder = AdapterTraceRecorder::new();
    let root = starweaver_core::TraceContext::from_trace_id("trace-adapter");
    let span = starweaver_runtime::TraceRecorder::start_span(
        &recorder,
        starweaver_runtime::SpanSpec::new("gen_ai.invoke_agent"),
        &root,
    );
    starweaver_runtime::TraceRecorder::close_span(
        &recorder,
        &span,
        SpanStatus::Error {
            error_type: "test_error".to_string(),
        },
    );

    let spans = recorder.spans();
    assert_eq!(spans.len(), 1);
    assert_eq!(spans[0].trace_id, "trace-adapter");
    let export = recorder.otel_gen_ai_spans();
    assert_eq!(export.len(), 1);
    assert_eq!(export[0].trace_id, "trace-adapter");
    assert_eq!(
        export[0].attributes["error.type"],
        serde_json::json!("test_error")
    );
}

#[test]
fn span_specs_and_events_carry_trace_levels() {
    let recorder = InMemoryTraceRecorder::new();
    let root = starweaver_core::TraceContext::from_trace_id("trace-debug");
    let span = starweaver_runtime::TraceRecorder::start_span(
        &recorder,
        starweaver_runtime::SpanSpec::new("starweaver.filter.all").debug(),
        &root,
    );
    starweaver_runtime::TraceRecorder::record_event(
        &recorder,
        &span,
        starweaver_runtime::SpanEvent::new("starweaver.filter.snapshot").debug(),
    );
    starweaver_runtime::TraceRecorder::close_span(&recorder, &span, SpanStatus::Ok);

    let spans = recorder.spans();
    assert_eq!(spans[0].level, TraceLevel::Debug);
    assert_eq!(spans[0].events[0].level, TraceLevel::Debug);
}

struct FailingRunStartCapability;

#[async_trait]
impl AgentCapability for FailingRunStartCapability {
    async fn on_run_start_with_context(
        &self,
        _state: &mut AgentRunState,
        _context: &mut AgentContext,
    ) -> CapabilityResult<()> {
        Err(CapabilityError::Failed("run start failed".to_string()))
    }
}

#[tokio::test]
async fn run_start_error_closes_agent_span_and_restores_trace_context() {
    let recorder = Arc::new(InMemoryTraceRecorder::new());
    let root = TraceContext::from_trace_id("trace-parent").with_span_id("span-parent");
    let agent = Agent::new(Arc::new(starweaver_model::TestModel::with_text("unused")))
        .with_capability(Arc::new(FailingRunStartCapability))
        .with_trace_recorder(recorder.clone());
    let mut context = agent.new_context().with_trace_context(root.clone());

    let error = agent
        .run_with_context("hello", &mut context)
        .await
        .unwrap_err();

    assert!(error.to_string().contains("run start failed"));
    assert_eq!(context.trace_context, root);
    let spans = recorder.spans();
    assert!(
        spans
            .iter()
            .all(|span| !matches!(span.status, SpanStatus::Open))
    );
    let agent_span = spans
        .iter()
        .find(|span| span.name == "gen_ai.invoke_agent")
        .unwrap();
    assert_eq!(agent_span.trace_id, "trace-parent");
    assert_eq!(agent_span.parent_span_id.as_deref(), Some("span-parent"));
    assert!(matches!(agent_span.status, SpanStatus::Error { .. }));
}

struct FailingBeforeToolCapability;

#[async_trait]
impl AgentCapability for FailingBeforeToolCapability {
    async fn before_tool_execution_with_context(
        &self,
        _state: &mut AgentRunState,
        _context: &mut AgentContext,
        _tool_context: &mut ToolContext,
        _call: &ToolCallPart,
    ) -> CapabilityResult<()> {
        Err(CapabilityError::Failed("before tool failed".to_string()))
    }
}

#[tokio::test]
async fn before_tool_error_closes_active_tool_step_and_agent_spans() {
    let recorder = Arc::new(InMemoryTraceRecorder::new());
    let tool = FunctionTool::new(
        "echo",
        Some("Echo".to_string()),
        serde_json::json!({"type": "object"}),
        |_context: ToolContext, args: serde_json::Value| async move { Ok(ToolResult::new(args)) },
    );
    let tools = ToolRegistry::new().with_tool(Arc::new(tool));
    let model = starweaver_model::TestModel::with_responses(vec![ModelResponse {
        parts: vec![ModelResponsePart::ToolCall(ToolCallPart {
            id: "call-1".to_string(),
            name: "echo".to_string(),
            arguments: serde_json::json!({"text": "hello"}).into(),
        })],
        ..ModelResponse::text("")
    }]);
    let root = TraceContext::from_trace_id("trace-tool").with_span_id("span-parent");
    let agent = Agent::new(Arc::new(model))
        .with_tools(tools)
        .with_capability(Arc::new(FailingBeforeToolCapability))
        .with_trace_recorder(recorder.clone());
    let mut context = agent.new_context().with_trace_context(root.clone());

    let error = agent
        .run_with_context("hello", &mut context)
        .await
        .unwrap_err();

    assert!(error.to_string().contains("before tool failed"));
    assert_eq!(context.trace_context, root);
    let spans = recorder.spans();
    assert!(
        spans
            .iter()
            .all(|span| !matches!(span.status, SpanStatus::Open))
    );
    let tool_span = spans
        .iter()
        .find(|span| span.name == "gen_ai.execute_tool")
        .unwrap();
    let step_span = spans
        .iter()
        .find(|span| span.name == "starweaver.loop.step")
        .unwrap();
    let agent_span = spans
        .iter()
        .find(|span| span.name == "gen_ai.invoke_agent")
        .unwrap();
    assert!(matches!(tool_span.status, SpanStatus::Error { .. }));
    assert!(matches!(step_span.status, SpanStatus::Error { .. }));
    assert!(matches!(agent_span.status, SpanStatus::Error { .. }));
}