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

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

use crate::loop_runner::{AgentLoopParams, CommitWiring, prepare_resume, run_agent_loop};
#[cfg(feature = "background")]
use crate::plugins::Plugin;
use crate::registry::ResolvedAgent;
use crate::state::StateStore;

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

#[cfg(feature = "background")]
struct DelegateResolver<'a> {
    inner: &'a dyn crate::registry::AgentResolver,
    agent_id: &'a str,
    resolved: ResolvedAgent,
    context: Option<crate::extensions::background::BackgroundTaskExecutionContext>,
}

#[cfg(not(feature = "background"))]
struct DelegateResolver<'a> {
    inner: &'a dyn crate::registry::AgentResolver,
    agent_id: &'a str,
    resolved: ResolvedAgent,
}

#[cfg(feature = "background")]
impl<'a> DelegateResolver<'a> {
    fn new(
        inner: &'a dyn crate::registry::AgentResolver,
        agent_id: &'a str,
        resolved: ResolvedAgent,
        context: Option<crate::extensions::background::BackgroundTaskExecutionContext>,
    ) -> Self {
        Self {
            inner,
            agent_id,
            resolved,
            context,
        }
    }

    fn with_background_control(&self, mut resolved: ResolvedAgent) -> ResolvedAgent {
        if let Some(context) = &self.context {
            LocalBackend::ensure_background_cancel_tool(&mut resolved, context);
        }
        resolved
    }
}

#[cfg(feature = "background")]
impl crate::registry::AgentResolver for DelegateResolver<'_> {
    fn resolve(&self, agent_id: &str) -> Result<ResolvedAgent, crate::RuntimeError> {
        if agent_id == self.agent_id {
            return Ok(self.resolved.clone());
        }
        self.inner
            .resolve(agent_id)
            .map(|resolved| self.with_background_control(resolved))
    }

    fn resolve_execution(
        &self,
        agent_id: &str,
    ) -> Result<crate::resolution::ExecutionPlan, crate::RuntimeError> {
        if agent_id == self.agent_id {
            return Ok(crate::resolution::ExecutionPlan::from_resolved_agent(
                &self.resolved,
            ));
        }
        match self.inner.resolve_execution(agent_id)? {
            crate::resolution::ExecutionPlan::Local(agent) => {
                Ok(crate::resolution::ExecutionPlan::Local(Box::new(
                    self.with_background_control(*agent),
                )))
            }
            other => Ok(other),
        }
    }

    fn agent_ids(&self) -> Vec<String> {
        self.inner.agent_ids()
    }
}

#[cfg(not(feature = "background"))]
impl<'a> DelegateResolver<'a> {
    fn new(
        inner: &'a dyn crate::registry::AgentResolver,
        agent_id: &'a str,
        resolved: ResolvedAgent,
    ) -> Self {
        Self {
            inner,
            agent_id,
            resolved,
        }
    }
}

#[cfg(not(feature = "background"))]
impl crate::registry::AgentResolver for DelegateResolver<'_> {
    fn resolve(&self, agent_id: &str) -> Result<ResolvedAgent, crate::RuntimeError> {
        if agent_id == self.agent_id {
            return Ok(self.resolved.clone());
        }
        self.inner.resolve(agent_id)
    }

    fn resolve_execution(
        &self,
        agent_id: &str,
    ) -> Result<crate::resolution::ExecutionPlan, crate::RuntimeError> {
        if agent_id == self.agent_id {
            return Ok(crate::resolution::ExecutionPlan::from_resolved_agent(
                &self.resolved,
            ));
        }
        self.inner.resolve_execution(agent_id)
    }

    fn agent_ids(&self) -> Vec<String> {
        self.inner.agent_ids()
    }
}
/// Local runtime backend for executing the standard loop in-process.
pub struct LocalBackend;

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

    pub(crate) async fn execute_resolved(
        resolved: &ResolvedAgent,
        request: BackendDelegateRunRequest<'_>,
    ) -> Result<BackendRunResult, ExecutionBackendError> {
        Self::new()
            .execute_resolved_delegate(resolved, request)
            .await
    }
}

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

#[async_trait]
impl ExecutionBackend for LocalBackend {
    fn capabilities(&self) -> crate::resolution::BackendProfile {
        crate::resolution::BackendProfile::full_local()
    }

    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_pending_boundary(
            AgentLoopParams {
                resolver: request.resolver,
                agent_id: request.agent_id,
                runtime: phase_runtime,
                sink: request.sink,
                checkpoint_store: request.checkpoint_store,
                commit: request.commit,
                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,
                initial_state_seed: None,
            },
            thread_ctx,
            request.control.pending_boundary,
        )
        .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,
            thread_state: None,
        })
    }

    pub async fn execute_delegate(
        &self,
        request: BackendDelegateRunRequest<'_>,
    ) -> Result<BackendRunResult, ExecutionBackendError> {
        let resolved = crate::registry::AgentResolver::resolve(request.resolver, request.agent_id)
            .map_err(|error| map_resolve_error(request.agent_id, error))?;

        self.execute_resolved_delegate(&resolved, request).await
    }

    pub(crate) async fn execute_resolved_delegate(
        &self,
        resolved: &ResolvedAgent,
        request: BackendDelegateRunRequest<'_>,
    ) -> Result<BackendRunResult, ExecutionBackendError> {
        match (request.policy.persistence, request.policy.continuation) {
            (BackendDelegatePersistence::Ephemeral, BackendDelegateContinuation::Disabled) => {}
        }
        #[cfg(feature = "background")]
        let background_context = crate::extensions::background::current_background_task_context();
        #[cfg(feature = "background")]
        let mut initial_resolved = resolved.clone();
        #[cfg(not(feature = "background"))]
        let initial_resolved = resolved.clone();
        #[cfg(feature = "background")]
        if let Some(context) = &background_context {
            Self::ensure_background_cancel_tool(&mut initial_resolved, context);
        }

        let store = crate::state::StateStore::new();
        store
            .install_plugin(crate::loop_runner::LoopStatePlugin)
            .map_err(|error| ExecutionBackendError::ExecutionFailed(error.to_string()))?;
        store
            .install_plugin(crate::loop_runner::LoopActionHandlersPlugin)
            .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, &initial_resolved, owner_inbox.as_ref())
            .map_err(|error| ExecutionBackendError::ExecutionFailed(error.to_string()))?;

        #[cfg(feature = "background")]
        let bg_manager = if initial_resolved
            .env
            .plugins
            .iter()
            .any(|plugin| plugin.descriptor().name == "background_tasks")
        {
            None
        } else {
            // Bind the auto-created plugin through the same `bind_runtime_context`
            // seam the resolved-env plugins use (see `bind_local_execution_env`),
            // rather than re-setting store/owner_inbox by hand. If the host
            // scoped an ambient durable sink for this run, wire it so durable
            // `send_message` routes deliver; otherwise child-only.
            let manager =
                std::sync::Arc::new(crate::extensions::background::BackgroundTaskManager::new());
            let plugin = match crate::extensions::background::current_durable_message_sink() {
                Some(sink) => crate::extensions::background::BackgroundTaskPlugin::with_messaging(
                    manager.clone(),
                    sink,
                ),
                None => crate::extensions::background::BackgroundTaskPlugin::new(manager.clone()),
            };
            plugin.bind_runtime_context(&store, owner_inbox.as_ref());
            store
                .install_plugin(plugin)
                .map_err(|error| ExecutionBackendError::ExecutionFailed(error.to_string()))?;
            Some(manager)
        };

        #[cfg(feature = "background")]
        let background_cancel_managers = {
            let mut managers =
                crate::extensions::background::managers_for_resolved_agent(&initial_resolved);
            if let Some(manager) = &bg_manager {
                managers.push(manager.clone());
            }
            crate::extensions::background::dedup_managers(managers)
        };

        #[cfg(feature = "background")]
        let delegate_resolver = DelegateResolver::new(
            request.resolver,
            request.agent_id,
            initial_resolved.clone(),
            background_context.clone(),
        );
        #[cfg(not(feature = "background"))]
        let delegate_resolver =
            DelegateResolver::new(request.resolver, request.agent_id, initial_resolved.clone());
        let child_resolver: &dyn crate::registry::AgentResolver = &delegate_resolver;

        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);
        }
        #[cfg(feature = "background")]
        let _background_cancel_guard = crate::extensions::background::spawn_run_cancellation_guard(
            sub_run_id.clone(),
            request.control.cancellation_token.clone(),
            background_cancel_managers,
        );

        let result = run_agent_loop(AgentLoopParams {
            resolver: child_resolver,
            agent_id: request.agent_id,
            runtime: &phase_runtime,
            sink: request.sink,
            checkpoint_store: None,
            commit: CommitWiring::default(),
            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,
            initial_state_seed: request.state_seed,
        })
        .await
        .map_err(ExecutionBackendError::Loop)?;

        // ADR-0038 C4: split persisted state by scope so the consuming
        // checkpoint path can route run-scoped keys to the run record and
        // thread-scoped keys to the per-thread `thread_state` store.
        let run_state = store
            .export_run_scoped()
            .map_err(|error| ExecutionBackendError::ExecutionFailed(error.to_string()))?;
        let thread_state = store
            .export_thread_scoped()
            .map_err(|error| ExecutionBackendError::ExecutionFailed(error.to_string()))?;

        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: Some(run_state),
            thread_state: (!thread_state.extensions.is_empty()).then_some(thread_state),
        })
    }

    #[cfg(feature = "background")]
    fn ensure_background_cancel_tool(
        resolved: &mut ResolvedAgent,
        context: &crate::extensions::background::BackgroundTaskExecutionContext,
    ) {
        if resolved
            .tools
            .contains_key(crate::extensions::background::CANCEL_TASK_TOOL_ID)
        {
            return;
        }

        let tool: std::sync::Arc<dyn awaken_runtime_contract::contract::tool::Tool> =
            std::sync::Arc::new(
                crate::extensions::background::CancelTaskTool::with_current_task(
                    context.manager.clone(),
                    context.task_id.clone(),
                ),
            );
        resolved.tools.insert(
            crate::extensions::background::CANCEL_TASK_TOOL_ID.into(),
            tool.clone(),
        );
        resolved.env.tools.insert(
            crate::extensions::background::CANCEL_TASK_TOOL_ID.into(),
            tool,
        );
    }

    pub(crate) fn bind_local_execution_env(
        store: &StateStore,
        resolved: &ResolvedAgent,
        owner_inbox: Option<&crate::inbox::InboxSender>,
    ) -> Result<(), awaken_runtime_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()),
    }
}

fn map_resolve_error(agent_id: &str, error: crate::RuntimeError) -> ExecutionBackendError {
    match error {
        crate::RuntimeError::AgentNotFound { agent_id } => {
            ExecutionBackendError::AgentNotFound(agent_id)
        }
        other => ExecutionBackendError::ExecutionFailed(format!(
            "failed to resolve agent '{agent_id}': {other}"
        )),
    }
}

#[cfg(test)]
#[path = "local_tests.rs"]
mod tests;