cloacina 0.10.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
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
/*
 *  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.
 */

//! Unified Workflow Execution DAL with compile-time backend selection
//!
//! All state transitions are transactional: the status update and execution event
//! are written atomically. If either fails, both are rolled back.

use super::models::{
    NewUnifiedExecutionEvent, NewUnifiedWorkflowExecution, UnifiedWorkflowExecution,
};
use super::DAL;
use crate::database::schema::unified::{execution_events, workflow_executions};
use crate::database::universal_types::{UniversalTimestamp, UniversalUuid};
use crate::error::ValidationError;
use crate::models::execution_event::ExecutionEventType;
use crate::models::workflow_execution::{NewWorkflowExecution, WorkflowExecutionRecord};
use diesel::prelude::*;

/// Filter for `WorkflowExecutionDAL::list_filtered`. CLOACI-T-0594 /
/// API-02: closes the silent-filter-drop bug where the REST route's
/// `--status` / `--workflow_name` query params were discarded.
#[derive(Debug, Clone, Default)]
pub struct ExecutionListFilter {
    /// Filter by status (e.g. `Pending`, `Running`, `Completed`, `Failed`).
    /// `None` means no status filter.
    pub status: Option<String>,
    /// Filter by exact workflow name. `None` means no name filter.
    pub workflow_name: Option<String>,
    /// SQL `LIMIT`. Caller is responsible for bounding (route validates
    /// `limit <= 1000`); the DAL trusts whatever is passed.
    pub limit: i64,
    /// SQL `OFFSET`.
    pub offset: i64,
}

/// Data access layer for workflow execution operations with compile-time backend selection.
#[derive(Clone)]
pub struct WorkflowExecutionDAL<'a> {
    dal: &'a DAL,
}

impl<'a> WorkflowExecutionDAL<'a> {
    pub fn new(dal: &'a DAL) -> Self {
        Self { dal }
    }

    /// Creates a new workflow execution record in the database.
    ///
    /// This operation is transactional: the workflow record and execution event
    /// are written atomically.
    pub async fn create(
        &self,
        new_execution: NewWorkflowExecution,
    ) -> Result<WorkflowExecutionRecord, ValidationError> {
        use diesel::connection::Connection;

        let execution: UnifiedWorkflowExecution = crate::interact_on_backend!(self.dal, |conn| {
            conn.transaction::<_, diesel::result::Error, _>(|conn| {
                let id = UniversalUuid::new_v4();
                let now = UniversalTimestamp::now();

                let unified_new = NewUnifiedWorkflowExecution {
                    id,
                    workflow_name: new_execution.workflow_name,
                    workflow_version: new_execution.workflow_version,
                    status: new_execution.status,
                    context_id: new_execution.context_id,
                    started_at: now,
                    created_at: now,
                    updated_at: now,
                };

                // Insert workflow record
                diesel::insert_into(workflow_executions::table)
                    .values(&unified_new)
                    .execute(conn)?;

                // Retrieve the created record
                let execution: UnifiedWorkflowExecution =
                    workflow_executions::table.find(id).first(conn)?;

                // Insert execution event for workflow start
                let event = NewUnifiedExecutionEvent {
                    id: UniversalUuid::new_v4(),
                    workflow_execution_id: execution.id,
                    task_execution_id: None,
                    event_type: ExecutionEventType::WorkflowStarted.as_str().to_string(),
                    event_data: None,
                    worker_id: None,
                    created_at: now,
                    request_id: None,
                    runner_id: None,
                    tenant_id: None,
                };
                diesel::insert_into(execution_events::table)
                    .values(&event)
                    .execute(conn)?;

                Ok(execution)
            })
        })?;

        Ok(execution.into())
    }

    pub async fn get_by_id(
        &self,
        id: UniversalUuid,
    ) -> Result<WorkflowExecutionRecord, ValidationError> {
        let execution: UnifiedWorkflowExecution = crate::interact_on_backend!(self.dal, |conn| {
            workflow_executions::table.find(id).first(conn)
        })?;

        Ok(execution.into())
    }

    pub async fn get_active_executions(
        &self,
    ) -> Result<Vec<WorkflowExecutionRecord>, ValidationError> {
        let executions: Vec<UnifiedWorkflowExecution> =
            crate::interact_on_backend!(self.dal, |conn| {
                workflow_executions::table
                    .filter(workflow_executions::status.eq_any(vec!["Pending", "Running"]))
                    .load(conn)
            })?;

        Ok(executions.into_iter().map(Into::into).collect())
    }

    pub async fn update_status(
        &self,
        id: UniversalUuid,
        status: &str,
    ) -> Result<(), ValidationError> {
        let status = status.to_string();
        let now = UniversalTimestamp::now();
        crate::interact_on_backend!(self.dal, |conn| {
            diesel::update(workflow_executions::table.find(id))
                .set((
                    workflow_executions::status.eq(status),
                    workflow_executions::updated_at.eq(now),
                ))
                .execute(conn)
        })?;

        Ok(())
    }

    /// Set a workflow execution's trigger origin (CLOACI-T-0776). Called right
    /// after creation by the REST execute endpoint to mark an operator run as
    /// `"manual"`. Best-effort metadata — failures are non-fatal to the run.
    pub async fn set_trigger_origin(
        &self,
        id: UniversalUuid,
        origin: &str,
    ) -> Result<(), ValidationError> {
        let origin = origin.to_string();
        crate::interact_on_backend!(self.dal, |conn| {
            diesel::update(workflow_executions::table.find(id))
                .set(workflow_executions::trigger_origin.eq(origin))
                .execute(conn)
        })?;

        Ok(())
    }

    /// Marks a workflow execution as completed.
    ///
    /// This operation is transactional: the status update and execution event
    /// are written atomically.
    pub async fn mark_completed(&self, id: UniversalUuid) -> Result<(), ValidationError> {
        use diesel::connection::Connection;

        crate::interact_on_backend!(self.dal, |conn| {
            conn.transaction::<_, diesel::result::Error, _>(|conn| {
                let now = UniversalTimestamp::now();

                // Only transition from Running to Completed — prevents duplicate
                // WorkflowCompleted events when two scheduler ticks race.
                let rows = diesel::update(
                    workflow_executions::table
                        .find(id)
                        .filter(workflow_executions::status.ne_all(vec!["Completed", "Failed"])),
                )
                .set((
                    workflow_executions::status.eq("Completed"),
                    workflow_executions::completed_at.eq(Some(now)),
                    workflow_executions::updated_at.eq(now),
                ))
                .execute(conn)?;

                // Only insert event if we actually transitioned
                if rows > 0 {
                    let event = NewUnifiedExecutionEvent {
                        id: UniversalUuid::new_v4(),
                        workflow_execution_id: id,
                        task_execution_id: None,
                        event_type: ExecutionEventType::WorkflowCompleted.as_str().to_string(),
                        event_data: None,
                        worker_id: None,
                        created_at: now,
                        request_id: None,
                        runner_id: None,
                        tenant_id: None,
                    };
                    diesel::insert_into(execution_events::table)
                        .values(&event)
                        .execute(conn)?;
                }

                Ok(())
            })
        })?;

        Ok(())
    }

    pub async fn get_last_version(
        &self,
        workflow_name: &str,
    ) -> Result<Option<String>, ValidationError> {
        let workflow_name = workflow_name.to_string();
        let version: Option<String> = crate::interact_on_backend!(self.dal, |conn| {
            workflow_executions::table
                .filter(workflow_executions::workflow_name.eq(workflow_name))
                .order(workflow_executions::started_at.desc())
                .select(workflow_executions::workflow_version)
                .first(conn)
                .optional()
        })?;

        Ok(version)
    }

    /// Marks a workflow execution as failed with an error reason.
    ///
    /// This operation is transactional: the status update and execution event
    /// are written atomically.
    pub async fn mark_failed(
        &self,
        id: UniversalUuid,
        reason: &str,
    ) -> Result<(), ValidationError> {
        use diesel::connection::Connection;

        let reason = reason.to_string();
        crate::interact_on_backend!(self.dal, |conn| {
            conn.transaction::<_, diesel::result::Error, _>(|conn| {
                let now = UniversalTimestamp::now();

                // Only transition from Running to Failed — prevents duplicate
                // WorkflowFailed events when two scheduler ticks race.
                let rows = diesel::update(
                    workflow_executions::table
                        .find(id)
                        .filter(workflow_executions::status.ne_all(vec!["Completed", "Failed"])),
                )
                .set((
                    workflow_executions::status.eq("Failed"),
                    workflow_executions::completed_at.eq(Some(now)),
                    workflow_executions::error_details.eq(&reason),
                    workflow_executions::updated_at.eq(now),
                ))
                .execute(conn)?;

                // Only insert event if we actually transitioned
                if rows > 0 {
                    let event_data = serde_json::json!({ "reason": reason }).to_string();
                    let event = NewUnifiedExecutionEvent {
                        id: UniversalUuid::new_v4(),
                        workflow_execution_id: id,
                        task_execution_id: None,
                        event_type: ExecutionEventType::WorkflowFailed.as_str().to_string(),
                        event_data: Some(event_data),
                        worker_id: None,
                        created_at: now,
                        request_id: None,
                        runner_id: None,
                        tenant_id: None,
                    };
                    diesel::insert_into(execution_events::table)
                        .values(&event)
                        .execute(conn)?;
                }

                Ok(())
            })
        })?;

        Ok(())
    }

    pub async fn cancel(&self, id: UniversalUuid) -> Result<(), ValidationError> {
        let now = UniversalTimestamp::now();
        crate::interact_on_backend!(self.dal, |conn| {
            diesel::update(workflow_executions::table.find(id))
                .set((
                    workflow_executions::status.eq("Cancelled"),
                    workflow_executions::completed_at.eq(Some(now)),
                    workflow_executions::updated_at.eq(now),
                ))
                .execute(conn)
        })?;

        Ok(())
    }

    /// Pauses a running workflow execution.
    ///
    /// Sets the workflow status to 'Paused', records the pause timestamp,
    /// and optionally stores a reason for the pause.
    ///
    /// This operation is transactional: the status update and execution event
    /// are written atomically.
    pub async fn pause(
        &self,
        id: UniversalUuid,
        reason: Option<&str>,
    ) -> Result<(), ValidationError> {
        use diesel::connection::Connection;

        let reason = reason.map(|r| r.to_string());
        crate::interact_on_backend!(self.dal, |conn| {
            conn.transaction::<_, diesel::result::Error, _>(|conn| {
                let now = UniversalTimestamp::now();

                // Update workflow status
                diesel::update(workflow_executions::table.find(id))
                    .set((
                        workflow_executions::status.eq("Paused"),
                        workflow_executions::paused_at.eq(Some(now)),
                        workflow_executions::pause_reason.eq(&reason),
                        workflow_executions::updated_at.eq(now),
                    ))
                    .execute(conn)?;

                // Insert execution event with pause reason
                let event_data = reason.map(|r| serde_json::json!({ "reason": r }).to_string());
                let event = NewUnifiedExecutionEvent {
                    id: UniversalUuid::new_v4(),
                    workflow_execution_id: id,
                    task_execution_id: None,
                    event_type: ExecutionEventType::WorkflowPaused.as_str().to_string(),
                    event_data,
                    worker_id: None,
                    created_at: now,
                    request_id: None,
                    runner_id: None,
                    tenant_id: None,
                };
                diesel::insert_into(execution_events::table)
                    .values(&event)
                    .execute(conn)?;

                Ok(())
            })
        })?;

        Ok(())
    }

    /// Resumes a paused workflow execution.
    ///
    /// Sets the workflow status back to 'Running' and clears the pause metadata.
    ///
    /// This operation is transactional: the status update and execution event
    /// are written atomically.
    pub async fn resume(&self, id: UniversalUuid) -> Result<(), ValidationError> {
        use diesel::connection::Connection;

        crate::interact_on_backend!(self.dal, |conn| {
            conn.transaction::<_, diesel::result::Error, _>(|conn| {
                let now = UniversalTimestamp::now();

                // Update workflow status
                diesel::update(workflow_executions::table.find(id))
                    .set((
                        workflow_executions::status.eq("Running"),
                        workflow_executions::paused_at.eq(None::<UniversalTimestamp>),
                        workflow_executions::pause_reason.eq(None::<String>),
                        workflow_executions::updated_at.eq(now),
                    ))
                    .execute(conn)?;

                // Insert execution event
                let event = NewUnifiedExecutionEvent {
                    id: UniversalUuid::new_v4(),
                    workflow_execution_id: id,
                    task_execution_id: None,
                    event_type: ExecutionEventType::WorkflowResumed.as_str().to_string(),
                    event_data: None,
                    worker_id: None,
                    created_at: now,
                    request_id: None,
                    runner_id: None,
                    tenant_id: None,
                };
                diesel::insert_into(execution_events::table)
                    .values(&event)
                    .execute(conn)?;

                Ok(())
            })
        })?;

        Ok(())
    }

    pub async fn update_final_context(
        &self,
        id: UniversalUuid,
        final_context_id: UniversalUuid,
    ) -> Result<(), ValidationError> {
        let now = UniversalTimestamp::now();
        crate::interact_on_backend!(self.dal, |conn| {
            diesel::update(workflow_executions::table.find(id))
                .set((
                    workflow_executions::context_id.eq(Some(final_context_id)),
                    workflow_executions::updated_at.eq(now),
                ))
                .execute(conn)
        })?;

        Ok(())
    }

    pub async fn list_recent(
        &self,
        limit: i64,
    ) -> Result<Vec<WorkflowExecutionRecord>, ValidationError> {
        let executions: Vec<UnifiedWorkflowExecution> =
            crate::interact_on_backend!(self.dal, |conn| {
                workflow_executions::table
                    .order(workflow_executions::started_at.desc())
                    .limit(limit)
                    .load(conn)
            })?;

        Ok(executions.into_iter().map(Into::into).collect())
    }

    /// CLOACI-T-0594 / API-02: filtered list endpoint. Supports
    /// `status` (e.g. "Failed", "Running") and `workflow_name`
    /// filters with bounded pagination. Replaces the old route-level
    /// `get_active_executions()` call that silently ignored the query
    /// string.
    pub async fn list_filtered(
        &self,
        filter: ExecutionListFilter,
    ) -> Result<Vec<WorkflowExecutionRecord>, ValidationError> {
        let executions: Vec<UnifiedWorkflowExecution> =
            crate::interact_on_backend!(self.dal, |conn| {
                let mut query = workflow_executions::table.into_boxed();
                if let Some(ref status) = filter.status {
                    query = query.filter(workflow_executions::status.eq(status.clone()));
                }
                if let Some(ref name) = filter.workflow_name {
                    query = query.filter(workflow_executions::workflow_name.eq(name.clone()));
                }
                query
                    .order(workflow_executions::started_at.desc())
                    .limit(filter.limit)
                    .offset(filter.offset)
                    .load(conn)
            })?;

        Ok(executions.into_iter().map(Into::into).collect())
    }
}