Enum EscalationPolicy

Source

pub enum EscalationPolicy {
    AutoApprove,
    AutoReject,
    Notify(Vec<NotificationTarget>),
    Escalate(Assignee),
    Chain(Vec<EscalationPolicy>),
}

Expand description

What to do when an approval gate misses its SLA deadline.

§Examples

use ironflow_engine::config::{EscalationPolicy, NotificationTarget};

// Warn the on-call channel after one hour, give up after two.
let policy = EscalationPolicy::Chain(vec![
    EscalationPolicy::Notify(vec![NotificationTarget::Slack {
        webhook_url: "https://hooks.slack.com/services/T/B/X".to_string(),
        channel: "#deploys".to_string(),
    }]),
    EscalationPolicy::AutoReject,
]);
assert_eq!(policy.len(), 2);

Variants§

§

AutoApprove

Complete the step with approved_by: "system:timeout" and resume the run.

§

AutoReject

Fail the step and the run with the reason "approval timeout".

§

Notify(Vec<NotificationTarget>)

Notify each target without changing state, then restart the timer.

§

Escalate(Assignee)

Reassign the approval to another user or group, then restart the timer.

§

Chain(Vec<EscalationPolicy>)

Apply the policies one per expiry, in order.

Implementations§

Source §

impl EscalationPolicy

Source

pub fn stage(&self, index: usize) -> Option<&EscalationPolicy>

The policy to apply at escalation stage index.

For a Chain, this is the index-th link. For any other variant, stage 0 is the policy itself and every later stage is None — the chain is exhausted. A repeating policy never reaches stage 1 outside a chain because it re-arms at the same stage; see is_repeating.

§Examples

use ironflow_engine::config::EscalationPolicy;
use ironflow_store::entities::Assignee;

let single = EscalationPolicy::AutoReject;
assert_eq!(single.stage(0), Some(&EscalationPolicy::AutoReject));
assert_eq!(single.stage(1), None);

let chain = EscalationPolicy::Chain(vec![
    EscalationPolicy::Escalate(Assignee::group("sre-oncall")),
    EscalationPolicy::AutoReject,
]);
assert_eq!(chain.stage(1), Some(&EscalationPolicy::AutoReject));
assert_eq!(chain.stage(2), None);

Source

pub fn is_terminal(&self) -> bool

Whether this policy resolves the gate instead of leaving it open.

§Examples

use ironflow_engine::config::EscalationPolicy;
use ironflow_store::entities::Assignee;

assert!(EscalationPolicy::AutoApprove.is_terminal());
assert!(EscalationPolicy::AutoReject.is_terminal());
assert!(!EscalationPolicy::Escalate(Assignee::group("sre")).is_terminal());

Source

pub fn is_repeating(&self) -> bool

Whether this policy re-arms the timer at the same stage.

Outside a Chain, a repeating policy fires again at every expiry until a human resolves the gate. Inside a chain, the stage still advances so the next link eventually runs.

§Examples

use ironflow_engine::config::EscalationPolicy;
use ironflow_store::entities::Assignee;

assert!(EscalationPolicy::Notify(Vec::new()).is_repeating());
assert!(EscalationPolicy::Escalate(Assignee::group("sre")).is_repeating());
assert!(!EscalationPolicy::AutoApprove.is_repeating());

Source

pub fn len(&self) -> usize

Number of stages this policy declares.

A Chain reports its length; every other variant reports 1.

§Examples

use ironflow_engine::config::EscalationPolicy;

assert_eq!(EscalationPolicy::AutoReject.len(), 1);
assert_eq!(
    EscalationPolicy::Chain(vec![EscalationPolicy::AutoReject]).len(),
    1
);

Source

pub fn is_empty(&self) -> bool

Whether this policy declares no stage at all.

Only an empty Chain is empty: it never escalates, and the gate stays open with no timer after the first expiry.

§Examples

use ironflow_engine::config::EscalationPolicy;

assert!(EscalationPolicy::Chain(Vec::new()).is_empty());
assert!(!EscalationPolicy::AutoReject.is_empty());