agentplane 0.4.0

Durable, replayable agent runtime — the journal is the plan of record
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
//! The worklist on redb.
//!
//! Claiming happens inside one write transaction that checks eligibility and
//! writes the holder together. Two reviewers opening the same queue at the same
//! moment must not both believe they hold a task — and a check followed by a
//! separate write has exactly that window.

use async_trait::async_trait;
use redb::{ReadableDatabase, ReadableTable, TableDefinition};

use crate::case::{ClaimError, TaskStore};
use crate::core::{CaseId, StoreError, Task, TaskId, TaskState, Timestamp};

use super::redb::{MAX_STR, RedbStore, be, begin_write};

/// `task_id -> the task as JSON`.
///
/// Stored whole rather than split into columns: `Task` already round-trips
/// through serde, and redb has no column concept to gain from splitting it.
/// Everything the indexes below need is derived from the parsed task, so the row
/// and its indexes cannot disagree about a field that exists in only one of them.
const TASKS: TableDefinition<(&str, &str), &str> = TableDefinition::new("tasks");

const QUEUE: TableDefinition<(&str, u8, i64, &str), ()> = TableDefinition::new("tasks_queue");

/// `(due_at, task_id) -> ()`, pending work with a window that can close.
const OVERDUE: TableDefinition<(&str, i64, &str), ()> = TableDefinition::new("tasks_overdue");

/// `(case_id, created_at, task_id) -> ()`.
const BY_CASE: TableDefinition<(&str, &str, i64, &str), ()> = TableDefinition::new("tasks_by_case");

/// `task_id -> ()`, every task still waiting on somebody.
///
/// Its length *is* the backlog. Counting by walking `TASKS` would parse a task
/// from JSON per row to read one field, which turns an operator's dashboard
/// refresh into a full deserialization of the worklist.
///
/// Wider than [`QUEUE`], deliberately: a claimed task has left the queue but is
/// still a decision the plane is waiting on, and a backlog that shrank the
/// moment a reviewer opened something would report progress that had not
/// happened.
const PENDING: TableDefinition<(&str, &str), ()> = TableDefinition::new("tasks_pending");

pub(super) fn create_tables(w: &redb::WriteTransaction) -> Result<(), StoreError> {
    w.open_table(TASKS).map_err(|e| be(&e))?;
    w.open_table(QUEUE).map_err(|e| be(&e))?;
    w.open_table(OVERDUE).map_err(|e| be(&e))?;
    w.open_table(BY_CASE).map_err(|e| be(&e))?;
    w.open_table(PENDING).map_err(|e| be(&e))?;
    Ok(())
}

fn ts(t: Timestamp) -> i64 {
    t.unix_timestamp()
}

/// Queue order, most urgent first.
fn priority_rank(s: &str) -> u8 {
    match s {
        "urgent" => 0,
        "high" => 1,
        "normal" => 2,
        _ => 3,
    }
}

/// Whether a task is still waiting on somebody.
fn is_queued(state: &str) -> bool {
    matches!(state, "open" | "escalated")
}

fn is_pending(state: &str) -> bool {
    matches!(state, "open" | "claimed" | "escalated")
}

/// Move a task between the derived indexes, in the transaction that writes it.
fn reindex(
    w: &redb::WriteTransaction,
    tenant: &str,
    id: &str,
    was: &Task,
    now_state: TaskState,
) -> Result<(), StoreError> {
    let (before, after) = (was.state.as_str(), now_state.as_str());
    if before == after {
        return Ok(());
    }
    let rank = priority_rank(was.priority.as_str());
    let created = ts(was.created_at);
    let mut queue = w.open_table(QUEUE).map_err(|e| be(&e))?;
    match (is_queued(before), is_queued(after)) {
        (true, false) => {
            queue
                .remove((tenant, rank, created, id))
                .map_err(|e| be(&e))?;
        }
        (false, true) => {
            queue
                .insert((tenant, rank, created, id), ())
                .map_err(|e| be(&e))?;
        }
        _ => {}
    }
    drop(queue);

    let mut pending = w.open_table(PENDING).map_err(|e| be(&e))?;
    match (is_pending(before), is_pending(after)) {
        (true, false) => {
            pending.remove((tenant, id)).map_err(|e| be(&e))?;
        }
        (false, true) => {
            pending.insert((tenant, id), ()).map_err(|e| be(&e))?;
        }
        _ => {}
    }
    drop(pending);

    if let Some(due) = was.due_at {
        let mut overdue = w.open_table(OVERDUE).map_err(|e| be(&e))?;
        match (is_pending(before), is_pending(after)) {
            (true, false) => {
                overdue.remove((tenant, ts(due), id)).map_err(|e| be(&e))?;
            }
            (false, true) => {
                overdue
                    .insert((tenant, ts(due), id), ())
                    .map_err(|e| be(&e))?;
            }
            _ => {}
        }
    }
    Ok(())
}

/// Read a task back out of the store.
fn load(
    t: &impl ReadableTable<(&'static str, &'static str), &'static str>,
    tenant: &str,
    id: &str,
) -> Result<Option<Task>, StoreError> {
    match t.get((tenant, id)).map_err(|e| be(&e))? {
        None => Ok(None),
        Some(v) => Ok(Some(serde_json::from_str(v.value())?)),
    }
}

#[async_trait]
impl TaskStore for RedbStore {
    async fn open(&self, task: &Task) -> Result<Task, StoreError> {
        let tenant = self.tenant_name();
        let id = task.id.to_hex();
        let encoded = serde_json::to_string(task)?;
        let (rank, created) = (priority_rank(task.priority.as_str()), ts(task.created_at));
        let (queued, pending) = (
            is_queued(task.state.as_str()),
            is_pending(task.state.as_str()),
        );
        let due = task.due_at.map(ts);
        let case = task.case.map(|c| c.to_string());
        self.with_db(move |db| {
            let w = begin_write(db)?;
            let out = {
                let mut tasks = w.open_table(TASKS).map_err(|e| be(&e))?;
                // First open wins, by id: reopening must not rewrite a task
                // somebody may already hold.
                if let Some(found) = load(&tasks, &tenant, &id)? {
                    found
                } else {
                    {
                        tasks
                            .insert((tenant.as_str(), id.as_str()), encoded.as_str())
                            .map_err(|e| be(&e))?;
                        drop(tasks);
                        if queued {
                            w.open_table(QUEUE)
                                .map_err(|e| be(&e))?
                                .insert((tenant.as_str(), rank, created, id.as_str()), ())
                                .map_err(|e| be(&e))?;
                        }
                        if let Some(d) = due
                            && pending
                        {
                            w.open_table(OVERDUE)
                                .map_err(|e| be(&e))?
                                .insert((tenant.as_str(), d, id.as_str()), ())
                                .map_err(|e| be(&e))?;
                        }
                        if pending {
                            w.open_table(PENDING)
                                .map_err(|e| be(&e))?
                                .insert((tenant.as_str(), id.as_str()), ())
                                .map_err(|e| be(&e))?;
                        }
                        if let Some(c) = &case {
                            w.open_table(BY_CASE)
                                .map_err(|e| be(&e))?
                                .insert((tenant.as_str(), c.as_str(), created, id.as_str()), ())
                                .map_err(|e| be(&e))?;
                        }
                        serde_json::from_str(&encoded)?
                    }
                }
            };
            w.commit().map_err(|e| be(&e))?;
            Ok(out)
        })
        .await
    }

    async fn task(&self, id: TaskId) -> Result<Option<Task>, StoreError> {
        let tenant = self.tenant_name();
        let key = id.to_hex();
        self.with_db(move |db| {
            let r = db.begin_read().map_err(|e| be(&e))?;
            let t = r.open_table(TASKS).map_err(|e| be(&e))?;
            load(&t, &tenant, &key)
        })
        .await
    }

    async fn claim(&self, id: TaskId, actor: &str, roles: &[String]) -> Result<Task, ClaimError> {
        let tenant = self.tenant_name();
        let key = id.to_hex();
        let actor = actor.to_owned();
        let roles = roles.to_vec();
        self.with_db(move |db| {
            let w = begin_write(db)?;
            let out = {
                let mut tasks = w.open_table(TASKS).map_err(|e| be(&e))?;
                match load(&tasks, &tenant, &key)? {
                    None => Err(ClaimError::NotFound(id)),
                    Some(task) => {
                        // Eligibility before availability, and the order is
                        // load-bearing — see `TaskStore::claim`.
                        //
                        // Four eyes: whoever proposed the action does not
                        // approve it.
                        if task.excluded_actors.iter().any(|a| a == &actor) {
                            Err(ClaimError::Excluded { actor })
                        } else if !task.candidate_roles.is_empty()
                            && !task.candidate_roles.iter().any(|r| roles.contains(r))
                        {
                            Err(ClaimError::WrongRole { actor })
                        } else if !task.state.is_pending() {
                            Err(ClaimError::NotPending {
                                task: id,
                                state: task.state,
                            })
                        } else if let Some(holder) = task.assignee.as_ref().filter(|h| *h != &actor)
                        {
                            Err(ClaimError::AlreadyClaimed {
                                task: id,
                                holder: holder.clone(),
                            })
                        } else {
                            let mut updated = task.clone();
                            updated.assignee = Some(actor);
                            updated.state = TaskState::Claimed;
                            tasks
                                .insert(
                                    (tenant.as_str(), key.as_str()),
                                    serde_json::to_string(&updated)?.as_str(),
                                )
                                .map_err(|e| be(&e))?;
                            drop(tasks);
                            reindex(&w, &tenant, &key, &task, TaskState::Claimed)?;
                            Ok(updated)
                        }
                    }
                }
            };
            w.commit().map_err(|e| be(&e))?;
            Ok(out)
        })
        .await?
    }

    async fn release(&self, id: TaskId, actor: &str) -> Result<(), ClaimError> {
        let tenant = self.tenant_name();
        let key = id.to_hex();
        let actor = actor.to_owned();
        self.with_db(move |db| {
            let w = begin_write(db)?;
            let out = {
                let mut tasks = w.open_table(TASKS).map_err(|e| be(&e))?;
                let found = load(&tasks, &tenant, &key)?;
                // Not "no such task": the row may exist and be held by somebody
                // else. Reporting success here would tell a caller they released
                // work they never held.
                let held = found.as_ref().is_some_and(|t| {
                    t.state == TaskState::Claimed && t.assignee.as_deref() == Some(actor.as_str())
                });
                if held {
                    let task = found.expect("held implies present");
                    let mut updated = task.clone();
                    updated.assignee = None;
                    updated.state = TaskState::Open;
                    tasks
                        .insert(
                            (tenant.as_str(), key.as_str()),
                            serde_json::to_string(&updated)?.as_str(),
                        )
                        .map_err(|e| be(&e))?;
                    drop(tasks);
                    reindex(&w, &tenant, &key, &task, TaskState::Open)?;
                    Ok(())
                } else {
                    Err(ClaimError::NotHeld { task: id, actor })
                }
            };
            w.commit().map_err(|e| be(&e))?;
            Ok(out)
        })
        .await?
    }

    async fn set_state(&self, id: TaskId, state: TaskState) -> Result<(), StoreError> {
        let tenant = self.tenant_name();
        let key = id.to_hex();
        self.with_db(move |db| {
            let w = begin_write(db)?;
            {
                let mut tasks = w.open_table(TASKS).map_err(|e| be(&e))?;
                let Some(task) = load(&tasks, &tenant, &key)? else {
                    return Err(StoreError::NotFound(id.to_string()));
                };
                let mut updated = task.clone();
                updated.state = state;
                tasks
                    .insert(
                        (tenant.as_str(), key.as_str()),
                        serde_json::to_string(&updated)?.as_str(),
                    )
                    .map_err(|e| be(&e))?;
                drop(tasks);
                reindex(&w, &tenant, &key, &task, state)?;
            }
            w.commit().map_err(|e| be(&e))?;
            Ok(())
        })
        .await
    }

    async fn queue(&self, roles: &[String], limit: usize) -> Result<Vec<Task>, StoreError> {
        let tenant = self.tenant_name();
        let roles = roles.to_vec();
        self.with_db(move |db| {
            let r = db.begin_read().map_err(|e| be(&e))?;
            let q = r.open_table(QUEUE).map_err(|e| be(&e))?;
            let tasks = r.open_table(TASKS).map_err(|e| be(&e))?;
            let mut out = Vec::new();
            // The index is keyed by priority rank then age, so redb's ascending
            // order is already the queue order.
            for e in q.iter().map_err(|e| be(&e))? {
                if out.len() >= limit {
                    break;
                }
                let (k, _) = e.map_err(|e| be(&e))?;
                if let Some(t) = load(&tasks, &tenant, k.value().3)? {
                    // Filtered here rather than in the index, so role semantics
                    // live in one place: the queue can never show work the claim
                    // path would refuse.
                    if t.candidate_roles.is_empty()
                        || t.candidate_roles.iter().any(|r| roles.contains(r))
                    {
                        out.push(t);
                    }
                }
            }
            Ok(out)
        })
        .await
    }

    async fn for_case(&self, case: CaseId) -> Result<Vec<Task>, StoreError> {
        let tenant = self.tenant_name();
        let key = case.to_string();
        self.with_db(move |db| {
            let r = db.begin_read().map_err(|e| be(&e))?;
            let by_case = r.open_table(BY_CASE).map_err(|e| be(&e))?;
            let tasks = r.open_table(TASKS).map_err(|e| be(&e))?;
            let mut out = Vec::new();
            for e in by_case
                .range(
                    (tenant.as_str(), key.as_str(), i64::MIN, "")
                        ..=(tenant.as_str(), key.as_str(), i64::MAX, MAX_STR),
                )
                .map_err(|e| be(&e))?
            {
                let (k, _) = e.map_err(|e| be(&e))?;
                if let Some(t) = load(&tasks, &tenant, k.value().3)? {
                    out.push(t);
                }
            }
            Ok(out)
        })
        .await
    }

    async fn open_count(&self) -> Result<u64, StoreError> {
        let tenant = self.tenant_name();
        self.with_db(move |db| {
            let r = db.begin_read().map_err(|e| be(&e))?;
            // Counted over this tenant's range rather than `len()` on the
            // table: a whole-table count reports every tenant's open tasks as
            // this one's, which is a metric that reads plausibly and is wrong.
            let pending = r.open_table(PENDING).map_err(|e| be(&e))?;
            let mut n = 0u64;
            for e in pending
                .range((tenant.as_str(), "")..=(tenant.as_str(), MAX_STR))
                .map_err(|e| be(&e))?
            {
                e.map_err(|e| be(&e))?;
                n += 1;
            }
            Ok(n)
        })
        .await
    }

    async fn overdue(&self, now: Timestamp, limit: usize) -> Result<Vec<Task>, StoreError> {
        let tenant = self.tenant_name();
        let cutoff = ts(now);
        self.with_db(move |db| {
            let r = db.begin_read().map_err(|e| be(&e))?;
            let od = r.open_table(OVERDUE).map_err(|e| be(&e))?;
            let tasks = r.open_table(TASKS).map_err(|e| be(&e))?;
            let mut out = Vec::new();
            for e in od
                .range((tenant.as_str(), i64::MIN, "")..=(tenant.as_str(), cutoff, MAX_STR))
                .map_err(|e| be(&e))?
            {
                if out.len() >= limit {
                    break;
                }
                let (k, _) = e.map_err(|e| be(&e))?;
                if let Some(t) = load(&tasks, &tenant, k.value().2)? {
                    out.push(t);
                }
            }
            Ok(out)
        })
        .await
    }
}