maf 0.1.0-alpha.6

//! Typed interfaces for RPCs and stores.
//!
//! This module provides functionality to extract type information from RPCs and stores defined
//! in the application. It uses the `schemars` crate to generate JSON schemas for the types, which
//! can be passed to the client for type-safe interactions.

use std::sync::Arc;

use schemars::{JsonSchema, Schema, SchemaGenerator};
use serde::de::DeserializeOwned;

use crate::{
    callable::IntoCallable, store::SelectContext, App, Params, Store, StoreData, StoreMut,
    StoreRef, User,
};

/// A description of a store, including its name and the schema of its select type.
#[derive(Debug, Clone, PartialEq)]
pub struct StoreDesc {
    pub name: String,
    pub select: Arc<Schema>,
}

impl StoreDesc {
    /// Create a new `StoreDesc` for the given store data type `T`.
    pub fn new<T>(generator: &mut SchemaGenerator) -> Self
    where
        T: StoreData,
    {
        StoreDesc {
            name: T::name().as_ref().to_string(),
            select: T::Select::schema(generator),
        }
    }
}

/// A description of a RPC, including its name, parameter schema, and result schema.
#[derive(Debug, Clone, PartialEq)]
pub struct RpcDesc {
    pub name: String,
    /// If the RPC does not take parameters, this is `None`.
    pub params: Option<Arc<Schema>>,
    pub result: Arc<Schema>,
}

pub trait ExtractRpcDesc<Params, Ret, const IS_ASYNC: bool> {
    fn extract(generator: &mut SchemaGenerator, name: String) -> RpcDesc;
}

trait GetParamSchema {
    const IS_PARAM: bool = false;
    fn get_param_schema(_generator: &mut SchemaGenerator) -> Arc<Schema> {
        panic!("get_param_schema called on non-param type")
    }
}

impl<T> GetParamSchema for Params<T>
where
    T: DeserializeOwned + JsonSchema,
{
    const IS_PARAM: bool = true;

    fn get_param_schema(generator: &mut SchemaGenerator) -> Arc<Schema> {
        T::schema(generator)
    }
}

// Since specialization does not exist in stable Rust, a macro is used to implement the trait for
// types that is not `Params<T>`. This is needed to extract parameter schemas for RPCs.
macro_rules! impl_not_param {
    // Case where the type does not have a type parameter
    ($t:ty) => {
        impl GetParamSchema for $t {
            const IS_PARAM: bool = false;
        }
    };

    // Case where the type has a type parameter
    ($t:ty, $($param:tt)*) => {
        impl<$($param)*> GetParamSchema for $t {
            const IS_PARAM: bool = false;
        }
    };
}

impl_not_param!(App);
impl_not_param!(User);
impl_not_param!(Store<T>, T: StoreData);
impl_not_param!(StoreRef<T>, T: StoreData);
impl_not_param!(StoreMut<T>, T: StoreData);

trait RpcResult {
    fn schema(generator: &mut SchemaGenerator) -> Arc<Schema>;
}

impl<T> RpcResult for T
where
    T: JsonSchema,
{
    fn schema(generator: &mut SchemaGenerator) -> Arc<Schema> {
        Arc::new(T::json_schema(generator))
    }
}

// Case where the type is a function that takes no parameters
impl<Ret, F> ExtractRpcDesc<(), Ret, false> for F
where
    Ret: RpcResult,
    F: Fn() -> Ret,
{
    fn extract(generator: &mut SchemaGenerator, name: String) -> RpcDesc {
        RpcDesc {
            name,
            params: None,
            result: Ret::schema(generator),
        }
    }
}

impl<Ret, Fut, F> ExtractRpcDesc<(), Ret, true> for F
where
    Ret: RpcResult,
    Fut: std::future::Future<Output = Ret>,
    F: Fn() -> Fut,
{
    fn extract(generator: &mut SchemaGenerator, name: String) -> RpcDesc {
        RpcDesc {
            name,
            params: None,
            result: Ret::schema(generator),
        }
    }
}

// Implementations for functions with parameters (from 1 to 9 parameters)
macro_rules! impl_extract_rpc_desc {
    ($($members:ident),+) => {
        impl<
            $($members),+,
            Ret,
            F,
        > ExtractRpcDesc<($($members,)+), Ret, false> for F
        where
            $($members: GetParamSchema),+,
            Ret: RpcResult,
            F: Fn($($members),+) -> Ret,
        {
            fn extract(generator: &mut SchemaGenerator, name: String) -> RpcDesc {
                let params = if false { None } $(else if $members::IS_PARAM {
                    Some($members::get_param_schema(generator))
                })* else {
                    None
                };

                RpcDesc {
                    name,
                    params,
                    result: Ret::schema(generator),
                }
            }
        }

        impl<
            $($members),+,
            Ret,
            Fut,
            F,
        > ExtractRpcDesc<($($members,)+), Ret, true> for F
        where
            $($members: GetParamSchema),+,
            Ret: RpcResult,
            Fut: std::future::Future<Output = Ret>,
            F: Fn($($members),+) -> Fut,
        {
            fn extract(generator: &mut SchemaGenerator, name: String) -> RpcDesc {
                let params = if false { None } $(else if $members::IS_PARAM {
                    Some($members::get_param_schema(generator))
                })* else {
                    None
                };

                RpcDesc {
                    name,
                    params,
                    result: Ret::schema(generator),
                }
            }
        }
    };
}

impl_extract_rpc_desc!(T1);
impl_extract_rpc_desc!(T1, T2);
impl_extract_rpc_desc!(T1, T2, T3);
impl_extract_rpc_desc!(T1, T2, T3, T4);
impl_extract_rpc_desc!(T1, T2, T3, T4, T5);
impl_extract_rpc_desc!(T1, T2, T3, T4, T5, T6);
impl_extract_rpc_desc!(T1, T2, T3, T4, T5, T6, T7);
impl_extract_rpc_desc!(T1, T2, T3, T4, T5, T6, T7, T8);
impl_extract_rpc_desc!(T1, T2, T3, T4, T5, T6, T7, T8, T9);

pub trait ExtractSelectDesc<Params, Ret, const IS_ASYNC: bool> {
    fn extract(generator: &mut SchemaGenerator, name: String) -> StoreDesc;
}

impl<F, Params, Ret, const IS_ASYNC: bool> ExtractSelectDesc<Params, Ret, IS_ASYNC> for F
where
    F: IntoCallable<SelectContext, Params, Ret, std::convert::Infallible, (), IS_ASYNC>,
    Ret: JsonSchema,
{
    fn extract(generator: &mut SchemaGenerator, name: String) -> StoreDesc {
        let result = Ret::schema(generator);
        StoreDesc {
            name,
            select: result,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        typed::{desc::ExtractRpcDesc, ExtractSelectDesc},
        Params, Store, StoreData,
    };

    struct Test;
    impl StoreData for Test {
        type Select<'this> = i32;

        fn init() -> Self {
            Test
        }

        fn select(&self, _user: &crate::User) -> Self::Select<'_> {
            1
        }
    }

    fn is_extract_rpc_desc<F, Params, Ret, const IS_ASYNC: bool>(_fn: F)
    where
        F: ExtractRpcDesc<Params, Ret, IS_ASYNC>,
    {
    }

    #[test]
    fn extract_rpc_desc_compiles() {
        fn string_to_string_fn(_params: Params<String>) -> String {
            "hello".to_string()
        }
        fn string_to_unit_fn(_params: Params<String>) {}
        async fn with_store_fn(_params: Params<String>, _store: Store<Test>) -> i32 {
            0
        }
        fn unit_to_unit_fn() {}

        async fn async_string_to_string_fn(_params: Params<String>) -> String {
            "hello".to_string()
        }

        is_extract_rpc_desc(string_to_string_fn);
        is_extract_rpc_desc(string_to_unit_fn);
        is_extract_rpc_desc(with_store_fn);
        is_extract_rpc_desc(unit_to_unit_fn);
        is_extract_rpc_desc(async_string_to_string_fn);
    }

    fn is_extract_select_desc<F, Params, Ret, const IS_ASYNC: bool>(_fn: F)
    where
        F: ExtractSelectDesc<Params, Ret, IS_ASYNC>,
    {
    }

    #[test]
    fn extract_select_desc_compiles() {
        fn select_test_store(_store: Store<Test>) -> i32 {
            42
        }
        async fn async_select_test_store(_store: Store<Test>) -> i32 {
            42
        }

        is_extract_select_desc(select_test_store);
        is_extract_select_desc(async_select_test_store);
    }
}