Feature: Validate extracted data from request

[chrislearn]

No description provided.

[Voronar]

I put it here just as a temporary workaround I found useful. A validated alternative to the existed JsonBody JSON extractor wrapper.

Wrapping the raw validator::ValidationError into the ParseError::Other not an ideal solution, but one can wrap the raw validation error into more useful app specific error container and then catch it with a custom Salvo Catcher before sending an error response.

P.S. In the workaround JsonValidatedBody(T) can't be generic over Option<T> because Validate trait is not implemented for Option<T>. But one can write new JsonValidatedOptionalBody struct with corresponding impl<'de, T: validator::Validate> Extractible<'de> for JsonValidatedOptionalBody<Option<T>> implementation to satisfy Option<T>: Validate constraint.

P.P.S. Tested only with salvo = "0.44"

Implementation

use salvo::{
    async_trait,
    extract::Metadata,
    http::ParseError,
    oapi::{Components, Content, Operation, RequestBody, ToRequestBody},
    prelude::{EndpointArgRegister, ToSchema},
    Extractible, Request,
};
use serde::{Deserialize, Deserializer};
use std::ops::{Deref, DerefMut};

pub struct JsonValidatedBody<T>(pub T);

impl<T> JsonValidatedBody<T> {
    /// Consumes self and returns the value of the parameter.
    pub fn into_inner(self) -> T {
        self.0
    }
}

#[async_trait]
impl<'de, T: validator::Validate> Extractible<'de> for JsonValidatedBody<T>
where
    T: Deserialize<'de> + Send,
{
    fn metadata() -> &'de Metadata {
        static METADATA: Metadata = Metadata::new("");
        &METADATA
    }
    async fn extract(req: &'de mut Request) -> Result<Self, ParseError> {
        let res: Self = req.parse_json().await?;

        res.0.validate().map_err(ParseError::other)?;

        Ok(res)
    }
    async fn extract_with_arg(req: &'de mut Request, _arg: &str) -> Result<Self, ParseError> {
        let res = Self::extract(req).await?;

        res.0.validate().map_err(ParseError::other)?;

        Ok(res)
    }
}

impl<'de, T> Deserialize<'de> for JsonValidatedBody<T>
where
    T: Deserialize<'de>,
{
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        T::deserialize(deserializer).map(JsonValidatedBody)
    }
}

impl<'de, T> EndpointArgRegister for JsonValidatedBody<T>
where
    T: Deserialize<'de> + ToSchema,
{
    fn register(components: &mut Components, operation: &mut Operation, _arg: &str) {
        let request_body = Self::to_request_body(components);
        let _ = <T as ToSchema>::to_schema(components);
        operation.request_body = Some(request_body);
    }
}

impl<'de, T> ToRequestBody for JsonValidatedBody<T>
where
    T: Deserialize<'de> + ToSchema,
{
    fn to_request_body(components: &mut Components) -> RequestBody {
        RequestBody::new()
            .description("Extract json format data from request.")
            .add_content("application/json", Content::new(T::to_schema(components)))
    }
}

impl<T> Deref for JsonValidatedBody<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T> DerefMut for JsonValidatedBody<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

Usage

#[derive(Deserialize, Validate)]
struct MyObject;

#[handler]
async fn handle(body: JsonValidatedBody <MyObject>) -> String { format!("OK") }

[z91300]

更新至 0.64 版本以上代码报错，错误信息如下：

error[E0195]: lifetime parameters or bounds on method `extract` do not match the trait declaration
  --> rsns-server\src\common\request.rs:51:14
   |
51 |     async fn extract(req: &'de mut Request) -> Result<Self, ParseError> {
   |              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ lifetimes do not match method in trait

error[E0195]: lifetime parameters or bounds on method `extract_with_arg` do not match the trait declaration
  --> rsns-server\src\common\request.rs:65:14
   |
65 |     async fn extract_with_arg(req: &'de mut Request, _arg: &str) -> Result<Self, ParseError> {
   |              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ lifetimes do not match method in trait

[chrislearn]

更新至 0.64 版本以上代码报错，错误信息如下：

error[E0195]: lifetime parameters or bounds on method `extract` do not match the trait declaration
  --> rsns-server\src\common\request.rs:51:14
   |
51 |     async fn extract(req: &'de mut Request) -> Result<Self, ParseError> {
   |              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ lifetimes do not match method in trait

error[E0195]: lifetime parameters or bounds on method `extract_with_arg` do not match the trait declaration
  --> rsns-server\src\common\request.rs:65:14
   |
65 |     async fn extract_with_arg(req: &'de mut Request, _arg: &str) -> Result<Self, ParseError> {
   |              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ lifetimes do not match method in trait

请更新至最新版本 rust, 如果还是出错，麻烦给出最小重现的例子，谢谢。

[z91300]

@chrislearn 0.65.1 最新版本配合上述代码 示例如下 ↓

salvo_validator_test.zip

0.64 、0.65版本报错信息同上，0.63版本正常

[chrislearn]

@chrislearn 0.65.1 最新版本配合上述代码 示例如下 ↓

salvo_validator_test.zip

0.64 、0.65版本报错信息同上，0.63版本正常

去除掉上面的 #[async_trait]

#[async_trait]
impl<'de, T: validator::Validate> Extractible<'de> for JsonValidatedBody<T>

[ollyde]

Did you guys fix lifetime parameters or bounds on method `extract` do not match the trait declaration lifetimes do not match method in trait

I still have it

From the zip

use salvo::{
    async_trait,
    extract::Metadata,
    http::ParseError,
    oapi::{Components, Content, Operation, RequestBody, ToRequestBody},
    prelude::{EndpointArgRegister, ToSchema},
    Extractible, Request,
};
use serde::{Deserialize, Deserializer};
use std::ops::{Deref, DerefMut};

pub struct JsonValidatedBody<T>(pub T);

impl<T> JsonValidatedBody<T> {
    /// Consumes self and returns the value of the parameter.
    pub fn into_inner(self) -> T {
        self.0
    }
}

#[async_trait]
impl<'de, T: validator::Validate> Extractible<'de> for JsonValidatedBody<T>
where
    T: Deserialize<'de> + Send,
{
    fn metadata() -> &'de Metadata {
        static METADATA: Metadata = Metadata::new("");
        &METADATA
    }
    async fn extract(req: &'de mut Request) -> Result<Self, ParseError> {
        let res: Self = req.parse_json().await?;

        res.0.validate().map_err(ParseError::other)?;

        Ok(res)
    }
    async fn extract_with_arg(req: &'de mut Request, _arg: &str) -> Result<Self, ParseError> {
        let res = Self::extract(req).await?;

        res.0.validate().map_err(ParseError::other)?;

        Ok(res)
    }
}

impl<'de, T> Deserialize<'de> for JsonValidatedBody<T>
where
    T: Deserialize<'de>,
{
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        T::deserialize(deserializer).map(JsonValidatedBody)
    }
}

impl<'de, T> EndpointArgRegister for JsonValidatedBody<T>
where
    T: Deserialize<'de> + ToSchema,
{
    fn register(components: &mut Components, operation: &mut Operation, _arg: &str) {
        let request_body = Self::to_request_body(components);
        let _ = <T as ToSchema>::to_schema(components);
        operation.request_body = Some(request_body);
    }
}

impl<'de, T> ToRequestBody for JsonValidatedBody<T>
where
    T: Deserialize<'de> + ToSchema,
{
    fn to_request_body(components: &mut Components) -> RequestBody {
        RequestBody::new()
            .description("Extract json format data from request.")
            .add_content("application/json", Content::new(T::to_schema(components)))
    }
}

impl<T> Deref for JsonValidatedBody<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T> DerefMut for JsonValidatedBody<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

[ollyde]

This is broken, trying to validate this

#[derive(Serialize, Deserialize, Debug, ToSchema, ToResponse, Validate)]
#[salvo(extract(default_source(from = "body")))]
pub struct Input {
    #[validate(max_length = 50)]
    #[validate(min_length = 2)]
    #[validate(pattern = "[a-z0-9 ]*")]
    #[salvo(schema(max_length = 50, min_length = 2, pattern = "[a-z0-9 ]*"))]
    pub new_name: Option<String>,
    pub group_id: String,
}

/// Fetch message for a group
#[endpoint(tags("Messages"))]
pub async fn edit_message_group(
    req: &mut Request,
    depot: &mut Depot,
    input: JsonValidatedBody<Input>,
) -> Result<Json<MessageGroup>, ApiError> {

I get

the trait bound messaging::routes::edit_message_group::Input: validator::Validate is not satisfied
the trait validator::Validate is implemented for &T

[chrislearn]

I'm using the code below, but I'm not getting compilation errors. If you do encounter a compilation error, please provide a minimal reproducible code base. I cannot run the code you gave above directly.

use salvo::oapi::extract::*;
use salvo::prelude::*;
use serde::{Serialize, Deserialize};
use validator::Validate;


#[derive(Serialize, Deserialize, Debug, ToSchema, ToResponse, Validate)]
#[salvo(extract(default_source(from = "body")))]
pub struct Input {
    #[validate(length(min = 50))]
    #[salvo(schema(max_length = 50, min_length = 2, pattern = "[a-z0-9 ]*"))]
    pub new_name: Option<String>,
    pub group_id: String,
}

/// Fetch message for a group
#[endpoint(tags("Messages"))]
pub async fn hello(
    input: JsonBody<Input>,
) -> String{
"".into()
}

#[tokio::main]
async fn main() {
    tracing_subscriber::fmt().init();

    let router = Router::new().push(Router::with_path("hello").get(hello));

    let doc = OpenApi::new("test api", "0.0.1").merge_router(&router);

    let router = router
        .unshift(doc.into_router("/api-doc/openapi.json"))
        .unshift(SwaggerUi::new("/api-doc/openapi.json").into_router("/swagger-ui"));

    let acceptor = TcpListener::new("0.0.0.0:5800").bind().await;
    Server::new(acceptor).serve(router).await;
}

[ollyde]

@chrislearn is it possible to use the salvo macro property instead of labeling it twice?

[chrislearn]

Now you do need to write it twice. Perhaps verification-related functions will be implemented in future versions and there is no need to write it twice.

[ollyde]

@chrislearn would be super nice not to write it twice and manually check :-D thanks for reply.

[brussee]

Hope you don't mind me posting this drop of knowledge:
"Parse, don't validate" which I agree with fully.

For more info, please see this comment: serde-rs/serde#939 (comment) and the following comment, both referring to: https://lexi-lambda.github.io/blog/2019/11/05/parse-don-t-validate/

Hope this helps!