meerkat-machine-schema 0.8.13

Formal machine schemas and transition definitions for Meerkat
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

use meerkat_machine_dsl::machine;

use super::OptionValueExt;

machine! {
    machine RuntimeDeliveryMachine {
        version: 1,
        rust: "self" / "catalog::dsl::runtime_delivery",

        state {
            lifecycle_phase: RuntimeDeliveryPhase,
            delivery_ids: Set<String>,
            delivery_sequences: Map<String, u64>,
            delivery_source_sequences: Map<String, u64>,
            committed_sequences: Set<u64>,
            next_sequence: u64,
            applied_cursor: u64,
        }

        init(Active) {
            delivery_ids = EmptySet,
            delivery_sequences = EmptyMap,
            delivery_source_sequences = EmptyMap,
            committed_sequences = EmptySet,
            next_sequence = 0,
            applied_cursor = 0,
        }

        terminal []

        phase RuntimeDeliveryPhase {
            Active,
        }

        input RuntimeDeliveryInput {
            CommitDelivery {
                delivery_id: String,
                source_sequence: u64,
            },
            MarkDeliveryApplied {
                delivery_id: String,
                delivery_sequence: u64,
            },
        }

        effect RuntimeDeliveryEffect {
            DeliveryCommitted {
                delivery_id: String,
                source_sequence: u64,
                delivery_sequence: u64,
            },
            DeliveryReused {
                delivery_id: String,
                source_sequence: u64,
                delivery_sequence: u64,
            },
            DeliveryApplied {
                delivery_id: String,
                delivery_sequence: u64,
            },
        }

        invariant applied_cursor_does_not_pass_committed_sequence {
            self.applied_cursor <= self.next_sequence
        }

        invariant empty_delivery_set_has_zero_sequence {
            self.delivery_ids.len() != 0 || self.next_sequence == 0
        }

        invariant delivery_identity_and_sequence_cardinality_match {
            self.delivery_ids.len() == self.committed_sequences.len()
        }

        invariant committed_sequence_cardinality_tracks_high_water {
            self.committed_sequences.len() == self.next_sequence
        }

        disposition DeliveryCommitted => routed [DetachedJobMachine] seam NoOwnerRealization,
        disposition DeliveryReused => routed [DetachedJobMachine] seam NoOwnerRealization,
        disposition DeliveryApplied => local seam OwnerRealizationOnly,

        transition CommitNewDelivery {
            on input CommitDelivery { delivery_id, source_sequence }
            guard {
                self.lifecycle_phase == Phase::Active
                    && self.delivery_ids.contains(delivery_id) == false
                    && source_sequence > 0
                    && self.next_sequence < u64::MAX
            }
            update {
                self.next_sequence += 1;
                self.delivery_ids.insert(delivery_id);
                self.delivery_sequences.insert(delivery_id, self.next_sequence);
                self.delivery_source_sequences.insert(delivery_id, source_sequence);
                self.committed_sequences.insert(self.next_sequence);
            }
            to Active
            emit DeliveryCommitted {
                delivery_id: delivery_id,
                source_sequence: source_sequence,
                delivery_sequence: self.next_sequence
            }
        }

        transition ReuseCommittedDelivery {
            on input CommitDelivery { delivery_id, source_sequence }
            guard {
                self.lifecycle_phase == Phase::Active
                    && self.delivery_ids.contains(delivery_id)
                    && self.delivery_source_sequences.get_cloned(delivery_id).get("value") == source_sequence
            }
            update {}
            to Active
            emit DeliveryReused {
                delivery_id: delivery_id,
                source_sequence: source_sequence,
                delivery_sequence: self.delivery_sequences.get_cloned(delivery_id).get("value")
            }
        }

        transition ApplyNextDelivery {
            on input MarkDeliveryApplied { delivery_id, delivery_sequence }
            guard {
                self.lifecycle_phase == Phase::Active
                    && self.delivery_ids.contains(delivery_id)
                    && self.delivery_sequences.get_cloned(delivery_id).get("value") == delivery_sequence
                    && delivery_sequence > self.applied_cursor
                    && delivery_sequence - 1 == self.applied_cursor
            }
            update {
                self.applied_cursor = delivery_sequence;
            }
            to Active
            emit DeliveryApplied {
                delivery_id: delivery_id,
                delivery_sequence: delivery_sequence
            }
        }

        transition ObserveAlreadyAppliedDelivery {
            on input MarkDeliveryApplied { delivery_id, delivery_sequence }
            guard {
                self.lifecycle_phase == Phase::Active
                    && self.delivery_ids.contains(delivery_id)
                    && self.delivery_sequences.get_cloned(delivery_id).get("value") == delivery_sequence
                    && delivery_sequence <= self.applied_cursor
            }
            update {}
            to Active
            emit DeliveryApplied {
                delivery_id: delivery_id,
                delivery_sequence: delivery_sequence
            }
        }
    }
}