a3s-code-core 8.0.3

A3S Code Core - Embeddable AI agent library with tool execution
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
use std::collections::BTreeMap;
use std::fmt;
use std::marker::PhantomData;
use std::sync::Arc;

use async_trait::async_trait;
use tokio_util::sync::CancellationToken;

use super::projection::CatalogInner;
use super::{
    CapabilityAdapterError, CapabilityCatalog, CapabilityCatalogStamp, CapabilityCommitReceipt,
    CapabilityEffect, CapabilityId, CapabilityProjection, CapabilityProjectionError,
    CapabilityReadinessPlan, CapabilitySet, CapabilityValue, UseGenerationLeaseProvider,
};

pub const MAX_CAPABILITY_TRANSACTION_EFFECTS: usize = 4_096;

/// Transaction state before fallible runtime preparation.
#[derive(Debug)]
pub struct Staged;

/// Transaction state after every adapter prepared successfully.
#[derive(Debug)]
pub struct Prepared;

/// Transaction state after the complete value projection passed validation.
#[derive(Debug)]
pub struct Validated;

/// One atomically returned runtime value and its reversible resources.
///
/// Adapters must return acquired resources in the same successful value. If
/// their future is cancelled before returning, they remain responsible for
/// cancellation-safe local RAII cleanup. Once returned, the transaction owns
/// every effect and transfers it to the catalog rollback queue on any failure.
#[must_use = "prepared capability effects must be transferred into a transaction"]
pub struct PreparedCapability {
    value: CapabilityValue,
    effects: Vec<Box<dyn CapabilityEffect>>,
}

impl PreparedCapability {
    pub fn new(value: CapabilityValue) -> Self {
        Self {
            value,
            effects: Vec::new(),
        }
    }

    pub fn push_effect<E>(&mut self, effect: E) -> Result<(), CapabilityAdapterError>
    where
        E: CapabilityEffect,
    {
        self.push_boxed_effect(Box::new(effect))
    }

    pub fn push_boxed_effect(
        &mut self,
        effect: Box<dyn CapabilityEffect>,
    ) -> Result<(), CapabilityAdapterError> {
        // The transaction checks the aggregate immediately after an adapter
        // returns. Keeping this append infallible ensures an oversized batch
        // is first transferred into catalog-owned rollback instead of dropping
        // already acquired effects inside the adapter.
        self.effects.push(effect);
        Ok(())
    }

    fn into_parts(self) -> (CapabilityValue, Vec<Box<dyn CapabilityEffect>>) {
        (self.value, self.effects)
    }
}

/// Surface-owned fallible preparation boundary.
///
/// Tool, Skill, MCP, and other concerns implement this trait beside their
/// native runtime types. The adapter does not resolve packages or dependencies;
/// it projects one descriptor from the already selected A3S Use snapshot. A
/// successful return is the surface readiness barrier: the adapter must not
/// report success while its value still depends on unfinished initialization.
#[async_trait]
pub trait CapabilityProjectionAdapter: Send + 'static {
    async fn prepare(
        self: Box<Self>,
        cancellation: CancellationToken,
    ) -> Result<PreparedCapability, CapabilityAdapterError>;
}

struct ReadyValueAdapter(CapabilityValue);

#[async_trait]
impl CapabilityProjectionAdapter for ReadyValueAdapter {
    async fn prepare(
        self: Box<Self>,
        _cancellation: CancellationToken,
    ) -> Result<PreparedCapability, CapabilityAdapterError> {
        Ok(PreparedCapability::new(self.0))
    }
}

struct TransactionBody {
    catalog: Arc<CatalogInner>,
    base: CapabilityCatalogStamp,
    target: Arc<CapabilitySet>,
    readiness: Arc<CapabilityReadinessPlan>,
    effects: Vec<Box<dyn CapabilityEffect>>,
    rollback_armed: bool,
}

impl Drop for TransactionBody {
    fn drop(&mut self) {
        if self.rollback_armed {
            let effects = std::mem::take(&mut self.effects);
            self.catalog.enqueue_rollback(effects);
        }
    }
}

/// Atomic capability contribution transaction guarded by Rust typestate.
///
/// Only [`CapabilityTxn<Validated>`] exposes `commit`. A prepared transaction
/// cannot publish, and dropping any uncommitted state transfers all completed
/// effects to the catalog-owned asynchronous rollback queue.
///
/// ```compile_fail
/// use a3s_code_core::capability::{CapabilityTxn, Prepared};
///
/// fn publish_without_validation(txn: CapabilityTxn<Prepared>) {
///     let _ = txn.commit();
/// }
/// ```
#[must_use = "capability transactions must be committed or drained as rollback"]
pub struct CapabilityTxn<S> {
    body: Option<TransactionBody>,
    staged: BTreeMap<CapabilityId, Box<dyn CapabilityProjectionAdapter>>,
    prepared: BTreeMap<CapabilityId, CapabilityValue>,
    projection: Option<Arc<CapabilityProjection>>,
    _state: PhantomData<S>,
}

impl CapabilityCatalog {
    pub fn begin(
        &self,
        target: Arc<CapabilitySet>,
    ) -> Result<CapabilityTxn<Staged>, CapabilityProjectionError> {
        let base = self.current_stamp();
        let expected = base
            .generation()
            .checked_next()
            .ok_or(CapabilityProjectionError::GenerationExhausted)?;
        if target.generation() != expected {
            return Err(CapabilityProjectionError::TargetGenerationMismatch {
                expected: expected.get(),
                actual: target.generation().get(),
            });
        }
        let readiness = Arc::new(CapabilityReadinessPlan::from_set(&target)?);
        Ok(CapabilityTxn {
            body: Some(TransactionBody {
                catalog: Arc::clone(&self.inner),
                base,
                target,
                readiness,
                effects: Vec::new(),
                rollback_armed: true,
            }),
            staged: BTreeMap::new(),
            prepared: BTreeMap::new(),
            projection: None,
            _state: PhantomData,
        })
    }

    /// Start a one-time recovery transaction from the untouched empty catalog
    /// to an exact historical generation. This is intentionally separate from
    /// ordinary N -> N+1 publication and is only usable before the Session has
    /// published any scoped capability generation.
    pub(crate) fn begin_recovery_bootstrap(
        &self,
        target: Arc<CapabilitySet>,
    ) -> Result<CapabilityTxn<Staged>, CapabilityProjectionError> {
        let current = self.pin();
        let current_set = current.projection().set();
        if current_set.generation().get() != 0 || !current_set.is_empty() {
            return Err(CapabilityProjectionError::BootstrapUnavailable {
                actual_generation: current_set.generation().get(),
                actual_capabilities: current_set.len(),
            });
        }
        if target.generation().get() == 0 {
            return Err(CapabilityProjectionError::BootstrapTargetGeneration {
                actual: target.generation().get(),
            });
        }
        let base = current.stamp().clone();
        drop(current);
        let readiness = Arc::new(CapabilityReadinessPlan::from_set(&target)?);
        Ok(CapabilityTxn {
            body: Some(TransactionBody {
                catalog: Arc::clone(&self.inner),
                base,
                target,
                readiness,
                effects: Vec::new(),
                rollback_armed: true,
            }),
            staged: BTreeMap::new(),
            prepared: BTreeMap::new(),
            projection: None,
            _state: PhantomData,
        })
    }
}

impl CapabilityTxn<Staged> {
    pub fn stage<A>(
        &mut self,
        id: CapabilityId,
        adapter: A,
    ) -> Result<&mut Self, CapabilityProjectionError>
    where
        A: CapabilityProjectionAdapter,
    {
        let body = self
            .body
            .as_ref()
            .ok_or(CapabilityProjectionError::InvalidTransactionState)?;
        if !body.target.contains(&id) {
            return Err(CapabilityProjectionError::UnknownStagedCapability {
                capability: id.to_string(),
            });
        }
        if self.staged.contains_key(&id) {
            return Err(CapabilityProjectionError::DuplicateStagedCapability {
                capability: id.to_string(),
            });
        }
        self.staged.insert(id, Box::new(adapter));
        Ok(self)
    }

    pub fn stage_value(
        &mut self,
        id: CapabilityId,
        value: CapabilityValue,
    ) -> Result<&mut Self, CapabilityProjectionError> {
        self.stage(id, ReadyValueAdapter(value))
    }

    pub(crate) fn stage_boxed(
        &mut self,
        id: CapabilityId,
        adapter: Box<dyn CapabilityProjectionAdapter>,
    ) -> Result<&mut Self, CapabilityProjectionError> {
        let body = self
            .body
            .as_ref()
            .ok_or(CapabilityProjectionError::InvalidTransactionState)?;
        if !body.target.contains(&id) {
            return Err(CapabilityProjectionError::UnknownStagedCapability {
                capability: id.to_string(),
            });
        }
        if self.staged.contains_key(&id) {
            return Err(CapabilityProjectionError::DuplicateStagedCapability {
                capability: id.to_string(),
            });
        }
        self.staged.insert(id, adapter);
        Ok(self)
    }

    pub async fn prepare(
        mut self,
        cancellation: CancellationToken,
    ) -> Result<CapabilityTxn<Prepared>, CapabilityProjectionError> {
        if cancellation.is_cancelled() {
            return Err(CapabilityProjectionError::Cancelled);
        }
        let body = self
            .body
            .as_ref()
            .ok_or(CapabilityProjectionError::InvalidTransactionState)?;
        if let Some((id, _)) = body
            .target
            .iter()
            .find(|(id, _)| !self.staged.contains_key(*id))
        {
            return Err(CapabilityProjectionError::MissingStagedCapability {
                capability: id.to_string(),
            });
        }
        let activation_order = body.readiness.activation_order().to_vec();
        for id in activation_order {
            let adapter = self.staged.remove(&id).ok_or_else(|| {
                CapabilityProjectionError::MissingStagedCapability {
                    capability: id.to_string(),
                }
            })?;
            let result = tokio::select! {
                biased;
                _ = cancellation.cancelled() => {
                    return Err(CapabilityProjectionError::Cancelled);
                }
                result = adapter.prepare(cancellation.clone()) => result,
            };
            let prepared = result.map_err(|error| CapabilityProjectionError::PrepareFailed {
                capability: id.to_string(),
                message: error.message().to_owned(),
            })?;
            let (value, mut effects) = prepared.into_parts();
            let body = self
                .body
                .as_mut()
                .ok_or(CapabilityProjectionError::InvalidTransactionState)?;
            body.effects.append(&mut effects);
            if body.effects.len() > MAX_CAPABILITY_TRANSACTION_EFFECTS {
                return Err(CapabilityProjectionError::EffectBoundExceeded {
                    max: MAX_CAPABILITY_TRANSACTION_EFFECTS,
                });
            }
            self.prepared.insert(id, value);
        }
        if cancellation.is_cancelled() {
            return Err(CapabilityProjectionError::Cancelled);
        }
        self.transition()
    }
}

impl CapabilityTxn<Prepared> {
    pub fn validate(mut self) -> Result<CapabilityTxn<Validated>, CapabilityProjectionError> {
        let target = Arc::clone(
            &self
                .body
                .as_ref()
                .ok_or(CapabilityProjectionError::InvalidTransactionState)?
                .target,
        );
        let readiness = Arc::clone(
            &self
                .body
                .as_ref()
                .ok_or(CapabilityProjectionError::InvalidTransactionState)?
                .readiness,
        );
        let values = std::mem::take(&mut self.prepared);
        self.projection = Some(CapabilityProjection::with_readiness(
            target, readiness, values,
        )?);
        self.transition()
    }
}

impl CapabilityTxn<Validated> {
    pub(crate) fn projection(&self) -> Result<&CapabilityProjection, CapabilityProjectionError> {
        self.projection
            .as_deref()
            .ok_or(CapabilityProjectionError::InvalidTransactionState)
    }

    pub fn commit(mut self) -> Result<CapabilityCommitReceipt, CapabilityProjectionError> {
        self.commit_inner(None)
    }

    pub(crate) fn commit_with_use_lease_provider(
        mut self,
        provider: Option<Arc<dyn UseGenerationLeaseProvider>>,
    ) -> Result<CapabilityCommitReceipt, CapabilityProjectionError> {
        self.commit_inner(provider)
    }

    fn commit_inner(
        &mut self,
        provider: Option<Arc<dyn UseGenerationLeaseProvider>>,
    ) -> Result<CapabilityCommitReceipt, CapabilityProjectionError> {
        let projection = self
            .projection
            .take()
            .ok_or(CapabilityProjectionError::InvalidTransactionState)?;
        let mut body = self
            .body
            .take()
            .ok_or(CapabilityProjectionError::InvalidTransactionState)?;
        let effects = std::mem::take(&mut body.effects);
        let result = body
            .catalog
            .publish(&body.base, projection, provider, effects);
        // `publish` owns the effect batch on both success and CAS conflict.
        body.rollback_armed = false;
        result
    }
}

impl<S> CapabilityTxn<S> {
    fn transition<T>(mut self) -> Result<CapabilityTxn<T>, CapabilityProjectionError> {
        let body = self
            .body
            .take()
            .ok_or(CapabilityProjectionError::InvalidTransactionState)?;
        Ok(CapabilityTxn {
            body: Some(body),
            staged: std::mem::take(&mut self.staged),
            prepared: std::mem::take(&mut self.prepared),
            projection: self.projection.take(),
            _state: PhantomData,
        })
    }

    pub fn base(&self) -> Result<&CapabilityCatalogStamp, CapabilityProjectionError> {
        self.body
            .as_ref()
            .map(|body| &body.base)
            .ok_or(CapabilityProjectionError::InvalidTransactionState)
    }

    pub fn target(&self) -> Result<&CapabilitySet, CapabilityProjectionError> {
        self.body
            .as_ref()
            .map(|body| body.target.as_ref())
            .ok_or(CapabilityProjectionError::InvalidTransactionState)
    }
}

impl<S> fmt::Debug for CapabilityTxn<S> {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter
            .debug_struct("CapabilityTxn")
            .field("base", &self.body.as_ref().map(|body| &body.base))
            .field(
                "target_generation",
                &self.body.as_ref().map(|body| body.target.generation()),
            )
            .field("staged", &self.staged.len())
            .field("prepared", &self.prepared.len())
            .field("validated", &self.projection.is_some())
            .finish()
    }
}