runx-core 0.6.19

Pure Rust parity kernel for runx state-machine and policy decisions.
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

use runx_contracts::JsonObject;

use super::super::types::{
    GraphStatus, GraphStepStatus, SequentialGraphEvent, SequentialGraphState,
    SequentialGraphStepState, StepAdmissionWitness,
};

#[must_use]
pub fn transition_sequential_graph(
    state: &SequentialGraphState,
    event: &SequentialGraphEvent,
) -> SequentialGraphState {
    let mut next = state.clone();
    apply_sequential_graph_event(&mut next, event);
    next
}

pub fn apply_sequential_graph_event(
    state: &mut SequentialGraphState,
    event: &SequentialGraphEvent,
) {
    match event {
        SequentialGraphEvent::StartStep { step_id, at } => {
            update_step_in_place(state, step_id, |step| start_step_in_place(step, at));
            state.status = GraphStatus::Running;
        }
        SequentialGraphEvent::StepSucceeded {
            step_id,
            at,
            receipt_id,
            admission_witness,
            outputs,
        } => update_step_in_place(state, step_id, |step| {
            succeed_step_in_place(step, at, receipt_id, admission_witness, outputs.clone())
        }),
        SequentialGraphEvent::StepFailed { step_id, at, error } => {
            update_step_in_place(state, step_id, |step| fail_step_in_place(step, at, error));
        }
        SequentialGraphEvent::StepSkipped { step_id, at } => {
            update_step_in_place(state, step_id, |step| skip_step_in_place(step, at));
        }
        SequentialGraphEvent::Complete if is_graph_complete(state) => {
            state.status = GraphStatus::Succeeded;
        }
        SequentialGraphEvent::Complete => {}
        SequentialGraphEvent::PauseGraph { .. } => {
            state.status = GraphStatus::Paused;
        }
        SequentialGraphEvent::EscalateGraph { .. } => {
            state.status = GraphStatus::Escalated;
        }
        SequentialGraphEvent::FailGraph { .. } => {
            state.status = GraphStatus::Failed;
        }
    }
}

fn start_step_in_place(step: &mut SequentialGraphStepState, at: &str) {
    if matches!(
        step.status,
        GraphStepStatus::Running | GraphStepStatus::Succeeded
    ) {
        return;
    }
    step.status = GraphStepStatus::Running;
    step.attempts += 1;
    step.started_at = Some(at.to_owned());
    step.completed_at = None;
    step.outputs = None;
    step.error = None;
}

fn succeed_step_in_place(
    step: &mut SequentialGraphStepState,
    at: &str,
    receipt_id: &str,
    admission_witness: &StepAdmissionWitness,
    outputs: Option<JsonObject>,
) {
    if step.status != GraphStepStatus::Running {
        return;
    }
    if !admission_witness.matches_step_receipt(&step.step_id, receipt_id) {
        return;
    }
    step.status = GraphStepStatus::Succeeded;
    step.completed_at = Some(at.to_owned());
    step.receipt_id = Some(receipt_id.to_owned());
    step.outputs = outputs;
    step.error = None;
}

fn fail_step_in_place(step: &mut SequentialGraphStepState, at: &str, error: &str) {
    if step.status != GraphStepStatus::Running {
        return;
    }
    step.status = GraphStepStatus::Failed;
    step.completed_at = Some(at.to_owned());
    step.outputs = None;
    step.error = Some(error.to_owned());
}

fn skip_step_in_place(step: &mut SequentialGraphStepState, at: &str) {
    if step.status != GraphStepStatus::Pending {
        return;
    }
    step.status = GraphStepStatus::Skipped;
    step.completed_at = Some(at.to_owned());
    step.outputs = None;
    step.error = None;
}

fn update_step_in_place(
    state: &mut SequentialGraphState,
    step_id: &str,
    update: impl FnOnce(&mut SequentialGraphStepState),
) {
    if let Some(step) = state.steps.iter_mut().find(|step| step.step_id == step_id) {
        update(step);
    }
}

fn is_graph_complete(state: &SequentialGraphState) -> bool {
    state.steps.iter().all(|step| {
        !matches!(
            step.status,
            GraphStepStatus::Pending | GraphStepStatus::Running
        )
    })
}