ironflow_store/memory/

mod.rs

//! In-memory [`Store`](crate::store::Store) implementation for development and testing.
//!
//! [`InMemoryStore`] uses `Arc<RwLock<..>>` internally, making it safe to share
//! across tasks. Data is lost when the process exits.
//!
//! # Examples
//!
//! ```no_run
//! use std::collections::HashMap;
//! use ironflow_store::prelude::*;
//! use serde_json::json;
//!
//! # async fn example() -> Result<(), ironflow_store::error::StoreError> {
//! let store = InMemoryStore::new();
//!
//! let run = store.create_run(NewRun {
//!     workflow_name: "test".to_string(),
//!     trigger: TriggerKind::Manual,
//!     payload: json!({}),
//!     max_retries: 3,
//!     handler_version: None,
//!     labels: HashMap::new(),
//!     scheduled_at: None,
//!     created_by: None,
//!     idempotency_key: None,
//!     max_cost_usd: None,
//! }).await?.into_run();
//!
//! assert_eq!(run.status.state, RunStatus::Pending);
//! # Ok(())
//! # }
//! ```

use std::collections::{BTreeSet, HashMap};
use std::sync::Arc;

use tokio::sync::RwLock;
use uuid::Uuid;

use crate::entities::User;

mod api_key_store;
mod approval_delegation_store;
mod artifact_store;
mod audit_log_store;
mod log_store;
mod run_store;
mod schedule_store;
mod secret_store;
mod stats_history;
mod user_store;

#[derive(Debug, Default)]
pub(super) struct State {
    pub(super) runs: HashMap<Uuid, crate::entities::Run>,
    /// Idempotency key -> run holding it. Guarded by the same lock as `runs`,
    /// so check-then-insert is atomic.
    pub(super) idempotency_keys: HashMap<String, Uuid>,
    pub(super) steps: HashMap<Uuid, crate::entities::Step>,
    pub(super) step_dependencies: Vec<crate::entities::StepDependency>,
    pub(super) artifacts: HashMap<Uuid, crate::entities::Artifact>,
    pub(super) users: HashMap<Uuid, User>,
    /// Group membership per user, kept sorted and deduplicated.
    pub(super) user_groups: HashMap<Uuid, BTreeSet<String>>,
    pub(super) api_keys: HashMap<Uuid, crate::entities::ApiKey>,
    pub(super) secrets: HashMap<String, EncryptedSecret>,
    pub(super) schedules: HashMap<Uuid, crate::entities::Schedule>,
    pub(super) approval_delegations: HashMap<Uuid, crate::entities::ApprovalDelegation>,
    pub(super) audit_logs: Vec<crate::entities::AuditLogEntry>,
    pub(super) log_entries: Vec<crate::entities::LogEntry>,
}

#[derive(Debug, Clone)]
pub(super) struct EncryptedSecret {
    pub(super) id: Uuid,
    pub(super) key: String,
    #[cfg(feature = "secret-store")]
    pub(super) encrypted_value: Vec<u8>,
    #[cfg(feature = "secret-store")]
    pub(super) nonce: Vec<u8>,
    #[cfg(feature = "secret-store")]
    pub(super) key_version: i32,
    pub(super) created_at: chrono::DateTime<chrono::Utc>,
    pub(super) updated_at: chrono::DateTime<chrono::Utc>,
}

/// In-memory store backed by `Arc<RwLock<..>>`.
///
/// Thread-safe and cheap to clone. All data is held in memory and lost on drop.
/// Implements [`Store`](crate::store::Store) so a single `Arc<InMemoryStore>`
/// covers runs, users, API keys, and secrets.
///
/// # Examples
///
/// ```
/// use ironflow_store::memory::InMemoryStore;
///
/// let store = InMemoryStore::new();
/// let store2 = store.clone(); // cheap Arc clone
/// ```
#[derive(Debug, Clone)]
pub struct InMemoryStore {
    pub(super) state: Arc<RwLock<State>>,
    #[cfg(feature = "secret-store")]
    pub(super) key_ring: Option<Arc<crate::crypto::KeyRing>>,
}

impl InMemoryStore {
    /// Create a new empty in-memory store.
    ///
    /// # Examples
    ///
    /// ```
    /// use ironflow_store::memory::InMemoryStore;
    ///
    /// let store = InMemoryStore::new();
    /// ```
    pub fn new() -> Self {
        Self {
            state: Arc::new(RwLock::new(State::default())),
            #[cfg(feature = "secret-store")]
            key_ring: None,
        }
    }

    /// Set a single, unversioned master key for secret encryption.
    ///
    /// Shorthand for a key ring holding this key alone at
    /// [`LEGACY_KEY_VERSION`](crate::crypto::LEGACY_KEY_VERSION).
    ///
    /// Required before using [`SecretStore`](crate::secret_store::SecretStore)
    /// methods that read/write secret values. Without a key, those methods
    /// return [`StoreError::Crypto`](crate::error::StoreError::Crypto).
    ///
    /// Listing and deleting secrets works without a key.
    ///
    /// # Examples
    ///
    /// ```
    /// use ironflow_store::memory::InMemoryStore;
    /// use ironflow_store::crypto::MasterKey;
    ///
    /// # fn example() -> Result<(), ironflow_store::crypto::CryptoError> {
    /// let mut store = InMemoryStore::new();
    /// let key = MasterKey::from_hex(
    ///     "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
    /// )?;
    /// store.set_master_key(key);
    /// # Ok(())
    /// # }
    /// ```
    #[cfg(feature = "secret-store")]
    pub fn set_master_key(&mut self, key: crate::crypto::MasterKey) {
        self.set_key_ring(crate::crypto::KeyRing::single(key));
    }

    /// Set the versioned key ring for secret encryption.
    ///
    /// New secrets are encrypted with the ring's active version; existing ones
    /// are decrypted with whichever version they were written with.
    ///
    /// # Examples
    ///
    /// ```
    /// use ironflow_store::memory::InMemoryStore;
    /// use ironflow_store::crypto::KeyRing;
    ///
    /// # fn example() -> Result<(), ironflow_store::crypto::CryptoError> {
    /// let mut store = InMemoryStore::new();
    /// let spec = format!("1:{},2:{}", "aa".repeat(32), "bb".repeat(32));
    /// store.set_key_ring(KeyRing::from_spec(&spec, Some(2))?);
    /// # Ok(())
    /// # }
    /// ```
    #[cfg(feature = "secret-store")]
    pub fn set_key_ring(&mut self, ring: crate::crypto::KeyRing) {
        self.key_ring = Some(Arc::new(ring));
    }

    /// Override a run's `created_at` timestamp for testing retention policies.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use chrono::{Utc, TimeDelta};
    /// use ironflow_store::memory::InMemoryStore;
    /// use uuid::Uuid;
    ///
    /// # async fn example(store: &InMemoryStore, run_id: Uuid) {
    /// let old = Utc::now() - TimeDelta::days(100);
    /// store.set_run_created_at(run_id, old).await;
    /// # }
    /// ```
    pub async fn set_run_created_at(
        &self,
        run_id: Uuid,
        created_at: chrono::DateTime<chrono::Utc>,
    ) {
        let mut state = self.state.write().await;
        if let Some(run) = state.runs.get_mut(&run_id) {
            run.created_at = created_at;
        }
    }
}

impl Default for InMemoryStore {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use serde_json::json;

    use crate::entities::{NewRun, TriggerKind};

    use super::InMemoryStore;

    pub(crate) fn new_run_req(name: &str) -> NewRun {
        NewRun {
            created_by: None,
            workflow_name: name.to_string(),
            trigger: TriggerKind::Manual,
            payload: json!({}),
            max_retries: 3,
            handler_version: None,
            labels: HashMap::new(),
            scheduled_at: None,
            idempotency_key: None,
            max_cost_usd: None,
        }
    }

    pub(crate) async fn create_terminal_run(
        store: &InMemoryStore,
        name: &str,
        status: crate::entities::RunStatus,
    ) -> crate::entities::Run {
        use crate::store::RunStore;

        let run = store
            .create_run(new_run_req(name))
            .await
            .unwrap()
            .into_run();
        store
            .update_run_status(run.id, crate::entities::RunStatus::Running)
            .await
            .unwrap();
        store.update_run_status(run.id, status).await.unwrap();
        store.get_run(run.id).await.unwrap().unwrap()
    }
}