sayiir-persistence 0.4.0

Pluggable persistence backends for Sayiir workflow snapshots
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

//! Shared validation helpers for persistence backends.

use sayiir_core::snapshot::{SignalKind, SnapshotStatus};

use crate::BackendError;

/// Validate that a signal can be sent to a workflow in the given state.
///
/// Returns `Ok(())` if the signal is allowed, or a [`BackendError`] describing
/// why it cannot be delivered. Unknown status strings (forward-compatibility)
/// are treated as permissive.
pub fn validate_signal_allowed(status: &str, kind: SignalKind) -> Result<(), BackendError> {
    use std::str::FromStr;

    let Ok(status) = SnapshotStatus::from_str(status) else {
        // Unknown status from DB — be permissive (forward compatibility).
        return Ok(());
    };

    match kind {
        SignalKind::Cancel => match status {
            SnapshotStatus::Completed | SnapshotStatus::Failed => {
                Err(BackendError::CannotCancel(status.as_ref().to_string()))
            }
            _ => Ok(()),
        },
        SignalKind::Pause => match status {
            SnapshotStatus::Completed | SnapshotStatus::Failed | SnapshotStatus::Cancelled => {
                Err(BackendError::CannotPause(status.as_ref().to_string()))
            }
            _ => Ok(()),
        },
    }
}

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

    #[test]
    fn cancel_rejected_on_completed() {
        let err = validate_signal_allowed("Completed", SignalKind::Cancel).unwrap_err();
        assert!(matches!(err, BackendError::CannotCancel(_)));
    }

    #[test]
    fn cancel_rejected_on_failed() {
        let err = validate_signal_allowed("Failed", SignalKind::Cancel).unwrap_err();
        assert!(matches!(err, BackendError::CannotCancel(_)));
    }

    #[test]
    fn cancel_allowed_on_in_progress() {
        validate_signal_allowed("InProgress", SignalKind::Cancel).unwrap();
    }

    #[test]
    fn cancel_allowed_on_paused() {
        validate_signal_allowed("Paused", SignalKind::Cancel).unwrap();
    }

    #[test]
    fn cancel_allowed_on_cancelled() {
        // Idempotent: cancelling an already-cancelled workflow is fine.
        validate_signal_allowed("Cancelled", SignalKind::Cancel).unwrap();
    }

    #[test]
    fn pause_rejected_on_completed() {
        let err = validate_signal_allowed("Completed", SignalKind::Pause).unwrap_err();
        assert!(matches!(err, BackendError::CannotPause(_)));
    }

    #[test]
    fn pause_rejected_on_failed() {
        let err = validate_signal_allowed("Failed", SignalKind::Pause).unwrap_err();
        assert!(matches!(err, BackendError::CannotPause(_)));
    }

    #[test]
    fn pause_rejected_on_cancelled() {
        let err = validate_signal_allowed("Cancelled", SignalKind::Pause).unwrap_err();
        assert!(matches!(err, BackendError::CannotPause(_)));
    }

    #[test]
    fn pause_allowed_on_in_progress() {
        validate_signal_allowed("InProgress", SignalKind::Pause).unwrap();
    }

    #[test]
    fn pause_allowed_on_paused() {
        // Idempotent: pausing an already-paused workflow is fine.
        validate_signal_allowed("Paused", SignalKind::Pause).unwrap();
    }

    // Unknown statuses are treated as permissive (forward compatibility).
    #[test]
    fn unknown_status_allows_cancel() {
        validate_signal_allowed("SomeFutureStatus", SignalKind::Cancel).unwrap();
    }

    #[test]
    fn unknown_status_allows_pause() {
        validate_signal_allowed("SomeFutureStatus", SignalKind::Pause).unwrap();
    }
}