rio_rs/state/

mod.rs

#![doc = include_str!("README.md")]

use std::ops::Deref;

use crate::errors::LoadStateError;
use crate::registry::IdentifiableType;
use crate::{ServiceObject, WithId};
use async_trait::async_trait;
use serde::de::DeserializeOwned;
use serde::Serialize;

#[cfg(feature = "local")]
pub mod local;

#[cfg(feature = "redis")]
pub mod redis;

// #[cfg(feature = "sql")]
// pub mod sql;

#[cfg(feature = "sqlite")]
pub mod sqlite;

#[cfg(feature = "postgres")]
pub mod postgres;

/// Trait to define how to get and set states in and out of an object
///
/// One need to implement this trait for each state a object holds
#[async_trait]
pub trait State<T> {
    fn get_state(&self) -> &T;
    fn set_state(&mut self, value: T);

    async fn load<S: StateLoader<T> + Sync + Send>(
        &self,
        state_loader: &S,
        object_kind: &str,
        object_id: &str,
        state_type: &str,
    ) -> Result<T, LoadStateError> {
        state_loader.load(object_kind, object_id, state_type).await
    }
}

/// The `StateLoader` defines an interface to load serialized state from a source
///
/// **important** This trait is not responsible for serializing it back to its
/// original type
///
/// TODO use a reader type instead of String on load fn
#[async_trait]
pub trait StateLoader<T>: Send + Sync {
    /// <div class="warning">
    /// TODO
    ///
    /// This here can't be used right now as it depends on the type `T` when
    /// called.
    ///
    /// This makes its usage quite cluncky (if not impossible) as you need to invoke it
    /// with a target of this loader
    /// </div>
    async fn prepare(&self) {}

    async fn load(
        &self,
        object_kind: &str,
        object_id: &str,
        state_type: &str,
    ) -> Result<T, LoadStateError>;
}

/// Auto implement [StateLoader] for every type that derefs to a [StateLoader]
///
/// This way you can create a wrapper for a [StateLoader] and it will automatically
/// get this implementation
#[async_trait]
impl<O, T, S> StateLoader<O> for T
where
    T: Deref<Target = S> + Send + Sync,
    S: StateLoader<O>,
    O: DeserializeOwned,
{
    async fn load(
        &self,
        object_kind: &str,
        object_id: &str,
        state_type: &str,
    ) -> Result<O, LoadStateError> {
        self.deref().load(object_kind, object_id, state_type).await
    }
}

/// The `StateSave` defines an interface to save serialized data into a persistence
/// backend (memory, sql server, etc)
///
/// **important** This trait is not responsible for serializing the state from
/// its original type
///
/// TODO it sucks this needs to be generic over T (the type it is persisting)
///      because then we are forced to do like `StateSaver::<TestState1>::prepare`
#[async_trait]
pub trait StateSaver<T>: Sync + Send {
    async fn prepare(&self) {}

    async fn save(
        &self,
        object_kind: &str,
        object_id: &str,
        state_type: &str,
        data: &T,
    ) -> Result<(), LoadStateError>;
}

/// Auto implement [StateSaver] for every type that derefs to a StateSaver
///
/// This way you can create a wrapper for a [StateSaver] and it will automatically
/// get this implementation
#[async_trait]
impl<O, T, S> StateSaver<O> for T
where
    T: Deref<Target = S> + Send + Sync,
    S: StateSaver<O>,
    O: Serialize + Send + Sync,
{
    async fn save(
        &self,
        object_kind: &str,
        object_id: &str,
        state_type: &str,
        data: &O,
    ) -> Result<(), LoadStateError> {
        self.deref()
            .save(object_kind, object_id, state_type, data)
            .await
    }
}

/// Reponsible for managing states for a specific object
///
/// With this trait one can load/save individual states from an orig (Self) object
#[async_trait]
pub trait ObjectStateManager {
    /// Load the state from the backend, deserialize it, and map it into the
    /// right state
    async fn load_state<T, S>(&mut self, state_loader: &S) -> Result<(), LoadStateError>
    where
        T: IdentifiableType + Serialize + DeserializeOwned + Default, // neends default cause of trait State
        S: StateLoader<T> + Send + Sync,
        Self: State<T> + IdentifiableType + WithId + Send + Sync,
    {
        let object_kind = Self::user_defined_type_id();
        let object_id = self.id();
        let state_type = T::user_defined_type_id();
        let data: T = self
            .load(state_loader, object_kind, object_id, state_type)
            .await
            .or(Err(LoadStateError::ObjectNotFound))?;

        self.set_state(data);
        Ok(())
    }

    /// Serialize the data out of the state and save it to the backend provided
    async fn save_state<T, S>(&self, state_saver: &S) -> Result<(), LoadStateError>
    where
        T: IdentifiableType + Serialize + DeserializeOwned + Sync + Default, // Needs default cause of trait State
        S: StateSaver<T>,
        Self: State<T> + IdentifiableType + WithId + Send + Sync,
    {
        let object_kind = Self::user_defined_type_id();
        let object_id = self.id();

        let state_type = T::user_defined_type_id();
        let state_value: &T = self.get_state();
        state_saver
            .save(object_kind, object_id, state_type, state_value)
            .await?;
        Ok(())
    }
}

// If an struct implements ServiceObject, it gets ObjectStateManager out of the box
impl<T> ObjectStateManager for T where T: ServiceObject {}

#[cfg(test)]
mod test {
    use super::*;
    use rio_macros::{ManagedState, TypeName, WithId};
    use serde::Deserialize;

    type TestResult = Result<(), Box<dyn std::error::Error>>;

    #[derive(Default, Debug, PartialEq, Serialize, Deserialize)]
    struct PersonState {
        name: String,
        age: u8,
    }

    impl IdentifiableType for Option<PersonState> {
        fn instance_type_id(&self) -> &'static str {
            "OptionPersonState"
        }
    }

    #[derive(Default, Debug, Serialize, Deserialize, PartialEq, TypeName)]
    #[rio_path = "crate"]
    struct LegalPersonState {
        legal_name: String,
        id_document: String,
    }

    #[tokio::test]
    async fn sanity_check() -> TestResult {
        let local_state = local::LocalState::new();
        let state = PersonState {
            name: "Foo".to_string(),
            age: 21,
        };
        local_state.save("a", "1", "PersonState", &state).await?;
        let new_state: PersonState = local_state.load("a", "1", "PersonState").await?;
        assert_eq!(state, new_state);
        Ok(())
    }

    #[tokio::test]
    async fn model_call() -> TestResult {
        #[derive(Debug, Default, WithId, TypeName, ManagedState)]
        #[rio_path = "crate"]
        struct Person {
            id: String,
            #[managed_state]
            person_state: Option<PersonState>,
            #[managed_state]
            legal_state: LegalPersonState,
        }
        impl ObjectStateManager for Person {}

        impl Person {
            async fn load_all_states(
                &mut self,
                state_loader: &local::LocalState,
            ) -> Result<(), LoadStateError> {
                self.load_state::<Option<PersonState>, _>(state_loader)
                    .await?;
                self.load_state::<LegalPersonState, _>(state_loader).await?;
                Ok(())
            }

            async fn save_all_states(
                &mut self,
                state_saver: &local::LocalState,
            ) -> Result<(), LoadStateError> {
                // WUT?
                self.save_state::<Option<PersonState>, _>(state_saver)
                    .await?;
                self.save_state::<LegalPersonState, _>(state_saver).await?;
                Ok(())
            }
        }

        let local_state = local::LocalState::new();

        {
            let mut person = Person::default();
            person.person_state = Some(PersonState {
                name: "Foo".to_string(),
                age: 22,
            });
            person.legal_state = LegalPersonState {
                legal_name: "Foo Bla".to_string(),
                id_document: "123.123.123-12".to_string(),
            };
            person.save_all_states(&local_state).await?;
        }
        {
            let mut person = Person::default();
            person.load_all_states(&local_state).await?;
            assert!(person.person_state.is_some());
            assert_eq!(&person.legal_state.legal_name, "Foo Bla");
        }
        Ok(())
    }
}