meerkat-machine-schema 0.5.1

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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
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 mob_orchestrator_machine() -> MachineSchema {
    MachineSchema {
        machine: "MobOrchestratorMachine".into(),
        version: 2,
        rust: RustBinding {
            crate_name: "meerkat-mob".into(),
            module: "generated::mob_orchestrator".into(),
        },
        state: StateSchema {
            phase: EnumSchema {
                name: "OrchestratorState".into(),
                variants: vec![
                    variant("Creating"),
                    variant("Running"),
                    variant("Stopped"),
                    variant("Completed"),
                    variant("Destroyed"),
                ],
            },
            fields: vec![
                field("coordinator_bound", TypeRef::Bool),
                field("pending_spawn_count", TypeRef::U32),
                field("active_flow_count", TypeRef::U32),
                field("topology_revision", TypeRef::U32),
                field("supervisor_active", TypeRef::Bool),
            ],
            init: InitSchema {
                phase: "Creating".into(),
                fields: vec![
                    init("coordinator_bound", Expr::Bool(false)),
                    init("pending_spawn_count", Expr::U64(0)),
                    init("active_flow_count", Expr::U64(0)),
                    init("topology_revision", Expr::U64(0)),
                    init("supervisor_active", Expr::Bool(false)),
                ],
            },
            terminal_phases: vec!["Destroyed".into()],
        },
        inputs: EnumSchema {
            name: "MobOrchestratorInput".into(),
            variants: vec![
                variant("InitializeOrchestrator"),
                variant("BindCoordinator"),
                variant("UnbindCoordinator"),
                variant("StageSpawn"),
                variant("CompleteSpawn"),
                variant("StartFlow"),
                variant("CompleteFlow"),
                variant("StopOrchestrator"),
                variant("ResumeOrchestrator"),
                variant("MarkCompleted"),
                variant("DestroyOrchestrator"),
                // Phase C: force-cancel a member's in-flight turn
                variant("ForceCancelMember"),
            ],
        },
        effects: EnumSchema {
            name: "MobOrchestratorEffect".into(),
            variants: vec![
                variant("ActivateSupervisor"),
                variant("DeactivateSupervisor"),
                variant("FlowActivated"),
                variant("FlowDeactivated"),
                variant("EmitOrchestratorNotice"),
                // Phase C: member force-cancel initiated
                variant("MemberForceCancelled"),
            ],
        },
        helpers: vec![],
        derived: vec![],
        invariants: vec![InvariantSchema {
            name: "destroyed_is_terminal".into(),
            expr: Expr::Or(vec![
                Expr::Neq(
                    Box::new(Expr::CurrentPhase),
                    Box::new(Expr::Phase("Destroyed".into())),
                ),
                Expr::Neq(
                    Box::new(Expr::Field("supervisor_active".into())),
                    Box::new(Expr::Bool(true)),
                ),
            ]),
        }],
        transitions: vec![
            TransitionSchema {
                name: "InitializeOrchestrator".into(),
                from: vec!["Creating".into()],
                on: InputMatch {
                    variant: "InitializeOrchestrator".into(),
                    bindings: vec![],
                },
                guards: vec![],
                updates: vec![Update::Assign {
                    field: "supervisor_active".into(),
                    expr: Expr::Bool(true),
                }],
                to: "Running".into(),
                emit: vec![EffectEmit {
                    variant: "ActivateSupervisor".into(),
                    fields: IndexMap::new(),
                }],
            },
            TransitionSchema {
                name: "BindCoordinator".into(),
                from: vec!["Running".into(), "Stopped".into(), "Completed".into()],
                on: InputMatch {
                    variant: "BindCoordinator".into(),
                    bindings: vec![],
                },
                guards: vec![Guard {
                    name: "coordinator_is_not_bound".into(),
                    expr: Expr::Eq(
                        Box::new(Expr::Field("coordinator_bound".into())),
                        Box::new(Expr::Bool(false)),
                    ),
                }],
                updates: vec![
                    Update::Assign {
                        field: "coordinator_bound".into(),
                        expr: Expr::Bool(true),
                    },
                    Update::Increment {
                        field: "topology_revision".into(),
                        amount: 1,
                    },
                ],
                to: "Running".into(),
                emit: vec![EffectEmit {
                    variant: "EmitOrchestratorNotice".into(),
                    fields: IndexMap::new(),
                }],
            },
            TransitionSchema {
                name: "UnbindCoordinator".into(),
                from: vec!["Running".into(), "Stopped".into(), "Completed".into()],
                on: InputMatch {
                    variant: "UnbindCoordinator".into(),
                    bindings: vec![],
                },
                guards: vec![
                    Guard {
                        name: "coordinator_is_bound".into(),
                        expr: Expr::Eq(
                            Box::new(Expr::Field("coordinator_bound".into())),
                            Box::new(Expr::Bool(true)),
                        ),
                    },
                    Guard {
                        name: "no_pending_spawns".into(),
                        expr: Expr::Eq(
                            Box::new(Expr::Field("pending_spawn_count".into())),
                            Box::new(Expr::U64(0)),
                        ),
                    },
                ],
                updates: vec![
                    Update::Assign {
                        field: "coordinator_bound".into(),
                        expr: Expr::Bool(false),
                    },
                    Update::Increment {
                        field: "topology_revision".into(),
                        amount: 1,
                    },
                ],
                to: "Stopped".into(),
                emit: vec![EffectEmit {
                    variant: "EmitOrchestratorNotice".into(),
                    fields: IndexMap::new(),
                }],
            },
            TransitionSchema {
                name: "StageSpawn".into(),
                from: vec!["Running".into()],
                on: InputMatch {
                    variant: "StageSpawn".into(),
                    bindings: vec![],
                },
                guards: vec![Guard {
                    name: "coordinator_is_bound".into(),
                    expr: Expr::Eq(
                        Box::new(Expr::Field("coordinator_bound".into())),
                        Box::new(Expr::Bool(true)),
                    ),
                }],
                updates: vec![
                    Update::Increment {
                        field: "pending_spawn_count".into(),
                        amount: 1,
                    },
                    Update::Increment {
                        field: "topology_revision".into(),
                        amount: 1,
                    },
                ],
                to: "Running".into(),
                emit: vec![EffectEmit {
                    variant: "EmitOrchestratorNotice".into(),
                    fields: IndexMap::new(),
                }],
            },
            TransitionSchema {
                name: "CompleteSpawn".into(),
                from: vec!["Running".into(), "Stopped".into()],
                on: InputMatch {
                    variant: "CompleteSpawn".into(),
                    bindings: vec![],
                },
                guards: vec![Guard {
                    name: "has_pending_spawns".into(),
                    expr: Expr::Gt(
                        Box::new(Expr::Field("pending_spawn_count".into())),
                        Box::new(Expr::U64(0)),
                    ),
                }],
                updates: vec![
                    Update::Decrement {
                        field: "pending_spawn_count".into(),
                        amount: 1,
                    },
                    Update::Increment {
                        field: "topology_revision".into(),
                        amount: 1,
                    },
                ],
                to: "Running".into(),
                emit: vec![EffectEmit {
                    variant: "EmitOrchestratorNotice".into(),
                    fields: IndexMap::new(),
                }],
            },
            TransitionSchema {
                name: "StartFlow".into(),
                from: vec!["Running".into(), "Completed".into()],
                on: InputMatch {
                    variant: "StartFlow".into(),
                    bindings: vec![],
                },
                guards: vec![Guard {
                    name: "coordinator_is_bound".into(),
                    expr: Expr::Eq(
                        Box::new(Expr::Field("coordinator_bound".into())),
                        Box::new(Expr::Bool(true)),
                    ),
                }],
                updates: vec![Update::Increment {
                    field: "active_flow_count".into(),
                    amount: 1,
                }],
                to: "Running".into(),
                emit: vec![
                    EffectEmit {
                        variant: "FlowActivated".into(),
                        fields: IndexMap::new(),
                    },
                    EffectEmit {
                        variant: "EmitOrchestratorNotice".into(),
                        fields: IndexMap::new(),
                    },
                ],
            },
            TransitionSchema {
                name: "CompleteFlow".into(),
                from: vec!["Running".into(), "Completed".into()],
                on: InputMatch {
                    variant: "CompleteFlow".into(),
                    bindings: vec![],
                },
                guards: vec![Guard {
                    name: "has_active_flows".into(),
                    expr: Expr::Gt(
                        Box::new(Expr::Field("active_flow_count".into())),
                        Box::new(Expr::U64(0)),
                    ),
                }],
                updates: vec![Update::Decrement {
                    field: "active_flow_count".into(),
                    amount: 1,
                }],
                to: "Running".into(),
                emit: vec![
                    EffectEmit {
                        variant: "FlowDeactivated".into(),
                        fields: IndexMap::new(),
                    },
                    EffectEmit {
                        variant: "EmitOrchestratorNotice".into(),
                        fields: IndexMap::new(),
                    },
                ],
            },
            TransitionSchema {
                name: "StopOrchestrator".into(),
                from: vec!["Running".into(), "Completed".into()],
                on: InputMatch {
                    variant: "StopOrchestrator".into(),
                    bindings: vec![],
                },
                guards: vec![Guard {
                    name: "no_active_flows".into(),
                    expr: Expr::Eq(
                        Box::new(Expr::Field("active_flow_count".into())),
                        Box::new(Expr::U64(0)),
                    ),
                }],
                updates: vec![Update::Assign {
                    field: "supervisor_active".into(),
                    expr: Expr::Bool(false),
                }],
                to: "Stopped".into(),
                emit: vec![EffectEmit {
                    variant: "DeactivateSupervisor".into(),
                    fields: IndexMap::new(),
                }],
            },
            TransitionSchema {
                name: "ResumeOrchestrator".into(),
                from: vec!["Stopped".into()],
                on: InputMatch {
                    variant: "ResumeOrchestrator".into(),
                    bindings: vec![],
                },
                guards: vec![Guard {
                    name: "coordinator_is_bound".into(),
                    expr: Expr::Eq(
                        Box::new(Expr::Field("coordinator_bound".into())),
                        Box::new(Expr::Bool(true)),
                    ),
                }],
                updates: vec![Update::Assign {
                    field: "supervisor_active".into(),
                    expr: Expr::Bool(true),
                }],
                to: "Running".into(),
                emit: vec![EffectEmit {
                    variant: "ActivateSupervisor".into(),
                    fields: IndexMap::new(),
                }],
            },
            TransitionSchema {
                name: "MarkCompleted".into(),
                from: vec!["Running".into(), "Stopped".into()],
                on: InputMatch {
                    variant: "MarkCompleted".into(),
                    bindings: vec![],
                },
                guards: vec![
                    Guard {
                        name: "no_active_flows".into(),
                        expr: Expr::Eq(
                            Box::new(Expr::Field("active_flow_count".into())),
                            Box::new(Expr::U64(0)),
                        ),
                    },
                    Guard {
                        name: "no_pending_spawns".into(),
                        expr: Expr::Eq(
                            Box::new(Expr::Field("pending_spawn_count".into())),
                            Box::new(Expr::U64(0)),
                        ),
                    },
                ],
                updates: vec![],
                to: "Completed".into(),
                emit: vec![EffectEmit {
                    variant: "EmitOrchestratorNotice".into(),
                    fields: IndexMap::new(),
                }],
            },
            TransitionSchema {
                name: "DestroyOrchestrator".into(),
                from: vec!["Stopped".into(), "Completed".into()],
                on: InputMatch {
                    variant: "DestroyOrchestrator".into(),
                    bindings: vec![],
                },
                guards: vec![
                    Guard {
                        name: "no_pending_spawns".into(),
                        expr: Expr::Eq(
                            Box::new(Expr::Field("pending_spawn_count".into())),
                            Box::new(Expr::U64(0)),
                        ),
                    },
                    Guard {
                        name: "no_active_flows".into(),
                        expr: Expr::Eq(
                            Box::new(Expr::Field("active_flow_count".into())),
                            Box::new(Expr::U64(0)),
                        ),
                    },
                ],
                updates: vec![
                    Update::Assign {
                        field: "supervisor_active".into(),
                        expr: Expr::Bool(false),
                    },
                    Update::Assign {
                        field: "coordinator_bound".into(),
                        expr: Expr::Bool(false),
                    },
                ],
                to: "Destroyed".into(),
                emit: vec![
                    EffectEmit {
                        variant: "DeactivateSupervisor".into(),
                        fields: IndexMap::new(),
                    },
                    EffectEmit {
                        variant: "EmitOrchestratorNotice".into(),
                        fields: IndexMap::new(),
                    },
                ],
            },
            // Phase C: ForceCancelMember — cancels in-flight turn
            TransitionSchema {
                name: "ForceCancelMember".into(),
                from: vec!["Running".into()],
                on: InputMatch {
                    variant: "ForceCancelMember".into(),
                    bindings: vec![],
                },
                guards: vec![Guard {
                    name: "coordinator_is_bound".into(),
                    expr: Expr::Eq(
                        Box::new(Expr::Field("coordinator_bound".into())),
                        Box::new(Expr::Bool(true)),
                    ),
                }],
                updates: vec![],
                to: "Running".into(),
                emit: vec![
                    EffectEmit {
                        variant: "MemberForceCancelled".into(),
                        fields: IndexMap::new(),
                    },
                    EffectEmit {
                        variant: "EmitOrchestratorNotice".into(),
                        fields: IndexMap::new(),
                    },
                ],
            },
        ],
        ci_step_limit: None,
        effect_dispositions: vec![
            disposition(
                "ActivateSupervisor",
                EffectDisposition::Routed {
                    consumer_machines: vec!["MobLifecycleMachine".into()],
                },
            ),
            disposition(
                "DeactivateSupervisor",
                EffectDisposition::Routed {
                    consumer_machines: vec!["MobLifecycleMachine".into()],
                },
            ),
            disposition(
                "FlowActivated",
                EffectDisposition::Routed {
                    consumer_machines: vec!["FlowRunMachine".into(), "MobLifecycleMachine".into()],
                },
            ),
            disposition(
                "FlowDeactivated",
                EffectDisposition::Routed {
                    consumer_machines: vec!["MobLifecycleMachine".into()],
                },
            ),
            disposition("EmitOrchestratorNotice", EffectDisposition::External),
            disposition(
                "MemberForceCancelled",
                EffectDisposition::Routed {
                    consumer_machines: vec!["RuntimeControlMachine".into()],
                },
            ),
        ],
    }
}

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

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,
    }
}

#[cfg(test)]
mod tests {
    use super::mob_orchestrator_machine;

    #[test]
    fn validates_mob_orchestrator_style_machine() {
        let schema = mob_orchestrator_machine();

        assert_eq!(schema.machine, "MobOrchestratorMachine");
        assert_eq!(schema.rust.crate_name, "meerkat-mob");
        assert_eq!(schema.rust.module, "generated::mob_orchestrator");
        assert!(
            schema
                .transitions
                .iter()
                .any(|transition| transition.name == "InitializeOrchestrator")
        );
        assert_eq!(schema.validate(), Ok(()));
    }
}