apalis-workflow 0.1.0-rc.7

A flexible and composable task workflow engine for rust
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

use apalis_core::error::BoxDynError;
use petgraph::{algo::Cycle, graph::NodeIndex};
use std::fmt::Debug;
use thiserror::Error;

/// Errors that can occur during DAG workflow execution.
#[derive(Error, Debug)]
pub enum DagFlowError {
    /// An error originating from the actual node execution.
    #[error("Node execution error: {0}")]
    NodeExecutionError(#[source] BoxDynError),
    /// An error originating from the backend.
    #[error("Backend error: {0}")]
    Backend(#[source] BoxDynError),

    /// An error originating from the service.
    #[error("MissingService error: {0:?}")]
    MissingService(petgraph::graph::NodeIndex),

    /// An error originating from the service.
    #[error("Service error: {0}")]
    Service(#[from] DagServiceError),

    /// An error related to codec operations.
    #[error("Codec error: {0}")]
    Codec(#[source] BoxDynError),

    /// An error related to metadata operations.
    #[error("Metadata error: {0}")]
    Metadata(#[source] BoxDynError),

    /// An error indicating that dependencies are not ready.
    #[error("Dependencies not ready")]
    DependenciesNotReady,

    /// An error indicating a missing task ID for a dependency node.
    #[error("Missing task ID for dependency node {0:?}")]
    MissingDependencyTaskId(petgraph::graph::NodeIndex),

    /// An error indicating that a task result was not found for a node.
    #[error("Task result not found for node {0:?}")]
    TaskResultNotFound(petgraph::graph::NodeIndex),

    /// An error indicating that a dependency task has failed.
    #[error("Dependency task failed: {0}")]
    DependencyTaskFailed(String),

    /// An error indicating an unexpected response type during fan-in.
    #[error("Unexpected response type during fan-in")]
    UnexpectedResponseType,

    /// An error indicating a mismatch in the number of inputs during fan-in.
    #[error("Input count mismatch: expected {expected} inputs for fan-in, got {actual}")]
    InputCountMismatch {
        /// The expected number of inputs.
        expected: usize,
        /// The actual number of inputs received.
        actual: usize,
    },
    /// An error indicating that entry fan-out is not completed.
    #[error("Entry fan-out not completed")]
    EntryFanOutIncomplete,

    /// DAG contains cycles.
    #[error("DAG contains cycles involving nodes: {0:?}")]
    CyclicDAG(Cycle<NodeIndex>),
}

/// Error encountered by Service Error
#[derive(Error, Debug)]
pub enum DagServiceError {
    /// DAG service poll error.
    #[error("DAG encountered a poll error in a service: {0:?}")]
    PollError(#[source] BoxDynError),
    /// Missing previous node
    #[error("Missing previous node")]
    MissingPreviousNode,
    /// Missing Fanin Handler
    #[error("Missing Fanin Handler")]
    MissingFaninHandler,
    /// Missing next node
    #[error("Missing next node")]
    MissingNextNode,
    /// Missing TaskId for incoming node
    #[error("Missing TaskId for incoming node")]
    MissingIncomingTaskId,
    /// Missing result for TaskId
    #[error("Missing result for TaskId {0}")]
    MissingTaskIdResult(String),
    /// Dependency task returned invalid response, which is unexpected during fan-in
    #[error("Fan-in dependency task returned invalid response")]
    InvalidFanInDependencyResult,

    /// Dependency task failed
    #[error("Dependency task failed: {0:?}")]
    DependencyTaskFailed(#[source] BoxDynError),
}