awaken-runtime 0.2.1

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
//! In-process execution backend backed by the standard loop runner.

use async_trait::async_trait;
use awaken_contract::contract::identity::{RunIdentity, RunOrigin};
use awaken_contract::contract::lifecycle::TerminationReason;

use crate::loop_runner::{AgentLoopParams, prepare_resume, run_agent_loop};
use crate::registry::ResolvedAgent;
use crate::state::StateStore;

use super::{
    BackendCapabilities, BackendDelegateContinuation, BackendDelegatePersistence,
    BackendDelegateRunRequest, BackendRootRunRequest, BackendRunOutput, BackendRunResult,
    BackendRunStatus, ExecutionBackend, ExecutionBackendError,
};

/// Local runtime backend for executing the standard loop in-process.
pub struct LocalBackend;

impl LocalBackend {
    #[must_use]
    pub fn new() -> Self {
        Self
    }
}

impl Default for LocalBackend {
    fn default() -> Self {
        Self::new()
    }
}

#[async_trait]
impl ExecutionBackend for LocalBackend {
    fn capabilities(&self) -> BackendCapabilities {
        BackendCapabilities::full()
    }

    async fn execute_delegate(
        &self,
        request: BackendDelegateRunRequest<'_>,
    ) -> Result<BackendRunResult, ExecutionBackendError> {
        Self::execute_delegate(self, request).await
    }

    async fn execute_root(
        &self,
        request: BackendRootRunRequest<'_>,
    ) -> Result<BackendRunResult, ExecutionBackendError> {
        self.execute_root_with_thread_context(request, None).await
    }
}

impl LocalBackend {
    pub(crate) async fn execute_root_with_thread_context(
        &self,
        request: BackendRootRunRequest<'_>,
        thread_ctx: Option<crate::ThreadContextSnapshot>,
    ) -> Result<BackendRunResult, ExecutionBackendError> {
        let phase_runtime = request
            .local
            .as_ref()
            .map(|context| context.phase_runtime)
            .ok_or_else(|| {
                ExecutionBackendError::ExecutionFailed(
                    "local root execution requires a phase runtime context".into(),
                )
            })?;
        let run_identity = request.run_identity.clone();
        let run_id = run_identity.run_id.clone();
        if !request.decisions.is_empty() {
            prepare_resume(phase_runtime.store(), request.decisions, None)
                .map_err(crate::loop_runner::AgentLoopError::PhaseError)
                .map_err(ExecutionBackendError::Loop)?;
        }

        let result = crate::loop_runner::run_agent_loop_with_thread_context(
            AgentLoopParams {
                resolver: request.resolver,
                agent_id: request.agent_id,
                runtime: phase_runtime,
                sink: request.sink,
                checkpoint_store: request.checkpoint_store,
                messages: request.messages,
                run_identity,
                cancellation_token: request.control.cancellation_token,
                decision_rx: request.control.decision_rx,
                overrides: request.overrides,
                frontend_tools: request.frontend_tools,
                inbox: request.inbox,
                is_continuation: request.is_continuation,
            },
            thread_ctx,
        )
        .await
        .map_err(ExecutionBackendError::Loop)?;

        let response = if result.response.is_empty() {
            None
        } else {
            Some(result.response)
        };
        Ok(BackendRunResult {
            agent_id: request.agent_id.to_string(),
            status: map_termination(&result.termination),
            termination: result.termination,
            status_reason: None,
            output: BackendRunOutput::from_text(response.clone()),
            response,
            steps: result.steps,
            run_id: Some(run_id),
            inbox: None,
            state: None,
        })
    }

    pub async fn execute_delegate(
        &self,
        request: BackendDelegateRunRequest<'_>,
    ) -> Result<BackendRunResult, ExecutionBackendError> {
        match (request.policy.persistence, request.policy.continuation) {
            (BackendDelegatePersistence::Ephemeral, BackendDelegateContinuation::Disabled) => {}
        }
        let resolved = request
            .resolver
            .resolve(request.agent_id)
            .map_err(|error| {
                ExecutionBackendError::AgentNotFound(format!(
                    "failed to resolve agent '{}': {error}",
                    request.agent_id
                ))
            })?;

        let store = crate::state::StateStore::new();
        store
            .install_plugin(crate::loop_runner::LoopStatePlugin)
            .map_err(|error| ExecutionBackendError::ExecutionFailed(error.to_string()))?;

        let phase_runtime = crate::phase::PhaseRuntime::new(store.clone())
            .map_err(|error| ExecutionBackendError::ExecutionFailed(error.to_string()))?;

        let (owner_inbox, inbox_receiver) = {
            let (sender, receiver) = crate::inbox::inbox_channel();
            (Some(sender), receiver)
        };

        Self::bind_local_execution_env(&store, &resolved, owner_inbox.as_ref())
            .map_err(|error| ExecutionBackendError::ExecutionFailed(error.to_string()))?;

        #[cfg(feature = "background")]
        let bg_manager = if resolved
            .env
            .plugins
            .iter()
            .any(|plugin| plugin.descriptor().name == "background_tasks")
        {
            None
        } else {
            let manager = crate::extensions::background::BackgroundTaskManager::new();
            let manager = std::sync::Arc::new(manager);
            manager.set_store(store.clone());
            Some(manager)
        };

        #[cfg(feature = "background")]
        if let Some(manager) = &bg_manager {
            if let Some(sender) = owner_inbox.clone() {
                manager.set_owner_inbox(sender);
            }
            store
                .install_plugin(crate::extensions::background::BackgroundTaskPlugin::new(
                    manager.clone(),
                ))
                .map_err(|error| ExecutionBackendError::ExecutionFailed(error.to_string()))?;
        }

        let sub_run_id = uuid::Uuid::now_v7().to_string();
        let mut run_identity = RunIdentity::new(
            sub_run_id.clone(),
            request.parent.parent_thread_id.clone(),
            sub_run_id.clone(),
            request.parent.parent_run_id.clone(),
            request.agent_id.to_string(),
            RunOrigin::Subagent,
        );
        if let Some(parent_tool_call_id) = request.parent.parent_tool_call_id.clone() {
            run_identity = run_identity.with_parent_tool_call_id(parent_tool_call_id);
        }

        let result = run_agent_loop(AgentLoopParams {
            resolver: request.resolver,
            agent_id: request.agent_id,
            runtime: &phase_runtime,
            sink: request.sink,
            checkpoint_store: None,
            messages: request.messages,
            run_identity,
            cancellation_token: request.control.cancellation_token,
            decision_rx: request.control.decision_rx,
            overrides: None,
            frontend_tools: Vec::new(),
            inbox: Some(inbox_receiver),
            is_continuation: false,
        })
        .await
        .map_err(ExecutionBackendError::Loop)?;

        let response = if result.response.is_empty() {
            None
        } else {
            Some(result.response)
        };
        Ok(BackendRunResult {
            agent_id: request.agent_id.to_string(),
            status: map_termination(&result.termination),
            termination: result.termination,
            status_reason: None,
            output: BackendRunOutput::from_text(response.clone()),
            response,
            steps: result.steps,
            run_id: Some(sub_run_id),
            inbox: owner_inbox,
            state: None,
        })
    }

    pub(crate) fn bind_local_execution_env(
        store: &StateStore,
        resolved: &ResolvedAgent,
        owner_inbox: Option<&crate::inbox::InboxSender>,
    ) -> Result<(), awaken_contract::StateError> {
        if !resolved.env.key_registrations.is_empty() {
            store.register_keys(&resolved.env.key_registrations)?;
        }
        for plugin in &resolved.env.plugins {
            plugin.bind_runtime_context(store, owner_inbox);
        }
        Ok(())
    }
}

fn map_termination(termination: &TerminationReason) -> BackendRunStatus {
    match termination {
        TerminationReason::NaturalEnd | TerminationReason::BehaviorRequested => {
            BackendRunStatus::Completed
        }
        TerminationReason::Cancelled => BackendRunStatus::Cancelled,
        TerminationReason::Stopped(reason) => {
            BackendRunStatus::Failed(format!("stopped: {reason:?}"))
        }
        TerminationReason::Blocked(message) => {
            BackendRunStatus::Failed(format!("blocked: {message}"))
        }
        TerminationReason::Suspended => BackendRunStatus::Suspended(None),
        TerminationReason::Error(message) => BackendRunStatus::Failed(message.clone()),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::Arc;
    use std::sync::Mutex;
    use std::sync::atomic::{AtomicUsize, Ordering};

    use async_trait::async_trait;
    use awaken_contract::contract::content::ContentBlock;
    use awaken_contract::contract::event_sink::NullEventSink;
    use awaken_contract::contract::executor::{
        InferenceExecutionError, InferenceRequest, LlmExecutor,
    };
    use awaken_contract::contract::inference::{StopReason, StreamResult, TokenUsage};
    use awaken_contract::contract::message::{Message, ToolCall};
    use awaken_contract::contract::tool::{
        Tool, ToolCallContext, ToolDescriptor, ToolError, ToolOutput, ToolResult,
    };
    use serde_json::{Value, json};

    use crate::backend::{
        BackendControl, BackendDelegatePolicy, BackendDelegateRunRequest, BackendParentContext,
    };
    use crate::loop_runner::build_agent_env;
    use crate::plugins::{Plugin, PluginDescriptor};
    use crate::registry::{AgentResolver, ExecutionResolver, ResolvedExecution};

    struct ScriptedLlm {
        responses: Mutex<Vec<StreamResult>>,
    }

    impl ScriptedLlm {
        fn new(responses: Vec<StreamResult>) -> Self {
            Self {
                responses: Mutex::new(responses),
            }
        }
    }

    #[async_trait]
    impl LlmExecutor for ScriptedLlm {
        async fn execute(
            &self,
            _request: InferenceRequest,
        ) -> Result<StreamResult, InferenceExecutionError> {
            let mut responses = self.responses.lock().unwrap();
            assert!(!responses.is_empty(), "scripted LLM exhausted");
            Ok(responses.remove(0))
        }

        fn name(&self) -> &str {
            "scripted"
        }
    }

    fn text_response(text: &str) -> StreamResult {
        StreamResult {
            content: vec![ContentBlock::text(text)],
            tool_calls: vec![],
            usage: Some(TokenUsage::default()),
            stop_reason: Some(StopReason::EndTurn),
            has_incomplete_tool_calls: false,
        }
    }

    fn tool_call_response(text: &str, tool_name: &str, call_id: &str, args: Value) -> StreamResult {
        StreamResult {
            content: vec![ContentBlock::text(text)],
            tool_calls: vec![ToolCall::new(call_id, tool_name, args)],
            usage: Some(TokenUsage::default()),
            stop_reason: Some(StopReason::ToolUse),
            has_incomplete_tool_calls: false,
        }
    }

    struct EchoTool;

    #[async_trait]
    impl Tool for EchoTool {
        fn descriptor(&self) -> ToolDescriptor {
            ToolDescriptor::new("echo", "echo", "Echoes input back")
        }

        async fn execute(
            &self,
            args: Value,
            _ctx: &ToolCallContext,
        ) -> Result<ToolOutput, ToolError> {
            Ok(ToolResult::success_with_message("echo", args, "tool result should not win").into())
        }
    }

    struct BindingPlugin {
        bind_count: Arc<AtomicUsize>,
    }

    impl Plugin for BindingPlugin {
        fn descriptor(&self) -> PluginDescriptor {
            PluginDescriptor {
                name: "binding-plugin",
            }
        }

        fn bind_runtime_context(
            &self,
            _store: &crate::state::StateStore,
            _owner_inbox: Option<&crate::inbox::InboxSender>,
        ) {
            self.bind_count.fetch_add(1, Ordering::SeqCst);
        }
    }

    struct FixedResolver {
        agent: ResolvedAgent,
        plugins: Vec<Arc<dyn Plugin>>,
    }

    impl AgentResolver for FixedResolver {
        fn resolve(&self, _agent_id: &str) -> Result<ResolvedAgent, crate::RuntimeError> {
            let mut agent = self.agent.clone();
            agent.env = build_agent_env(&self.plugins, &agent).expect("build env");
            Ok(agent)
        }
    }

    impl ExecutionResolver for FixedResolver {
        fn resolve_execution(
            &self,
            agent_id: &str,
        ) -> Result<ResolvedExecution, crate::RuntimeError> {
            self.resolve(agent_id).map(ResolvedExecution::local)
        }
    }

    #[tokio::test]
    async fn execute_delegate_binds_plugin_runtime_context() {
        let bind_count = Arc::new(AtomicUsize::new(0));
        let plugin: Arc<dyn Plugin> = Arc::new(BindingPlugin {
            bind_count: bind_count.clone(),
        });
        let resolver = FixedResolver {
            agent: ResolvedAgent::new(
                "delegate",
                "m",
                "sys",
                Arc::new(ScriptedLlm::new(vec![text_response("delegated response")])),
            ),
            plugins: vec![plugin],
        };

        let result = LocalBackend::new()
            .execute_delegate(BackendDelegateRunRequest {
                agent_id: "delegate",
                messages: vec![Message::user("hello")],
                new_messages: vec![Message::user("hello")],
                sink: Arc::new(NullEventSink),
                resolver: &resolver,
                parent: BackendParentContext {
                    parent_run_id: Some("parent-run".into()),
                    parent_thread_id: Some("parent-thread".into()),
                    parent_tool_call_id: Some("tool-1".into()),
                },
                control: BackendControl::default(),
                policy: BackendDelegatePolicy::default(),
            })
            .await
            .expect("delegate execution should succeed");

        assert!(matches!(result.status, BackendRunStatus::Completed));
        assert_eq!(bind_count.load(Ordering::SeqCst), 1);
    }

    #[tokio::test]
    async fn execute_delegate_returns_final_non_tool_message_after_tool_output() {
        let resolver = FixedResolver {
            agent: ResolvedAgent::new(
                "delegate",
                "m",
                "sys",
                Arc::new(ScriptedLlm::new(vec![
                    tool_call_response(
                        "checking",
                        "echo",
                        "call-1",
                        json!({"message": "tool result should not win"}),
                    ),
                    text_response("final child answer"),
                ])),
            )
            .with_tool(Arc::new(EchoTool)),
            plugins: Vec::new(),
        };

        let result = LocalBackend::new()
            .execute_delegate(BackendDelegateRunRequest {
                agent_id: "delegate",
                messages: vec![Message::user("delegate with a tool")],
                new_messages: vec![Message::user("delegate with a tool")],
                sink: Arc::new(NullEventSink),
                resolver: &resolver,
                parent: BackendParentContext {
                    parent_run_id: Some("parent-run".into()),
                    parent_thread_id: Some("parent-thread".into()),
                    parent_tool_call_id: Some("tool-1".into()),
                },
                control: BackendControl::default(),
                policy: BackendDelegatePolicy::default(),
            })
            .await
            .expect("delegate execution should succeed");

        assert!(matches!(result.status, BackendRunStatus::Completed));
        assert_eq!(result.response.as_deref(), Some("final child answer"));
        assert_eq!(result.output.text.as_deref(), Some("final child answer"));
        assert_eq!(result.steps, 2);
    }
}