aion_integrations/

contract.rs

//! The harness-integration seam: the [`AgentHarness`] trait an integrator implements and the
//! live [`AgentSession`] it produces.
//!
//! This is the SDK's published extension seam, mirroring `aion-client`'s `WorkflowTransport`
//! (a dedicated `#[async_trait]` contract module). It is **harness-blind by construction**: no
//! signature names a concrete harness, a transport, or a wire protocol. A harness is integrated
//! by implementing these traits in a separate adapter crate; the seam speaks only neutral run
//! identity, the neutral [`ActivityEvent`] / [`InterventionCommand`] types, the neutral
//! [`InterventionCapabilities`] advertisement, and a neutral terminal [`Payload`].
//!
//! # Designed from two cases so it is provably general
//!
//! The seam is designed against two deliberately different integrations at once, so it cannot be
//! shaped by any one harness:
//!
//! - a full rich-path harness (a bidirectional channel, streamed events out, acknowledged
//!   commands in, a structured terminal result), and
//! - a plain-stdout, **observability-only** CLI agent (no command channel at all): it demuxes
//!   interleaved stdout into [`ActivityEvent`]s (mostly [`aion_core::ActivityEventKind::Raw`]),
//!   advertises an **empty** [`InterventionCapabilities`] set, and yields its final output as the
//!   result.
//!
//! The empty-capability case is what forces [`AgentSession::intervene`] to be
//! optional-by-capability: an empty advertisement is a valid, first-class tier, and a session
//! that advertises it rejects every command with [`HarnessError::CapabilityNotSupported`].

use aion_core::{ActivityEvent, InterventionCapabilities, InterventionCommand, Payload};
use async_trait::async_trait;
use futures::stream::BoxStream;

use crate::error::HarnessError;
use crate::spec::AgentRunSpec;

/// How to run one agent harness — the SDK's published extension seam.
///
/// An integrator implements this (in a separate adapter crate) to teach Aion how to spawn or
/// connect their harness for a single activity attempt. It is harness-blind: [`Self::start`]
/// takes only the neutral [`AgentRunSpec`] and returns a live [`AgentSession`].
#[async_trait]
pub trait AgentHarness: Send + Sync {
    /// The live session type this harness produces for one attempt.
    type Session: AgentSession;

    /// Spawns or connects the harness for one activity attempt, negotiates capabilities, and
    /// returns a live session.
    ///
    /// `spec` carries the neutral run identity (`workflow_id`, `activity_id`, `attempt`) and the
    /// input [`Payload`] — never any harness-specific configuration.
    ///
    /// # Errors
    ///
    /// Returns a [`HarnessError`] when the harness cannot be spawned/connected or when the
    /// capability handshake fails ([`HarnessError::Transport`] / [`HarnessError::Protocol`]).
    async fn start(&self, spec: AgentRunSpec) -> Result<Self::Session, HarnessError>;
}

/// A live agent run for one activity attempt.
///
/// Produced by [`AgentHarness::start`]. Exposes the negotiated capability set, a stream of
/// neutral events OUT, a neutral command sink IN, and a single terminal result.
#[async_trait]
pub trait AgentSession: Send {
    /// The capability set negotiated at start.
    ///
    /// The server and ops console gate on THIS, never on harness identity. An **empty** set is a
    /// first-class advertisement — an observability-only harness supports no interventions.
    fn capabilities(&self) -> &InterventionCapabilities;

    /// The stream of neutral events produced by this run.
    ///
    /// Every item is an [`ActivityEvent`]; how the adapter derives them (mapping a structured
    /// notification, or demuxing interleaved stdout into mostly
    /// [`aion_core::ActivityEventKind::Raw`]) is an adapter-internal detail invisible here.
    fn events(&mut self) -> BoxStream<'static, ActivityEvent>;

    /// Delivers a neutral intervention command into the running agent.
    ///
    /// A session whose advertised [`Self::capabilities`] set does not contain the command's
    /// primitive rejects it with [`HarnessError::CapabilityNotSupported`]. An observability-only
    /// session (empty set) rejects **every** command this way; the server never routes one to it
    /// because the advertised set is empty.
    ///
    /// # Errors
    ///
    /// Returns [`HarnessError::CapabilityNotSupported`] when the command's primitive is not
    /// advertised, [`HarnessError::StaleTarget`] when the command targets a superseded attempt,
    /// or a transport/protocol error when delivery fails.
    async fn intervene(&self, cmd: InterventionCommand) -> Result<(), HarnessError>;

    /// Awaits the single terminal result of the run.
    ///
    /// Consumes the session: exactly one terminal result is produced per attempt, and it is the
    /// replay-authoritative activity output the worker captures.
    ///
    /// **The completed result is the canonical agent-outcome record.** A completed run's payload
    /// is the JSON serialization of [`aion_core::AgentOutcome`] —
    /// `{"text": <the whole accumulated output>, "final_message": <the last completed answer>,
    /// "stop_reason": <canonical snake_case reason>,
    /// "session_id": <the handle of the conversation that produced the outcome>}` —
    /// from EVERY harness. The adapter maps its native terminal outcome onto the record at this
    /// boundary (`stop_reason` spelled through the one
    /// [`StopKind::canonical_stop_reason`](aion_core::StopKind::canonical_stop_reason) mapping);
    /// a native outcome that cannot fill the record (e.g. a structured, non-text output) is a
    /// typed [`HarnessError::Contract`] naming this contract and what was found — a deterministic
    /// refusal the worker maps to a terminal activity failure — never a payload a workflow's
    /// decoder then chokes on.
    ///
    /// # Errors
    ///
    /// Returns [`HarnessError::Harness`] when the run reported an application-level failure,
    /// [`HarnessError::Contract`] when the completed run's native outcome cannot satisfy the
    /// agent-outcome contract, or a transport/protocol error when the terminal result could not
    /// be received.
    async fn wait_result(self) -> Result<Payload, HarnessError>;
}

/// An object-safe erased [`AgentSession`], so a worker can drive a session behind a
/// `Box<dyn ..>` without being generic over the concrete harness.
///
/// It mirrors [`AgentSession`] exactly EXCEPT that the terminal [`Self::wait_result`]
/// takes `self: Box<Self>` (rather than `self` by value), which is what makes the
/// trait object-safe — an owned-`self` method is not dispatchable through `dyn`. A
/// blanket impl over every [`AgentSession`] means an integrator implements only the
/// ergonomic typed trait and gets the erased form for free.
///
/// The async methods are `?Send`-dispatched. [`AgentSession`] is `Send` but not
/// `Sync`, so a `&session` cannot cross threads; the worker holds an erased session
/// inside ONE task and drives it (plus its event drain) there — never `tokio::spawn`-ing
/// a borrow of it — so requiring `Sync` would over-constrain every adapter for no gain.
#[async_trait(?Send)]
pub trait DynAgentSession: Send {
    /// The negotiated capability set — see [`AgentSession::capabilities`].
    fn capabilities(&self) -> &InterventionCapabilities;

    /// The neutral event stream OUT — see [`AgentSession::events`].
    fn events(&mut self) -> BoxStream<'static, ActivityEvent>;

    /// Deliver a neutral command IN — see [`AgentSession::intervene`].
    ///
    /// # Errors
    ///
    /// Propagates [`AgentSession::intervene`]'s errors unchanged.
    async fn intervene(&self, cmd: InterventionCommand) -> Result<(), HarnessError>;

    /// Await the single terminal result — see [`AgentSession::wait_result`]. Takes
    /// `Box<Self>` (not `self`) so the trait stays object-safe.
    ///
    /// # Errors
    ///
    /// Propagates [`AgentSession::wait_result`]'s errors unchanged.
    async fn wait_result(self: Box<Self>) -> Result<Payload, HarnessError>;
}

#[async_trait(?Send)]
impl<S: AgentSession + 'static> DynAgentSession for S {
    fn capabilities(&self) -> &InterventionCapabilities {
        AgentSession::capabilities(self)
    }

    fn events(&mut self) -> BoxStream<'static, ActivityEvent> {
        AgentSession::events(self)
    }

    async fn intervene(&self, cmd: InterventionCommand) -> Result<(), HarnessError> {
        AgentSession::intervene(self, cmd).await
    }

    async fn wait_result(self: Box<Self>) -> Result<Payload, HarnessError> {
        AgentSession::wait_result(*self).await
    }
}

/// An object-safe erased [`AgentHarness`], so a worker can HOLD a harness behind a
/// `Arc<dyn DynAgentHarness>` (the typed [`AgentHarness`] is not object-safe — it has
/// an associated `Session` type).
///
/// A blanket impl over every [`AgentHarness`] erases the session type into a
/// `Box<dyn DynAgentSession>`, so a composition root passes any typed harness and the
/// worker drives it without naming the concrete type.
#[async_trait]
pub trait DynAgentHarness: Send + Sync {
    /// Spawn/connect the harness for one attempt, returning an erased session.
    ///
    /// # Errors
    ///
    /// Propagates [`AgentHarness::start`]'s errors unchanged.
    async fn start_dyn(&self, spec: AgentRunSpec)
    -> Result<Box<dyn DynAgentSession>, HarnessError>;
}

#[async_trait]
impl<H: AgentHarness> DynAgentHarness for H
where
    H::Session: 'static,
{
    async fn start_dyn(
        &self,
        spec: AgentRunSpec,
    ) -> Result<Box<dyn DynAgentSession>, HarnessError> {
        let session = AgentHarness::start(self, spec).await?;
        Ok(Box::new(session))
    }
}