awaken-runtime 0.4.0

Phase-based execution engine, plugin system, and agent loop for Awaken
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
//! Conversion between awaken types and genai types.

use genai::chat::{
    self, ChatMessage, ChatRequest, ContentPart, MessageContent, Tool as GenaiTool,
    ToolCall as GenaiToolCall, ToolResponse,
};

use awaken_contract::contract::content::ContentBlock;
use awaken_contract::contract::inference::{StopReason, TokenUsage};
use awaken_contract::contract::message::{Message, Role, ToolCall};
use awaken_contract::contract::tool::ToolDescriptor;

// ---------------------------------------------------------------------------
// Message → ChatMessage
// ---------------------------------------------------------------------------

/// Convert an awaken `Message` to a genai `ChatMessage`.
pub fn to_chat_message(msg: &Message) -> ChatMessage {
    match msg.role {
        Role::System => {
            let text = msg.text();
            ChatMessage::system(text)
        }
        Role::User => {
            let parts = to_content_parts(&msg.content);
            if parts.len() == 1
                && let ContentPart::Text(text) = &parts[0]
            {
                return ChatMessage::user(text.clone());
            }
            ChatMessage::user(MessageContent::from_parts(parts))
        }
        Role::Assistant => {
            if let Some(ref calls) = msg.tool_calls {
                let genai_calls: Vec<GenaiToolCall> =
                    calls.iter().map(to_genai_tool_call).collect();
                let text = msg.text();
                if text.is_empty() {
                    ChatMessage::from(genai_calls)
                } else {
                    let mut content = MessageContent::from_text(text);
                    for call in genai_calls {
                        content.push(ContentPart::ToolCall(call));
                    }
                    ChatMessage::assistant(content)
                }
            } else {
                ChatMessage::assistant(msg.text())
            }
        }
        Role::Tool => {
            let call_id = msg.tool_call_id.as_deref().unwrap_or("");
            let response = ToolResponse {
                call_id: call_id.to_string(),
                content: msg.text(),
            };
            ChatMessage::from(response)
        }
    }
}

/// Convert awaken `ContentBlock`s to genai `ContentPart`s.
fn to_content_parts(blocks: &[ContentBlock]) -> Vec<ContentPart> {
    blocks
        .iter()
        .filter_map(|b| match b {
            ContentBlock::Text { text } => Some(ContentPart::Text(text.clone())),
            ContentBlock::Image { source } => match source {
                awaken_contract::contract::content::ImageSource::Url { url } => {
                    Some(ContentPart::from_binary_url("image/png", url, None))
                }
                awaken_contract::contract::content::ImageSource::Base64 { media_type, data } => {
                    Some(ContentPart::from_binary_base64(
                        media_type,
                        data.as_str(),
                        None,
                    ))
                }
            },
            ContentBlock::Document { source, .. } => match source {
                awaken_contract::contract::content::DocumentSource::Url { url } => {
                    Some(ContentPart::from_binary_url("application/pdf", url, None))
                }
                awaken_contract::contract::content::DocumentSource::Base64 { media_type, data } => {
                    Some(ContentPart::from_binary_base64(
                        media_type,
                        data.as_str(),
                        None,
                    ))
                }
            },
            ContentBlock::Audio { source } => match source {
                awaken_contract::contract::content::AudioSource::Url { url } => {
                    Some(ContentPart::from_binary_url("audio/mpeg", url, None))
                }
                awaken_contract::contract::content::AudioSource::Base64 { media_type, data } => {
                    Some(ContentPart::from_binary_base64(
                        media_type,
                        data.as_str(),
                        None,
                    ))
                }
            },
            ContentBlock::Video { source } => match source {
                awaken_contract::contract::content::VideoSource::Url { url } => {
                    Some(ContentPart::from_binary_url("video/mp4", url, None))
                }
                awaken_contract::contract::content::VideoSource::Base64 { media_type, data } => {
                    Some(ContentPart::from_binary_base64(
                        media_type,
                        data.as_str(),
                        None,
                    ))
                }
            },
            // ToolUse, ToolResult, Thinking are handled separately
            _ => None,
        })
        .collect()
}

fn to_genai_tool_call(call: &ToolCall) -> GenaiToolCall {
    // Defend against null arguments from streaming parsers — Anthropic API
    // requires `input` to be an object, never null.
    let fn_arguments = if call.arguments.is_null() {
        serde_json::Value::Object(serde_json::Map::new())
    } else {
        call.arguments.clone()
    };
    GenaiToolCall {
        call_id: call.id.clone(),
        fn_name: call.name.clone(),
        fn_arguments,
        thought_signatures: None,
    }
}

// ---------------------------------------------------------------------------
// ToolDescriptor → genai::Tool
// ---------------------------------------------------------------------------

/// Convert an awaken `ToolDescriptor` to a genai `Tool`.
pub fn to_genai_tool(desc: &ToolDescriptor) -> GenaiTool {
    GenaiTool::new(&desc.id)
        .with_description(&desc.description)
        .with_schema(desc.parameters.clone())
}

// ---------------------------------------------------------------------------
// Build ChatRequest
// ---------------------------------------------------------------------------

/// Build a genai `ChatRequest` from messages, system prompt, and tools.
pub fn build_chat_request(
    system: &[ContentBlock],
    messages: &[Message],
    tools: &[ToolDescriptor],
    enable_prompt_cache: bool,
) -> ChatRequest {
    let mut chat_messages: Vec<ChatMessage> = Vec::with_capacity(messages.len() + 1);

    // System prompt as first message
    if !system.is_empty() {
        let text = awaken_contract::contract::content::extract_text(system);
        if !text.is_empty() {
            let mut msg = ChatMessage::system(text);
            if enable_prompt_cache {
                msg = msg.with_options(chat::CacheControl::Ephemeral);
            }
            chat_messages.push(msg);
        }
    }

    // Conversation messages — all go to LLM (including Internal visibility)
    for msg in messages {
        chat_messages.push(to_chat_message(msg));
    }

    let genai_tools: Vec<GenaiTool> = tools.iter().map(to_genai_tool).collect();

    let mut request = ChatRequest::new(chat_messages);
    if !genai_tools.is_empty() {
        request = request.with_tools(genai_tools);
    }

    request
}

// ---------------------------------------------------------------------------
// genai types → awaken types
// ---------------------------------------------------------------------------

/// Map genai `StopReason` to awaken `StopReason`.
pub fn map_stop_reason(reason: &chat::StopReason) -> Option<StopReason> {
    match reason {
        chat::StopReason::Completed(_) => Some(StopReason::EndTurn),
        chat::StopReason::MaxTokens(_) => Some(StopReason::MaxTokens),
        chat::StopReason::ToolCall(_) => Some(StopReason::ToolUse),
        chat::StopReason::StopSequence(_) => Some(StopReason::StopSequence),
        chat::StopReason::ContentFilter(_) | chat::StopReason::Other(_) => None,
    }
}

/// Map genai `Usage` to awaken `TokenUsage`.
pub fn map_usage(u: &chat::Usage) -> TokenUsage {
    let (cache_read, cache_creation) = u
        .prompt_tokens_details
        .as_ref()
        .map_or((None, None), |d| (d.cached_tokens, d.cache_creation_tokens));

    let thinking_tokens = u
        .completion_tokens_details
        .as_ref()
        .and_then(|d| d.reasoning_tokens);

    TokenUsage {
        prompt_tokens: u.prompt_tokens,
        completion_tokens: u.completion_tokens,
        total_tokens: u.total_tokens,
        cache_read_tokens: cache_read,
        cache_creation_tokens: cache_creation,
        thinking_tokens,
    }
}

/// Convert a genai `ToolCall` to an awaken `ToolCall`.
pub fn from_genai_tool_call(call: &GenaiToolCall) -> ToolCall {
    ToolCall::new(&call.call_id, &call.fn_name, call.fn_arguments.clone())
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn user_message_converts_to_chat_message() {
        let msg = Message::user("hello");
        let cm = to_chat_message(&msg);
        assert!(matches!(cm.role, chat::ChatRole::User));
    }

    #[test]
    fn tool_descriptor_converts_to_genai_tool() {
        let desc = ToolDescriptor::new("calc", "calculator", "Evaluates math");
        let tool = to_genai_tool(&desc);
        assert_eq!(tool.name, "calc".into());
    }

    #[test]
    fn stop_reason_mapping() {
        assert_eq!(
            map_stop_reason(&chat::StopReason::Completed("stop".into())),
            Some(StopReason::EndTurn)
        );
        assert_eq!(
            map_stop_reason(&chat::StopReason::MaxTokens("length".into())),
            Some(StopReason::MaxTokens)
        );
        assert_eq!(
            map_stop_reason(&chat::StopReason::ToolCall("tool_use".into())),
            Some(StopReason::ToolUse)
        );
    }

    #[test]
    fn assistant_with_tool_calls_converts() {
        let msg = Message::assistant_with_tool_calls(
            "Let me calc",
            vec![ToolCall::new("c1", "calculator", json!({"expr": "2+2"}))],
        );
        let cm = to_chat_message(&msg);
        assert!(matches!(cm.role, chat::ChatRole::Assistant));
    }

    // -- Task 1 tests --------------------------------------------------------

    #[test]
    fn to_chat_message_user() {
        let msg = Message::user("How are you?");
        let cm = to_chat_message(&msg);
        assert!(matches!(cm.role, chat::ChatRole::User));
        let text = cm.content.first_text().expect("should have text");
        assert_eq!(text, "How are you?");
    }

    #[test]
    fn to_chat_message_assistant_with_tools() {
        let calls = vec![
            ToolCall::new("c1", "search", json!({"q": "rust"})),
            ToolCall::new("c2", "calc", json!({"expr": "1+1"})),
        ];
        let msg = Message::assistant_with_tool_calls("I'll help", calls);
        let cm = to_chat_message(&msg);
        assert!(matches!(cm.role, chat::ChatRole::Assistant));
        // Content should include text and tool call parts
        let tool_calls = cm.content.tool_calls();
        assert_eq!(tool_calls.len(), 2);
        assert_eq!(tool_calls[0].fn_name, "search");
        assert_eq!(tool_calls[1].fn_name, "calc");
        // Text should still be present
        let text = cm.content.first_text().expect("should have text");
        assert_eq!(text, "I'll help");
    }

    #[test]
    fn to_chat_message_assistant_with_tools_no_text() {
        let calls = vec![ToolCall::new("c1", "search", json!({"q": "rust"}))];
        let msg = Message::assistant_with_tool_calls("", calls);
        let cm = to_chat_message(&msg);
        assert!(matches!(cm.role, chat::ChatRole::Assistant));
        let tool_calls = cm.content.tool_calls();
        assert_eq!(tool_calls.len(), 1);
        assert_eq!(tool_calls[0].call_id, "c1");
    }

    #[test]
    fn to_chat_message_tool_result() {
        let msg = Message::tool("call-42", "Result is 42");
        let cm = to_chat_message(&msg);
        assert!(matches!(cm.role, chat::ChatRole::Tool));
        // ToolResponse messages store content as a ToolResponse part, not plain text.
        // Verify the content is non-empty and the role is correct.
        assert!(!cm.content.parts().is_empty());
    }

    #[test]
    fn to_chat_message_system() {
        let msg = Message::system("You are a helpful assistant.");
        let cm = to_chat_message(&msg);
        assert!(matches!(cm.role, chat::ChatRole::System));
        let text = cm.content.first_text().expect("should have text");
        assert_eq!(text, "You are a helpful assistant.");
    }

    #[test]
    fn build_chat_request_no_tools() {
        let system = vec![ContentBlock::text("Be helpful")];
        let messages = vec![Message::user("hi")];
        let req = build_chat_request(&system, &messages, &[], false);
        // System message + user message = 2 messages
        assert_eq!(req.messages.len(), 2);
        assert!(matches!(req.messages[0].role, chat::ChatRole::System));
        assert!(matches!(req.messages[1].role, chat::ChatRole::User));
        // No tools
        assert!(req.tools.is_none());
    }

    #[test]
    fn build_chat_request_with_tools() {
        let tools = vec![
            ToolDescriptor::new("search", "search", "Web search"),
            ToolDescriptor::new("calc", "calc", "Calculator"),
        ];
        let req = build_chat_request(&[], &[Message::user("hi")], &tools, false);
        let genai_tools = req.tools.expect("should have tools");
        assert_eq!(genai_tools.len(), 2);
        assert_eq!(genai_tools[0].name, "search".into());
        assert_eq!(genai_tools[1].name, "calc".into());
    }

    #[test]
    fn to_genai_tool_preserves_schema() {
        let schema = json!({
            "type": "object",
            "properties": {
                "query": {"type": "string", "description": "Search query"},
                "limit": {"type": "integer"}
            },
            "required": ["query"]
        });
        let desc =
            ToolDescriptor::new("search", "search", "Web search").with_parameters(schema.clone());
        let tool = to_genai_tool(&desc);
        assert_eq!(tool.schema.as_ref().expect("schema present"), &schema);
        assert_eq!(tool.description.as_deref(), Some("Web search"));
    }

    #[test]
    fn build_chat_request_empty_system_skipped() {
        let req = build_chat_request(&[], &[Message::user("hi")], &[], false);
        // Only user message, no system
        assert_eq!(req.messages.len(), 1);
        assert!(matches!(req.messages[0].role, chat::ChatRole::User));
    }

    #[test]
    fn build_chat_request_prompt_cache_sets_options() {
        let system = vec![ContentBlock::text("Be helpful")];
        let req = build_chat_request(&system, &[], &[], true);
        assert_eq!(req.messages.len(), 1);
        // The system message should have options set (cache control)
        assert!(req.messages[0].options.is_some());
    }

    #[test]
    fn from_genai_tool_call_roundtrip() {
        let genai_call = GenaiToolCall {
            call_id: "c1".into(),
            fn_name: "search".into(),
            fn_arguments: json!({"q": "rust"}),
            thought_signatures: None,
        };
        let awaken_call = from_genai_tool_call(&genai_call);
        assert_eq!(awaken_call.id, "c1");
        assert_eq!(awaken_call.name, "search");
        assert_eq!(awaken_call.arguments, json!({"q": "rust"}));
    }

    #[test]
    fn map_usage_handles_all_fields() {
        let genai_usage = chat::Usage {
            prompt_tokens: Some(100),
            completion_tokens: Some(50),
            total_tokens: Some(150),
            prompt_tokens_details: Some(chat::PromptTokensDetails {
                cached_tokens: Some(20),
                cache_creation_tokens: Some(10),
                cache_creation_details: None,
                audio_tokens: None,
            }),
            completion_tokens_details: Some(chat::CompletionTokensDetails {
                reasoning_tokens: Some(5),
                accepted_prediction_tokens: None,
                rejected_prediction_tokens: None,
                audio_tokens: None,
            }),
        };
        let usage = map_usage(&genai_usage);
        assert_eq!(usage.prompt_tokens, Some(100));
        assert_eq!(usage.completion_tokens, Some(50));
        assert_eq!(usage.total_tokens, Some(150));
        assert_eq!(usage.cache_read_tokens, Some(20));
        assert_eq!(usage.cache_creation_tokens, Some(10));
        assert_eq!(usage.thinking_tokens, Some(5));
    }

    #[test]
    fn stop_reason_content_filter_maps_to_none() {
        assert_eq!(
            map_stop_reason(&chat::StopReason::ContentFilter("filter".into())),
            None
        );
    }

    #[test]
    fn stop_reason_other_maps_to_none() {
        assert_eq!(
            map_stop_reason(&chat::StopReason::Other("unknown".into())),
            None
        );
    }

    #[test]
    fn stop_reason_stop_sequence_maps_correctly() {
        assert_eq!(
            map_stop_reason(&chat::StopReason::StopSequence("seq".into())),
            Some(StopReason::StopSequence)
        );
    }

    #[test]
    fn prompt_cache_hints_applied_to_system_messages() {
        let system = vec![ContentBlock::text("You are a helpful assistant.")];
        let messages = vec![Message::user("hello")];
        let req = build_chat_request(&system, &messages, &[], true);

        // The system message (first) should have CacheControl::Ephemeral in options
        let system_msg = &req.messages[0];
        assert!(matches!(system_msg.role, chat::ChatRole::System));
        let opts = system_msg
            .options
            .as_ref()
            .expect("system message should have options when prompt cache is enabled");
        assert_eq!(opts.cache_control, Some(chat::CacheControl::Ephemeral));
    }

    #[test]
    fn prompt_cache_hints_not_applied_when_disabled() {
        let system = vec![ContentBlock::text("You are a helpful assistant.")];
        let messages = vec![Message::user("hello")];
        let req = build_chat_request(&system, &messages, &[], false);

        // The system message should NOT have options set
        let system_msg = &req.messages[0];
        assert!(matches!(system_msg.role, chat::ChatRole::System));
        assert!(
            system_msg.options.is_none(),
            "system message should not have options when prompt cache is disabled"
        );
    }

    // -----------------------------------------------------------------------
    // Migrated from uncarve: additional conversion tests
    // -----------------------------------------------------------------------

    #[test]
    fn to_chat_message_with_special_characters() {
        let msg = Message::user("Hello <world> & \"friends\"!");
        let cm = to_chat_message(&msg);
        let text = cm.content.first_text().expect("should have text");
        assert_eq!(text, "Hello <world> & \"friends\"!");
    }

    #[test]
    fn to_chat_message_empty_content() {
        let msg = Message::user("");
        let cm = to_chat_message(&msg);
        let text = cm.content.first_text().expect("should have text");
        assert_eq!(text, "");
    }

    #[test]
    fn to_chat_message_assistant_plain_text() {
        let msg = Message::assistant("Just text, no tools");
        let cm = to_chat_message(&msg);
        assert!(matches!(cm.role, chat::ChatRole::Assistant));
        let text = cm.content.first_text().expect("should have text");
        assert_eq!(text, "Just text, no tools");
        assert!(
            cm.content.tool_calls().is_empty(),
            "plain assistant should have no tool calls"
        );
    }

    #[test]
    fn build_chat_request_empty_messages() {
        let req = build_chat_request(&[], &[], &[], false);
        assert!(req.messages.is_empty());
        assert!(req.tools.is_none());
    }

    #[test]
    fn build_chat_request_multiple_tools_preserves_order() {
        let tools = vec![
            ToolDescriptor::new("alpha", "alpha", "Tool alpha"),
            ToolDescriptor::new("beta", "beta", "Tool beta"),
            ToolDescriptor::new("gamma", "gamma", "Tool gamma"),
        ];
        let req = build_chat_request(&[], &[Message::user("hi")], &tools, false);
        let genai_tools = req.tools.expect("should have tools");
        assert_eq!(genai_tools.len(), 3);
        assert_eq!(genai_tools[0].name, "alpha".into());
        assert_eq!(genai_tools[1].name, "beta".into());
        assert_eq!(genai_tools[2].name, "gamma".into());
    }

    #[test]
    fn to_genai_tool_with_empty_schema() {
        let desc = ToolDescriptor::new("test", "test", "Test tool");
        let tool = to_genai_tool(&desc);
        assert_eq!(tool.name, "test".into());
        assert_eq!(tool.description.as_deref(), Some("Test tool"));
    }

    #[test]
    fn from_genai_tool_call_preserves_arguments() {
        let complex_args = json!({
            "query": "test query",
            "options": {"limit": 10, "offset": 0},
            "tags": ["a", "b", "c"]
        });
        let genai_call = GenaiToolCall {
            call_id: "c99".into(),
            fn_name: "search".into(),
            fn_arguments: complex_args.clone(),
            thought_signatures: None,
        };
        let awaken_call = from_genai_tool_call(&genai_call);
        assert_eq!(awaken_call.arguments, complex_args);
    }

    #[test]
    fn map_usage_handles_none_fields() {
        let genai_usage = chat::Usage {
            prompt_tokens: None,
            completion_tokens: None,
            total_tokens: None,
            prompt_tokens_details: None,
            completion_tokens_details: None,
        };
        let usage = map_usage(&genai_usage);
        assert_eq!(usage.prompt_tokens, None);
        assert_eq!(usage.completion_tokens, None);
        assert_eq!(usage.total_tokens, None);
        assert_eq!(usage.cache_read_tokens, None);
        assert_eq!(usage.cache_creation_tokens, None);
        assert_eq!(usage.thinking_tokens, None);
    }

    #[test]
    fn to_chat_message_tool_with_empty_call_id() {
        let msg = Message::tool("", "result content");
        let cm = to_chat_message(&msg);
        assert!(matches!(cm.role, chat::ChatRole::Tool));
    }

    #[test]
    fn build_chat_request_system_and_multiple_messages() {
        let system = vec![
            ContentBlock::text("system 1"),
            ContentBlock::text("system 2"),
        ];
        let messages = vec![
            Message::user("u1"),
            Message::assistant("a1"),
            Message::user("u2"),
        ];
        let req = build_chat_request(&system, &messages, &[], false);
        // 1 system (combined) + 3 messages
        assert_eq!(req.messages.len(), 4);
        assert!(matches!(req.messages[0].role, chat::ChatRole::System));
        assert!(matches!(req.messages[1].role, chat::ChatRole::User));
        assert!(matches!(req.messages[2].role, chat::ChatRole::Assistant));
        assert!(matches!(req.messages[3].role, chat::ChatRole::User));
    }
}