meerkat-machine-schema 0.5.0

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
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
434
435
436
use indexmap::IndexMap;

use crate::{
    EffectDisposition, EffectDispositionRule, EffectEmit, EnumSchema, Expr, FieldInit, FieldSchema,
    Guard, InitSchema, InputMatch, InvariantSchema, MachineSchema, RustBinding, StateSchema,
    TransitionSchema, TypeRef, Update, VariantSchema,
};

pub fn input_lifecycle_machine() -> MachineSchema {
    MachineSchema {
        machine: "InputLifecycleMachine".into(),
        version: 1,
        rust: RustBinding {
            crate_name: "meerkat-runtime".into(),
            module: "generated::input_lifecycle".into(),
        },
        state: StateSchema {
            phase: EnumSchema {
                name: "InputLifecycleState".into(),
                variants: vec![
                    variant("Accepted"),
                    variant("Queued"),
                    variant("Staged"),
                    variant("Applied"),
                    variant("AppliedPendingConsumption"),
                    variant("Consumed"),
                    variant("Superseded"),
                    variant("Coalesced"),
                    variant("Abandoned"),
                ],
            },
            fields: vec![
                field(
                    "terminal_outcome",
                    TypeRef::Option(Box::new(TypeRef::Named("InputTerminalOutcome".into()))),
                ),
                field(
                    "last_run_id",
                    TypeRef::Option(Box::new(TypeRef::Named("RunId".into()))),
                ),
                field(
                    "last_boundary_sequence",
                    TypeRef::Option(Box::new(TypeRef::Named("BoundarySequence".into()))),
                ),
            ],
            init: InitSchema {
                phase: "Accepted".into(),
                fields: vec![
                    init("terminal_outcome", Expr::None),
                    init("last_run_id", Expr::None),
                    init("last_boundary_sequence", Expr::None),
                ],
            },
            terminal_phases: vec![
                "Consumed".into(),
                "Superseded".into(),
                "Coalesced".into(),
                "Abandoned".into(),
            ],
        },
        inputs: EnumSchema {
            name: "InputLifecycleInput".into(),
            variants: vec![
                variant("QueueAccepted"),
                VariantSchema {
                    name: "StageForRun".into(),
                    fields: vec![field("run_id", TypeRef::Named("RunId".into()))],
                },
                variant("RollbackStaged"),
                VariantSchema {
                    name: "MarkApplied".into(),
                    fields: vec![field("run_id", TypeRef::Named("RunId".into()))],
                },
                VariantSchema {
                    name: "MarkAppliedPendingConsumption".into(),
                    fields: vec![field(
                        "boundary_sequence",
                        TypeRef::Named("BoundarySequence".into()),
                    )],
                },
                variant("Consume"),
                variant("ConsumeOnAccept"),
                variant("Supersede"),
                variant("Coalesce"),
                variant("Abandon"),
            ],
        },
        effects: EnumSchema {
            name: "InputLifecycleEffect".into(),
            variants: vec![
                VariantSchema {
                    name: "InputLifecycleNotice".into(),
                    fields: vec![field(
                        "new_state",
                        TypeRef::Named("InputLifecycleState".into()),
                    )],
                },
                VariantSchema {
                    name: "RecordTerminalOutcome".into(),
                    fields: vec![field(
                        "outcome",
                        TypeRef::Named("InputTerminalOutcome".into()),
                    )],
                },
                VariantSchema {
                    name: "RecordRunAssociation".into(),
                    fields: vec![field("run_id", TypeRef::Named("RunId".into()))],
                },
                VariantSchema {
                    name: "RecordBoundarySequence".into(),
                    fields: vec![field(
                        "boundary_sequence",
                        TypeRef::Named("BoundarySequence".into()),
                    )],
                },
            ],
        },
        helpers: vec![],
        derived: vec![],
        invariants: vec![
            InvariantSchema {
                name: "accepted_has_no_run_or_boundary_metadata".into(),
                expr: Expr::Or(vec![
                    Expr::Neq(
                        Box::new(Expr::CurrentPhase),
                        Box::new(Expr::Phase("Accepted".into())),
                    ),
                    Expr::And(vec![
                        Expr::Eq(
                            Box::new(Expr::Field("last_run_id".into())),
                            Box::new(Expr::None),
                        ),
                        Expr::Eq(
                            Box::new(Expr::Field("last_boundary_sequence".into())),
                            Box::new(Expr::None),
                        ),
                    ]),
                ]),
            },
            InvariantSchema {
                name: "boundary_metadata_requires_application".into(),
                expr: Expr::Or(vec![
                    Expr::Eq(
                        Box::new(Expr::Field("last_boundary_sequence".into())),
                        Box::new(Expr::None),
                    ),
                    Expr::Or(vec![
                        Expr::Eq(
                            Box::new(Expr::CurrentPhase),
                            Box::new(Expr::Phase("AppliedPendingConsumption".into())),
                        ),
                        Expr::Eq(
                            Box::new(Expr::CurrentPhase),
                            Box::new(Expr::Phase("Consumed".into())),
                        ),
                        Expr::Eq(
                            Box::new(Expr::CurrentPhase),
                            Box::new(Expr::Phase("Abandoned".into())),
                        ),
                    ]),
                ]),
            },
        ],
        transitions: vec![
            transition(
                "QueueAccepted",
                &["Accepted"],
                "QueueAccepted",
                &[],
                &[notice("Queued")],
                "Queued",
            ),
            TransitionSchema {
                name: "StageForRun".into(),
                from: vec!["Queued".into()],
                on: InputMatch {
                    variant: "StageForRun".into(),
                    bindings: vec!["run_id".into()],
                },
                guards: vec![],
                updates: vec![Update::Assign {
                    field: "last_run_id".into(),
                    expr: Expr::Some(Box::new(Expr::Binding("run_id".into()))),
                }],
                to: "Staged".into(),
                emit: vec![
                    notice("Staged"),
                    EffectEmit {
                        variant: "RecordRunAssociation".into(),
                        fields: IndexMap::from([("run_id".into(), Expr::Binding("run_id".into()))]),
                    },
                ],
            },
            transition(
                "RollbackStaged",
                &["Staged"],
                "RollbackStaged",
                &[],
                &[notice("Queued")],
                "Queued",
            ),
            TransitionSchema {
                name: "MarkApplied".into(),
                from: vec!["Staged".into()],
                on: InputMatch {
                    variant: "MarkApplied".into(),
                    bindings: vec!["run_id".into()],
                },
                guards: vec![Guard {
                    name: "matches_last_run".into(),
                    expr: Expr::Eq(
                        Box::new(Expr::Field("last_run_id".into())),
                        Box::new(Expr::Some(Box::new(Expr::Binding("run_id".into())))),
                    ),
                }],
                updates: vec![],
                to: "Applied".into(),
                emit: vec![notice("Applied")],
            },
            TransitionSchema {
                name: "MarkAppliedPendingConsumption".into(),
                from: vec!["Applied".into()],
                on: InputMatch {
                    variant: "MarkAppliedPendingConsumption".into(),
                    bindings: vec!["boundary_sequence".into()],
                },
                guards: vec![],
                updates: vec![Update::Assign {
                    field: "last_boundary_sequence".into(),
                    expr: Expr::Some(Box::new(Expr::Binding("boundary_sequence".into()))),
                }],
                to: "AppliedPendingConsumption".into(),
                emit: vec![
                    notice("AppliedPendingConsumption"),
                    EffectEmit {
                        variant: "RecordBoundarySequence".into(),
                        fields: IndexMap::from([(
                            "boundary_sequence".into(),
                            Expr::Binding("boundary_sequence".into()),
                        )]),
                    },
                ],
            },
            TransitionSchema {
                name: "Consume".into(),
                from: vec!["AppliedPendingConsumption".into()],
                on: InputMatch {
                    variant: "Consume".into(),
                    bindings: vec![],
                },
                guards: vec![],
                updates: vec![Update::Assign {
                    field: "terminal_outcome".into(),
                    expr: Expr::Some(Box::new(Expr::String("Consumed".into()))),
                }],
                to: "Consumed".into(),
                emit: vec![
                    notice("Consumed"),
                    EffectEmit {
                        variant: "RecordTerminalOutcome".into(),
                        fields: IndexMap::from([(
                            "outcome".into(),
                            Expr::String("Consumed".into()),
                        )]),
                    },
                ],
            },
            TransitionSchema {
                name: "ConsumeOnAccept".into(),
                from: vec!["Accepted".into()],
                on: InputMatch {
                    variant: "ConsumeOnAccept".into(),
                    bindings: vec![],
                },
                guards: vec![],
                updates: vec![Update::Assign {
                    field: "terminal_outcome".into(),
                    expr: Expr::Some(Box::new(Expr::String("Consumed".into()))),
                }],
                to: "Consumed".into(),
                emit: vec![
                    notice("Consumed"),
                    EffectEmit {
                        variant: "RecordTerminalOutcome".into(),
                        fields: IndexMap::from([(
                            "outcome".into(),
                            Expr::String("Consumed".into()),
                        )]),
                    },
                ],
            },
            TransitionSchema {
                name: "Supersede".into(),
                from: vec!["Queued".into()],
                on: InputMatch {
                    variant: "Supersede".into(),
                    bindings: vec![],
                },
                guards: vec![],
                updates: vec![Update::Assign {
                    field: "terminal_outcome".into(),
                    expr: Expr::Some(Box::new(Expr::String("Superseded".into()))),
                }],
                to: "Superseded".into(),
                emit: vec![
                    notice("Superseded"),
                    EffectEmit {
                        variant: "RecordTerminalOutcome".into(),
                        fields: IndexMap::from([(
                            "outcome".into(),
                            Expr::String("Superseded".into()),
                        )]),
                    },
                ],
            },
            TransitionSchema {
                name: "Coalesce".into(),
                from: vec!["Queued".into()],
                on: InputMatch {
                    variant: "Coalesce".into(),
                    bindings: vec![],
                },
                guards: vec![],
                updates: vec![Update::Assign {
                    field: "terminal_outcome".into(),
                    expr: Expr::Some(Box::new(Expr::String("Coalesced".into()))),
                }],
                to: "Coalesced".into(),
                emit: vec![
                    notice("Coalesced"),
                    EffectEmit {
                        variant: "RecordTerminalOutcome".into(),
                        fields: IndexMap::from([(
                            "outcome".into(),
                            Expr::String("Coalesced".into()),
                        )]),
                    },
                ],
            },
            TransitionSchema {
                name: "Abandon".into(),
                from: vec![
                    "Accepted".into(),
                    "Queued".into(),
                    "Staged".into(),
                    "Applied".into(),
                    "AppliedPendingConsumption".into(),
                ],
                on: InputMatch {
                    variant: "Abandon".into(),
                    bindings: vec![],
                },
                guards: vec![],
                updates: vec![Update::Assign {
                    field: "terminal_outcome".into(),
                    expr: Expr::Some(Box::new(Expr::String("Abandoned".into()))),
                }],
                to: "Abandoned".into(),
                emit: vec![
                    notice("Abandoned"),
                    EffectEmit {
                        variant: "RecordTerminalOutcome".into(),
                        fields: IndexMap::from([(
                            "outcome".into(),
                            Expr::String("Abandoned".into()),
                        )]),
                    },
                ],
            },
        ],
        effect_dispositions: vec![
            disposition("InputLifecycleNotice", EffectDisposition::Local),
            disposition("RecordTerminalOutcome", EffectDisposition::Local),
            disposition("RecordRunAssociation", EffectDisposition::Local),
            disposition("RecordBoundarySequence", EffectDisposition::Local),
        ],
    }
}

fn disposition(name: &str, d: EffectDisposition) -> EffectDispositionRule {
    EffectDispositionRule {
        effect_variant: name.into(),
        disposition: d,
        handoff_protocol: None,
    }
}

fn transition(
    name: &str,
    from: &[&str],
    on: &str,
    bindings: &[&str],
    emit: &[EffectEmit],
    to: &str,
) -> TransitionSchema {
    TransitionSchema {
        name: name.into(),
        from: from.iter().map(|phase| (*phase).into()).collect(),
        on: InputMatch {
            variant: on.into(),
            bindings: bindings.iter().map(|binding| (*binding).into()).collect(),
        },
        guards: vec![],
        updates: vec![],
        to: to.into(),
        emit: emit.to_vec(),
    }
}

fn notice(new_state: &str) -> EffectEmit {
    EffectEmit {
        variant: "InputLifecycleNotice".into(),
        fields: IndexMap::from([("new_state".into(), Expr::String(new_state.into()))]),
    }
}

fn variant(name: &str) -> VariantSchema {
    VariantSchema {
        name: name.into(),
        fields: vec![],
    }
}

fn field(name: &str, ty: TypeRef) -> FieldSchema {
    FieldSchema {
        name: name.into(),
        ty,
    }
}

fn init(field: &str, expr: Expr) -> FieldInit {
    FieldInit {
        field: field.into(),
        expr,
    }
}