stipping 0.1.0

An auditable request-confirm-observe state machine for reliable stop confirmation
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
//! Auditable stop confirmation through request, acknowledgement, and observation.
//!
//! The state machine deliberately separates an accepted stop intent from proof
//! that the subject actually stopped.
//!
//! ```
//! use stipping::{Observation, StopConfirmation, StopState};
//!
//! let mut stop = StopConfirmation::new("batch processor")?;
//! stop.request_stop("maintenance window")?;
//! stop.confirm_intent("worker acknowledged cancellation")?;
//! stop.verify(Observation::stopped("worker exited"))?;
//! assert_eq!(stop.state(), StopState::StoppedConfirmed);
//! # Ok::<(), stipping::StopError>(())
//! ```

use std::error::Error;
use std::fmt::{self, Display, Formatter};

/// Current phase of a stop-confirmation workflow.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub enum StopState {
    /// No stop request is pending.
    #[default]
    Running,
    /// A stop was requested but has not been acknowledged.
    StopRequested,
    /// The request was acknowledged; physical or logical cessation is unverified.
    IntentConfirmed,
    /// Cessation was observed after acknowledgement.
    StoppedConfirmed,
}

/// Operation attempted on the state machine.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum StopAction {
    /// Submit a stop request.
    RequestStop,
    /// Acknowledge the stop intent.
    ConfirmIntent,
    /// Verify an observation.
    Verify,
    /// Cancel a pending request.
    Cancel,
    /// Return a confirmed stop to the running state.
    Resume,
}

/// Kind of an accepted audit event.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum StopEventKind {
    /// A stop was requested.
    StopRequested,
    /// The stop intent was acknowledged.
    IntentConfirmed,
    /// Cessation was observed.
    StoppedObserved,
    /// A pending request was cancelled.
    RequestCancelled,
    /// A confirmed stop was resumed.
    Resumed,
}

/// One accepted transition in insertion order.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct StopEvent {
    kind: StopEventKind,
    note: String,
}

impl StopEvent {
    /// Event category.
    pub const fn kind(&self) -> StopEventKind {
        self.kind
    }

    /// Caller-provided reason, acknowledgement, or evidence.
    pub fn note(&self) -> &str {
        &self.note
    }
}

/// Observation supplied after stop intent has been confirmed.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub enum Observation {
    /// The subject is still active; another observation is required.
    Active(String),
    /// The subject has stopped, with supporting evidence.
    Stopped(String),
}

impl Observation {
    /// Creates an active observation.
    pub fn active(evidence: impl Into<String>) -> Self {
        Self::Active(evidence.into())
    }

    /// Creates a stopped observation.
    pub fn stopped(evidence: impl Into<String>) -> Self {
        Self::Stopped(evidence.into())
    }

    fn evidence(&self) -> &str {
        match self {
            Self::Active(evidence) | Self::Stopped(evidence) => evidence,
        }
    }
}

/// Stateful coordinator for the stop-confirmation principle.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct StopConfirmation {
    subject: String,
    state: StopState,
    events: Vec<StopEvent>,
}

impl StopConfirmation {
    /// Creates a running workflow for a named subject.
    pub fn new(subject: impl Into<String>) -> Result<Self, StopError> {
        let subject = subject.into();
        require_text(&subject, TextField::Subject)?;
        Ok(Self {
            subject,
            state: StopState::Running,
            events: Vec::new(),
        })
    }

    /// Subject whose stopping is being confirmed.
    pub fn subject(&self) -> &str {
        &self.subject
    }

    /// Current workflow phase.
    pub const fn state(&self) -> StopState {
        self.state
    }

    /// Ordered log of accepted transitions.
    pub fn events(&self) -> &[StopEvent] {
        &self.events
    }

    /// Whether cessation has been both acknowledged and observed.
    pub const fn is_stopped_confirmed(&self) -> bool {
        matches!(self.state, StopState::StoppedConfirmed)
    }

    /// Records a stop request from the running state.
    pub fn request_stop(&mut self, reason: impl Into<String>) -> Result<(), StopError> {
        self.require_state(StopAction::RequestStop, StopState::Running)?;
        let reason = reason.into();
        require_text(&reason, TextField::Reason)?;
        self.transition(
            StopState::StopRequested,
            StopEventKind::StopRequested,
            reason,
        );
        Ok(())
    }

    /// Records explicit acknowledgement of a pending stop request.
    pub fn confirm_intent(&mut self, acknowledgement: impl Into<String>) -> Result<(), StopError> {
        self.require_state(StopAction::ConfirmIntent, StopState::StopRequested)?;
        let acknowledgement = acknowledgement.into();
        require_text(&acknowledgement, TextField::Acknowledgement)?;
        self.transition(
            StopState::IntentConfirmed,
            StopEventKind::IntentConfirmed,
            acknowledgement,
        );
        Ok(())
    }

    /// Checks observed state after acknowledgement.
    ///
    /// An active observation returns an error and keeps the workflow in
    /// `IntentConfirmed`, allowing a later retry.
    pub fn verify(&mut self, observation: Observation) -> Result<(), StopError> {
        self.require_state(StopAction::Verify, StopState::IntentConfirmed)?;
        require_text(observation.evidence(), TextField::Evidence)?;
        match observation {
            Observation::Active(evidence) => Err(StopError::StillActive { evidence }),
            Observation::Stopped(evidence) => {
                self.transition(
                    StopState::StoppedConfirmed,
                    StopEventKind::StoppedObserved,
                    evidence,
                );
                Ok(())
            }
        }
    }

    /// Cancels a requested or acknowledged stop and returns to running.
    pub fn cancel(&mut self, note: impl Into<String>) -> Result<(), StopError> {
        if !matches!(
            self.state,
            StopState::StopRequested | StopState::IntentConfirmed
        ) {
            return Err(StopError::InvalidTransition {
                action: StopAction::Cancel,
                state: self.state,
            });
        }
        let note = note.into();
        require_text(&note, TextField::Note)?;
        self.transition(StopState::Running, StopEventKind::RequestCancelled, note);
        Ok(())
    }

    /// Records resumption after a confirmed stop.
    pub fn resume(&mut self, note: impl Into<String>) -> Result<(), StopError> {
        self.require_state(StopAction::Resume, StopState::StoppedConfirmed)?;
        let note = note.into();
        require_text(&note, TextField::Note)?;
        self.transition(StopState::Running, StopEventKind::Resumed, note);
        Ok(())
    }

    fn require_state(&self, action: StopAction, expected: StopState) -> Result<(), StopError> {
        if self.state != expected {
            return Err(StopError::InvalidTransition {
                action,
                state: self.state,
            });
        }
        Ok(())
    }

    fn transition(&mut self, state: StopState, kind: StopEventKind, note: String) {
        self.events.push(StopEvent { kind, note });
        self.state = state;
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum TextField {
    Subject,
    Reason,
    Acknowledgement,
    Evidence,
    Note,
}

fn require_text(value: &str, field: TextField) -> Result<(), StopError> {
    if value.trim().is_empty() {
        return Err(match field {
            TextField::Subject => StopError::EmptySubject,
            TextField::Reason => StopError::EmptyReason,
            TextField::Acknowledgement => StopError::EmptyAcknowledgement,
            TextField::Evidence => StopError::EmptyEvidence,
            TextField::Note => StopError::EmptyNote,
        });
    }
    Ok(())
}

/// Invalid transition, missing description, or failed stop observation.
#[derive(Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum StopError {
    /// Subject was empty or whitespace-only.
    EmptySubject,
    /// Stop reason was empty or whitespace-only.
    EmptyReason,
    /// Intent acknowledgement was empty or whitespace-only.
    EmptyAcknowledgement,
    /// Observation evidence was empty or whitespace-only.
    EmptyEvidence,
    /// Cancellation or resumption note was empty or whitespace-only.
    EmptyNote,
    /// Action was not valid in the current state.
    InvalidTransition {
        /// Rejected action.
        action: StopAction,
        /// State in which it was attempted.
        state: StopState,
    },
    /// Observation showed that the subject had not stopped.
    StillActive {
        /// Evidence supplied with the observation.
        evidence: String,
    },
}

impl Display for StopError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::EmptySubject => f.write_str("stop subject cannot be empty"),
            Self::EmptyReason => f.write_str("stop reason cannot be empty"),
            Self::EmptyAcknowledgement => f.write_str("stop acknowledgement cannot be empty"),
            Self::EmptyEvidence => f.write_str("observation evidence cannot be empty"),
            Self::EmptyNote => f.write_str("transition note cannot be empty"),
            Self::InvalidTransition { action, state } => {
                write!(f, "action {action:?} is invalid in state {state:?}")
            }
            Self::StillActive { evidence } => {
                write!(
                    f,
                    "stop is not confirmed; subject remains active: {evidence}"
                )
            }
        }
    }
}

impl Error for StopError {}

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

    #[test]
    fn complete_confirmation_requires_three_steps() {
        let mut stop = StopConfirmation::new("motor").unwrap();
        stop.request_stop("guard opened").unwrap();
        stop.confirm_intent("controller acknowledged").unwrap();
        stop.verify(Observation::stopped("encoder reads zero"))
            .unwrap();
        assert_eq!(stop.state(), StopState::StoppedConfirmed);
        assert!(stop.is_stopped_confirmed());
        assert_eq!(stop.events().len(), 3);
        assert_eq!(stop.events()[2].kind(), StopEventKind::StoppedObserved);
    }

    #[test]
    fn acknowledgement_alone_is_not_a_confirmed_stop() {
        let mut stop = StopConfirmation::new("worker").unwrap();
        stop.request_stop("shutdown").unwrap();
        stop.confirm_intent("message received").unwrap();
        assert!(!stop.is_stopped_confirmed());
        assert_eq!(stop.state(), StopState::IntentConfirmed);
    }

    #[test]
    fn active_observation_preserves_retry_state_and_audit_log() {
        let mut stop = StopConfirmation::new("fan").unwrap();
        stop.request_stop("inspection").unwrap();
        stop.confirm_intent("relay opened").unwrap();
        let before = stop.events().len();
        assert_eq!(
            stop.verify(Observation::active("fan still coasting")),
            Err(StopError::StillActive {
                evidence: "fan still coasting".into()
            })
        );
        assert_eq!(stop.state(), StopState::IntentConfirmed);
        assert_eq!(stop.events().len(), before);
        stop.verify(Observation::stopped("fan is motionless"))
            .unwrap();
    }

    #[test]
    fn transitions_cannot_be_skipped() {
        let mut stop = StopConfirmation::new("job").unwrap();
        assert_eq!(
            stop.confirm_intent("accepted"),
            Err(StopError::InvalidTransition {
                action: StopAction::ConfirmIntent,
                state: StopState::Running
            })
        );
        assert_eq!(stop.events().len(), 0);
    }

    #[test]
    fn pending_request_can_be_cancelled() {
        let mut stop = StopConfirmation::new("job").unwrap();
        stop.request_stop("mistake").unwrap();
        stop.cancel("false alarm").unwrap();
        assert_eq!(stop.state(), StopState::Running);
        assert_eq!(stop.events()[1].kind(), StopEventKind::RequestCancelled);
    }

    #[test]
    fn confirmed_stop_can_resume_and_start_another_cycle() {
        let mut stop = StopConfirmation::new("service").unwrap();
        stop.request_stop("deploy").unwrap();
        stop.confirm_intent("signal handled").unwrap();
        stop.verify(Observation::stopped("health check is down"))
            .unwrap();
        stop.resume("deploy finished").unwrap();
        stop.request_stop("second deploy").unwrap();
        assert_eq!(stop.state(), StopState::StopRequested);
        assert_eq!(stop.events().len(), 5);
    }

    #[test]
    fn empty_descriptions_are_rejected_without_transition() {
        assert_eq!(StopConfirmation::new("  "), Err(StopError::EmptySubject));
        let mut stop = StopConfirmation::new("job").unwrap();
        assert_eq!(stop.request_stop(""), Err(StopError::EmptyReason));
        assert_eq!(stop.state(), StopState::Running);
        stop.request_stop("requested").unwrap();
        assert_eq!(
            stop.confirm_intent("  "),
            Err(StopError::EmptyAcknowledgement)
        );
    }

    #[test]
    fn event_notes_are_preserved_in_order() {
        let mut stop = StopConfirmation::new("task").unwrap();
        stop.request_stop("first").unwrap();
        stop.confirm_intent("second").unwrap();
        stop.verify(Observation::stopped("third")).unwrap();
        let notes: Vec<_> = stop.events().iter().map(StopEvent::note).collect();
        assert_eq!(notes, ["first", "second", "third"]);
    }
}