operon 0.7.0

A workflow engine for parallel, incremental scheduling of DAG-defined multiplex tasks.
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

use std::fmt::Debug;
use std::str::FromStr;

use postgres_types::{FromSql, ToSql};

use crate::schema::{Job, OptionCoordinate};

#[derive(Debug, Clone, Copy)]
pub struct Ticket<const N: usize> {
    pub coordinate: [OptionCoordinate; N],
    deps_done: usize,
    deps_quota: usize,
    pub status: TicketStatus,
}

/// A ticket's lifecycle status.
///
/// The `ToSql`/`FromSql` derive maps this onto the Postgres `ticket_status` enum type.
#[derive(Debug, Clone, Default, Copy, PartialEq, Eq, ToSql, FromSql)]
#[postgres(name = "ticket_status")]
pub enum TicketStatus {
    #[default]
    #[postgres(name = "waiting")]
    Waiting,
    #[postgres(name = "queued")]
    Queued,
    #[postgres(name = "done")]
    Done,
}

pub trait TicketLike: Debug + Clone + Copy + Send + Sync + 'static {}

impl<const N: usize> TicketLike for Ticket<N> {}

pub trait TicketEnum: Debug + Clone + Send + Sync + 'static {}

#[derive(Debug, Clone)]
pub struct TicketExplosion<T: TicketEnum> {
    /// The ticket providing the coordinate of explosion.
    pub ticket: T,
    /// The dimension of explosion.
    pub dim: &'static str,
    /// The ub of the explosion resolution.
    pub ub: usize,
}

impl<const N: usize> Ticket<N> {
    pub const fn new(quota: usize) -> Self {
        let status = if quota == 0 {
            TicketStatus::Queued
        } else {
            TicketStatus::Waiting
        };

        Self {
            coordinate: [OptionCoordinate::none(); N],
            deps_done: 0usize,
            deps_quota: quota,
            status,
        }
    }

    pub const fn update_status(mut self) -> Self {
        if self.is_ready() {
            self.status = TicketStatus::Queued;
        }
        self
    }

    pub const fn with_coordinate<const IDX: usize>(mut self, coordinate: usize) -> Self {
        const { assert!(IDX < N) }
        self.coordinate[IDX] = OptionCoordinate::some(coordinate);
        self
    }

    pub const fn is_ready(&self) -> bool {
        self.deps_done >= self.deps_quota
    }

    pub const fn resolve(&self) -> Option<Job<N>> {
        if !self.is_ready() {
            return None;
        }

        let mut coordinate = [0usize; N];
        let mut i = 0;

        while i < N {
            let Some(src) = self.coordinate[i].0 else {
                return None;
            };
            coordinate[i] = src;
            i += 1;
        }

        Some(Job { coordinate })
    }

    /// Reconstructs a ticket from its raw parts.
    ///
    /// Used by storage backends when materializing a ticket read back from persistence.
    pub(crate) fn from_parts(
        coordinate: [OptionCoordinate; N],
        deps_done: usize,
        deps_quota: usize,
        status: TicketStatus,
    ) -> Self {
        Self {
            coordinate,
            deps_done,
            deps_quota,
            status,
        }
    }

    pub(crate) fn deps_done(&self) -> usize {
        self.deps_done
    }

    pub(crate) fn deps_quota(&self) -> usize {
        self.deps_quota
    }
}

impl ::std::fmt::Display for TicketStatus {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        match self {
            TicketStatus::Waiting => write!(f, "waiting"),
            TicketStatus::Queued => write!(f, "queued"),
            TicketStatus::Done => write!(f, "done"),
        }
    }
}

impl FromStr for TicketStatus {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "waiting" => Ok(TicketStatus::Waiting),
            "queued" => Ok(TicketStatus::Queued),
            "done" => Ok(TicketStatus::Done),
            _ => Err(format!("Invalid ticket status: {s}")),
        }
    }
}