qail-workflow-postgres 2.0.4

QAIL Flow Ledger - PostgreSQL workflow state, lease, idempotency, timeout, and side-effect storage
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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
use std::sync::Arc;
use std::time::Duration;

use async_trait::async_trait;
use chrono::{DateTime, Utc};
use qail_core::ast::{Operator, Qail, Value as QailValue};
use qail_pg::{PgDriver, PgPool, PgRow, PooledConnection};
use qail_workflow::{
    WorkflowContext, WorkflowError, WorkflowLease, WorkflowOperation, WorkflowOperationStatus,
    WorkflowSideEffect, WorkflowSideEffectStatus,
};
use tokio::sync::Mutex;

use crate::tables::PgWorkflowTables;
use crate::util::{
    STATUS_COMPLETED, STATUS_FAILED, STATUS_STARTED, deadline_after, deadline_from_duration,
    excluded, finish_pool_connection, finish_pool_tx, finish_tx, is_duplicate, is_stale_timestamp,
    json_error, missing_started_row, operation_kind_text, option_string, optional_json, pg_error,
    required_string, timestamp,
};

#[derive(Clone)]
enum PgWorkflowBackend {
    Driver(Arc<Mutex<PgDriver>>),
    Pool(PgPool),
}

#[async_trait]
trait PgWorkflowConnection: Send {
    async fn execute_ast(&mut self, cmd: &Qail) -> qail_pg::PgResult<u64>;
    async fn fetch_all_ast(&mut self, cmd: &Qail) -> qail_pg::PgResult<Vec<PgRow>>;
}

#[async_trait]
impl PgWorkflowConnection for PgDriver {
    async fn execute_ast(&mut self, cmd: &Qail) -> qail_pg::PgResult<u64> {
        self.execute(cmd).await
    }

    async fn fetch_all_ast(&mut self, cmd: &Qail) -> qail_pg::PgResult<Vec<PgRow>> {
        self.fetch_all(cmd).await
    }
}

#[async_trait]
impl PgWorkflowConnection for PooledConnection {
    async fn execute_ast(&mut self, cmd: &Qail) -> qail_pg::PgResult<u64> {
        self.execute(cmd).await
    }

    async fn fetch_all_ast(&mut self, cmd: &Qail) -> qail_pg::PgResult<Vec<PgRow>> {
        self.fetch_all_uncached(cmd).await
    }
}

/// PostgreSQL workflow storage using either a single `PgDriver` or a `PgPool`.
#[derive(Clone)]
pub struct PgWorkflowStore {
    backend: PgWorkflowBackend,
    tables: PgWorkflowTables,
    timeout_claim_ttl: Duration,
    in_progress_ttl: Duration,
}

impl PgWorkflowStore {
    /// Create a store around an existing driver.
    pub fn new(driver: PgDriver) -> Self {
        Self::from_shared(Arc::new(Mutex::new(driver)))
    }

    /// Create a store around a shared driver handle.
    pub fn from_shared(driver: Arc<Mutex<PgDriver>>) -> Self {
        Self {
            backend: PgWorkflowBackend::Driver(driver),
            tables: PgWorkflowTables::default(),
            timeout_claim_ttl: Duration::from_secs(60),
            in_progress_ttl: Duration::from_secs(3600),
        }
    }

    /// Create a store around an existing PostgreSQL connection pool.
    ///
    /// The store uses raw pooled connections because workflow ledger tables are
    /// internal runtime state, not tenant-scoped application data.
    pub fn from_pool(pool: PgPool) -> Self {
        Self {
            backend: PgWorkflowBackend::Pool(pool),
            tables: PgWorkflowTables::default(),
            timeout_claim_ttl: Duration::from_secs(60),
            in_progress_ttl: Duration::from_secs(3600),
        }
    }

    /// Connect a store from a PostgreSQL URL.
    pub async fn connect_url(url: &str) -> Result<Self, WorkflowError> {
        let driver = PgDriver::connect_url(url).await.map_err(pg_error)?;
        Ok(Self::new(driver))
    }

    /// Override storage table names.
    pub fn with_tables(mut self, tables: PgWorkflowTables) -> Self {
        self.tables = tables;
        self
    }

    /// Override how long a timeout drain claim should be held.
    pub fn with_timeout_claim_ttl(mut self, ttl: Duration) -> Self {
        self.timeout_claim_ttl = ttl;
        self
    }

    /// Override how long a started operation or side effect is considered in progress.
    pub fn with_in_progress_ttl(mut self, ttl: Duration) -> Self {
        self.in_progress_ttl = ttl;
        self
    }

    /// Return the storage table names.
    pub fn tables(&self) -> &PgWorkflowTables {
        &self.tables
    }

    /// Return QAIL AST schema commands for this store.
    pub fn schema_commands(&self) -> Vec<Qail> {
        self.tables.schema_commands()
    }

    async fn execute_command(&self, cmd: &Qail) -> Result<u64, WorkflowError> {
        match &self.backend {
            PgWorkflowBackend::Driver(driver) => {
                let mut driver = driver.lock().await;
                driver.execute_ast(cmd).await.map_err(pg_error)
            }
            PgWorkflowBackend::Pool(pool) => {
                // SAFETY: workflow storage owns internal ledger tables and every
                // command is generated as QAIL AST, so no tenant app data is read.
                let mut conn = pool.acquire_raw().await.map_err(pg_error)?;
                let result = conn.execute_ast(cmd).await.map_err(pg_error);
                finish_pool_connection(conn, result).await
            }
        }
    }

    async fn fetch_all_command(&self, cmd: &Qail) -> Result<Vec<PgRow>, WorkflowError> {
        match &self.backend {
            PgWorkflowBackend::Driver(driver) => {
                let mut driver = driver.lock().await;
                driver.fetch_all_ast(cmd).await.map_err(pg_error)
            }
            PgWorkflowBackend::Pool(pool) => {
                // SAFETY: workflow storage owns internal ledger tables and every
                // command is generated as QAIL AST, so no tenant app data is read.
                let mut conn = pool.acquire_raw().await.map_err(pg_error)?;
                let result = conn.fetch_all_ast(cmd).await.map_err(pg_error);
                finish_pool_connection(conn, result).await
            }
        }
    }

    async fn begin_pool_transaction(pool: &PgPool) -> Result<PooledConnection, WorkflowError> {
        // SAFETY: workflow storage owns internal ledger tables and every command
        // is generated as QAIL AST, so no tenant app data is read.
        let mut conn = pool.acquire_raw().await.map_err(pg_error)?;
        if let Err(err) = conn.begin().await.map_err(pg_error) {
            let _ = conn.rollback_and_release().await;
            return Err(err);
        }
        Ok(conn)
    }

    /// Execute the schema commands through the AST driver path.
    pub async fn install_schema(&self) -> Result<(), WorkflowError> {
        for cmd in self.schema_commands() {
            self.execute_command(&cmd).await?;
        }
        Ok(())
    }

    pub(crate) async fn save_state(&self, ctx: &WorkflowContext) -> Result<(), WorkflowError> {
        let context_json = serde_json::to_string(ctx).map_err(json_error)?;
        let wait = ctx.cursor.as_ref().and_then(|cursor| cursor.wait.as_ref());
        let wait_event = wait.map(|wait| wait.event.clone());
        let wait_deadline = wait.map(|wait| timestamp(wait.deadline_at));
        let now = timestamp(Utc::now());

        let cmd = Qail::add(&self.tables.states)
            .columns([
                "workflow_id",
                "definition_name",
                "definition_version",
                "current_state",
                "context",
                "wait_event",
                "wait_deadline_at",
                "timeout_claimed_until",
                "created_at",
                "updated_at",
            ])
            .values([
                QailValue::String(ctx.workflow_id.clone()),
                option_string(ctx.definition_name.clone()),
                option_string(ctx.definition_version.clone()),
                QailValue::String(ctx.current_state.clone()),
                QailValue::Json(context_json),
                option_string(wait_event),
                option_string(wait_deadline),
                QailValue::Null,
                QailValue::String(timestamp(ctx.created_at)),
                QailValue::String(now),
            ])
            .on_conflict_update(
                &["workflow_id"],
                &[
                    ("definition_name", excluded("definition_name")),
                    ("definition_version", excluded("definition_version")),
                    ("current_state", excluded("current_state")),
                    ("context", excluded("context")),
                    ("wait_event", excluded("wait_event")),
                    ("wait_deadline_at", excluded("wait_deadline_at")),
                    ("timeout_claimed_until", excluded("timeout_claimed_until")),
                    ("updated_at", excluded("updated_at")),
                ],
            );

        self.execute_command(&cmd).await?;
        Ok(())
    }

    pub(crate) async fn load_state(
        &self,
        workflow_id: &str,
    ) -> Result<Option<WorkflowContext>, WorkflowError> {
        let cmd = Qail::get(&self.tables.states)
            .columns(["context"])
            .eq("workflow_id", workflow_id)
            .limit(1);

        let rows = self.fetch_all_command(&cmd).await?;
        let Some(row) = rows.first() else {
            return Ok(None);
        };
        let context_json = required_string(row, 0, "context")?;
        let ctx = serde_json::from_str(&context_json).map_err(json_error)?;
        Ok(Some(ctx))
    }

    pub(crate) async fn acquire_workflow_lease(
        &self,
        lease: &WorkflowLease,
    ) -> Result<bool, WorkflowError> {
        match &self.backend {
            PgWorkflowBackend::Driver(driver) => {
                let mut driver = driver.lock().await;
                driver.begin().await.map_err(pg_error)?;

                let result = self.acquire_workflow_lease_tx(&mut *driver, lease).await;
                finish_tx(&mut driver, result).await
            }
            PgWorkflowBackend::Pool(pool) => {
                let mut conn = Self::begin_pool_transaction(pool).await?;
                let result = self.acquire_workflow_lease_tx(&mut conn, lease).await;
                finish_pool_tx(conn, result).await
            }
        }
    }

    async fn acquire_workflow_lease_tx<C>(
        &self,
        conn: &mut C,
        lease: &WorkflowLease,
    ) -> Result<bool, WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        let now = timestamp(Utc::now());
        let expires_at = timestamp(deadline_from_duration(lease.ttl)?);
        let existing = Qail::get(&self.tables.leases)
            .columns(["owner", "expires_at"])
            .eq("workflow_id", lease.workflow_id.as_str())
            .for_update()
            .limit(1);

        let rows = conn.fetch_all_ast(&existing).await.map_err(pg_error)?;
        if let Some(row) = rows.first() {
            let expires = required_string(row, 1, "expires_at")?;
            if expires > now {
                return Ok(false);
            }

            let update = Qail::set(&self.tables.leases)
                .set_value("owner", lease.owner.clone())
                .set_value("expires_at", expires_at)
                .set_value("updated_at", now)
                .eq("workflow_id", lease.workflow_id.as_str());
            conn.execute_ast(&update).await.map_err(pg_error)?;
            return Ok(true);
        }

        let insert = Qail::add(&self.tables.leases)
            .columns(["workflow_id", "owner", "expires_at", "updated_at"])
            .values([
                QailValue::String(lease.workflow_id.clone()),
                QailValue::String(lease.owner.clone()),
                QailValue::String(expires_at),
                QailValue::String(now),
            ]);

        match conn.execute_ast(&insert).await {
            Ok(_) => Ok(true),
            Err(err) if is_duplicate(&err) => Ok(false),
            Err(err) => Err(pg_error(err)),
        }
    }

    pub(crate) async fn release_workflow_lease(
        &self,
        lease: &WorkflowLease,
    ) -> Result<(), WorkflowError> {
        let cmd = Qail::del(&self.tables.leases)
            .eq("workflow_id", lease.workflow_id.as_str())
            .eq("owner", lease.owner.as_str());
        self.execute_command(&cmd).await?;
        Ok(())
    }

    pub(crate) async fn begin_workflow_operation(
        &self,
        operation: &WorkflowOperation,
    ) -> Result<WorkflowOperationStatus, WorkflowError> {
        self.ensure_in_progress_ttl()?;
        match &self.backend {
            PgWorkflowBackend::Driver(driver) => {
                let mut driver = driver.lock().await;
                driver.begin().await.map_err(pg_error)?;

                let result = self
                    .begin_workflow_operation_tx(&mut *driver, operation)
                    .await;
                finish_tx(&mut driver, result).await
            }
            PgWorkflowBackend::Pool(pool) => {
                let mut conn = Self::begin_pool_transaction(pool).await?;
                let result = self.begin_workflow_operation_tx(&mut conn, operation).await;
                finish_pool_tx(conn, result).await
            }
        }
    }

    async fn begin_workflow_operation_tx<C>(
        &self,
        conn: &mut C,
        operation: &WorkflowOperation,
    ) -> Result<WorkflowOperationStatus, WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        let operation_kind = operation_kind_text(&operation.kind);
        let now = Utc::now();
        let existing = Qail::get(&self.tables.operations)
            .columns(["status", "state", "kind", "workflow_name", "updated_at"])
            .eq("workflow_id", operation.workflow_id.as_str())
            .eq("idempotency_key", operation.idempotency_key.as_str())
            .for_update()
            .limit(1);
        let rows = conn.fetch_all_ast(&existing).await.map_err(pg_error)?;

        if let Some(row) = rows.first() {
            let status = required_string(row, 0, "status")?;
            let stored_kind = required_string(row, 2, "kind")?;
            if stored_kind != operation_kind {
                return Err(WorkflowError::Other(format!(
                    "Workflow operation idempotency key '{}' was previously used for kind {}, not {}",
                    operation.idempotency_key, stored_kind, operation_kind
                )));
            }
            let stored_workflow_name = required_string(row, 3, "workflow_name")?;
            if stored_workflow_name != operation.workflow_name {
                return Err(WorkflowError::Other(format!(
                    "Workflow operation idempotency key '{}' was previously used for workflow '{}', not '{}'",
                    operation.idempotency_key, stored_workflow_name, operation.workflow_name
                )));
            }

            return match status.as_str() {
                STATUS_STARTED => {
                    let updated_at = required_string(row, 4, "updated_at")?;
                    if is_stale_timestamp(
                        &updated_at,
                        now,
                        self.in_progress_ttl,
                        "workflow operation updated_at",
                    )? {
                        self.mark_started_workflow_operation_started_tx(conn, operation)
                            .await?;
                        Ok(WorkflowOperationStatus::Started)
                    } else {
                        Ok(WorkflowOperationStatus::InProgress)
                    }
                }
                STATUS_COMPLETED => {
                    let state = required_string(row, 1, "state")?;
                    Ok(WorkflowOperationStatus::Completed { state })
                }
                STATUS_FAILED => {
                    self.mark_workflow_operation_started_tx(conn, operation)
                        .await?;
                    Ok(WorkflowOperationStatus::Started)
                }
                other => Err(WorkflowError::Other(format!(
                    "Unknown workflow operation status '{other}'"
                ))),
            };
        }

        let now = timestamp(Utc::now());
        let insert = Qail::add(&self.tables.operations)
            .columns([
                "workflow_name",
                "workflow_id",
                "idempotency_key",
                "kind",
                "status",
                "state",
                "error",
                "created_at",
                "updated_at",
            ])
            .values([
                QailValue::String(operation.workflow_name.clone()),
                QailValue::String(operation.workflow_id.clone()),
                QailValue::String(operation.idempotency_key.clone()),
                QailValue::String(operation_kind),
                QailValue::String(STATUS_STARTED.to_string()),
                QailValue::Null,
                QailValue::Null,
                QailValue::String(now.clone()),
                QailValue::String(now),
            ]);

        match conn.execute_ast(&insert).await {
            Ok(_) => Ok(WorkflowOperationStatus::Started),
            Err(err) if is_duplicate(&err) => Ok(WorkflowOperationStatus::InProgress),
            Err(err) => Err(pg_error(err)),
        }
    }

    fn ensure_in_progress_ttl(&self) -> Result<(), WorkflowError> {
        if self.in_progress_ttl.is_zero() {
            return Err(WorkflowError::Other(
                "Workflow in-progress TTL must be greater than zero".to_string(),
            ));
        }
        Ok(())
    }

    async fn mark_started_workflow_operation_started_tx<C>(
        &self,
        conn: &mut C,
        operation: &WorkflowOperation,
    ) -> Result<(), WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        self.refresh_workflow_operation_started_tx(conn, operation, STATUS_STARTED)
            .await
    }

    async fn mark_workflow_operation_started_tx<C>(
        &self,
        conn: &mut C,
        operation: &WorkflowOperation,
    ) -> Result<(), WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        self.refresh_workflow_operation_started_tx(conn, operation, STATUS_FAILED)
            .await
    }

    async fn refresh_workflow_operation_started_tx<C>(
        &self,
        conn: &mut C,
        operation: &WorkflowOperation,
        expected_status: &str,
    ) -> Result<(), WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        let operation_kind = operation_kind_text(&operation.kind);
        let cmd = Qail::set(&self.tables.operations)
            .set_value("status", STATUS_STARTED)
            .set_value("state", QailValue::Null)
            .set_value("error", QailValue::Null)
            .set_value("updated_at", timestamp(Utc::now()))
            .eq("workflow_name", operation.workflow_name.as_str())
            .eq("workflow_id", operation.workflow_id.as_str())
            .eq("idempotency_key", operation.idempotency_key.as_str())
            .eq("kind", operation_kind.as_str())
            .eq("status", expected_status);
        let affected = conn.execute_ast(&cmd).await.map_err(pg_error)?;
        if affected == 0 {
            return Err(WorkflowError::Other(format!(
                "Workflow operation '{}' was not found in {expected_status} state",
                operation.idempotency_key,
            )));
        }
        Ok(())
    }

    pub(crate) async fn complete_workflow_operation(
        &self,
        operation: &WorkflowOperation,
        state: &str,
    ) -> Result<(), WorkflowError> {
        let operation_kind = operation_kind_text(&operation.kind);
        let cmd = Qail::set(&self.tables.operations)
            .set_value("status", STATUS_COMPLETED)
            .set_value("state", state)
            .set_value("error", QailValue::Null)
            .set_value("updated_at", timestamp(Utc::now()))
            .eq("workflow_name", operation.workflow_name.as_str())
            .eq("workflow_id", operation.workflow_id.as_str())
            .eq("idempotency_key", operation.idempotency_key.as_str())
            .eq("kind", operation_kind.as_str())
            .eq("status", STATUS_STARTED);
        let affected = self.execute_command(&cmd).await?;
        if affected == 0 {
            return Err(missing_started_row(
                "operation",
                operation.idempotency_key.as_str(),
            ));
        }
        Ok(())
    }

    pub(crate) async fn fail_workflow_operation(
        &self,
        operation: &WorkflowOperation,
        error: &str,
    ) -> Result<(), WorkflowError> {
        let operation_kind = operation_kind_text(&operation.kind);
        let cmd = Qail::set(&self.tables.operations)
            .set_value("status", STATUS_FAILED)
            .set_value("error", error)
            .set_value("updated_at", timestamp(Utc::now()))
            .eq("workflow_name", operation.workflow_name.as_str())
            .eq("workflow_id", operation.workflow_id.as_str())
            .eq("idempotency_key", operation.idempotency_key.as_str())
            .eq("kind", operation_kind.as_str())
            .eq("status", STATUS_STARTED);
        let affected = self.execute_command(&cmd).await?;
        if affected == 0 {
            return Err(missing_started_row(
                "operation",
                operation.idempotency_key.as_str(),
            ));
        }
        Ok(())
    }

    pub(crate) async fn load_due_workflow_timeouts(
        &self,
        workflow_name: &str,
        now: DateTime<Utc>,
        limit: usize,
    ) -> Result<Vec<String>, WorkflowError> {
        if limit == 0 {
            return Ok(Vec::new());
        }
        if self.timeout_claim_ttl.is_zero() {
            return Err(WorkflowError::Other(
                "Workflow timeout claim TTL must be greater than zero".to_string(),
            ));
        }

        match &self.backend {
            PgWorkflowBackend::Driver(driver) => {
                let mut driver = driver.lock().await;
                driver.begin().await.map_err(pg_error)?;

                let result = self
                    .load_due_workflow_timeouts_tx(&mut *driver, workflow_name, now, limit)
                    .await;
                finish_tx(&mut driver, result).await
            }
            PgWorkflowBackend::Pool(pool) => {
                let mut conn = Self::begin_pool_transaction(pool).await?;
                let result = self
                    .load_due_workflow_timeouts_tx(&mut conn, workflow_name, now, limit)
                    .await;
                finish_pool_tx(conn, result).await
            }
        }
    }

    async fn load_due_workflow_timeouts_tx<C>(
        &self,
        conn: &mut C,
        workflow_name: &str,
        now: DateTime<Utc>,
        limit: usize,
    ) -> Result<Vec<String>, WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        let claim_until = timestamp(deadline_after(now, self.timeout_claim_ttl)?);
        let now = timestamp(now);
        let limit = i64::try_from(limit).unwrap_or(i64::MAX);
        let due = timeout_due_query(&self.tables, workflow_name, now.as_str(), limit);

        let rows = conn.fetch_all_ast(&due).await.map_err(pg_error)?;
        let mut ids = Vec::with_capacity(rows.len());
        for row in rows {
            let workflow_id = required_string(&row, 0, "workflow_id")?;
            let claim = Qail::set(&self.tables.states)
                .set_value("timeout_claimed_until", claim_until.clone())
                .set_value("updated_at", timestamp(Utc::now()))
                .eq("workflow_id", workflow_id.as_str());
            conn.execute_ast(&claim).await.map_err(pg_error)?;
            ids.push(workflow_id);
        }
        Ok(ids)
    }

    pub(crate) async fn begin_workflow_side_effect(
        &self,
        operation: &WorkflowSideEffect,
    ) -> Result<WorkflowSideEffectStatus, WorkflowError> {
        self.ensure_in_progress_ttl()?;
        match &self.backend {
            PgWorkflowBackend::Driver(driver) => {
                let mut driver = driver.lock().await;
                driver.begin().await.map_err(pg_error)?;

                let result = self
                    .begin_workflow_side_effect_tx(&mut *driver, operation)
                    .await;
                finish_tx(&mut driver, result).await
            }
            PgWorkflowBackend::Pool(pool) => {
                let mut conn = Self::begin_pool_transaction(pool).await?;
                let result = self
                    .begin_workflow_side_effect_tx(&mut conn, operation)
                    .await;
                finish_pool_tx(conn, result).await
            }
        }
    }

    async fn begin_workflow_side_effect_tx<C>(
        &self,
        conn: &mut C,
        operation: &WorkflowSideEffect,
    ) -> Result<WorkflowSideEffectStatus, WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        let existing = Qail::get(&self.tables.side_effects)
            .columns([
                "status",
                "result",
                "workflow_id",
                "state",
                "step_path",
                "kind",
                "updated_at",
            ])
            .eq("operation_id", operation.operation_id.as_str())
            .for_update()
            .limit(1);
        let rows = conn.fetch_all_ast(&existing).await.map_err(pg_error)?;

        if let Some(row) = rows.first() {
            let status = required_string(row, 0, "status")?;
            self.ensure_side_effect_identity(row, operation)?;
            return match status.as_str() {
                STATUS_STARTED => {
                    let updated_at = required_string(row, 6, "updated_at")?;
                    if is_stale_timestamp(
                        &updated_at,
                        Utc::now(),
                        self.in_progress_ttl,
                        "workflow side effect updated_at",
                    )? {
                        self.mark_started_workflow_side_effect_started_tx(conn, operation)
                            .await?;
                        Ok(WorkflowSideEffectStatus::Execute)
                    } else {
                        Err(WorkflowError::Other(format!(
                            "Workflow side effect '{}' is already in progress",
                            operation.operation_id
                        )))
                    }
                }
                STATUS_COMPLETED => Ok(WorkflowSideEffectStatus::AlreadyCompleted {
                    result: optional_json(row, 1)?,
                }),
                STATUS_FAILED => {
                    self.mark_workflow_side_effect_started_tx(conn, operation)
                        .await?;
                    Ok(WorkflowSideEffectStatus::Execute)
                }
                other => Err(WorkflowError::Other(format!(
                    "Unknown workflow side effect status '{other}'"
                ))),
            };
        }

        let now = timestamp(Utc::now());
        let insert = Qail::add(&self.tables.side_effects)
            .columns([
                "operation_id",
                "workflow_id",
                "state",
                "step_path",
                "kind",
                "status",
                "result",
                "error",
                "created_at",
                "updated_at",
            ])
            .values([
                QailValue::String(operation.operation_id.clone()),
                QailValue::String(operation.workflow_id.clone()),
                QailValue::String(operation.state.clone()),
                QailValue::String(operation.step_path.clone()),
                QailValue::String(operation.kind.as_str().to_string()),
                QailValue::String(STATUS_STARTED.to_string()),
                QailValue::Null,
                QailValue::Null,
                QailValue::String(now.clone()),
                QailValue::String(now),
            ]);

        match conn.execute_ast(&insert).await {
            Ok(_) => Ok(WorkflowSideEffectStatus::Execute),
            Err(err) if is_duplicate(&err) => Err(WorkflowError::Other(format!(
                "Workflow side effect '{}' is already in progress",
                operation.operation_id
            ))),
            Err(err) => Err(pg_error(err)),
        }
    }

    fn ensure_side_effect_identity(
        &self,
        row: &qail_pg::PgRow,
        operation: &WorkflowSideEffect,
    ) -> Result<(), WorkflowError> {
        let stored_workflow_id = required_string(row, 2, "workflow_id")?;
        let stored_state = required_string(row, 3, "state")?;
        let stored_step_path = required_string(row, 4, "step_path")?;
        let stored_kind = required_string(row, 5, "kind")?;
        let expected_kind = operation.kind.as_str();
        if stored_workflow_id != operation.workflow_id
            || stored_state != operation.state
            || stored_step_path != operation.step_path
            || stored_kind != expected_kind
        {
            return Err(WorkflowError::Other(format!(
                "Workflow side effect operation id '{}' was previously used for {}/{}/{}/{}, not {}/{}/{}/{}",
                operation.operation_id,
                stored_workflow_id,
                stored_state,
                stored_step_path,
                stored_kind,
                operation.workflow_id,
                operation.state,
                operation.step_path,
                expected_kind
            )));
        }
        Ok(())
    }

    async fn mark_workflow_side_effect_started_tx<C>(
        &self,
        conn: &mut C,
        operation: &WorkflowSideEffect,
    ) -> Result<(), WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        self.refresh_workflow_side_effect_started_tx(conn, operation, STATUS_FAILED)
            .await
    }

    async fn mark_started_workflow_side_effect_started_tx<C>(
        &self,
        conn: &mut C,
        operation: &WorkflowSideEffect,
    ) -> Result<(), WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        self.refresh_workflow_side_effect_started_tx(conn, operation, STATUS_STARTED)
            .await
    }

    async fn refresh_workflow_side_effect_started_tx<C>(
        &self,
        conn: &mut C,
        operation: &WorkflowSideEffect,
        expected_status: &str,
    ) -> Result<(), WorkflowError>
    where
        C: PgWorkflowConnection,
    {
        let cmd = Qail::set(&self.tables.side_effects)
            .set_value("status", STATUS_STARTED)
            .set_value("result", QailValue::Null)
            .set_value("error", QailValue::Null)
            .set_value("updated_at", timestamp(Utc::now()))
            .eq("operation_id", operation.operation_id.as_str())
            .eq("workflow_id", operation.workflow_id.as_str())
            .eq("state", operation.state.as_str())
            .eq("step_path", operation.step_path.as_str())
            .eq("kind", operation.kind.as_str())
            .eq("status", expected_status);
        let affected = conn.execute_ast(&cmd).await.map_err(pg_error)?;
        if affected == 0 {
            return Err(WorkflowError::Other(format!(
                "Workflow side effect '{}' was not found in {expected_status} state",
                operation.operation_id,
            )));
        }
        Ok(())
    }

    pub(crate) async fn complete_workflow_side_effect(
        &self,
        operation: &WorkflowSideEffect,
        result: Option<&serde_json::Value>,
    ) -> Result<(), WorkflowError> {
        let result = match result {
            Some(value) => QailValue::Json(serde_json::to_string(value).map_err(json_error)?),
            None => QailValue::Null,
        };
        let cmd = Qail::set(&self.tables.side_effects)
            .set_value("status", STATUS_COMPLETED)
            .set_value("result", result)
            .set_value("error", QailValue::Null)
            .set_value("updated_at", timestamp(Utc::now()))
            .eq("operation_id", operation.operation_id.as_str())
            .eq("workflow_id", operation.workflow_id.as_str())
            .eq("state", operation.state.as_str())
            .eq("step_path", operation.step_path.as_str())
            .eq("kind", operation.kind.as_str())
            .eq("status", STATUS_STARTED);
        let affected = self.execute_command(&cmd).await?;
        if affected == 0 {
            return Err(missing_started_row(
                "side effect",
                operation.operation_id.as_str(),
            ));
        }
        Ok(())
    }

    pub(crate) async fn fail_workflow_side_effect(
        &self,
        operation: &WorkflowSideEffect,
        error: &str,
    ) -> Result<(), WorkflowError> {
        let cmd = Qail::set(&self.tables.side_effects)
            .set_value("status", STATUS_FAILED)
            .set_value("error", error)
            .set_value("updated_at", timestamp(Utc::now()))
            .eq("operation_id", operation.operation_id.as_str())
            .eq("workflow_id", operation.workflow_id.as_str())
            .eq("state", operation.state.as_str())
            .eq("step_path", operation.step_path.as_str())
            .eq("kind", operation.kind.as_str())
            .eq("status", STATUS_STARTED);
        let affected = self.execute_command(&cmd).await?;
        if affected == 0 {
            return Err(missing_started_row(
                "side effect",
                operation.operation_id.as_str(),
            ));
        }
        Ok(())
    }
}

fn timeout_due_query(
    tables: &PgWorkflowTables,
    workflow_name: &str,
    now: &str,
    limit: i64,
) -> Qail {
    Qail::get(&tables.states)
        .columns(["workflow_id"])
        .eq("definition_name", workflow_name)
        .lte("wait_deadline_at", now)
        .is_not_null("wait_deadline_at")
        .or_filter("timeout_claimed_until", Operator::IsNull, QailValue::Null)
        .or_filter("timeout_claimed_until", Operator::Lt, now)
        .for_update_skip_locked()
        .limit(limit)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn due_timeout_query_uses_row_locking() {
        let tables = PgWorkflowTables::default();
        let cmd = timeout_due_query(&tables, "booking", "2026-01-01T00:00:00.000000Z", 10);

        assert!(cmd.lock_mode.is_some());
        assert!(cmd.skip_locked);
    }
}