agent-effects 0.2.0

Reliable side-effect execution for AI agents and autonomous applications
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
//! Deterministic races: pause one decision after reading its version, then
//! allow another worker to change the authoritative state before releasing it.
#[path = "support/reliability.rs"]
mod reliability;

use std::sync::Arc;
use std::sync::atomic::{AtomicU32, Ordering};
use std::time::Duration;

use agent_effects::store::{LateObservation, LateOutcome, Lease, StoreError};
use agent_effects::testkit::{Behavior, FakeRemote};
use agent_effects::{
    CompensationOutcome, EffectFailure, EffectHandler, EffectOutcome, EffectStatus, EffectStore,
    ManualClock, Resolution, Runtime, RuntimeError, Transition, Verification, WorkerId,
};
use agent_effects_memory::MemoryStore;
use reliability::fault_store::{Edge, FaultStore, Operation};
use reliability::{Durable, Protection, record, runtime};

type Store = FaultStore<MemoryStore>;

fn setup(protection: Protection) -> (Store, Runtime<Store>, FakeRemote) {
    let store = FaultStore::new(MemoryStore::new());
    let clock = Arc::new(ManualClock::default());
    let remote = FakeRemote::new(clock.clone());
    let rt = runtime(store.clone(), clock, remote.clone(), protection, "worker");
    (store, rt, remote)
}

async fn awaiting(rt: &Runtime<Store>) {
    assert!(matches!(
        rt.effect(Durable::NAME, "approval")
            .require_approval()
            .run(|_| async { Ok::<_, EffectFailure>("unused".to_string()) })
            .await
            .unwrap(),
        EffectOutcome::AwaitingApproval { .. }
    ));
}

async fn unknown(rt: &Runtime<Store>, remote: &FakeRemote) {
    let remote = remote.clone();
    assert!(matches!(
        rt.effect(Durable::NAME, "resolution")
            .input(&"resolution")
            .verify(|_| async { Ok::<_, EffectFailure>(Verification::<String>::Inconclusive) })
            .run(move |_| {
                let remote = remote.clone();
                async move {
                    remote.create("resolution", None).await?;
                    Err::<String, _>(EffectFailure::ambiguous("answer lost"))
                }
            })
            .await
            .unwrap(),
        EffectOutcome::Unknown { .. }
    ));
}

#[tokio::test]
async fn approve_versus_deny_accepts_and_audits_only_one_decision() {
    for approve_first in [false, true] {
        let (store, rt, _) = setup(Protection::None);
        awaiting(&rt).await;
        let pending = record(store.inner.as_ref(), "approval").await;
        let gate = store.controls.pause(
            Operation::Transition(if approve_first {
                Transition::Approve
            } else {
                Transition::Deny
            }),
            Edge::Before,
        );
        let stale = tokio::spawn({
            let rt = rt.clone();
            async move {
                if approve_first {
                    rt.approve(pending.id, "stale", "approve").await
                } else {
                    rt.deny(pending.id, "stale", "deny").await
                }
            }
        });
        gate.entered().await;
        if approve_first {
            rt.deny(pending.id, "winner", "deny").await.unwrap();
        } else {
            rt.approve(pending.id, "winner", "approve").await.unwrap();
        }
        gate.release();
        assert!(matches!(
            stale.await.unwrap(),
            Err(RuntimeError::Store(StoreError::VersionConflict { .. }))
        ));
        let calls = Arc::<AtomicU32>::default();
        let outcome = rt
            .effect(Durable::NAME, "approval")
            .require_approval()
            .run({
                let calls = calls.clone();
                move |_| {
                    calls.fetch_add(1, Ordering::SeqCst);
                    async { Ok::<_, EffectFailure>("done".to_string()) }
                }
            })
            .await
            .unwrap();
        assert_eq!(calls.load(Ordering::SeqCst), u32::from(!approve_first));
        assert!(matches!(
            outcome,
            EffectOutcome::Rejected(_) | EffectOutcome::Committed(_)
        ));
        let events = store.inner.events(pending.id).await.unwrap();
        let accepted: Vec<_> = events
            .iter()
            .filter(|e| matches!(e.transition, Transition::Approve | Transition::Deny))
            .collect();
        assert_eq!(accepted.len(), 1);
        assert_eq!(accepted[0].actor.as_deref(), Some("winner"));
    }
}

#[tokio::test]
async fn execution_can_follow_a_committed_approval_before_its_acknowledgement() {
    let (store, rt, _) = setup(Protection::None);
    awaiting(&rt).await;
    let pending = record(store.inner.as_ref(), "approval").await;
    let gate = store
        .controls
        .pause(Operation::Transition(Transition::Approve), Edge::After);
    let approval = tokio::spawn({
        let rt = rt.clone();
        async move { rt.approve(pending.id, "approver", "reviewed").await }
    });
    gate.entered().await;
    assert!(matches!(
        rt.effect(Durable::NAME, "approval")
            .require_approval()
            .run(|_| async { Ok::<_, EffectFailure>("done".to_string()) })
            .await
            .unwrap(),
        EffectOutcome::Committed(_)
    ));
    gate.release();
    approval.await.unwrap().unwrap();
    assert_eq!(
        record(store.inner.as_ref(), "approval").await.status,
        EffectStatus::Committed
    );
    let events = store.inner.events(pending.id).await.unwrap();
    let approved = events
        .iter()
        .position(|e| e.transition == Transition::Approve)
        .unwrap();
    let executed = events
        .iter()
        .position(|e| e.transition == Transition::StartAttempt)
        .unwrap();
    assert!(approved < executed);
    assert!(rt.deny(pending.id, "late", "too late").await.is_err());
}

#[tokio::test]
async fn recovery_fences_a_resolution_that_read_an_older_version() {
    let (store, rt, remote) = setup(Protection::Verified);
    unknown(&rt, &remote).await;
    let pending = record(store.inner.as_ref(), "resolution").await;
    let gate = store.controls.pause(
        Operation::Transition(Transition::ResolvedApplied),
        Edge::Before,
    );
    let resolution = tokio::spawn({
        let rt = rt.clone();
        async move {
            rt.resolve(
                pending.id,
                Resolution::applied(&"resolution#1").unwrap(),
                "stale",
                "confirmed",
            )
            .await
        }
    });
    gate.entered().await;
    rt.recover().await.unwrap();
    gate.release();
    assert!(matches!(
        resolution.await.unwrap(),
        Err(RuntimeError::Store(StoreError::VersionConflict { .. }))
    ));
    assert_eq!(
        record(store.inner.as_ref(), "resolution").await.status,
        EffectStatus::Committed
    );
    assert_eq!(remote.applications("resolution"), 1);
    assert_eq!(remote.requests(), 1);
    assert!(
        store
            .inner
            .events(pending.id)
            .await
            .unwrap()
            .iter()
            .all(|e| e.transition != Transition::ResolvedApplied)
    );
}

#[tokio::test]
async fn an_operator_cannot_resolve_while_recovery_holds_the_lease() {
    let (store, rt, remote) = setup(Protection::Verified);
    unknown(&rt, &remote).await;
    let pending = record(store.inner.as_ref(), "resolution").await;
    let gate = store.controls.pause(
        Operation::Transition(Transition::StartVerification),
        Edge::Before,
    );
    let recovery = tokio::spawn({
        let rt = rt.clone();
        async move { rt.recover().await }
    });
    gate.entered().await;
    assert!(matches!(
        rt.resolve(
            pending.id,
            Resolution::NotApplied,
            "operator",
            "claimed absent"
        )
        .await,
        Err(RuntimeError::Store(StoreError::LeaseHeld { .. }))
    ));
    gate.release();
    recovery.await.unwrap().unwrap();
    assert_eq!(
        record(store.inner.as_ref(), "resolution").await.status,
        EffectStatus::Committed
    );
    assert_eq!(remote.applications("resolution"), 1);
}

#[tokio::test]
async fn supplementary_evidence_does_not_conflict_with_an_authorized_resolution() {
    let (store, rt, remote) = setup(Protection::Verified);
    unknown(&rt, &remote).await;
    let pending = record(store.inner.as_ref(), "resolution").await;
    let gate = store.controls.pause(
        Operation::Transition(Transition::ResolvedApplied),
        Edge::Before,
    );
    let resolution = tokio::spawn({
        let rt = rt.clone();
        async move {
            rt.resolve(
                pending.id,
                Resolution::applied(&"resolution#1").unwrap(),
                "operator",
                "provider confirmed",
            )
            .await
        }
    });
    gate.entered().await;
    let lease = Lease {
        effect_id: pending.id,
        owner: WorkerId::new("late-worker"),
        epoch: pending.lease_epoch,
        expires_at: pending.updated_at,
    };
    store
        .append_late_observation(LateObservation::new(
            &pending,
            &lease,
            LateOutcome::Succeeded,
            pending.updated_at + Duration::from_secs(1),
        ))
        .await
        .unwrap();
    assert_eq!(store.inner.get(pending.id).await.unwrap().unwrap(), pending);
    gate.release();
    resolution.await.unwrap().unwrap();
    assert_eq!(
        record(store.inner.as_ref(), "resolution").await.status,
        EffectStatus::Committed
    );
    assert_eq!(
        store
            .inner
            .late_observations(pending.id, None, 10)
            .await
            .unwrap()
            .len(),
        1
    );
    let events = store.inner.events(pending.id).await.unwrap();
    let resolution = events
        .iter()
        .find(|e| e.transition == Transition::ResolvedApplied)
        .unwrap();
    assert_eq!(resolution.actor.as_deref(), Some("operator"));
}

#[tokio::test]
async fn conflicting_operator_resolutions_cannot_overwrite_the_winner() {
    let (store, rt, remote) = setup(Protection::Verified);
    unknown(&rt, &remote).await;
    let pending = record(store.inner.as_ref(), "resolution").await;
    let gate = store.controls.pause(
        Operation::Transition(Transition::ResolvedNotApplied),
        Edge::Before,
    );
    let stale = tokio::spawn({
        let rt = rt.clone();
        async move {
            rt.resolve(pending.id, Resolution::NotApplied, "stale", "not found")
                .await
        }
    });
    gate.entered().await;
    rt.resolve(
        pending.id,
        Resolution::applied(&"resolution#1").unwrap(),
        "winner",
        "provider confirmed",
    )
    .await
    .unwrap();
    gate.release();
    assert!(matches!(
        stale.await.unwrap(),
        Err(RuntimeError::Store(StoreError::VersionConflict { .. }))
    ));
    let committed = record(store.inner.as_ref(), "resolution").await;
    assert_eq!(committed.status, EffectStatus::Committed);
    assert!(
        rt.resolve(pending.id, Resolution::Retry, "late", "repeat")
            .await
            .is_err()
    );
    assert_eq!(
        store.inner.get(pending.id).await.unwrap().unwrap(),
        committed
    );
}

#[tokio::test]
async fn compensation_can_finish_before_operator_retry_acknowledgement() {
    let store = FaultStore::new(MemoryStore::new());
    let clock = Arc::new(ManualClock::default());
    let remote = FakeRemote::new(clock.clone()).script([
        Behavior::Succeed,
        Behavior::Fail(agent_effects::FailureClass::Permanent),
    ]);
    let rt = runtime(
        store.clone(),
        clock,
        remote.clone(),
        Protection::Idempotent,
        "worker",
    );
    rt.submit::<Durable>("undo", "undo".into()).await.unwrap();
    assert!(matches!(
        rt.compensate::<Durable>("undo").await.unwrap(),
        CompensationOutcome::Failed(_)
    ));
    let failed = record(store.inner.as_ref(), "undo").await;
    let gate = store.controls.pause(
        Operation::Transition(Transition::ResolvedRetry),
        Edge::After,
    );
    let retry = tokio::spawn({
        let rt = rt.clone();
        async move {
            rt.resolve(failed.id, Resolution::Retry, "operator", "safe undo retry")
                .await
        }
    });
    gate.entered().await;
    assert_eq!(
        rt.compensate::<Durable>("undo").await.unwrap(),
        CompensationOutcome::Compensated
    );
    gate.release();
    retry.await.unwrap().unwrap();
    assert_eq!(
        record(store.inner.as_ref(), "undo").await.status,
        EffectStatus::Compensated
    );
    assert_eq!(remote.cancellations("undo"), 1);
    let events = store.inner.events(failed.id).await.unwrap();
    assert_eq!(
        events
            .iter()
            .filter(|e| e.transition == Transition::ResolvedRetry)
            .count(),
        1
    );
    assert!(
        rt.resolve(failed.id, Resolution::Retry, "late", "repeat")
            .await
            .is_err()
    );
}

#[tokio::test]
async fn simultaneous_verification_workers_share_one_authoritative_result() {
    let (store, rt, remote) = setup(Protection::Verified);
    unknown(&rt, &remote).await;
    let id = record(store.inner.as_ref(), "resolution").await.id;
    let barrier = Arc::new(tokio::sync::Barrier::new(4));
    let mut tasks = tokio::task::JoinSet::new();
    for index in 0..4 {
        let rt = runtime(
            store.clone(),
            Arc::new(ManualClock::default()),
            remote.clone(),
            Protection::Verified,
            &format!("verifier-{index}"),
        );
        let barrier = barrier.clone();
        tasks.spawn(async move {
            barrier.wait().await;
            rt.recover().await
        });
    }
    while let Some(result) = tasks.join_next().await {
        result.unwrap().unwrap();
    }
    assert_eq!(
        record(store.inner.as_ref(), "resolution").await.status,
        EffectStatus::Committed
    );
    assert_eq!(remote.applications("resolution"), 1);
    assert_eq!(remote.requests(), 1);
    let events = store.inner.events(id).await.unwrap();
    assert_eq!(
        events
            .iter()
            .filter(|event| event.transition == Transition::VerificationConfirmed)
            .count(),
        1
    );
}