Skip to main content

basis_tasks/
lib.rs

1//! The durable task layer over [`basis`]: a filesystem-coordinated lifecycle
2//! for spawned agents, reachable from Rust and not only from a CLI.
3//!
4//! ADR-0019 retired the per-workspace daemon. A task is a directory under one
5//! global data directory; execution belongs to whichever process holds its
6//! `attach.lock` — one writer, ever; liveness belongs to the OS. No verb here
7//! leaves a resident process behind, and no verb takes a lock it does not
8//! need: `send`, `cancel`, `watch`, `list`, and the read-only accessors never
9//! attach at all. [`Tasks`] is the crate's front door; open one and see its
10//! docs for what each verb does and costs.
11//!
12//! Every rule ADR-0017 states is enforced exactly as it was inside the CLI
13//! this crate was extracted from, unchanged: 16 messages to a durable inbox,
14//! 4 KiB bounded summaries, a finite deadline on every unattended task,
15//! downward-only cancellation, and the wait-edge policy that keeps a
16//! `basis wait`-shaped call from ever cycling (a descendant or an independent
17//! root is a safe edge; an ancestor or a peer is not).
18//!
19//! # The environment protocol
20//!
21//! A task's runtime sets three environment variables for every command its
22//! turns run (ADR-0018), and this is the one place their names and meanings
23//! are declared — they are read by tools this crate never sees run, so this
24//! is a protocol this crate publishes rather than an implementation detail
25//! it could rename:
26//!
27//! - [`BASIS_TASK_ID`] — this task's own handle. A tool that wants to `send`
28//!   or `ask` its own task — a subagent reporting progress upward, for one —
29//!   reads this rather than being told.
30//! - [`BASIS_DATA_DIR`] — the data directory root [`Tasks::open`] would
31//!   resolve to on its own, named explicitly so a recursive `basis` (or any
32//!   other binary built on this crate) invoked from inside a turn resolves
33//!   the same data directory its parent did, rather than rediscovering one
34//!   from a possibly different environment.
35//! - [`BASIS_PARENT_TASK_ID`] — the parent's handle, present only when the
36//!   task has one. What lets a deeply nested spawn still name its whole
37//!   ownership chain without walking `meta.json` files to find it.
38//!
39//! [`current_task`] reads the first of these back, for a host that wants to
40//! know whether *it* is running as a task's tool call.
41
42mod approve;
43mod attach;
44mod client;
45mod data_dir;
46mod error;
47mod events;
48mod handle;
49mod inbox;
50mod live;
51mod lock;
52mod policy;
53mod spec;
54mod state;
55mod tasks;
56mod watch;
57
58pub use approve::{Approve, PromptHost, validate_approval};
59pub use attach::POLL;
60pub use client::{Reply, Tasks, WaitOutcome};
61pub use error::{Error, Hint};
62pub use handle::TaskHandle;
63pub use live::LiveSink;
64pub use spec::{Continuation, DEFAULT_DEADLINE, RunSpec};
65pub use state::{MAX_TASKS, now_ms};
66pub use tasks::{TaskSummary, probe_state};
67pub use watch::{EventCursor, WatchRecord};
68
69/// This task's own handle — see [`BASIS_TASK_ID`].
70pub const BASIS_TASK_ID: &str = "BASIS_TASK_ID";
71/// The data directory root this task's runtime resolved — see
72/// [`BASIS_DATA_DIR`].
73pub const BASIS_DATA_DIR: &str = "BASIS_DATA_DIR";
74/// This task's parent, when it has one — see [`BASIS_PARENT_TASK_ID`].
75pub const BASIS_PARENT_TASK_ID: &str = "BASIS_PARENT_TASK_ID";
76
77/// This process's own task, if it is itself running as one — read from
78/// [`BASIS_TASK_ID`]. `None` for a value that is absent, blank, or does not
79/// fit the task-handle grammar: basis's own runtime always sets a well-formed
80/// one, so a malformed value is not basis's, and treating it as "no current
81/// task" is the safer reading of somebody else's environment variable.
82pub fn current_task() -> Option<TaskHandle> {
83    let value = std::env::var(BASIS_TASK_ID).ok()?;
84    if value.trim().is_empty() {
85        return None;
86    }
87    TaskHandle::parse(value).ok()
88}