telers 1.0.0-beta.2

use crate::errors::{HandlerError, MiddlewareError};

use serde::{de::DeserializeOwned, Serialize};
use std::{
    borrow::Cow, collections::HashMap, error::Error as StdError, fmt::Debug, future::Future,
};
use thiserror;

pub const DEFAULT_DESTINY: &str = "default";

/// Storage key is used to identify the state and data of the user in the storage
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct StorageKey {
    pub bot_id: i64,
    pub chat_id: i64,
    pub user_id: i64,
    pub message_thread_id: Option<i64>,
    pub business_connection_id: Option<String>,
    pub destiny: &'static str,
}

impl StorageKey {
    #[inline]
    #[must_use]
    pub fn new(
        bot_id: i64,
        chat_id: i64,
        user_id: i64,
        message_thread_id: Option<i64>,
        business_connection_id: Option<String>,
    ) -> Self {
        Self {
            bot_id,
            chat_id,
            user_id,
            message_thread_id,
            business_connection_id,
            destiny: DEFAULT_DESTINY,
        }
    }

    #[inline]
    #[must_use]
    pub fn destiny(self, destiny: &'static str) -> Self {
        Self {
            destiny,
            ..self
        }
    }
}

#[derive(Debug, thiserror::Error)]
#[error("Storage error: {msg}")]
pub struct Error {
    msg: Cow<'static, str>,
    source: Box<dyn StdError + Send + Sync>,
}

impl Error {
    #[must_use]
    pub fn new<T>(msg: impl Into<Cow<'static, str>>, source: T) -> Self
    where
        T: StdError + Send + Sync + 'static,
    {
        Self {
            msg: msg.into(),
            source: Box::new(source),
        }
    }
}

/// To possible to wrap [`Error`] error in [`HandlerError`] struct without explicit conversion
impl From<Error> for HandlerError {
    fn from(err: Error) -> Self {
        Self::new(err)
    }
}

/// To possible to wrap [`Error`] error in [`MiddlewareError`] struct without explicit conversion
impl From<Error> for MiddlewareError {
    fn from(err: Error) -> Self {
        Self::new(err)
    }
}

/// Storage is used to store state and data of the user
/// # Notes
/// Storage is part of the FSM pattern,
/// don't use it for other purposes like database and store user data not related with state machine
pub trait Storage: Clone {
    type Error: Into<Error>;

    /// Set state for specified key
    /// # Arguments
    /// * `key` - Specified key to set state
    /// * `state` - State for specified key
    fn set_state<S>(
        &self,
        key: &StorageKey,
        state: S,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send
    where
        S: AsRef<str> + Send;

    /// Set previous state as current state
    /// # Arguments
    /// * `key` - Specified key to set previous 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
    fn set_previous_state(
        &self,
        key: &StorageKey,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send;

    /// Get state for specified key
    /// # Arguments
    /// * `key` - Specified key to get state
    /// # Returns
    /// State for specified key, if state is no exists, then `None` will be return
    fn get_state(
        &self,
        key: &StorageKey,
    ) -> impl Future<Output = Result<Option<Box<str>>, Self::Error>> + Send;

    /// Get states stack for specified key
    /// # Arguments
    /// * `key` - Specified key to 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 stack for specified key, if states stack is no exists, then empty slice will be return
    fn get_states(
        &self,
        key: &StorageKey,
    ) -> impl Future<Output = Result<Box<[Box<str>]>, Self::Error>> + Send;

    /// Remove states stack for specified key
    /// # 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
    fn remove_states(
        &self,
        key: &StorageKey,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send;

    /// Set data for specified key
    /// # Arguments
    /// * `key` - Specified key to set data
    /// * `data` - Data for specified key, if empty, then data will be clear
    fn set_data<Key, Value>(
        &self,
        key: &StorageKey,
        data: HashMap<Key, Value>,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send
    where
        Value: Serialize + Send,
        Key: AsRef<str> + Send;

    /// Set value to the data for specified key and value key
    /// # Arguments
    /// * `key` - Specified key to set data
    /// * `value_key` - Specified value key to set value to the data
    /// * `value` - Value for specified key and value key
    fn set_value<Key, Value>(
        &self,
        key: &StorageKey,
        value_key: Key,
        value: Value,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send
    where
        Value: Serialize + Send,
        Key: AsRef<str> + Send;

    /// Get data for specified key
    /// # Arguments
    /// * `key` - Specified key to get data
    /// # Returns
    /// Data for specified key, if data is no exists, then empty [`HashMap`] will be return
    fn get_data<Value>(
        &self,
        key: &StorageKey,
    ) -> impl Future<Output = Result<HashMap<Box<str>, Value>, Self::Error>> + Send
    where
        Value: DeserializeOwned;

    /// Get value from the data for specified key and value key
    /// # Arguments
    /// * `key` - Specified key to get data
    /// * `value_key` - Specified value key to get value from data
    /// # Returns
    /// Value for specified key and value key, if value is no exists, then `None` will be return
    fn get_value<Key, Value>(
        &self,
        key: &StorageKey,
        value_key: Key,
    ) -> impl Future<Output = Result<Option<Value>, Self::Error>> + Send
    where
        Value: DeserializeOwned,
        Key: AsRef<str> + Send;

    /// Remove data for specified key
    /// # Arguments
    /// * `key` - Specified key to remove data
    fn remove_data(&self, key: &StorageKey)
        -> impl Future<Output = Result<(), Self::Error>> + Send;
}

impl<'a, S> Storage for &'a S
where
    S: Storage + Sync + 'a,
{
    type Error = S::Error;

    async fn set_state<State>(&self, key: &StorageKey, state: State) -> Result<(), Self::Error>
    where
        State: AsRef<str> + Send,
    {
        S::set_state(self, key, state).await
    }

    async fn set_previous_state(&self, key: &StorageKey) -> Result<(), Self::Error> {
        S::set_previous_state(self, key).await
    }

    async fn get_state(&self, key: &StorageKey) -> Result<Option<Box<str>>, Self::Error> {
        S::get_state(self, key).await
    }

    async fn get_states(&self, key: &StorageKey) -> Result<Box<[Box<str>]>, Self::Error> {
        S::get_states(self, key).await
    }

    async fn remove_states(&self, key: &StorageKey) -> Result<(), Self::Error> {
        S::remove_states(self, key).await
    }

    async fn set_data<Key, Value>(
        &self,
        key: &StorageKey,
        data: HashMap<Key, Value>,
    ) -> Result<(), Self::Error>
    where
        Value: Serialize + Send,
        Key: AsRef<str> + Send,
    {
        S::set_data(self, key, data).await
    }

    async fn set_value<Key, Value>(
        &self,
        key: &StorageKey,
        value_key: Key,
        value: Value,
    ) -> Result<(), Self::Error>
    where
        Value: Serialize + Send,
        Key: AsRef<str> + Send,
    {
        S::set_value(self, key, value_key, value).await
    }

    async fn get_data<Value>(
        &self,
        key: &StorageKey,
    ) -> Result<HashMap<Box<str>, Value>, Self::Error>
    where
        Value: DeserializeOwned,
    {
        S::get_data(self, key).await
    }

    async fn get_value<Key, Value>(
        &self,
        key: &StorageKey,
        value_key: Key,
    ) -> Result<Option<Value>, Self::Error>
    where
        Value: DeserializeOwned,
        Key: AsRef<str> + Send,
    {
        S::get_value(self, key, value_key).await
    }

    async fn remove_data(&self, key: &StorageKey) -> Result<(), Self::Error> {
        S::remove_data(self, key).await
    }
}