cloacina 0.4.0

A Rust library for resilient task execution and orchestration.
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

/*
 *  Copyright 2025-2026 Colliery Software
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

//! Task Execution Data Access Layer for Unified Backend Support
//!
//! This module provides the data access layer for managing task executions in the pipeline system
//! with runtime backend selection between PostgreSQL and SQLite.
//!
//! Key features:
//! - Task state management (Ready, Running, Completed, Failed, Skipped)
//! - Retry mechanism with configurable backoff
//! - Recovery system for handling orphaned tasks
//! - Atomic task claiming for distributed execution
//! - Pipeline completion and failure detection

mod claiming;
mod crud;
mod queries;
mod recovery;
mod state;

use super::DAL;
use crate::database::universal_types::UniversalUuid;

/// Statistics about retry behavior for a pipeline execution.
#[derive(Debug, Default)]
pub struct RetryStats {
    /// Number of tasks that required at least one retry.
    pub tasks_with_retries: i32,
    /// Total number of retry attempts across all tasks.
    pub total_retries: i32,
    /// Maximum number of attempts used by any single task.
    pub max_attempts_used: i32,
    /// Number of tasks that exhausted all retry attempts and failed.
    pub tasks_exhausted_retries: i32,
}

/// Result structure for atomic task claiming operations.
#[derive(Debug)]
pub struct ClaimResult {
    /// Unique identifier of the claimed task
    pub id: UniversalUuid,
    /// ID of the pipeline execution this task belongs to
    pub pipeline_execution_id: UniversalUuid,
    /// Name of the task that was claimed
    pub task_name: String,
    /// Current attempt number for this task
    pub attempt: i32,
}

/// Result of attempting to claim a task for a specific runner.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RunnerClaimResult {
    /// Successfully claimed the task.
    Claimed,
    /// Another runner already claimed this task.
    AlreadyClaimed,
}

/// Result of a heartbeat attempt.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum HeartbeatResult {
    /// Heartbeat updated successfully — this runner still owns the claim.
    Ok,
    /// Claim was lost — another runner has claimed this task (or claim was released).
    ClaimLost,
}

/// A task with a stale claim (heartbeat expired).
#[derive(Debug, Clone)]
pub struct StaleClaim {
    /// Task execution ID.
    pub task_id: UniversalUuid,
    /// The runner that claimed it (now presumed dead).
    pub claimed_by: UniversalUuid,
    /// Last heartbeat timestamp.
    pub heartbeat_at: chrono::DateTime<chrono::Utc>,
}

/// Data access layer for task execution operations with runtime backend selection.
#[derive(Clone)]
pub struct TaskExecutionDAL<'a> {
    dal: &'a DAL,
}

impl<'a> TaskExecutionDAL<'a> {
    /// Creates a new TaskExecutionDAL instance.
    pub fn new(dal: &'a DAL) -> Self {
        Self { dal }
    }
}