gl_client/lsps/

json_rpc_erased.rs

// The json-rpc implementation used in json_rpc is strongly typed and heavily
// relies on Generics. In Rust all the required types are created at compile type.
//
// This is, Vec<u8> and Vec<u32> are considered 2 different types.
//
// When creating language bindings we must either
// - explicitly implement ffi for every type.
// - use a trait that erases tye type. In this case we replace the type by Vec<u8>. This byte-array can be parsed by the foreign language
//
// Note, that this
//
// If you are a rust-developer you probably want to use the json_rpc-module directly
// If you are building a foreign function interface you probably want to use the type-erased version
//
// The JsonRpcMethodErased wraps the JsonRpcMethod into a type that works with Vec<u8>.
// The JsonRpcMethodErased is object-safe and can be owned using a Box.
//
// The JsonRpcMethodErased method
// - does not do strict type-checking at compile-time
// - comes at a small runtime cost (requires Box, serializes and deserializes some objects twice, unwrapping results)
// - comes at a small dev-cost for requiring a bit more error-handling

use crate::lsps::json_rpc::{
    ErrorData, JsonRpcMethod, JsonRpcRequest, JsonRpcResponse, JsonRpcResponseFailure,
    JsonRpcResponseSuccess, MapErrorCode,
};
use serde::Serialize;

pub type JsonRpcRequestErased = JsonRpcRequest<Vec<u8>>;
pub type JsonRpcResponseErased = JsonRpcResponse<Vec<u8>, Vec<u8>>;
pub type JsonRpcResponseSuccessErased = JsonRpcResponseSuccess<Vec<u8>>;
pub type JsonRpcResponseFailureErased = JsonRpcResponseFailure<Vec<u8>>;
pub type JsonRpcErrorDataErased = ErrorData<Vec<u8>>;

pub trait JsonRpcMethodErased {
    fn name(&self) -> &str;

    fn create_request(
        &self,
        params: Vec<u8>,
        json_rpc_id: String,
    ) -> Result<JsonRpcRequestErased, serde_json::Error>;

    fn parse_json_response_str(
        &self,
        json_str: &str,
    ) -> Result<JsonRpcResponseErased, serde_json::Error>;

    fn parse_json_response_value(
        &self,
        json_str: serde_json::Value,
    ) -> Result<JsonRpcResponseErased, serde_json::Error>;
}

impl<I, O, E> JsonRpcMethodErased for JsonRpcMethod<I, O, E>
where
    I: serde::de::DeserializeOwned + Serialize,
    O: serde::de::DeserializeOwned + Serialize,
    E: serde::de::DeserializeOwned + Serialize + MapErrorCode,
{
    fn name(&self) -> &str {
        self.method
    }

    fn create_request(
        &self,
        params: Vec<u8>,
        json_rpc_id: String,
    ) -> Result<JsonRpcRequestErased, serde_json::Error> {
        let typed_params: I = serde_json::from_slice(&params)?;
        JsonRpcMethod::create_request(self, typed_params, json_rpc_id).erase()
    }

    fn parse_json_response_str(
        &self,
        json_str: &str,
    ) -> Result<JsonRpcResponseErased, serde_json::Error> {
        // Check if the json-struct matches the expected type
        JsonRpcMethod::<I, O, E>::parse_json_response_str(self, json_str)?.erase()
    }

    fn parse_json_response_value(
        &self,
        json_value: serde_json::Value,
    ) -> Result<JsonRpcResponseErased, serde_json::Error> {
        JsonRpcMethod::<I, O, E>::parse_json_response_value(self, json_value)?.erase()
    }
}

impl<I, O, E> JsonRpcMethod<I, O, E>
where
    I: serde::de::DeserializeOwned + Serialize + 'static,
    O: serde::de::DeserializeOwned + Serialize + 'static,
    E: serde::de::DeserializeOwned + Serialize + 'static + MapErrorCode,
{
    pub fn erase_box(self) -> Box<dyn JsonRpcMethodErased> {
        Box::new(self)
    }

    pub fn ref_erase(&self) -> &dyn JsonRpcMethodErased {
        self
    }
}

// The trait JsonRpcUnerased is only intended to be used by library developers
//
// The user of this library might want to use the strongly typed generic version
// or the fully type-erased version
//
// As a library developer, we don't want to implement the same functionality twice
// for the same RPC-call.
//
// That is why we introduce the JsonRpcUnerased trait.
// It fills in the serde_json::Value type wherever either I, O or E should be.
//
// By using this trait, functionality will work for both type of users

pub trait JsonRpcMethodUnerased<'a, I, O, E> {
    fn name(&self) -> &str;

    fn create_request(
        &self,
        params: I,
        json_rpc_id: String,
    ) -> Result<JsonRpcRequest<I>, serde_json::Error>;

    fn parse_json_response_str(
        &self,
        json_str: &str,
    ) -> Result<JsonRpcResponse<O, E>, serde_json::Error>;

    fn parse_json_response_value(
        &self,
        json_value: serde_json::Value,
    ) -> Result<JsonRpcResponse<O, E>, serde_json::Error>;
}

// Dummy implementation for when the user uses the generic api
impl<'a, I, O, E> JsonRpcMethodUnerased<'a, I, O, E> for JsonRpcMethod<I, O, E>
where
    O: serde::de::DeserializeOwned,
    E: serde::de::DeserializeOwned + MapErrorCode,
{
    fn name(&self) -> &str {
        JsonRpcMethod::name(self)
    }

    fn create_request(
        &self,
        params: I,
        json_rpc_id: String,
    ) -> Result<JsonRpcRequest<I>, serde_json::Error> {
        Ok(JsonRpcMethod::create_request(self, params, json_rpc_id))
    }

    fn parse_json_response_str(
        &self,
        json_str: &str,
    ) -> Result<JsonRpcResponse<O, E>, serde_json::Error> {
        JsonRpcMethod::parse_json_response_str(self, json_str)
    }

    fn parse_json_response_value(
        &self,
        json_value: serde_json::Value,
    ) -> Result<JsonRpcResponse<O, E>, serde_json::Error> {
        JsonRpcMethod::parse_json_response_value(self, json_value)
    }
}

struct UneraseWrapper<'a> {
    inner: &'a dyn JsonRpcMethodErased,
}

impl<'a> JsonRpcMethodUnerased<'a, Vec<u8>, Vec<u8>, Vec<u8>> for UneraseWrapper<'a> {
    fn name(&self) -> &str {
        self.inner.name()
    }

    fn create_request(
        &self,
        params: Vec<u8>,
        json_rpc_id: String,
    ) -> Result<JsonRpcRequestErased, serde_json::Error> {
        self.inner.create_request(params, json_rpc_id)
    }

    fn parse_json_response_str(
        &self,
        json_str: &str,
    ) -> Result<JsonRpcResponseErased, serde_json::Error> {
        self.inner.parse_json_response_str(json_str)
    }

    fn parse_json_response_value(
        &self,
        json_value: serde_json::Value,
    ) -> Result<JsonRpcResponseErased, serde_json::Error> {
        self.inner.parse_json_response_value(json_value)
    }
}

impl dyn JsonRpcMethodErased {
    // The impl promises here we return a concrete type
    // However, we'd rather keep the implementation details private in this module and don't want users messing with it
    pub fn unerase(&self) -> impl JsonRpcMethodUnerased<Vec<u8>, Vec<u8>, Vec<u8>> {
        UneraseWrapper { inner: self }
    }
}

impl<I> JsonRpcRequest<I>
where
    I: Serialize,
{
    fn erase(self) -> Result<JsonRpcRequestErased, serde_json::Error> {
        let value = serde_json::to_vec(&self.params)?;
        Ok(JsonRpcRequest {
            jsonrpc: self.jsonrpc,
            id: self.id,
            method: self.method,
            params: value,
        })
    }
}

impl<O> JsonRpcResponseSuccess<O>
where
    O: Serialize,
{
    fn erase(self) -> Result<JsonRpcResponseSuccessErased, serde_json::Error> {
        Ok(JsonRpcResponseSuccessErased {
            id: self.id,
            result: serde_json::to_vec(&self.result)?,
            jsonrpc: self.jsonrpc,
        })
    }
}

impl<E> JsonRpcResponseFailure<E>
where
    E: Serialize,
{
    fn erase(self) -> Result<JsonRpcResponseFailureErased, serde_json::Error> {
        Ok(JsonRpcResponseFailureErased {
            id: self.id,
            error: self.error.erase()?,
            jsonrpc: self.jsonrpc,
        })
    }
}

impl<E> ErrorData<E>
where
    E: Serialize,
{
    fn erase(self) -> Result<JsonRpcErrorDataErased, serde_json::Error> {
        let error_data = if let Some(error) = &self.data {
            Some(serde_json::to_vec(error)?)
        } else {
            None
        };

        let x = JsonRpcErrorDataErased {
            code: self.code,
            data: error_data,
            message: self.message,
        };

        Ok(x)
    }
}

impl<O, E> JsonRpcResponse<O, E>
where
    O: Serialize,
    E: Serialize,
{
    fn erase(self) -> Result<JsonRpcResponseErased, serde_json::Error> {
        let result = match self {
            Self::Ok(ok) => JsonRpcResponseErased::Ok(ok.erase()?),
            Self::Error(err) => JsonRpcResponseErased::Error(err.erase()?),
        };

        Ok(result)
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::lsps::json_rpc::{generate_random_rpc_id, DefaultError, JsonRpcMethod};

    #[derive(Serialize, serde::Deserialize)]
    struct TestRequestStruct {
        test: String,
    }

    #[derive(Serialize, serde::Deserialize)]
    struct TestResponseStruct {
        response: String,
    }

    #[test]
    fn create_rpc_request_from_method_erased() {
        let rpc_method = JsonRpcMethod::<TestRequestStruct, (), DefaultError>::new("test.method");
        let rpc_method_erased = rpc_method.erase_box();

        // This rpc-request should work becasue the parameters match the schema
        let json_data = serde_json::json!({"test" : "This should work"});
        let vec_data: Vec<u8> = serde_json::to_vec(&json_data).unwrap();

        let json_rpc_id = generate_random_rpc_id();
        let rpc_request: JsonRpcRequest<Vec<u8>> = rpc_method_erased
            .create_request(vec_data, json_rpc_id)
            .unwrap();
        assert_eq!(rpc_request.method, "test.method");
    }

    #[test]
    fn create_rpc_request_from_method_erased_checks_types() {
        let rpc_method = JsonRpcMethod::<TestRequestStruct, (), DefaultError>::new("test.method");
        let rpc_method_erased = rpc_method.erase_box();

        // This rpc-request should fail because the parameters do not match the schema
        // The test field is missing
        let param_vec = serde_json::to_vec(&serde_json::json!({})).unwrap();
        let json_rpc_id = generate_random_rpc_id();
        let rpc_request = rpc_method_erased.create_request(param_vec, json_rpc_id);
        assert!(rpc_request.is_err());
    }

    #[test]
    fn parse_rpc_request_from_method_erased() {
        let rpc_method = JsonRpcMethod::<TestRequestStruct, TestResponseStruct, DefaultError>::new(
            "test.method",
        );
        let rpc_method_erased = rpc_method.erase_box();

        let json_value = serde_json::json!({
            "jsonrpc" : "2.0",
            "id" : "abcdef",
            "result" : {"response" : "content"}
        });

        rpc_method_erased
            .parse_json_response_value(json_value)
            .unwrap();
    }

    #[test]
    fn parse_rpc_request_from_method_erased_fails() {
        let rpc_method = JsonRpcMethod::<TestRequestStruct, TestResponseStruct, DefaultError>::new(
            "test.method",
        );
        let rpc_method_erased = rpc_method.erase_box();

        let json_value = serde_json::json!({
            "jsonrpd" : "2.0", // See the typo-here
            "id" : "abcdef",
            "result" : {"response" : "content"}
        });

        let result: Result<JsonRpcResponseErased, serde_json::Error> =
            rpc_method_erased.parse_json_response_value(json_value);
        assert!(result.is_err());

        // TODO: improve the error-message here
        // It currently gives a vague error-message about not matching one of the enum scenarios in JsonRpcResponse
        // It should at least mention that the field jsonrpc is missing
        //assert!(format!("{:?}", result).contains("jsonrpc"));
    }
}