meerkat-machine-schema 0.5.2

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
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 schedule_lifecycle_machine() -> MachineSchema {
    MachineSchema {
        machine: "ScheduleLifecycleMachine".into(),
        version: 1,
        rust: RustBinding {
            crate_name: "meerkat-schedule".into(),
            module: "generated::schedule_lifecycle".into(),
        },
        state: StateSchema {
            phase: EnumSchema {
                name: "ScheduleLifecycleState".into(),
                variants: vec![variant("Active"), variant("Paused"), variant("Deleted")],
            },
            fields: vec![
                field("revision", TypeRef::U64),
                field("trigger_key", TypeRef::String),
                field("target_binding_key", TypeRef::String),
                field("misfire_policy", TypeRef::Enum("MisfirePolicy".into())),
                field("overlap_policy", TypeRef::Enum("OverlapPolicy".into())),
                field(
                    "missing_target_policy",
                    TypeRef::Enum("MissingTargetPolicy".into()),
                ),
                field(
                    "planning_cursor_utc_ms",
                    TypeRef::Option(Box::new(TypeRef::U64)),
                ),
                field("next_occurrence_ordinal", TypeRef::U64),
            ],
            init: InitSchema {
                phase: "Active".into(),
                fields: vec![
                    init("revision", Expr::U64(1)),
                    init("trigger_key", Expr::String("trigger-0".into())),
                    init("target_binding_key", Expr::String("target-0".into())),
                    init("misfire_policy", misfire_policy(MisfirePolicyVariant::Skip)),
                    init(
                        "overlap_policy",
                        overlap_policy(OverlapPolicyVariant::SkipIfRunning),
                    ),
                    init(
                        "missing_target_policy",
                        missing_target_policy(MissingTargetPolicyVariant::MarkMisfired),
                    ),
                    init("planning_cursor_utc_ms", Expr::None),
                    init("next_occurrence_ordinal", Expr::U64(0)),
                ],
            },
            terminal_phases: vec!["Deleted".into()],
        },
        inputs: EnumSchema {
            name: "ScheduleLifecycleInput".into(),
            variants: vec![
                VariantSchema {
                    name: "Revise".into(),
                    fields: vec![
                        field("trigger_key", TypeRef::String),
                        field("target_binding_key", TypeRef::String),
                        field("misfire_policy", TypeRef::Enum("MisfirePolicy".into())),
                        field("overlap_policy", TypeRef::Enum("OverlapPolicy".into())),
                        field(
                            "missing_target_policy",
                            TypeRef::Enum("MissingTargetPolicy".into()),
                        ),
                    ],
                },
                VariantSchema {
                    name: "RecordPlanningWindow".into(),
                    fields: vec![
                        field("planning_cursor_utc_ms", TypeRef::U64),
                        field("next_occurrence_ordinal", TypeRef::U64),
                    ],
                },
                variant("Pause"),
                variant("Resume"),
                variant("Delete"),
            ],
        },
        effects: EnumSchema {
            name: "ScheduleLifecycleEffect".into(),
            variants: vec![
                VariantSchema {
                    name: "EmitScheduleNotice".into(),
                    fields: vec![
                        field("new_state", TypeRef::Named("ScheduleLifecycleState".into())),
                        field("revision", TypeRef::U64),
                    ],
                },
                VariantSchema {
                    name: "SupersedePendingOccurrences".into(),
                    fields: vec![field("superseding_revision", TypeRef::U64)],
                },
                VariantSchema {
                    name: "PlanningWindowRecorded".into(),
                    fields: vec![
                        field("planning_cursor_utc_ms", TypeRef::U64),
                        field("next_occurrence_ordinal", TypeRef::U64),
                    ],
                },
            ],
        },
        helpers: vec![],
        derived: vec![],
        invariants: vec![
            InvariantSchema {
                name: "revision_is_positive".into(),
                expr: Expr::Gt(
                    Box::new(Expr::Field("revision".into())),
                    Box::new(Expr::U64(0)),
                ),
            },
            InvariantSchema {
                name: "deleted_has_no_planning_cursor".into(),
                expr: Expr::Or(vec![
                    Expr::Neq(
                        Box::new(Expr::CurrentPhase),
                        Box::new(Expr::Phase("Deleted".into())),
                    ),
                    Expr::Eq(
                        Box::new(Expr::Field("planning_cursor_utc_ms".into())),
                        Box::new(Expr::None),
                    ),
                ]),
            },
            InvariantSchema {
                name: "planning_cursor_requires_occurrence_progress".into(),
                expr: Expr::Or(vec![
                    Expr::Eq(
                        Box::new(Expr::Field("planning_cursor_utc_ms".into())),
                        Box::new(Expr::None),
                    ),
                    Expr::Gt(
                        Box::new(Expr::Field("next_occurrence_ordinal".into())),
                        Box::new(Expr::U64(0)),
                    ),
                ]),
            },
        ],
        transitions: vec![
            revise_transition("ReviseActive", "Active"),
            revise_transition("RevisePaused", "Paused"),
            planning_window_transition("RecordPlanningWindowActive", "Active"),
            planning_window_transition("RecordPlanningWindowPaused", "Paused"),
            TransitionSchema {
                name: "PauseActive".into(),
                from: vec!["Active".into()],
                on: InputMatch {
                    variant: "Pause".into(),
                    bindings: vec![],
                },
                guards: vec![],
                updates: vec![],
                to: "Paused".into(),
                emit: vec![schedule_notice()],
            },
            TransitionSchema {
                name: "ResumePaused".into(),
                from: vec!["Paused".into()],
                on: InputMatch {
                    variant: "Resume".into(),
                    bindings: vec![],
                },
                guards: vec![],
                updates: vec![],
                to: "Active".into(),
                emit: vec![schedule_notice()],
            },
            delete_transition("DeleteActive", "Active"),
            delete_transition("DeletePaused", "Paused"),
        ],
        effect_dispositions: vec![
            disposition("EmitScheduleNotice", EffectDisposition::External),
            disposition(
                "SupersedePendingOccurrences",
                EffectDisposition::Routed {
                    consumer_machines: vec!["OccurrenceLifecycleMachine".into()],
                },
            ),
            disposition("PlanningWindowRecorded", EffectDisposition::Local),
        ],
        ci_step_limit: None,
    }
}

fn revise_transition(name: &str, phase: &str) -> TransitionSchema {
    TransitionSchema {
        name: name.into(),
        from: vec![phase.into()],
        on: InputMatch {
            variant: "Revise".into(),
            bindings: vec![
                "trigger_key".into(),
                "target_binding_key".into(),
                "misfire_policy".into(),
                "overlap_policy".into(),
                "missing_target_policy".into(),
            ],
        },
        guards: vec![],
        updates: vec![
            Update::Assign {
                field: "trigger_key".into(),
                expr: Expr::Binding("trigger_key".into()),
            },
            Update::Assign {
                field: "target_binding_key".into(),
                expr: Expr::Binding("target_binding_key".into()),
            },
            Update::Assign {
                field: "misfire_policy".into(),
                expr: Expr::Binding("misfire_policy".into()),
            },
            Update::Assign {
                field: "overlap_policy".into(),
                expr: Expr::Binding("overlap_policy".into()),
            },
            Update::Assign {
                field: "missing_target_policy".into(),
                expr: Expr::Binding("missing_target_policy".into()),
            },
            Update::Increment {
                field: "revision".into(),
                amount: 1,
            },
            Update::Assign {
                field: "planning_cursor_utc_ms".into(),
                expr: Expr::None,
            },
        ],
        to: phase.into(),
        emit: vec![
            schedule_notice(),
            EffectEmit {
                variant: "SupersedePendingOccurrences".into(),
                fields: IndexMap::from([(
                    "superseding_revision".into(),
                    Expr::Field("revision".into()),
                )]),
            },
        ],
    }
}

fn planning_window_transition(name: &str, phase: &str) -> TransitionSchema {
    TransitionSchema {
        name: name.into(),
        from: vec![phase.into()],
        on: InputMatch {
            variant: "RecordPlanningWindow".into(),
            bindings: vec![
                "planning_cursor_utc_ms".into(),
                "next_occurrence_ordinal".into(),
            ],
        },
        guards: vec![Guard {
            name: "planning_window_advances_ordinal".into(),
            expr: Expr::Gt(
                Box::new(Expr::Binding("next_occurrence_ordinal".into())),
                Box::new(Expr::U64(0)),
            ),
        }],
        updates: vec![
            Update::Assign {
                field: "planning_cursor_utc_ms".into(),
                expr: Expr::Some(Box::new(Expr::Binding("planning_cursor_utc_ms".into()))),
            },
            Update::Assign {
                field: "next_occurrence_ordinal".into(),
                expr: Expr::Binding("next_occurrence_ordinal".into()),
            },
        ],
        to: phase.into(),
        emit: vec![
            schedule_notice(),
            EffectEmit {
                variant: "PlanningWindowRecorded".into(),
                fields: IndexMap::from([
                    (
                        "planning_cursor_utc_ms".into(),
                        Expr::Binding("planning_cursor_utc_ms".into()),
                    ),
                    (
                        "next_occurrence_ordinal".into(),
                        Expr::Binding("next_occurrence_ordinal".into()),
                    ),
                ]),
            },
        ],
    }
}

fn delete_transition(name: &str, phase: &str) -> TransitionSchema {
    TransitionSchema {
        name: name.into(),
        from: vec![phase.into()],
        on: InputMatch {
            variant: "Delete".into(),
            bindings: vec![],
        },
        guards: vec![],
        updates: vec![
            Update::Increment {
                field: "revision".into(),
                amount: 1,
            },
            Update::Assign {
                field: "planning_cursor_utc_ms".into(),
                expr: Expr::None,
            },
        ],
        to: "Deleted".into(),
        emit: vec![
            schedule_notice(),
            EffectEmit {
                variant: "SupersedePendingOccurrences".into(),
                fields: IndexMap::from([(
                    "superseding_revision".into(),
                    Expr::Field("revision".into()),
                )]),
            },
        ],
    }
}

fn schedule_notice() -> EffectEmit {
    EffectEmit {
        variant: "EmitScheduleNotice".into(),
        fields: IndexMap::from([
            ("new_state".into(), Expr::CurrentPhase),
            ("revision".into(), Expr::Field("revision".into())),
        ]),
    }
}

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

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

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

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

#[derive(Clone, Copy)]
enum MisfirePolicyVariant {
    Skip,
}

fn misfire_policy(variant: MisfirePolicyVariant) -> Expr {
    Expr::NamedVariant {
        enum_name: "MisfirePolicy".into(),
        variant: match variant {
            MisfirePolicyVariant::Skip => "Skip".into(),
        },
    }
}

#[derive(Clone, Copy)]
enum OverlapPolicyVariant {
    SkipIfRunning,
}

fn overlap_policy(variant: OverlapPolicyVariant) -> Expr {
    Expr::NamedVariant {
        enum_name: "OverlapPolicy".into(),
        variant: match variant {
            OverlapPolicyVariant::SkipIfRunning => "SkipIfRunning".into(),
        },
    }
}

#[derive(Clone, Copy)]
enum MissingTargetPolicyVariant {
    MarkMisfired,
}

fn missing_target_policy(variant: MissingTargetPolicyVariant) -> Expr {
    Expr::NamedVariant {
        enum_name: "MissingTargetPolicy".into(),
        variant: match variant {
            MissingTargetPolicyVariant::MarkMisfired => "MarkMisfired".into(),
        },
    }
}