salvo_oapi/extract/parameter/
query.rs

1use std::fmt::{self, Debug, Display, Formatter};
2use std::ops::{Deref, DerefMut};
3
4use salvo_core::Request;
5use salvo_core::extract::{Extractible, Metadata};
6use salvo_core::http::ParseError;
7use serde::{Deserialize, Deserializer};
8
9use crate::endpoint::EndpointArgRegister;
10use crate::{Components, Operation, Parameter, ParameterIn, ToSchema};
11
12/// Represents the parameters passed by the URI path.
13pub struct QueryParam<T, const REQUIRED: bool = true>(Option<T>);
14impl<T> QueryParam<T, true> {
15    /// Consumes self and returns the value of the parameter.
16    pub fn into_inner(self) -> T {
17        self.0.expect("`QueryParam<T, true>` into_inner get `None`")
18    }
19}
20impl<T> QueryParam<T, false> {
21    /// Consumes self and returns the value of the parameter.
22    pub fn into_inner(self) -> Option<T> {
23        self.0
24    }
25}
26
27impl<T> Deref for QueryParam<T, true> {
28    type Target = T;
29
30    fn deref(&self) -> &Self::Target {
31        self.0
32            .as_ref()
33            .expect("`QueryParam<T, true>` defref get `None`")
34    }
35}
36impl<T> Deref for QueryParam<T, false> {
37    type Target = Option<T>;
38
39    fn deref(&self) -> &Self::Target {
40        &self.0
41    }
42}
43
44impl<T> DerefMut for QueryParam<T, true> {
45    fn deref_mut(&mut self) -> &mut Self::Target {
46        self.0
47            .as_mut()
48            .expect("`QueryParam<T, true>` defref_mut get `None`")
49    }
50}
51impl<T> DerefMut for QueryParam<T, false> {
52    fn deref_mut(&mut self) -> &mut Self::Target {
53        &mut self.0
54    }
55}
56
57impl<'de, T, const R: bool> Deserialize<'de> for QueryParam<T, R>
58where
59    T: Deserialize<'de>,
60{
61    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
62    where
63        D: Deserializer<'de>,
64    {
65        T::deserialize(deserializer).map(|value| Self(Some(value)))
66    }
67}
68
69impl<T: Debug, const R: bool> Debug for QueryParam<T, R> {
70    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
71        self.0.fmt(f)
72    }
73}
74
75impl<T: Display> Display for QueryParam<T, true> {
76    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
77        self.0
78            .as_ref()
79            .expect("`QueryParam<T, true>` as_ref get `None`")
80            .fmt(f)
81    }
82}
83
84impl<'ex, T> Extractible<'ex> for QueryParam<T, true>
85where
86    T: Deserialize<'ex>,
87{
88    fn metadata() -> &'static Metadata {
89        static METADATA: Metadata = Metadata::new("");
90        &METADATA
91    }
92    #[allow(refining_impl_trait)]
93    async fn extract(_req: &'ex mut Request) -> Result<Self, ParseError> {
94        panic!("query parameter can not be extracted from request")
95    }
96    #[allow(refining_impl_trait)]
97    async fn extract_with_arg(req: &'ex mut Request, arg: &str) -> Result<Self, ParseError> {
98        let value = req.query(arg).ok_or_else(|| {
99            ParseError::other(format!(
100                "query parameter {arg} not found or convert to type failed"
101            ))
102        })?;
103        Ok(Self(value))
104    }
105}
106impl<'ex, T> Extractible<'ex> for QueryParam<T, false>
107where
108    T: Deserialize<'ex>,
109{
110    fn metadata() -> &'static Metadata {
111        static METADATA: Metadata = Metadata::new("");
112        &METADATA
113    }
114    #[allow(refining_impl_trait)]
115    async fn extract(_req: &'ex mut Request) -> Result<Self, ParseError> {
116        panic!("query parameter can not be extracted from request")
117    }
118    #[allow(refining_impl_trait)]
119    async fn extract_with_arg(req: &'ex mut Request, arg: &str) -> Result<Self, ParseError> {
120        Ok(Self(req.query(arg)))
121    }
122}
123
124impl<T, const R: bool> EndpointArgRegister for QueryParam<T, R>
125where
126    T: ToSchema,
127{
128    fn register(components: &mut Components, operation: &mut Operation, arg: &str) {
129        let parameter = Parameter::new(arg)
130            .parameter_in(ParameterIn::Query)
131            .description(format!("Get parameter `{arg}` from request url query."))
132            .schema(T::to_schema(components))
133            .required(R);
134        operation.parameters.insert(parameter);
135    }
136}
137
138#[cfg(test)]
139mod tests {
140    use assert_json_diff::assert_json_eq;
141    use salvo_core::test::TestClient;
142    use serde_json::json;
143
144    use super::*;
145
146    #[test]
147    fn test_required_query_param_into_inner() {
148        let param = QueryParam::<String, true>(Some("param".to_owned()));
149        assert_eq!("param".to_owned(), param.into_inner());
150    }
151
152    #[test]
153    fn test_required_query_param_deref() {
154        let param = QueryParam::<String, true>(Some("param".to_owned()));
155        assert_eq!(&"param".to_owned(), param.deref())
156    }
157
158    #[test]
159    fn test_required_query_param_deref_mut() {
160        let mut param = QueryParam::<String, true>(Some("param".to_owned()));
161        assert_eq!(&mut "param".to_owned(), param.deref_mut())
162    }
163
164    #[test]
165    fn test_query_param_into_inner() {
166        let param = QueryParam::<String, false>(Some("param".to_owned()));
167        assert_eq!(Some("param".to_owned()), param.into_inner());
168    }
169
170    #[test]
171    fn test_query_param_deref() {
172        let param = QueryParam::<String, false>(Some("param".to_owned()));
173        assert_eq!(&Some("param".to_owned()), param.deref())
174    }
175
176    #[test]
177    fn test_query_param_deref_mut() {
178        let mut param = QueryParam::<String, false>(Some("param".to_owned()));
179        assert_eq!(&mut Some("param".to_owned()), param.deref_mut())
180    }
181
182    #[test]
183    fn test_query_param_deserialize() {
184        let param = serde_json::from_str::<QueryParam<String, true>>(r#""param""#).unwrap();
185        assert_eq!(param.0.unwrap(), "param");
186    }
187
188    #[test]
189    fn test_query_param_debug() {
190        let param = QueryParam::<String, true>(Some("param".to_owned()));
191        assert_eq!(format!("{param:?}"), r#"Some("param")"#);
192    }
193
194    #[test]
195    fn test_query_param_display() {
196        let param = QueryParam::<String, true>(Some("param".to_owned()));
197        assert_eq!(format!("{param}"), "param");
198    }
199
200    #[test]
201    fn test_required_query_param_metadata() {
202        let metadata = QueryParam::<String, true>::metadata();
203        assert_eq!("", metadata.name);
204    }
205
206    #[tokio::test]
207    #[should_panic]
208    async fn test_required_query_prarm_extract() {
209        let mut req = Request::new();
210        let _ = QueryParam::<String, true>::extract(&mut req).await;
211    }
212
213    #[tokio::test]
214    async fn test_required_query_prarm_extract_with_value() {
215        let req = TestClient::get("http://127.0.0.1:5801").build_hyper();
216        let schema = req.uri().scheme().cloned().unwrap();
217        let mut req = Request::from_hyper(req, schema);
218        req.queries_mut()
219            .insert("param".to_owned(), "param".to_owned());
220        let result = QueryParam::<String, true>::extract_with_arg(&mut req, "param").await;
221        assert_eq!(result.unwrap().0.unwrap(), "param");
222    }
223
224    #[tokio::test]
225    #[should_panic]
226    async fn test_required_query_prarm_extract_with_value_panic() {
227        let req = TestClient::get("http://127.0.0.1:5801").build_hyper();
228        let schema = req.uri().scheme().cloned().unwrap();
229        let mut req = Request::from_hyper(req, schema);
230        let result = QueryParam::<String, true>::extract_with_arg(&mut req, "param").await;
231        assert_eq!(result.unwrap().0.unwrap(), "param");
232    }
233
234    #[test]
235    fn test_query_param_metadata() {
236        let metadata = QueryParam::<String, false>::metadata();
237        assert_eq!("", metadata.name);
238    }
239
240    #[tokio::test]
241    #[should_panic]
242    async fn test_query_prarm_extract() {
243        let mut req = Request::new();
244        let _ = QueryParam::<String, false>::extract(&mut req).await;
245    }
246
247    #[tokio::test]
248    async fn test_query_prarm_extract_with_value() {
249        let req = TestClient::get("http://127.0.0.1:5801").build_hyper();
250        let schema = req.uri().scheme().cloned().unwrap();
251        let mut req = Request::from_hyper(req, schema);
252        req.queries_mut()
253            .insert("param".to_owned(), "param".to_owned());
254        let result = QueryParam::<String, false>::extract_with_arg(&mut req, "param").await;
255        assert_eq!(result.unwrap().0.unwrap(), "param");
256    }
257
258    #[tokio::test]
259    #[should_panic]
260    async fn test_query_prarm_extract_with_value_panic() {
261        let req = TestClient::get("http://127.0.0.1:5801").build_hyper();
262        let schema = req.uri().scheme().cloned().unwrap();
263        let mut req = Request::from_hyper(req, schema);
264        let result = QueryParam::<String, false>::extract_with_arg(&mut req, "param").await;
265        assert_eq!(result.unwrap().0.unwrap(), "param");
266    }
267
268    #[test]
269    fn test_query_param_register() {
270        let mut components = Components::new();
271        let mut operation = Operation::new();
272        QueryParam::<String, false>::register(&mut components, &mut operation, "arg");
273
274        assert_json_eq!(
275            operation,
276            json!({
277                "parameters": [
278                    {
279                        "name": "arg",
280                        "in": "query",
281                        "description": "Get parameter `arg` from request url query.",
282                        "required": false,
283                        "schema": {
284                            "type": "string"
285                        }
286                    }
287                ],
288                "responses": {}
289            })
290        )
291    }
292}
salvo_oapi/extract/parameter/query.rs

salvo_oapi/extract/parameter/
query.rs
