salvo_oapi/extract/parameter/

path.rs

use std::fmt::{self, Debug, Formatter};
use std::ops::{Deref, DerefMut};

use salvo_core::Depot;
use salvo_core::extract::{Extractible, Metadata};
use salvo_core::http::{ParseError, Request};
use serde::{Deserialize, Deserializer};

use crate::endpoint::EndpointArgRegister;
use crate::{Components, Operation, Parameter, ParameterIn, ToSchema};

/// Represents the parameters passed by the URI path.
pub struct PathParam<T>(pub T);
impl<T> PathParam<T> {
    /// Consumes self and returns the value of the parameter.
    pub fn into_inner(self) -> T {
        self.0
    }
}

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

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

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

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

impl<T> fmt::Debug for PathParam<T>
where
    T: Debug,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl<T> fmt::Display for PathParam<T>
where
    T: fmt::Display,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl<'ex, T> Extractible<'ex> for PathParam<T>
where
    T: Deserialize<'ex>,
{
    fn metadata() -> &'static Metadata {
        static METADATA: Metadata = Metadata::new("");
        &METADATA
    }
    #[allow(refining_impl_trait)]
    async fn extract(_req: &'ex mut Request, _depot: &'ex mut Depot) -> Result<Self, ParseError> {
        unimplemented!("path parameter can not be extracted from request")
    }
    #[allow(refining_impl_trait)]
    async fn extract_with_arg(
        req: &'ex mut Request,
        _depot: &'ex mut Depot,
        arg: &str,
    ) -> Result<Self, ParseError> {
        let value = req.param(arg).ok_or_else(|| {
            ParseError::other(format!(
                "path parameter {arg} not found or convert to type failed"
            ))
        })?;
        Ok(Self(value))
    }
}

impl<T> EndpointArgRegister for PathParam<T>
where
    T: ToSchema,
{
    fn register(components: &mut Components, operation: &mut Operation, arg: &str) {
        let parameter = Parameter::new(arg)
            .parameter_in(ParameterIn::Path)
            .description(format!("Get parameter `{arg}` from request url path."))
            .schema(T::to_schema(components))
            .required(true);
        operation.parameters.insert(parameter);
    }
}

#[cfg(test)]
mod tests {
    use assert_json_diff::assert_json_eq;
    use salvo_core::test::TestClient;
    use serde_json::json;

    use super::*;

    #[test]
    fn test_path_param_into_inner() {
        let param = PathParam::<String>("param".to_owned());
        assert_eq!("param".to_owned(), param.into_inner());
    }

    #[test]
    fn test_path_param_deref() {
        let param = PathParam::<String>("param".to_owned());
        assert_eq!(&"param".to_owned(), param.deref())
    }

    #[test]
    fn test_path_param_deref_mut() {
        let mut param = PathParam::<String>("param".to_owned());
        assert_eq!(&mut "param".to_owned(), param.deref_mut())
    }

    #[test]
    fn test_path_param_deserialize() {
        let param = serde_json::from_str::<PathParam<String>>(r#""param""#).unwrap();
        assert_eq!(param.0, "param");
    }

    #[test]
    fn test_path_param_debug() {
        let param = PathParam::<String>("param".to_owned());
        assert_eq!(format!("{param:?}"), r#""param""#);
    }

    #[test]
    fn test_path_param_display() {
        let param = PathParam::<String>("param".to_owned());
        assert_eq!(format!("{param}"), "param");
    }

    #[test]
    fn test_path_param_metadata() {
        let metadata = PathParam::<String>::metadata();
        assert_eq!("", metadata.name);
    }

    #[tokio::test]
    #[should_panic]
    async fn test_path_prarm_extract() {
        let mut req = Request::new();
        let mut depot = Depot::new();
        let _ = PathParam::<String>::extract(&mut req, &mut depot).await;
    }

    #[tokio::test]
    async fn test_path_prarm_extract_with_value() {
        let req = TestClient::get("http://127.0.0.1:5801").build_hyper();
        let schema = req.uri().scheme().cloned().unwrap();
        let mut req = Request::from_hyper(req, schema);
        let mut depot = Depot::new();
        req.params_mut().insert("param", "param".to_owned());
        let result = PathParam::<String>::extract_with_arg(&mut req, &mut depot, "param").await;
        assert_eq!(result.unwrap().0, "param");
    }

    #[tokio::test]
    #[should_panic]
    async fn test_path_prarm_extract_with_value_panic() {
        let req = TestClient::get("http://127.0.0.1:5801").build_hyper();
        let schema = req.uri().scheme().cloned().unwrap();
        let mut req = Request::from_hyper(req, schema);
        let mut depot = Depot::new();
        let result = PathParam::<String>::extract_with_arg(&mut req, &mut depot, "param").await;
        assert_eq!(result.unwrap().0, "param");
    }

    #[test]
    fn test_path_param_register() {
        let mut components = Components::new();
        let mut operation = Operation::new();
        PathParam::<String>::register(&mut components, &mut operation, "arg");

        assert_json_eq!(
            operation,
            json!({
                "parameters": [
                    {
                        "name": "arg",
                        "in": "path",
                        "description": "Get parameter `arg` from request url path.",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "responses": {}
            })
        )
    }
}