xitca-codegen 0.4.0

proc macro for xitca
Documentation
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
use proc_macro::TokenStream;
use quote::quote;
use syn::{
    __private::{Span, TokenStream2},
    Error, FnArg, GenericArgument, GenericParam, Ident, ImplItemFn, ItemImpl, Pat, PatIdent, PathArguments, ReturnType,
    Stmt, Type, TypePath, WhereClause,
    punctuated::Punctuated,
    spanned::Spanned,
    token::Comma,
};

use crate::find_async_method;

pub(crate) fn middleware(_: TokenStream, input: ItemImpl) -> Result<TokenStream, Error> {
    let builder_impl = BuilderImpl::try_from_item(&input)?;
    let call_stream = CallImpl::try_from_item(&input)?.into_token_stream(&builder_impl);

    let BuilderImpl {
        service_ty,
        generics,
        where_clause,
        impl_fn,
        builder_ident,
        builder_ty,
        builder_stmts,
        arg_ident,
        arg_ty,
    } = builder_impl;

    let new_service_generic_err_ty = impl_fn
        .sig
        .generics
        .params
        .first()
        .ok_or_else(|| Error::new(impl_fn.sig.generics.span(), "expect generic E type"))?;

    let new_service_rt_err_ty = find_new_service_rt_err_ty(impl_fn)?;

    let base = quote! {
        impl<#generics, #new_service_generic_err_ty> ::xitca_service::Service<#arg_ty> for #builder_ty
        #where_clause
        {
            type Response = #service_ty;
            type Error = #new_service_rt_err_ty;

            async fn call(&self, #arg_ident: #arg_ty) -> Result<Self::Response, Self::Error> {
                let #builder_ident = &self;
                #(#builder_stmts)*
            }
        }

        #call_stream
    };

    let ready_impl = ReadyImpl::try_from_item(&input)?;
    Ok(try_extend_ready_impl(
        base,
        ready_impl,
        service_ty,
        generics,
        where_clause,
    ))
}

pub(crate) fn service(_: TokenStream, input: ItemImpl) -> Result<TokenStream, Error> {
    let builder_impl = BuilderImpl::try_from_item(&input)?;
    let call_impl = CallImpl::try_from_item(&input)?;

    let err_ty = call_impl.err_ty;

    let call_stream = call_impl.into_token_stream(&builder_impl);

    let BuilderImpl {
        service_ty,
        generics,
        where_clause,
        builder_ident,
        builder_ty,
        builder_stmts,
        arg_ident,
        arg_ty,
        ..
    } = builder_impl;

    let base = quote! {
        impl<#generics> ::xitca_service::Service<#arg_ty> for #builder_ty
        #where_clause
        {
            type Response = #service_ty;
            type Error = #err_ty;

            async fn call(&self, #arg_ident: #arg_ty) -> Result<Self::Response, Self::Error> {
                let #builder_ident = &self;
                #(#builder_stmts)*
            }
        }

        #call_stream
    };

    let ready_impl = ReadyImpl::try_from_item(&input)?;
    Ok(try_extend_ready_impl(
        base,
        ready_impl,
        service_ty,
        generics,
        where_clause,
    ))
}

fn try_extend_ready_impl(
    base: TokenStream2,
    ready_impl: Option<ReadyImpl<'_>>,
    service_ty: &TypePath,
    generics: &Punctuated<GenericParam, Comma>,
    where_clause: Option<&WhereClause>,
) -> TokenStream {
    let ready = ready_impl.map(
        |ReadyImpl {

             ready_stmts,
             ready_ret_ty,
         }| {
            quote! {
                impl<#generics> ::xitca_service::ready::ReadyService for #service_ty
                #where_clause
                {
                    type Ready = #ready_ret_ty;

                    #[inline]
                    async fn ready(&self) -> Self::Ready {
                        #(#ready_stmts)*
                    }
                }
            }
        },
    );

    quote! {
        #base
        #ready
    }
    .into()
}

struct BuilderImpl<'a> {
    service_ty: &'a TypePath,
    generics: &'a Punctuated<GenericParam, Comma>,
    where_clause: Option<&'a WhereClause>,
    impl_fn: &'a ImplItemFn,
    builder_ident: PatIdent,
    builder_ty: &'a Type,
    builder_stmts: &'a [Stmt],
    arg_ident: PatIdent,
    arg_ty: &'a Type,
}

impl<'a> BuilderImpl<'a> {
    fn try_from_item(input: &'a ItemImpl) -> Result<BuilderImpl<'a>, Error> {
        // Collect type path from impl.
        let Type::Path(ref service_ty) = *input.self_ty else {
            return Err(Error::new(input.self_ty.span(), "expect Struct or Enum"));
        };

        // collect generics.
        let generics = &input.generics.params;
        let where_clause = input.generics.where_clause.as_ref();

        // find methods from impl.
        let impl_fn = find_async_method(&input.items, "new_service")
            .ok_or_else(|| Error::new(input.span(), "can't find 'async fn new_service'"))??;

        // collect builder info
        let builder_stmts = impl_fn.block.stmts.as_slice();

        let mut inputs = impl_fn.sig.inputs.iter();

        let (builder_ident, builder_ty) = match inputs.next().ok_or_else(|| {
            Error::new(
                impl_fn.sig.inputs.span(),
                "expect Builder type as the first 'new_service' function argument",
            )
        })? {
            FnArg::Receiver(recv) => {
                return Err(Error::new(
                    recv.span(),
                    "new_service method does not accept Self as receiver",
                ));
            }
            FnArg::Typed(ty) => match (ty.pat.as_ref(), ty.ty.as_ref()) {
                (Pat::Wild(_), Type::Reference(ty_ref)) if ty_ref.mutability.is_none() => {
                    (default_pat_ident("_factory"), &ty_ref.elem)
                }
                (Pat::Ident(ident), Type::Reference(ty_ref)) if ty_ref.mutability.is_none() => {
                    (ident.to_owned(), &ty_ref.elem)
                }
                _ => {
                    return Err(Error::new(
                        ty.span(),
                        "new_service must receive ServiceFactory type as immutable reference",
                    ));
                }
            },
        };

        let (call_ident, call_ty) = match inputs.next().ok_or_else(|| {
            Error::new(
                impl_fn.sig.inputs.span(),
                "expect generic Arg type as the second 'new_service' function argument",
            )
        })? {
            FnArg::Receiver(recv) => {
                return Err(Error::new(
                    recv.span(),
                    "new_service method does not accept Self as receiver",
                ));
            }
            FnArg::Typed(ty) => match ty.pat.as_ref() {
                Pat::Wild(_) => (default_pat_ident("_service"), &*ty.ty),
                Pat::Ident(ident) => (ident.to_owned(), &*ty.ty),
                _ => {
                    return Err(Error::new(
                        ty.span(),
                        "new_service method must use 'arg: Arg' as second function argument",
                    ));
                }
            },
        };

        Ok(Self {
            service_ty,
            generics,
            where_clause,
            impl_fn,
            builder_ident,
            builder_ty,
            builder_stmts,
            arg_ident: call_ident,
            arg_ty: call_ty,
        })
    }
}

struct CallImpl<'a> {
    req_ident: PatIdent,
    req_ty: &'a Type,
    res_ty: &'a Type,
    err_ty: &'a Type,
    call_stmts: &'a [Stmt],
}

impl<'a> CallImpl<'a> {
    fn try_from_item(item: &'a ItemImpl) -> Result<Self, Error> {
        // collect Request, Response and Error type.
        let call_impl = find_async_method(&item.items, "call")
            .ok_or_else(|| Error::new(item.span(), "can't find 'async fn call'"))??;

        let mut inputs = call_impl.sig.inputs.iter();
        // ignore receiver and move on.
        // TODO: Check the first fn arg and make sure it's a Receiver of &Self.
        let _ = inputs.next().ok_or_else(|| {
            Error::new(
                call_impl.sig.inputs.span(),
                "expect &Self as the first 'call' function argument",
            )
        })?;

        let (req_ident, req_ty) = match inputs.next().ok_or_else(|| {
            Error::new(
                call_impl.sig.inputs.span(),
                "expect generic Req type as the second 'call' function argument",
            )
        })? {
            FnArg::Receiver(recv) => {
                return Err(Error::new(recv.span(), "call method does not accept Self as receiver"));
            }
            FnArg::Typed(ty) => match ty.pat.as_ref() {
                Pat::Wild(_) => (default_pat_ident("_req"), &*ty.ty),
                Pat::Ident(ident) => (ident.to_owned(), &*ty.ty),
                _ => {
                    return Err(Error::new(
                        ty.span(),
                        "call method must use 'req: Req' as second function argument",
                    ));
                }
            },
        };
        let (res_ty, err_ty) = res_ty(&call_impl.sig.output)?;
        let call_stmts = &call_impl.block.stmts;

        Ok(Self {
            req_ident,
            req_ty,
            res_ty,
            err_ty,
            call_stmts,
        })
    }

    fn into_token_stream(self, builder_impl: &BuilderImpl<'_>) -> TokenStream2 {
        let Self {
            req_ident,
            req_ty,
            res_ty,
            err_ty,
            call_stmts,
        } = self;

        let service_ty = builder_impl.service_ty;
        let generics = builder_impl.generics;
        let where_clause = builder_impl.where_clause;

        quote! {
            impl<#generics> ::xitca_service::Service<#req_ty> for #service_ty
            #where_clause
            {
                type Response = #res_ty;
                type Error = #err_ty;

                #[inline]
                async fn call(&self, #req_ident: #req_ty) -> Result<Self::Response, Self::Error> {
                    #(#call_stmts)*
                }
            }
        }
    }
}

struct ReadyImpl<'a> {
    ready_stmts: &'a [Stmt],
    ready_ret_ty: &'a Type,
}

impl<'a> ReadyImpl<'a> {
    fn try_from_item(item: &'a ItemImpl) -> Result<Option<Self>, Error> {
        let items = &item.items;
        let ready = find_async_method(items, "ready").transpose()?;
        match ready {
            Some(ready_impl) => {
                let ready_ret_ty = ready_ret_ty(&ready_impl.sig.output)?;
                let ready_stmts = &ready_impl.block.stmts;
                Ok(Some(Self {
                    ready_stmts,
                    ready_ret_ty,
                }))
            }
            None => Ok(None),
        }
    }
}

// Extract Result<T, E> types from a return type of function.
fn res_ty(ret: &ReturnType) -> Result<(&Type, &Type), Error> {
    if let ReturnType::Type(_, ty) = ret {
        if let Type::Path(path) = ty.as_ref() {
            if let Some(sig) = path.path.segments.first() {
                if sig.ident == "Result" {
                    if let PathArguments::AngleBracketed(ref arg) = sig.arguments {
                        if let (Some(GenericArgument::Type(ok_ty)), Some(GenericArgument::Type(err_ty))) =
                            (arg.args.first(), arg.args.last())
                        {
                            return Ok((ok_ty, err_ty));
                        }
                    }
                }
            }
        }
    }

    Err(Error::new(ret.span(), "expect Result<Self, <Error>> as return type"))
}

// Extract types from a return type of function.
fn ready_ret_ty(ret: &ReturnType) -> Result<&Type, Error> {
    match ret {
        ReturnType::Type(_, ty) => Ok(ty),
        _ => Err(Error::new(ret.span(), "expect ReadyService::Ready as return type")),
    }
}

// generate a default PatIdent
fn default_pat_ident(ident: &str) -> PatIdent {
    PatIdent {
        attrs: Vec::with_capacity(0),
        by_ref: None,
        mutability: None,
        ident: Ident::new(ident, Span::call_site()),
        subpat: None,
    }
}

fn find_new_service_rt_err_ty(func: &ImplItemFn) -> Result<&Type, Error> {
    if let ReturnType::Type(_, ref new_service_rt_ty) = func.sig.output {
        if let Type::Path(ref path) = **new_service_rt_ty {
            if let Some(path) = path.path.segments.first() {
                if path.ident == "Result" {
                    if let PathArguments::AngleBracketed(ref bracket) = path.arguments {
                        if let Some(GenericArgument::Type(ty)) = bracket.args.last() {
                            return Ok(ty);
                        }
                    };
                }
            }
        };
    }

    Err(Error::new(func.sig.output.span(), "expect Result<_, _> as return type"))
}