obzenflow_runtime 0.2.5

Runtime services for ObzenFlow - execution and coordination business logic
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

// SPDX-License-Identifier: MIT OR Apache-2.0
// SPDX-FileCopyrightText: 2025-2026 ObzenFlow Contributors
// https://obzenflow.dev

//! Canonical pipeline FSM construction and transition table.
//!
//! Each live phase observes the original journal through its named decision.
//! Internal bootstrap, deadlines and settlement inputs have explicit admission.
//! Only stale caller controls use the selective unhandled policy.

mod actions;
pub(super) mod context;
mod guards;
mod journal;
mod model;
mod transitions;

pub(crate) use actions::PipelineAction;
pub(crate) use context::PipelineContext;
pub(crate) use model::{PipelineDeadline, PipelineFsmEvent, PipelineFsmState};

use obzenflow_fsm::{fsm, StateMachine};

pub(crate) type PipelineFsm =
    StateMachine<PipelineFsmState, PipelineFsmEvent, PipelineContext, PipelineAction>;

pub(crate) fn build_pipeline_fsm_with_initial(initial: PipelineFsmState) -> PipelineFsm {
    fsm! {
        state: PipelineFsmState;
        event: PipelineFsmEvent;
        context: PipelineContext;
        action: PipelineAction;
        initial: initial;

        unhandled => transitions::unhandled;
        state PipelineFsmState::Created {
            on PipelineFsmEvent::Bootstrap => transitions::bootstrap;
            on PipelineFsmEvent::GracefulStop => transitions::stop_before_start;
            on PipelineFsmEvent::Cancel => transitions::stop_before_start;
            on PipelineFsmEvent::Abort => transitions::failure_before_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_before_terminal;
            on PipelineFsmEvent::Journal => journal::created;
        }
        state PipelineFsmState::Materializing {
            on PipelineFsmEvent::PhysicalSettlementSatisfied => transitions::initialisation_delivered;
            on PipelineFsmEvent::GracefulStop => transitions::stop_before_start;
            on PipelineFsmEvent::Cancel => transitions::stop_before_start;
            on PipelineFsmEvent::Abort => transitions::failure_before_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_before_terminal;
            on PipelineFsmEvent::Journal => journal::materializing;
        }
        state PipelineFsmState::AwaitingStageReadiness {
            on PipelineFsmEvent::GracefulStop => transitions::stop_before_start;
            on PipelineFsmEvent::Cancel => transitions::stop_before_start;
            on PipelineFsmEvent::Abort => transitions::failure_before_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_before_terminal;
            on PipelineFsmEvent::Journal => journal::awaiting_readiness;
        }
        state PipelineFsmState::ReadyForRun {
            on PipelineFsmEvent::Start => transitions::start;
            on PipelineFsmEvent::GracefulStop => transitions::stop_before_start;
            on PipelineFsmEvent::Cancel => transitions::stop_before_start;
            on PipelineFsmEvent::Abort => transitions::failure_before_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_before_terminal;
            on PipelineFsmEvent::Journal => journal::ready_for_run;
        }
        state PipelineFsmState::StartingSources {
            on PipelineFsmEvent::GracefulStop => transitions::begin_graceful_drain;
            on PipelineFsmEvent::Cancel => transitions::cancel_and_settle;
            on PipelineFsmEvent::Abort => transitions::failure_before_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_before_terminal;
            on PipelineFsmEvent::Journal => journal::starting_sources;
        }
        state PipelineFsmState::Running {
            on PipelineFsmEvent::GracefulStop => transitions::begin_graceful_drain;
            on PipelineFsmEvent::Cancel => transitions::cancel_and_settle;
            on PipelineFsmEvent::Abort => transitions::failure_before_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_before_terminal;
            on PipelineFsmEvent::Journal => journal::running;
        }
        state PipelineFsmState::SourceCompleted {
            on PipelineFsmEvent::GracefulStop => transitions::begin_graceful_drain;
            on PipelineFsmEvent::Cancel => transitions::cancel_and_settle;
            on PipelineFsmEvent::Abort => transitions::failure_before_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_before_terminal;
            on PipelineFsmEvent::Journal => journal::source_completed;
        }
        state PipelineFsmState::Draining {
            on PipelineFsmEvent::GracefulStop => transitions::begin_graceful_drain;
            on PipelineFsmEvent::Cancel => transitions::cancel_and_settle;
            on PipelineFsmEvent::GracefulStopExpired => transitions::cancel_and_settle;
            on PipelineFsmEvent::Abort => transitions::failure_before_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_before_terminal;
            on PipelineFsmEvent::Journal => journal::draining;
        }
        state PipelineFsmState::SettlingStages {
            on PipelineFsmEvent::PhysicalSettlementSatisfied => transitions::stage_owners_settled;
            on PipelineFsmEvent::GracefulStop => transitions::stop_during_settlement;
            on PipelineFsmEvent::Cancel => transitions::stop_during_settlement;
            on PipelineFsmEvent::GracefulStopExpired => transitions::stop_during_settlement;
            on PipelineFsmEvent::StageCleanupExpired => transitions::expire_stage_cleanup;
            on PipelineFsmEvent::Abort => transitions::failure_before_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_before_terminal;
            on PipelineFsmEvent::Journal => journal::settling_stages;
        }
        state PipelineFsmState::CatchingUpProducers {
            on PipelineFsmEvent::PhysicalSettlementSatisfied => transitions::producer_tail_reached;
            on PipelineFsmEvent::GracefulStop => transitions::stop_during_settlement;
            on PipelineFsmEvent::Cancel => transitions::stop_during_settlement;
            on PipelineFsmEvent::GracefulStopExpired => transitions::stop_during_settlement;
            on PipelineFsmEvent::Abort => transitions::failure_during_catchup;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_during_catchup;
            on PipelineFsmEvent::Journal => journal::catching_up_producers;
        }
        state PipelineFsmState::PublishingTerminal {
            on PipelineFsmEvent::GracefulStop => transitions::stop_during_settlement;
            on PipelineFsmEvent::Cancel => transitions::stop_during_settlement;
            on PipelineFsmEvent::GracefulStopExpired => transitions::stop_during_settlement;
            on PipelineFsmEvent::MetricsExpired => transitions::expire_metrics;
            on PipelineFsmEvent::Abort => transitions::failure_after_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_after_terminal;
            on PipelineFsmEvent::Journal => journal::publishing_terminal;
        }
        state PipelineFsmState::FinalisingMetrics {
            on PipelineFsmEvent::PhysicalSettlementSatisfied => transitions::metrics_owner_settled;
            on PipelineFsmEvent::GracefulStop => transitions::stop_during_settlement;
            on PipelineFsmEvent::Cancel => transitions::stop_during_settlement;
            on PipelineFsmEvent::GracefulStopExpired => transitions::stop_during_settlement;
            on PipelineFsmEvent::MetricsExpired => transitions::expire_metrics;
            on PipelineFsmEvent::Abort => transitions::failure_after_terminal;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_after_terminal;
            on PipelineFsmEvent::Journal => journal::finalising_metrics;
        }
        state PipelineFsmState::PublishingFinalMarker {
            on PipelineFsmEvent::PhysicalSettlementSatisfied => transitions::final_marker_settled;
            on PipelineFsmEvent::OperationalFailure => transitions::failure_after_terminal;
            on PipelineFsmEvent::Journal => journal::publishing_final_marker;
        }
        state PipelineFsmState::Finished {
        }
    }
}