agent-effects-store 0.2.0

Storage contract for agent-effects: effect records, leases, the state machine and a backend conformance suite
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

//! Supplementary observations that cannot change authoritative effect state.

use std::time::SystemTime;

use serde::{Deserialize, Serialize};

use crate::{EffectId, EffectRecord, Lease, WorkerId};

/// What a worker observed after it could no longer record an authoritative result.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum LateOutcome {
    /// The action returned success; this is not remote verification.
    Succeeded,
    /// The action returned an error; this does not prove non-application.
    Failed,
    /// The action panicked or was cancelled; its outcome is uncertain.
    Interrupted,
}

/// Append-only, untrusted evidence for operator reconciliation.
///
/// No input, output, response body, credential, or error message is retained.
/// Neither this observation nor its timestamps authorize a state transition.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct LateObservation {
    /// Unique observation id, used for idempotent append and pagination.
    pub id: EffectId,
    /// The effect this evidence concerns.
    pub effect_id: EffectId,
    /// The reporting worker.
    pub worker: WorkerId,
    /// The original fencing epoch, not the current holder's epoch.
    pub lease_epoch: u64,
    /// The action attempt, starting at 1.
    pub attempt: u32,
    /// Start timestamp originally persisted by the store, if available.
    pub attempt_started_at: Option<SystemTime>,
    /// The reporting worker's observation time; not a lease clock authority.
    pub observed_at: SystemTime,
    /// What the worker saw, without sensitive response data.
    pub outcome: LateOutcome,
}

impl LateObservation {
    /// Builds supplementary evidence about one attempted action.
    pub fn new(
        record: &EffectRecord,
        lease: &Lease,
        outcome: LateOutcome,
        observed_at: SystemTime,
    ) -> Self {
        Self {
            id: EffectId::new(),
            effect_id: record.id,
            worker: lease.owner.clone(),
            lease_epoch: lease.epoch,
            attempt: record.attempt_count,
            attempt_started_at: record.attempt_started_at,
            observed_at,
            outcome,
        }
    }
}