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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
#![forbid(unsafe_code)]

use std::borrow::Cow;

use proc_macro::TokenStream;
use proc_macro_error::*;
use quote::{format_ident, quote, ToTokens};
use syn::{spanned::Spanned, *};

#[proc_macro_error]
#[proc_macro_attribute]
pub fn rpc_trait(_args: TokenStream, trait_body: TokenStream) -> TokenStream {
    rpc_define(trait_body)
}

// TODO generics
#[proc_macro_error]
#[proc_macro]
pub fn rpc_define(trait_body: TokenStream) -> TokenStream {
    let root: Path = parse_quote! { ::tiny_rpc::rpc::re_export }; // TODO extract from meta

    let trait_body = parse_macro_input!(trait_body as ItemTrait);
    let ident = &trait_body.ident;
    let func_list = gen_func_list(&trait_body);
    let (req_rsp_body, req_ident, rsp_ident) =
        gen_req_rsp(&root, &trait_body.vis, ident, &func_list);
    let server_body = gen_server(&root, ident, &req_ident, &rsp_ident, &func_list);
    let client_body = gen_client(&root, ident, &req_ident, &rsp_ident, &func_list);

    let ret = quote! {
        #trait_body
        #req_rsp_body
        #server_body
        #client_body
    };
    if option_env!("RUST_TRACE_MACROS").is_some() {
        println!("{}", ret);
    }
    ret.into()
}

/// Check if `arg` is receiver we want, i.e., `&self`, `&'a self`, `self: &Self` and `self: &'a Self`
fn is_ref_receiver(arg: Option<&FnArg>) -> bool {
    let arg = match arg {
        Some(arg) => arg,
        None => return false,
    };

    match arg {
        FnArg::Receiver(receiver) => receiver.reference.is_some() && receiver.mutability.is_none(), // `&self`, not `self` or `&mut self`
        FnArg::Typed(PatType { pat, ty, .. }) => {
            matches!(pat.as_ref(), Pat::Ident(ident) if ident.ident == "self") // `self: T`
                && matches!(
                    ty.as_ref(),
                    Type::Reference(TypeReference{ mutability, elem, ..})
                        if mutability.is_none() && matches!(elem.as_ref(), Type::Path(path) if path.qself.is_none() && path.path.is_ident("Self")) // `self: T` where T is a reference to `Self`
                )
        }
    }
}

/// Generate a list of trait method.
///
/// This function emit error and generate dummy for following cases:
///  - A trait method which has a default implementation.
///  - The first input is not `&self` or its equivalent.
///  - An input is given in pattern, e.g., `(x, y): (f32, f32)`.
///  - A trait method which defined at least one lifetime generic parameter except `'req`
fn gen_func_list(trait_body: &ItemTrait) -> Vec<Cow<'_, TraitItemMethod>> {
    let ref_receiver: FnArg = parse_quote!(&self); // const

    trait_body
        .items
        .iter()
        .filter_map(|item| match item {
            TraitItem::Method(method) => {
                // check signatures and prepare dummy for bad method

                let mut method = Cow::Borrowed(method);
                if method.default.is_some() {
                    emit_error!(
                        method.default,
                        "trait method can't have default implementation"
                    );

                    // create dummy by remove default and append semicolon(`;`)
                    let mut dummy = method.into_owned();
                    dummy.semi_token = Some(Token![;](dummy.default.span()));
                    dummy.default = None;
                    method = Cow::Owned(dummy);
                }

                if !is_ref_receiver(method.sig.inputs.first()) {
                    emit_error!(method, "trait method must have `&self` receiver");

                    // create dummy by replace bad receiver, append one if none is provided
                    let mut dummy = method.into_owned();
                    match dummy.sig.inputs.first() {
                        Some(FnArg::Receiver(_)) => {
                            // e.g., `&mut self`
                            *(dummy
                                .sig
                                .inputs
                                .first_mut()
                                .expect("infallible: non-mutable use before")) =
                                ref_receiver.clone();
                        }
                        Some(FnArg::Typed(PatType { pat, .. })) => match &**pat {
                            Pat::Ident(PatIdent { ident, .. }) if ident == "self" => {
                                // e.g., `self: Box<Self>`
                                *(dummy
                                    .sig
                                    .inputs
                                    .first_mut()
                                    .expect("infallible: non-mutable use before")) =
                                    ref_receiver.clone();
                            }
                            _ => {
                                // no receiver, just argument
                                dummy.sig.inputs.insert(0, ref_receiver.clone());
                            }
                        },
                        None => {
                            // no receiver and argument
                            dummy.sig.inputs.insert(0, ref_receiver.clone());
                        }
                    }
                    method = Cow::Owned(dummy);
                }

                for i in 0..(method.sig.inputs.len()) {
                    if let FnArg::Typed(PatType { ref pat, .. }) = method.sig.inputs[i] {
                        match pat.as_ref() {
                            Pat::Ident(_) => {}
                            other => {
                                emit_error!(other, "trait method cannot use pattern as argument");

                                let dummy_ident = format_ident!("__dummy_{:x}", {
                                    use std::hash::{Hash, Hasher};

                                    let mut h =
                                        std::collections::hash_map::DefaultHasher::default();
                                    other.hash(&mut h);
                                    h.finish()
                                });

                                let new_pat = Box::new(Pat::Ident(PatIdent {
                                    ident: dummy_ident,
                                    attrs: Default::default(),
                                    by_ref: None,
                                    mutability: None,
                                    subpat: None,
                                }));

                                let mut dummy = method.into_owned();
                                match dummy.sig.inputs[i] {
                                    FnArg::Typed(PatType { ref mut pat, .. }) => *pat = new_pat,
                                    _ => unreachable!(),
                                }
                                method = Cow::Owned(dummy);
                            }
                        }
                    }
                }

                for lifetime in method.sig.generics.lifetimes() {
                    if lifetime.lifetime.ident != "req" {
                        emit_error!(
                            lifetime.lifetime.span(),
                            "trait method may only have one lifetime parameter called `'req`"
                        );
                    }
                }

                Some(method)
            }
            item => {
                emit_error!(
                    item,
                    "#[rpc_define] trait cannot have any item other than function"
                );
                None
            }
        })
        .collect::<Vec<_>>()
}

fn gen_req_rsp<'a>(
    root: &Path,
    vis: &Visibility,
    ident: &Ident,
    func_list: &[Cow<'a, TraitItemMethod>],
) -> (proc_macro2::TokenStream, Ident, Ident) {
    let unit_type = parse_quote!(()); // const
    let serde_borrow_attr: Attribute = parse_quote!(#[serde(borrow)]); // const

    let req_ident = format_ident!("{}Request", ident);
    let rsp_ident = format_ident!("{}Response", ident);
    let serde_path = format!("{}::serde", root.to_token_stream());
    let serde_path = LitStr::new(serde_path.as_str(), root.span());

    let func_ident = func_list
        .iter()
        .map(|method| &method.sig.ident)
        .collect::<Vec<_>>();
    let input_type = func_list.iter().map(|method| {
        method
            .sig
            .inputs
            .iter()
            .skip(1) // Skip the receiver, which must exist.
            .map(|input| match input {
                FnArg::Typed(PatType { ty, .. }) => ty,
                FnArg::Receiver(_) => unreachable!(),
            })
            .collect::<Vec<_>>()
    });
    let input_borrow = func_list.iter().map(|method| {
        if method.sig.generics.lifetimes().next().is_some() {
            Some(&serde_borrow_attr)
        } else {
            None
        }
    });
    let output_type = func_list.iter().map(|method| match method.sig.output {
        ReturnType::Default => &unit_type,
        ReturnType::Type(_, ref ty) => ty.as_ref(),
    });

    let req_rsp = quote! {
        #[derive(#root::Serialize, #root::Deserialize)]
        #[serde(crate = #serde_path)]
        #[serde(deny_unknown_fields)]
        #[allow(non_camel_case_types)]
        #vis enum #req_ident<'req> {
            #( #func_ident ( #input_borrow ( #(#input_type,)* ) ), )*
            ___tiny_rpc_marker((#root::Never, #root::PhantomData<&'req ()>))
        }

        #[derive(#root::Serialize, #root::Deserialize)]
        #[serde(crate = #serde_path)]
        #[serde(deny_unknown_fields)]
        #[allow(non_camel_case_types)]
        #vis enum #rsp_ident {
            #( #func_ident ( #output_type ), )*
        }
    };

    (req_rsp, req_ident, rsp_ident)
}

fn gen_server<'a>(
    root: &Path,
    ident: &Ident,
    req_ident: &Ident,
    rsp_ident: &Ident,
    func_list: &[Cow<'a, TraitItemMethod>],
) -> proc_macro2::TokenStream {
    let null_stream = quote! {}; // const
    let keyword_await = quote! { .await }; // const

    let server_ident = format_ident!("{}Server", ident);
    let func_ident = func_list
        .iter()
        .map(|method| &method.sig.ident)
        .collect::<Vec<_>>();
    let input_ident = func_list
        .iter()
        .map(|method| {
            method
                .sig
                .inputs
                .iter()
                .filter_map(|input| match input {
                    FnArg::Receiver(_) => None, // NOTE all receivers are now `&self`
                    FnArg::Typed(PatType { pat, .. }) => match &**pat {
                        Pat::Ident(ident) => Some(&ident.ident),
                        _ => unreachable!(),
                    },
                })
                .collect::<Vec<_>>()
        })
        .collect::<Vec<_>>();
    let await_if_async = func_list.iter().map(|method| {
        method
            .sig
            .asyncness
            .map_or(&null_stream, |_| &keyword_await)
    });

    quote! {
        pub struct #server_ident<T: #ident + #root::Send + #root::Sync + 'static>(#root::Arc<T>);

        impl<T: #ident + #root::Send + #root::Sync + 'static> #server_ident<T> {
            pub fn serve(server_impl: T, transport: #root::Transport) -> #root::BoxStream<'static, #root::BoxFuture<'static, ()>> {
                Self::__internal_serve(Self(#root::Arc::new(server_impl)), transport)
            }

            pub fn serve_arc(server_impl: #root::Arc<T>, transport: #root::Transport) -> #root::BoxStream<'static, #root::BoxFuture<'static, ()>> {
                Self::__internal_serve(Self(server_impl), transport)
            }

            fn __internal_serve(self, transport: #root::Transport) -> #root::BoxStream<'static, #root::BoxFuture<'static, ()>> {
                #root::Server::serve(self, transport)
            }
        }

        impl<T: #ident + #root::Send + #root::Sync + 'static> #root::Clone for #server_ident<T> {
            fn clone(&self) -> Self {
                Self(#root::Clone::clone(&self.0))
            }
        }

        impl<T: #ident + #root::Send + #root::Sync + 'static> #root::Server for #server_ident<T> {
            fn make_response(
                self,
                req: #root::RpcFrame,
            ) -> #root::BoxFuture<'static, #root::Result<#root::RpcFrame>> {
                #root::FutureExt::boxed(
                    async move {
                        let id = req.id()?;
                        let req = req.data()?;
                        let rsp = match req {
                            #(
                                #req_ident::#func_ident( ( #(#input_ident,)* ) ) => {
                                    #rsp_ident::#func_ident(self.0.#func_ident(#(#input_ident),*) #await_if_async)
                                }
                            )*
                            #req_ident::___tiny_rpc_marker(_) => #root::unreachable!(),
                        };
                        let rsp = #root::RpcFrame::new(id, rsp)?;
                        Ok(rsp)
                    }
                )
            }
        }
    }
}

fn gen_client<'a>(
    root: &Path,
    ident: &Ident,
    req_ident: &Ident,
    rsp_ident: &Ident,
    func_list: &[Cow<'a, TraitItemMethod>],
) -> proc_macro2::TokenStream {
    let unit_type: Type = parse_quote!(()); // const

    let client_ident = format_ident!("{}Client", ident);
    let signature = func_list
        .iter()
        .cloned()
        .map(|method| {
            let method = method.into_owned();
            let span = method.span();
            let mut sig = method.sig;

            if sig.asyncness.is_none() {
                sig.asyncness = Some(Token![async](span));
            }

            let ty = match sig.output {
                ReturnType::Type(_, ty) => *ty,
                ReturnType::Default => unit_type.clone(),
            };
            sig.output = parse_quote! { -> #root::Result<#ty> };
            sig
        })
        .collect::<Vec<_>>();
    let arg_ident = signature.iter().map(|sig| {
        sig.inputs
            .iter()
            .filter_map(|arg| match arg {
                FnArg::Receiver(_) => None,
                FnArg::Typed(PatType { pat, .. }) => match &**pat {
                    Pat::Ident(ident) => Some(&ident.ident),
                    _ => unreachable!(),
                },
            })
            .collect::<Vec<_>>()
    });
    let func_ident = signature.iter().map(|sig| &sig.ident);

    quote! {
        #[derive(Clone)]
        pub struct #client_ident(#root::IdGenerator, #root::ClientDriverHandle);

        impl #root::Client for #client_ident {
            fn from_handle(handle: #root::ClientDriverHandle) -> Self {
                Self(#root::IdGenerator::new(), handle)
            }

            fn handle(&self) -> &#root::ClientDriverHandle {
                &self.1
            }
        }

        impl #client_ident {
            pub fn new(transport: #root::Transport) -> (Self, #root::BoxFuture<'static, ()>) {
                #root::Client::new(transport)
            }

            #(
                pub #signature {
                    let args = ( #(#arg_ident,)* );
                    let id = self.0.next();
                    let span = info_span!(#root::stringify!(#func_ident), %id);

                    #root::Instrument::instrument(
                        async move {
                            let req = #req_ident::#func_ident(args);
                            let req = #root::RpcFrame::new(id, req)?;
                            let rsp = <Self as #root::Client>::make_request(self, req).await?;
                            let rsp = rsp.data()?;
                            match rsp {
                                #rsp_ident::#func_ident(ret) => Ok(ret),
                                _ => Err(#root::Into::into(#root::ProtocolError::ResponseMismatch(id))),
                            }
                        },
                        span,
                    )
                    .await
                }
            )*
        }
    }
}

#[test]
fn test_is_ref_receiver() {
    let ref_receiver: &[FnArg] = &[
        parse_quote!(self),
        parse_quote!(&self),
        parse_quote!(&'a self),
        parse_quote!(&mut self),
        parse_quote!(&'a mut self),
        parse_quote!(self: Self),
        parse_quote!(self: &Self),
        parse_quote!(self: &'a Self),
        parse_quote!(self: &mut Self),
        parse_quote!(self: &'a mut Self),
    ];
    let answer = &[
        false, true, true, false, false, false, true, true, false, false,
    ];

    assert_eq!(is_ref_receiver(None), false);
    for (t, a) in ref_receiver.into_iter().zip(answer) {
        assert_eq!(is_ref_receiver(Some(t)), *a);
    }
}