canic-host 0.111.0

Host-side App build and desired-state Fleet reconciliation library for Canic workspaces
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

//! Passive replay assessment facts and results; original evidence remains separately retained.

use crate::fleet_ensure::view::release::FleetReleaseReceiptsView;
use candid::Principal;
use std::collections::BTreeMap;

/// Host-owned projection of the source's recorded phase, without DTO or storage coupling.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ReleaseReplayState {
    Reserved,
    ExternalEffectInFlight,
    Committed,
    ExternalEffectStatusUnknown,
    ComponentChildLifecycleInterrupted,
    ResponseCommitFailed,
    CostSettlementFailed,
}

/// Local accounting observation, independent of any external effect's outcome.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ReleaseIntentState {
    Missing,
    Pending,
    Committed,
    Aborted,
}

/// Exact linked identity and stored state; expiry does not imply settlement.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct ReleaseIntentFact {
    pub intent_id: u64,
    pub state: ReleaseIntentState,
}

/// Original quota and cycle reservation kept distinct, without summing their quantities.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct ReleaseAccountingFacts {
    pub quota: ReleaseIntentFact,
    pub reservation: ReleaseIntentFact,
}

/// Source-owner replay phase and accounting facts supplied to pure policy.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ReleaseReplayFacts {
    pub slot: [u8; 32],
    pub operation_id: [u8; 32],
    pub status: ReleaseReplayState,
    pub accounting: Option<ReleaseAccountingFacts>,
}

/// Remaining replay-owner work; no variant authorizes dispatch or establishes release readiness.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ReleaseReplayDisposition {
    /// A recorded terminal response, which may describe success or refusal.
    RecordedCompletion,
    /// The receipt is reserved; its operation owner must establish the current outcome.
    ReservedOperation,
    /// An issued effect still needs its original reconciliation authority.
    EffectReconciliation,
    /// The child lifecycle journal owns interruption recovery.
    ChildLifecycleRecovery,
    /// The original owner must recover its response, without redispatching the effect.
    ResponseRecovery,
    /// The original owner must reconcile cost accounting before committing its response.
    AccountingRecovery,
}

/// Receipt disposition and separate accounting observations, keyed back to original evidence.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ReleaseReplayAssessment {
    pub slot: [u8; 32],
    pub operation_id: [u8; 32],
    pub disposition: ReleaseReplayDisposition,
    pub pending_intents: Vec<u64>,
    pub missing_intents: Vec<u64>,
}

/// Complete collected pages alongside their assessments; neither is a producer fence.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct FleetReleaseReplayAssessment {
    pub evidence: FleetReleaseReceiptsView,
    pub owners: BTreeMap<Principal, Vec<ReleaseReplayAssessment>>,
}