telers 1.0.0-beta.2

use super::{Storage, StorageKey};

use crate::FromContext;

use serde::{de::DeserializeOwned, Serialize};
use std::collections::HashMap;

/// Context is used to manage state and data of the user in specified storage
#[derive(FromContext)]
#[context(
    key = "fsm_context",
    description = "Context is used to manage state and data of the user in specified storage. \
                   This context is available only if `FSMContext` middleware is used and \
                   `user_id` in context is not empty."
)]
pub struct Context<S> {
    storage: S,
    key: StorageKey,
}

impl<S> Context<S> {
    #[inline]
    #[must_use]
    pub fn new(storage: S, key: StorageKey) -> Self {
        Self {
            storage,
            key,
        }
    }
}

impl<S> Clone for Context<S>
where
    S: Clone,
{
    #[inline]
    fn clone(&self) -> Self {
        Self {
            storage: self.storage.clone(),
            key: self.key.clone(),
        }
    }
}

impl<S> Context<S>
where
    S: Storage,
{
    /// Set current state
    /// # Arguments
    /// * `state` - State
    /// # Errors
    /// If storage error occurs, when set state
    pub async fn set_state<State>(&self, state: State) -> Result<(), S::Error>
    where
        State: AsRef<str> + Send,
    {
        self.storage.set_state(&self.key, state).await
    }

    /// Set previous state as current state
    /// # Errors
    /// If storage error occurs, when set previous state
    /// # Notes
    /// States stack is used to store states history,
    /// when user set new state, then current state will be push to the states stack,
    /// so you can use this method to back to the previous state
    pub async fn set_previous_state(&self) -> Result<(), S::Error> {
        self.storage.set_previous_state(&self.key).await
    }

    /// Get current state
    /// # Errors
    /// If storage error occurs, when get state
    /// # Returns
    /// State, if state is no exists, then `None` will be return
    pub async fn get_state(&self) -> Result<Option<Box<str>>, S::Error> {
        self.storage.get_state(&self.key).await
    }

    /// Get states stack
    /// # Errors
    /// If storage error occurs, when get states stack
    /// # Notes
    /// States stack is used to store states history,
    /// when user set new state, then current state will be push to the states stack,
    /// so you can use this method to get states history or back to the previous state
    /// # Returns
    /// States, if states is no exists, then empty slice will be return
    pub async fn get_states(&self) -> Result<Box<[Box<str>]>, S::Error> {
        self.storage.get_states(&self.key).await
    }

    /// Remove states stack
    /// # Errors
    /// If storage error occurs, when remove states stack
    /// # Notes
    /// States stack is used to store states history,
    /// when user set new state, then current state will be push to the states stack,
    /// so you can use this method to clear states history
    pub async fn remove_states(&self) -> Result<(), S::Error> {
        self.storage.remove_states(&self.key).await
    }

    /// Set current data
    /// # Arguments
    /// * `data` - Data, if empty, then data will be clear
    /// # Errors
    /// If storage error occurs, when set data
    pub async fn set_data<Key, Data>(&self, data: HashMap<Key, Data>) -> Result<(), S::Error>
    where
        Data: Serialize + Send,
        Key: AsRef<str> + Send,
    {
        self.storage.set_data(&self.key, data).await
    }

    /// Set value to the data for value key
    /// # Arguments
    /// * `value_key` - Specified value key to set value to data
    /// * `value` - Value for value key
    /// # Errors
    /// If storage error occurs, when set value to data
    pub async fn set_value<Key, Value>(&self, value_key: Key, value: Value) -> Result<(), S::Error>
    where
        Value: Serialize + Send,
        Key: AsRef<str> + Send,
    {
        self.storage.set_value(&self.key, value_key, value).await
    }

    /// Get current data
    /// # Errors
    /// If storage error occurs, when get data
    /// # Returns
    /// Data, if data is no exists, then empty [`HashMap`] will be return
    pub async fn get_data<Data>(&self) -> Result<HashMap<Box<str>, Data>, S::Error>
    where
        Data: DeserializeOwned,
    {
        self.storage.get_data(&self.key).await
    }

    /// Get value from data for value key
    /// # Arguments
    /// * `value_key` - Specified value key to get value from data
    /// # Errors
    /// If storage error occurs, when get value from data
    /// # Returns
    /// Value, if value is no exists, then `None` will be return
    pub async fn get_value<Key, Value>(&self, value_key: Key) -> Result<Option<Value>, S::Error>
    where
        Value: DeserializeOwned,
        Key: AsRef<str> + Send,
    {
        self.storage.get_value(&self.key, value_key).await
    }

    /// Remove current data
    /// # Errors
    /// If storage error occurs, when remove data
    pub async fn remove_data(&self) -> Result<(), S::Error> {
        self.storage.remove_data(&self.key).await
    }

    /// Finish current context by remove state and data.
    /// This method is just shortcut for [`Context::remove_states`] and [`Context::remove_data`] methods
    /// # Errors
    /// If storage error occurs, when remove state or data
    pub async fn finish(&self) -> Result<(), S::Error> {
        self.storage.remove_states(&self.key).await?;
        self.storage.remove_data(&self.key).await
    }
}