ironflow-store 2.38.1

Storage abstraction and implementations for ironflow run tracking
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

//! The [`ApprovalDelegationStore`] trait -- async storage for approval delegations.

use uuid::Uuid;

use crate::entities::{ApprovalDelegation, DelegationFilter, NewApprovalDelegation, Page};
use crate::store::StoreFuture;

/// Async storage abstraction for approval delegations.
///
/// All methods return a [`StoreFuture`] (boxed future) for object safety,
/// allowing the store to be used as `Arc<dyn ApprovalDelegationStore>`.
///
/// # Examples
///
/// ```no_run
/// use chrono::{TimeDelta, Utc};
/// use ironflow_store::prelude::*;
/// use uuid::Uuid;
///
/// # async fn example(alice: Uuid, bob: Uuid) -> Result<(), ironflow_store::error::StoreError> {
/// let store = InMemoryStore::new();
/// let now = Utc::now();
///
/// store.create_delegation(NewApprovalDelegation {
///     from_user_id: alice,
///     to_user_id: bob,
///     valid_from: now,
///     valid_until: now + TimeDelta::days(7),
///     workflow_filter: Some("deploy-*".to_string()),
/// }).await?;
///
/// let received = store.list_active_delegations(DelegationFilter {
///     to_user_id: Some(bob),
///     ..DelegationFilter::default()
/// }, 1, 20).await?;
/// assert_eq!(received.total, 1);
///
/// let found = store.find_active_delegation(alice, bob, "deploy-api").await?;
/// assert!(found.is_some());
/// # Ok(())
/// # }
/// ```
pub trait ApprovalDelegationStore: Send + Sync {
    /// Create a new delegation.
    ///
    /// # Errors
    ///
    /// Returns [`StoreError`](crate::error::StoreError) on storage failure.
    fn create_delegation(&self, req: NewApprovalDelegation) -> StoreFuture<'_, ApprovalDelegation>;

    /// Find a delegation by ID. Returns `None` if not found.
    ///
    /// Unlike [`list_active_delegations`](Self::list_active_delegations) this
    /// also returns expired and not-yet-started rows, so an expired delegation
    /// can still be revoked.
    ///
    /// # Errors
    ///
    /// Returns [`StoreError`](crate::error::StoreError) on storage failure.
    fn find_delegation_by_id(&self, id: Uuid) -> StoreFuture<'_, Option<ApprovalDelegation>>;

    /// List one page of the delegations matching `filter`, newest first.
    ///
    /// Active delegations only: `valid_from <= now < valid_until`. Expired and
    /// not-yet-started rows are filtered out at read time; nothing is deleted.
    /// Ordered by `created_at` descending. `page` is 1-based.
    ///
    /// The workflow glob is *not* applied here: use
    /// [`find_active_delegation`](Self::find_active_delegation) to check a
    /// delegation for a given workflow.
    ///
    /// # Errors
    ///
    /// Returns [`StoreError`](crate::error::StoreError) on storage failure.
    fn list_active_delegations(
        &self,
        filter: DelegationFilter,
        page: u32,
        per_page: u32,
    ) -> StoreFuture<'_, Page<ApprovalDelegation>>;

    /// Find an active delegation from `from_user_id` to `to_user_id` whose
    /// workflow filter matches `workflow_name`. Returns `None` if there is none.
    ///
    /// When several delegations qualify, the most recently created one wins.
    ///
    /// # Errors
    ///
    /// Returns [`StoreError`](crate::error::StoreError) on storage failure.
    fn find_active_delegation(
        &self,
        from_user_id: Uuid,
        to_user_id: Uuid,
        workflow_name: &str,
    ) -> StoreFuture<'_, Option<ApprovalDelegation>>;

    /// Revoke a delegation by ID.
    ///
    /// # Errors
    ///
    /// Returns [`StoreError::DelegationNotFound`](crate::error::StoreError) if
    /// the delegation does not exist.
    fn delete_delegation(&self, id: Uuid) -> StoreFuture<'_, ()>;
}