1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
//! The macros lib of Savlo web server framework.
//!
//! Read more: <https://salvo.rs>
#![doc(html_favicon_url = "https://salvo.rs/favicon-32x32.png")]
#![doc(html_logo_url = "https://salvo.rs/images/logo.svg")]
#![cfg_attr(docsrs, feature(doc_cfg))]

use proc_macro::TokenStream;
use syn::{parse_macro_input, DeriveInput, Item};

mod attribute;
mod extract;
mod handler;
mod shared;

pub(crate) use salvo_serde_util as serde_util;
use shared::*;

/// `handler` is a macro to help create `Handler` from function or impl block easily.
///
/// `Handler` is a trait, if `#[handler]` applied to `fn`,  `fn` will converted to a struct, and then implement `Handler`,
/// after use `handler`, you don't need to care arguments' order, omit unused arguments.
///
/// View `salvo_core::handler` for more details.
#[proc_macro_attribute]
pub fn handler(_args: TokenStream, input: TokenStream) -> TokenStream {
    let item = parse_macro_input!(input as Item);
    match handler::generate(item) {
        Ok(stream) => stream.into(),
        Err(e) => e.to_compile_error().into(),
    }
}

/// Generate code for extractible type.
#[proc_macro_derive(Extractible, attributes(salvo))]
pub fn derive_extractible(input: TokenStream) -> TokenStream {
    let args = parse_macro_input!(input as DeriveInput);
    match extract::generate(args) {
        Ok(stream) => stream.into(),
        Err(e) => e.to_compile_error().into(),
    }
}

#[cfg(test)]
mod tests {
    use quote::quote;
    use syn::parse2;

    use super::*;

    #[test]
    fn test_handler_for_fn() {
        let input = quote! {
            #[handler]
            async fn hello(req: &mut Request, depot: &mut Depot, res: &mut Response, ctrl: &mut FlowCtrl) {
                res.render_plain_text("Hello World");
            }
        };
        let item = parse2(input).unwrap();
        assert_eq!(
            handler::generate(item).unwrap().to_string(),
            quote! {
                #[allow(non_camel_case_types)]
                #[derive(Debug)]
                struct hello;
                impl hello {
                    #[handler]
                    async fn hello(req: &mut Request,depot: &mut Depot, res: &mut Response, ctrl: &mut FlowCtrl) {
                        {
                            res.render_plain_text("Hello World");
                        }
                    }
                }
                #[salvo::async_trait]
                impl salvo::Handler for hello {
                    async fn handle(
                        &self,
                        __macro_gen_req: &mut salvo::Request,
                        __macro_gen_depot: &mut salvo::Depot,
                        __macro_gen_res: &mut salvo::Response,
                        __macro_gen_ctrl: &mut salvo::FlowCtrl
                    ) {
                        Self::hello(__macro_gen_req, __macro_gen_depot, __macro_gen_res, __macro_gen_ctrl).await
                    }
                }
            }
            .to_string()
        );
    }

    #[test]
    fn test_handler_for_fn_return_result() {
        let input = quote! {
            #[handler]
            async fn hello(req: &mut Request, depot: &mut Depot, res: &mut Response, ctrl: &mut FlowCtrl) -> Result<(), Error> {
                Ok(())
            }
        };
        let item = parse2(input).unwrap();
        assert_eq!(
            handler::generate(item).unwrap().to_string(),
            quote!{
                #[allow(non_camel_case_types)]
                #[derive(Debug)]
                struct hello;
                impl hello {
                    #[handler]
                    async fn hello(req: &mut Request, depot: &mut Depot, res: &mut Response, ctrl: &mut FlowCtrl
                    ) -> Result<(), Error> {
                        {Ok(())}
                    }
                }
                #[salvo::async_trait]
                impl salvo::Handler for hello {
                    async fn handle(
                        &self,
                        __macro_gen_req: &mut salvo::Request,
                        __macro_gen_depot: &mut salvo::Depot,
                        __macro_gen_res: &mut salvo::Response,
                        __macro_gen_ctrl: &mut salvo::FlowCtrl
                    ) {
                        salvo::Writer::write(Self::hello(__macro_gen_req, __macro_gen_depot, __macro_gen_res, __macro_gen_ctrl).await, __macro_gen_req, __macro_gen_depot, __macro_gen_res).await;
                    }
                }
            }
            .to_string()
        );
    }

    #[test]
    fn test_handler_for_impl() {
        let input = quote! {
            #[handler]
            impl Hello {
                fn handle(req: &mut Request, depot: &mut Depot, res: &mut Response) {
                    res.render_plain_text("Hello World");
                }
            }
        };
        let item = parse2(input).unwrap();
        assert_eq!(
            handler::generate(item).unwrap().to_string(),
            quote! {
                #[handler]
                impl Hello {
                    fn handle(req: &mut Request, depot: &mut Depot, res: &mut Response) {
                        res.render_plain_text("Hello World");
                    }
                }
                #[salvo::async_trait]
                impl salvo::Handler for Hello {
                    async fn handle(
                        &self,
                        __macro_gen_req: &mut salvo::Request,
                        __macro_gen_depot: &mut salvo::Depot,
                        __macro_gen_res: &mut salvo::Response,
                        __macro_gen_ctrl: &mut salvo::FlowCtrl
                    ) {
                        Self::handle(__macro_gen_req, __macro_gen_depot, __macro_gen_res)
                    }
                }
            }
            .to_string()
        );
    }

    #[test]
    fn test_extract_simple() {
        let input = quote! {
            #[salvo(extract(default_source(from = "body")))]
            struct BadMan<'a> {
                #[salvo(extract(source(from = "query")))]
                id: i64,
                username: String,
            }
        };
        let item = parse2(input).unwrap();
        assert_eq!(
            extract::generate(item).unwrap().to_string(),
            quote!{
                impl<'__macro_gen_ex: 'a, 'a> salvo::extract::Extractible<'__macro_gen_ex> for BadMan<'a> {
                    fn metadata() -> &'static salvo::extract::Metadata {
                        static METADATA: salvo::__private::once_cell::sync::OnceCell<salvo::extract::Metadata> =
                            salvo::__private::once_cell::sync::OnceCell::new();
                        METADATA.get_or_init(|| {
                            let mut metadata = salvo::extract::Metadata::new("BadMan");
                            metadata = metadata.add_default_source(salvo::extract::metadata::Source::new(
                                salvo::extract::metadata::SourceFrom::Body,
                                salvo::extract::metadata::SourceParser::Smart
                            ));
                            let mut field = salvo::extract::metadata::Field::new("id");
                            field = field.add_source(salvo::extract::metadata::Source::new(
                                salvo::extract::metadata::SourceFrom::Query,
                                salvo::extract::metadata::SourceParser::Smart
                            ));
                            metadata = metadata.add_field(field);
                            let mut field = salvo::extract::metadata::Field::new("username");
                            metadata = metadata.add_field(field);
                            metadata
                        })
                    }
                    #[allow(refining_impl_trait)]
                    async fn extract(req: &'__macro_gen_ex mut salvo::http::Request) -> Result<Self, salvo::http::ParseError>
                    where
                        Self: Sized {
                        salvo::serde::from_request(req, Self::metadata()).await
                    }
                }
            }
            .to_string()
        );
    }

    #[test]
    fn test_extract_with_lifetime() {
        let input = quote! {
            #[salvo(extract(
                default_source(from = "query"),
                default_source(from = "param"),
                default_source(from = "body")
            ))]
            struct BadMan<'a> {
                id: i64,
                username: String,
                first_name: &'a str,
                last_name: String,
                lovers: Vec<String>,
            }
        };
        let item = parse2(input).unwrap();
        assert_eq!(
            extract::generate(item).unwrap().to_string(),
            quote!{
                impl<'__macro_gen_ex: 'a, 'a> salvo::extract::Extractible<'__macro_gen_ex> for BadMan<'a> {
                    fn metadata() -> &'static salvo::extract::Metadata {
                        static METADATA: salvo::__private::once_cell::sync::OnceCell<salvo::extract::Metadata> =
                            salvo::__private::once_cell::sync::OnceCell::new();
                        METADATA.get_or_init(|| {
                            let mut metadata = salvo::extract::Metadata::new("BadMan");
                            metadata = metadata.add_default_source(salvo::extract::metadata::Source::new(
                                salvo::extract::metadata::SourceFrom::Query,
                                salvo::extract::metadata::SourceParser::Smart
                            ));
                            metadata = metadata.add_default_source(salvo::extract::metadata::Source::new(
                                salvo::extract::metadata::SourceFrom::Param,
                                salvo::extract::metadata::SourceParser::Smart
                            ));
                            metadata = metadata.add_default_source(salvo::extract::metadata::Source::new(
                                salvo::extract::metadata::SourceFrom::Body,
                                salvo::extract::metadata::SourceParser::Smart
                            ));
                            let mut field = salvo::extract::metadata::Field::new("id");
                            metadata = metadata.add_field(field);
                            let mut field = salvo::extract::metadata::Field::new("username");
                            metadata = metadata.add_field(field);
                            let mut field = salvo::extract::metadata::Field::new("first_name");
                            metadata = metadata.add_field(field);
                            let mut field = salvo::extract::metadata::Field::new("last_name");
                            metadata = metadata.add_field(field);
                            let mut field = salvo::extract::metadata::Field::new("lovers");
                            metadata = metadata.add_field(field);
                            metadata
                        })
                    }
                    #[allow(refining_impl_trait)]
                    async fn extract(req: &'__macro_gen_ex mut salvo::http::Request) -> Result<Self, salvo::http::ParseError>
                    where
                        Self: Sized {
                        salvo::serde::from_request(req, Self::metadata()).await
                    }
                }
            }
            .to_string()
        );
    }
}