lenso-service 0.1.16

Public contracts for Lenso Providers and Autonomous Services.
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

use crate::{EffectiveReliabilityValues, ReliabilityProfile, ReliabilityProfileOverrides};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use utoipa::ToSchema;

pub const RELIABILITY_REPORT_PROTOCOL: &str = "lenso.reliability-report.v1";

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "snake_case")]
pub enum ReliabilityServiceState {
    Healthy,
    Degraded,
    Unavailable,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "snake_case")]
pub enum ReliabilityCheckState {
    Met,
    Breached,
    Unknown,
    Allowed,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "snake_case")]
pub enum ReliabilityIssueCode {
    ServiceRuntimeUnavailable,
    DependencyCriticalUnavailable,
    DependencyDegradableUnavailable,
    DependencyObservationMissing,
    QueueBacklogLimitExceeded,
    WorkflowBacklogLimitExceeded,
    TimerLagLimitExceeded,
    RetryExhaustionLimitExceeded,
    CompensationPressureLimitExceeded,
    AvailabilityTargetBreached,
    LatencyTargetBreached,
    ErrorBudgetLimitExceeded,
    ReliabilityObservationMissing,
    ReliabilityObservationSourceUnavailable,
    ReliabilityStoreObservationUnavailable,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct ReliabilityCheck {
    pub code: String,
    pub state: ReliabilityCheckState,
    pub observed: Value,
    pub expected: Value,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub evidence_references: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub issue_code: Option<ReliabilityIssueCode>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub next_actions: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct ActiveDegradedMode {
    pub dependency_id: String,
    pub mode: String,
    pub evidence_references: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct ReliabilityHealthResult {
    pub healthy: bool,
    pub semantics: String,
    pub issue_codes: Vec<ReliabilityIssueCode>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct ReliabilityEnforcementBoundary {
    pub reports_only: bool,
    pub blocks_production_promotion: bool,
    pub executes_canary_policy: bool,
    pub triggers_automated_rollback: bool,
}

impl Default for ReliabilityEnforcementBoundary {
    fn default() -> Self {
        Self {
            reports_only: true,
            blocks_production_promotion: false,
            executes_canary_policy: false,
            triggers_automated_rollback: false,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct ReliabilityReport {
    pub protocol: String,
    pub service_id: String,
    pub contract_id: String,
    pub contract_version: String,
    pub profile: ReliabilityProfile,
    #[serde(default)]
    pub overrides: ReliabilityProfileOverrides,
    pub effective_values: EffectiveReliabilityValues,
    pub state: ReliabilityServiceState,
    pub liveness: ReliabilityHealthResult,
    pub readiness: ReliabilityHealthResult,
    pub active_degraded_modes: Vec<ActiveDegradedMode>,
    pub checks: Vec<ReliabilityCheck>,
    pub enforcement: ReliabilityEnforcementBoundary,
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn v1_report_without_explicit_overrides_remains_readable() {
        let report = serde_json::from_value::<ReliabilityReport>(json!({
            "protocol": RELIABILITY_REPORT_PROTOCOL,
            "serviceId": "support-sla",
            "contractId": "support-reliability",
            "contractVersion": "v1",
            "profile": "standard",
            "effectiveValues": {
                "availabilityTargetBasisPoints": 9950,
                "latencyTargetMs": 1000,
                "queueBacklogLimit": 100,
                "workflowBacklogLimit": 100,
                "timerLagLimitMs": 1000,
                "retryExhaustionLimit": 5,
                "compensationPressureLimit": 5,
                "errorBudget": "rolling_30d",
                "errorBudgetConsumedLimitBasisPoints": 10000,
                "readiness": "serving",
                "liveness": "process_running"
            },
            "state": "healthy",
            "liveness": {
                "healthy": true,
                "semantics": "process_running",
                "issueCodes": []
            },
            "readiness": {
                "healthy": true,
                "semantics": "serving",
                "issueCodes": []
            },
            "activeDegradedModes": [],
            "checks": [],
            "enforcement": {
                "reportsOnly": true,
                "blocksProductionPromotion": false,
                "executesCanaryPolicy": false,
                "triggersAutomatedRollback": false
            }
        }))
        .expect("legacy v1 report should deserialize");

        assert_eq!(report.overrides, ReliabilityProfileOverrides::default());
    }
}