lenso-service 0.1.24

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
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
use crate::{
    ExtractionQuiescenceRun, ExtractionQuiescenceStatus, ExtractionVerificationResult,
    ExtractionVerificationStatus, extraction_input_digest,
};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::fmt;

pub const EXTRACTION_PROVISIONAL_CUTOVER_PROTOCOL: &str = "lenso.extraction-provisional-cutover.v1";

#[derive(
    Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub enum ExtractionProvisionalCutoverStatus {
    Provisional,
    Verified,
    RolledBack,
}

#[derive(
    Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub enum ExtractionTrafficRoute {
    Linked,
    CandidateVerificationOnly,
}

#[derive(
    Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, JsonSchema,
)]
#[serde(rename_all = "snake_case")]
pub enum ExtractionProvisionalCutoverIssueCode {
    PlanStale,
    AuthorityChanged,
    SourceNotQuiesced,
    FinalReconciliationMissing,
    CandidateUnhealthy,
    CompatibilityVerificationFailed,
    PolicyEvidenceFailed,
    StoryComparisonFailed,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct ExtractionProvisionalCutoverInputs {
    pub plan_id: String,
    pub plan_digest: String,
    pub authority_revision: String,
    pub routing_revision: String,
    pub candidate_service_id: String,
    pub candidate_healthy: bool,
    pub verification: ExtractionVerificationResult,
    pub quiescence: ExtractionQuiescenceRun,
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct ExtractionCutoverReceipt {
    pub step_id: String,
    pub step_digest: String,
    pub from_revision: String,
    pub to_revision: String,
    pub outcome: String,
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct ExtractionCutoverEvidence {
    pub kind: String,
    pub subject: String,
    pub digest: String,
    pub detail: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct ExtractionLinkedRollbackValidation {
    pub validation_digest: String,
    pub authority_revision: String,
    pub routing_revision: String,
    pub business_probe_digest: String,
    pub passed: bool,
}

impl ExtractionLinkedRollbackValidation {
    #[must_use]
    pub fn bind(
        run: &ExtractionProvisionalCutoverRun,
        business_probe_digest: impl Into<String>,
        passed: bool,
    ) -> Self {
        let mut validation = Self {
            validation_digest: String::new(),
            authority_revision: run.authority_revision.clone(),
            routing_revision: run.routing_revision_before.clone(),
            business_probe_digest: business_probe_digest.into(),
            passed,
        };
        validation.validation_digest = rollback_validation_digest(&validation);
        validation
    }

    fn is_valid_for(&self, run: &ExtractionProvisionalCutoverRun) -> bool {
        self.validation_digest == rollback_validation_digest(self)
            && self.authority_revision == run.authority_revision
            && self.routing_revision == run.routing_revision_before
            && !self.business_probe_digest.trim().is_empty()
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "camelCase")]
pub struct ExtractionProvisionalCutoverRun {
    pub protocol: String,
    pub cutover_id: String,
    pub cutover_digest: String,
    pub revision: u64,
    pub status: ExtractionProvisionalCutoverStatus,
    pub plan_id: String,
    pub plan_digest: String,
    pub authority_revision: String,
    pub routing_revision_before: String,
    pub routing_revision_current: String,
    pub candidate_service_id: String,
    pub verification_digest: String,
    pub quiescence_digest: String,
    pub source_high_water_mark: String,
    pub destination_checkpoint: String,
    pub route: ExtractionTrafficRoute,
    pub external_mutations_paused: bool,
    pub linked_mutations_open: bool,
    pub linked_authoritative: bool,
    pub candidate_authoritative: bool,
    pub candidate_healthy: bool,
    pub declared_verification_traffic_only: bool,
    pub verification_effects_isolated: bool,
    pub linked_business_probe_passed: bool,
    #[serde(default)]
    pub apply_receipts: Vec<ExtractionCutoverReceipt>,
    #[serde(default)]
    pub rollback_receipts: Vec<ExtractionCutoverReceipt>,
    #[serde(default)]
    pub evidence: Vec<ExtractionCutoverEvidence>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ExtractionProvisionalCutoverError {
    pub code: ExtractionProvisionalCutoverIssueCode,
    pub message: String,
    pub next_actions: Vec<String>,
}

impl fmt::Display for ExtractionProvisionalCutoverError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(&self.message)
    }
}

impl std::error::Error for ExtractionProvisionalCutoverError {}

pub fn start_provisional_cutover(
    inputs: ExtractionProvisionalCutoverInputs,
) -> Result<ExtractionProvisionalCutoverRun, ExtractionProvisionalCutoverError> {
    if inputs.plan_id != inputs.quiescence.plan_id
        || inputs.plan_digest != inputs.quiescence.plan_digest
        || inputs.plan_id != inputs.verification.plan_id
    {
        return Err(error(
            ExtractionProvisionalCutoverIssueCode::PlanStale,
            "Provisional Cutover evidence does not belong to one exact plan.",
            "Regenerate verification and quiescence evidence for the current plan.",
        ));
    }
    if inputs.authority_revision != inputs.quiescence.expected_authority_revision {
        return Err(error(
            ExtractionProvisionalCutoverIssueCode::AuthorityChanged,
            "Authority changed after quiescence began.",
            "Restore or regenerate evidence for the current linked authority.",
        ));
    }
    if inputs.quiescence.status != ExtractionQuiescenceStatus::Quiesced
        || !inputs.quiescence.linked_mutations_paused
        || !inputs.quiescence.linked_authority_remains_authoritative
    {
        return Err(error(
            ExtractionProvisionalCutoverIssueCode::SourceNotQuiesced,
            "Linked source is not stably quiesced.",
            "Complete drain, final delta, and reconciliation under the write pause.",
        ));
    }
    if inputs.quiescence.stable_source_high_water_mark.is_none()
        || inputs.quiescence.destination_checkpoint.is_none()
    {
        return Err(error(
            ExtractionProvisionalCutoverIssueCode::FinalReconciliationMissing,
            "Stable final reconciliation pins are missing.",
            "Record the final high-water mark and destination checkpoint.",
        ));
    }
    if !inputs.candidate_healthy {
        return Err(error(
            ExtractionProvisionalCutoverIssueCode::CandidateUnhealthy,
            "Candidate health verification failed.",
            "Restore candidate health before provisional routing.",
        ));
    }
    if inputs.verification.status != ExtractionVerificationStatus::Verified
        || !inputs.verification.provisional_cutover_eligible
    {
        return Err(error(
            ExtractionProvisionalCutoverIssueCode::CompatibilityVerificationFailed,
            "Compatibility and behavior verification did not pass.",
            "Remediate all verification blockers before provisional routing.",
        ));
    }
    let identity = digest(&(
        inputs.plan_id.as_str(),
        inputs.plan_digest.as_str(),
        inputs.authority_revision.as_str(),
        inputs.routing_revision.as_str(),
        inputs.verification.verification_digest.as_str(),
        inputs.quiescence.quiescence_digest.as_str(),
    ));
    let provisional_routing_revision = format!("provisional:{identity}");
    let apply_receipt = receipt(
        "route-verification-traffic",
        &inputs.routing_revision,
        &provisional_routing_revision,
        "applied",
    );
    let mut run = ExtractionProvisionalCutoverRun {
        protocol: EXTRACTION_PROVISIONAL_CUTOVER_PROTOCOL.to_owned(),
        cutover_id: format!("extraction-cutover:{identity}"),
        cutover_digest: String::new(),
        revision: 1,
        status: ExtractionProvisionalCutoverStatus::Provisional,
        plan_id: inputs.plan_id,
        plan_digest: inputs.plan_digest,
        authority_revision: inputs.authority_revision,
        routing_revision_before: inputs.routing_revision,
        routing_revision_current: provisional_routing_revision,
        candidate_service_id: inputs.candidate_service_id,
        verification_digest: inputs.verification.verification_digest,
        quiescence_digest: inputs.quiescence.quiescence_digest,
        source_high_water_mark: inputs
            .quiescence
            .stable_source_high_water_mark
            .expect("validated"),
        destination_checkpoint: inputs.quiescence.destination_checkpoint.expect("validated"),
        route: ExtractionTrafficRoute::CandidateVerificationOnly,
        external_mutations_paused: true,
        linked_mutations_open: false,
        linked_authoritative: true,
        candidate_authoritative: false,
        candidate_healthy: true,
        declared_verification_traffic_only: true,
        verification_effects_isolated: true,
        linked_business_probe_passed: false,
        apply_receipts: vec![apply_receipt],
        rollback_receipts: Vec::new(),
        evidence: vec![evidence(
            "provisional_routing",
            "candidate-verification-only",
            &identity,
            "Only declared read-only, recorded, or isolated synthetic verification traffic is routed to the candidate.",
        )],
    };
    refresh(&mut run);
    Ok(run)
}

#[must_use]
pub fn verify_provisional_cutover(
    mut run: ExtractionProvisionalCutoverRun,
    audit_identity: &str,
) -> ExtractionProvisionalCutoverRun {
    if run.status == ExtractionProvisionalCutoverStatus::Provisional {
        run.status = ExtractionProvisionalCutoverStatus::Verified;
        run.evidence.push(evidence(
            "provisional_verification",
            audit_identity,
            &run.verification_digest,
            "Candidate provisional verification passed while external mutations remained paused.",
        ));
        run.revision += 1;
        refresh(&mut run);
    }
    run
}

#[must_use]
pub fn fail_provisional_cutover(
    mut run: ExtractionProvisionalCutoverRun,
    failure: &str,
    audit_identity: &str,
    validation: ExtractionLinkedRollbackValidation,
) -> ExtractionProvisionalCutoverRun {
    if run.status == ExtractionProvisionalCutoverStatus::RolledBack {
        return run;
    }
    let restore_routing = receipt(
        "restore-linked-routing",
        &run.routing_revision_current,
        &run.routing_revision_before,
        "restored",
    );
    let validation_passed = validation.is_valid_for(&run) && validation.passed;
    run.rollback_receipts = vec![restore_routing];
    if validation_passed {
        run.rollback_receipts.push(receipt(
            "reopen-linked-mutations",
            "paused",
            "open",
            "validated",
        ));
    }
    run.status = ExtractionProvisionalCutoverStatus::RolledBack;
    run.routing_revision_current = run.routing_revision_before.clone();
    run.route = ExtractionTrafficRoute::Linked;
    run.external_mutations_paused = !validation_passed;
    run.linked_mutations_open = validation_passed;
    run.linked_authoritative = true;
    run.candidate_authoritative = false;
    run.linked_business_probe_passed = validation_passed;
    run.evidence.push(evidence(
        "rollback",
        audit_identity,
        failure,
        &format!(
            "Candidate verification failed: {failure}. Linked routing and authority were restored without reverse data movement."
        ),
    ));
    run.revision += 1;
    refresh(&mut run);
    run
}

#[must_use]
pub fn complete_provisional_rollback_validation(
    mut run: ExtractionProvisionalCutoverRun,
    validation: ExtractionLinkedRollbackValidation,
) -> ExtractionProvisionalCutoverRun {
    if run.status == ExtractionProvisionalCutoverStatus::RolledBack
        && run.external_mutations_paused
        && validation.is_valid_for(&run)
        && validation.passed
    {
        run.rollback_receipts.push(receipt(
            "reopen-linked-mutations",
            "paused",
            "open",
            "validated",
        ));
        run.external_mutations_paused = false;
        run.linked_mutations_open = true;
        run.linked_business_probe_passed = true;
        run.evidence.push(evidence(
            "linked_business_validation",
            "linked-authority",
            &validation.business_probe_digest,
            "Linked business behavior passed before mutations reopened.",
        ));
        run.revision += 1;
        refresh(&mut run);
    }
    run
}

fn rollback_validation_digest(validation: &ExtractionLinkedRollbackValidation) -> String {
    let mut value = validation.clone();
    value.validation_digest.clear();
    digest(&value)
}

fn error(
    code: ExtractionProvisionalCutoverIssueCode,
    message: &str,
    next_action: &str,
) -> ExtractionProvisionalCutoverError {
    ExtractionProvisionalCutoverError {
        code,
        message: message.to_owned(),
        next_actions: vec![next_action.to_owned()],
    }
}

fn receipt(
    step_id: &str,
    from_revision: &str,
    to_revision: &str,
    outcome: &str,
) -> ExtractionCutoverReceipt {
    let step_digest = digest(&(step_id, from_revision, to_revision, outcome));
    ExtractionCutoverReceipt {
        step_id: step_id.to_owned(),
        step_digest,
        from_revision: from_revision.to_owned(),
        to_revision: to_revision.to_owned(),
        outcome: outcome.to_owned(),
    }
}

fn evidence(kind: &str, subject: &str, value: &str, detail: &str) -> ExtractionCutoverEvidence {
    ExtractionCutoverEvidence {
        kind: kind.to_owned(),
        subject: subject.to_owned(),
        digest: extraction_input_digest(value.as_bytes()),
        detail: detail.to_owned(),
    }
}

fn refresh(run: &mut ExtractionProvisionalCutoverRun) {
    run.cutover_digest.clear();
    run.cutover_digest = digest(run);
}

#[must_use]
pub fn extraction_provisional_cutover_integrity_is_valid(
    run: &ExtractionProvisionalCutoverRun,
) -> bool {
    if run.protocol != EXTRACTION_PROVISIONAL_CUTOVER_PROTOCOL {
        return false;
    }
    let mut value = run.clone();
    value.cutover_digest.clear();
    run.cutover_digest == digest(&value)
}

fn digest(value: &impl Serialize) -> String {
    extraction_input_digest(&serde_json::to_vec(value).expect("Cutover values serialize"))
}