sark-gen 0.4.2

Sark proc-macro generators
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
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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
use proc_macro2::TokenStream;
use quote::{format_ident, quote};
use syn::{FnArg, ItemFn, ItemStruct, Result};

use crate::codegen::route_spec;
use crate::codegen::runtime::Runtime;
use crate::model::{RequestKind, ResponseKind};
use crate::parse::{
    infer_request_body_kind, infer_response_body_kind, parse_struct_route_cfg, take_route_cfg_attrs,
};
use crate::util::TypeExt;

pub(super) fn attr_fn(mut fun: ItemFn) -> Result<TokenStream> {
    let name = fun.sig.ident.clone();
    let vis = fun.vis.clone();
    let hidden_fn = format_ident!("__{}_fn", name);
    let output = fun.sig.output.clone();
    let output_ty = match &output {
        syn::ReturnType::Type(_, ty) => Some((**ty).clone()),
        syn::ReturnType::Default => None,
    };
    fun.sig.ident = hidden_fn.clone();
    let (
        state_ty_attr,
        body_ty,
        raw_body,
        request_ty_attr,
        static_response,
        response_body_kind_attr,
        request_body_kind_attr,
        max_body_attr,
    ) = take_route_cfg_attrs(&mut fun.attrs)?;
    let response_body_kind =
        response_body_kind_attr.unwrap_or_else(|| infer_response_body_kind(&output));
    let request_body_kind =
        request_body_kind_attr.unwrap_or_else(|| infer_request_body_kind(&fun.sig.inputs));
    let is_async = fun.sig.asyncness.is_some();
    let wants_timer = fun.sig.inputs.len() == 3;
    if fun.sig.inputs.len() != 2 && !(is_async && wants_timer) {
        return Err(syn::Error::new_spanned(
            &fun.sig.inputs,
            "function #[route(...)] requires signature `(request, state)` \
             or, for `async` handlers, `(request, state, timer)`",
        ));
    }
    if wants_timer && !is_async {
        return Err(syn::Error::new_spanned(
            &fun.sig.inputs,
            "function #[route(...)] timer argument is only valid on `async` handlers",
        ));
    }
    let request_arg_ty = match fun.sig.inputs.first() {
        Some(FnArg::Typed(pat)) => (*pat.ty).clone(),
        other => {
            return Err(syn::Error::new_spanned(
                other,
                "function #[route(...)] request argument must be typed",
            ));
        }
    };
    let state_arg_ty = match fun.sig.inputs.iter().nth(1) {
        Some(FnArg::Typed(pat)) => (*pat.ty).clone(),
        other => {
            return Err(syn::Error::new_spanned(
                other,
                "function #[route(...)] state argument must be typed",
            ));
        }
    };
    let state_arg_inner = match &state_arg_ty {
        syn::Type::Reference(r) => (*r.elem).clone(),
        other => {
            return Err(syn::Error::new_spanned(
                other,
                "function #[route(...)] state argument must be a reference (`&T`)",
            ));
        }
    };
    let request_ty = match request_ty_attr {
        Some(ty) => {
            if quote::quote!(#request_arg_ty).to_string() != quote::quote!(#ty).to_string() {
                return Err(syn::Error::new_spanned(
                    &request_arg_ty,
                    "function request argument type must match #[request(Type)]",
                ));
            }
            ty
        }
        None => request_arg_ty.clone(),
    };
    let state_ty = match state_ty_attr {
        Some(ty) => {
            if quote::quote!(#state_arg_inner).to_string() != quote::quote!(#ty).to_string() {
                return Err(syn::Error::new_spanned(
                    &state_arg_ty,
                    "function state argument type must match #[state(Type)]",
                ));
            }
            ty
        }
        None => state_arg_inner,
    };

    let state_has_lifetime = StateLifetimes::any(&state_ty);
    let state_ty = StateLifetimes::normalize(state_ty);
    let state_lt_def: TokenStream = if state_has_lifetime {
        quote! { 'state, }
    } else {
        TokenStream::new()
    };
    let state_lt_use: TokenStream = if state_has_lifetime {
        quote! { <'state> }
    } else {
        TokenStream::new()
    };

    let user_opted_borrowed = {
        let output_str = quote::quote!(#output).to_string();
        output_str.contains("'req")
    };
    {
        let request_ident = request_ty.type_ident()?;
        let request_inner = format_ident!("{}Inner", request_ident);
        if !fun
            .sig
            .generics
            .params
            .iter()
            .any(|p| matches!(p, syn::GenericParam::Lifetime(lt) if lt.lifetime.ident == "req"))
        {
            fun.sig.generics.params.insert(0, syn::parse_quote!('req));
        }
        if let Some(FnArg::Typed(pat)) = fun.sig.inputs.first_mut() {
            *pat.ty = syn::parse_quote!(#request_inner<'req>);
        }
        if state_has_lifetime {
            fun.sig.generics.params.insert(0, syn::parse_quote!('state));
            if let Some(FnArg::Typed(pat)) = fun.sig.inputs.iter_mut().nth(1) {
                *pat.ty = syn::parse_quote!(&'state #state_ty);
            }
        }
        if wants_timer && let Some(FnArg::Typed(pat)) = fun.sig.inputs.iter_mut().nth(2) {
            *pat.ty = syn::parse_quote!(::sark::Timer<'_>);
        }
    }

    let mut attrs: Vec<syn::Attribute> = Vec::new();
    attrs.push(syn::parse_quote!(#[allow(non_camel_case_types)]));
    attrs.push(syn::parse_quote!(#[state(#state_ty)]));
    if let Some(body_ty) = &body_ty {
        attrs.push(syn::parse_quote!(#[body(#body_ty)]));
    }
    if raw_body {
        attrs.push(syn::parse_quote!(#[raw_body]));
    }
    if static_response {
        attrs.push(syn::parse_quote!(#[static_response]));
    }
    match response_body_kind {
        ResponseKind::Inline => {}
        ResponseKind::Static => {
            attrs.push(syn::parse_quote!(#[response_body(Static)]));
        }
        ResponseKind::Stream => {
            attrs.push(syn::parse_quote!(#[response_body(Stream)]));
        }
    }
    match request_body_kind {
        RequestKind::Inline => {}
        RequestKind::Spilled => {
            attrs.push(syn::parse_quote!(#[request_body(Spilled)]));
        }
    }
    attrs.push(syn::parse_quote!(#[request(#request_ty)]));
    if let Some(expr) = &max_body_attr {
        attrs.push(syn::parse_quote!(#[max_body(#expr)]));
    }
    let st: ItemStruct = syn::parse_quote! {
        #(#attrs)*
        #vis struct #name {}
    };
    let stream_response_ty = if matches!(response_body_kind, ResponseKind::Stream) {
        output_ty.as_ref().map(|ty| quote!(#ty))
    } else {
        None
    };
    let route_tokens = attr(
        st,
        fun.sig.asyncness.is_some(),
        user_opted_borrowed,
        stream_response_ty.as_ref(),
    )?;
    let timer_param = if wants_timer {
        quote! { timer: ::sark::Timer<'a>, }
    } else {
        TokenStream::new()
    };
    let timer_call_arg = if wants_timer {
        quote! { , timer }
    } else {
        TokenStream::new()
    };
    let handle_impl = {
        let request_inner = {
            let ident = request_ty.type_ident()?;
            format_ident!("{}Inner", ident)
        };
        if fun.sig.asyncness.is_some() {
            quote! {
                #[allow(unreachable_code)]
                impl #name {
                    async fn handle<#state_lt_def 'a, 'req>(
                        &self,
                        request: #request_inner<'req>,
                        state: &'a #state_ty,
                        #timer_param
                    ) #output {
                        #hidden_fn(request, state #timer_call_arg).await
                    }
                }
            }
        } else {
            quote! {
                #[allow(unreachable_code)]
                impl #name {
                    fn handle<#state_lt_def 'req>(
                        &self,
                        request: #request_inner<'req>,
                        state: &#state_ty,
                    ) #output {
                        #hidden_fn(request, state)
                    }
                }
            }
        }
    };
    let request_inner_ident = {
        let ident = request_ty.type_ident()?;
        format_ident!("{}Inner", ident)
    };
    let hidden_fn_ref = format_ident!("__{}_fn_ref", name);
    let response_body_static = matches!(response_body_kind, ResponseKind::Static);
    let response_body_stream = matches!(response_body_kind, ResponseKind::Stream);
    let stream_output_ty = output_ty
        .as_ref()
        .map(|ty| quote!(#ty))
        .unwrap_or_else(|| quote!(::sark::sark_core::http::Stream));
    let shim_output_ty = if response_body_stream {
        stream_output_ty.clone()
    } else if user_opted_borrowed && !response_body_static {
        quote!(::sark::sark_core::http::FixedResponseInner<'req>)
    } else {
        quote!(::sark::sark_core::http::ServeInner<'req>)
    };
    let shim_body = {
        let call = if fun.sig.asyncness.is_some() {
            quote! { #hidden_fn(request, state #timer_call_arg).await }
        } else {
            quote! { #hidden_fn(request, state) }
        };
        if response_body_stream {
            quote! {
                async move {
                    let __resp: #stream_output_ty = #call;
                    __resp
                }
            }
        } else if response_body_static {
            quote! {
                async move {
                    let __resp = #call;
                    ::sark::sark_core::http::IntoServeResponseStatic::into_serve_response_static(__resp)
                }
            }
        } else if user_opted_borrowed {
            quote! {
                async move {
                    let __resp = #call;
                    ::core::convert::Into::into(__resp)
                }
            }
        } else {
            quote! {
                async move {
                    let __resp = #call;
                    ::sark::sark_core::http::IntoServeResponse::into_serve_response(__resp)
                }
            }
        }
    };
    let sync_shim = if fun.sig.asyncness.is_none() {
        let hidden_fn_sync = format_ident!("{}_sync", hidden_fn_ref);
        let sync_body = if response_body_stream {
            quote! {
                let __resp: #stream_output_ty =
                    #hidden_fn(request, state);
                __resp
            }
        } else if response_body_static {
            quote! {
                let __resp = #hidden_fn(request, state);
                ::sark::sark_core::http::IntoServeResponseStatic::into_serve_response_static(__resp)
            }
        } else if user_opted_borrowed {
            quote! {
                let __resp = #hidden_fn(request, state);
                ::core::convert::Into::into(__resp)
            }
        } else {
            quote! {
                let __resp = #hidden_fn(request, state);
                ::sark::sark_core::http::IntoServeResponse::into_serve_response(__resp)
            }
        };
        quote! {
            #[allow(
                dead_code,
                non_snake_case,
                unused_variables,
                unreachable_code,
                clippy::diverging_sub_expression
            )]
            fn #hidden_fn_sync<#state_lt_def 'a, 'req>(
                request: #request_inner_ident<'req>,
                state: &'a #state_ty,
            ) -> #shim_output_ty
            where
                #state_ty: 'a,
                'req: 'a,
            {
                #sync_body
            }
        }
    } else {
        TokenStream::new()
    };
    let shim = quote! {
        #[allow(
            dead_code,
            non_snake_case,
            unused_variables,
            unreachable_code,
            clippy::manual_async_fn,
            clippy::diverging_sub_expression
        )]
        fn #hidden_fn_ref<#state_lt_def 'a, 'req>(
            request: #request_inner_ident<'req>,
            state: &'a #state_ty,
            #timer_param
        ) -> impl ::core::future::Future<
            Output = #shim_output_ty,
        > + 'a
        where
            #state_ty: 'a,
            'req: 'a,
        {
            #shim_body
        }
        #sync_shim
    };
    let fiber_impl = if fun.sig.asyncness.is_some() {
        let from_parts_call = if body_ty.is_some() {
            quote! {
                #request_inner_ident::<'static>::from_parts(params, headers, parsed_body, raw_body)
            }
        } else {
            quote! {
                #request_inner_ident::<'static>::from_parts(params, headers, raw_body)
            }
        };
        let hidden_fn_ref_turbofish = if state_has_lifetime {
            quote! { #hidden_fn_ref::<'state, 'd, 'static> }
        } else {
            quote! { #hidden_fn_ref::<'d, 'static> }
        };
        let state_outlives_d: TokenStream = if state_has_lifetime {
            quote! { 'state: 'd, }
        } else {
            TokenStream::new()
        };
        quote! {
            impl #state_lt_use ::sark::fiber::Route<#state_ty> for #name {
                fn invoke<'d>(
                    self: &'d Self,
                    params: <Self as ::sark::service::RouteSpec>::Params<'static>,
                    req: ::sark::Request,
                    headers: <Self as ::sark::service::RouteSpec>::Headers<'static>,
                    parsed_body: <Self as ::sark::service::RouteSpec>::ParsedBody<'static>,
                    state: &'d #state_ty,
                    timer: ::sark::Timer<'d>,
                ) -> ::sark::fiber::Fiber<'d, impl ::core::future::Future<
                    Output = <Self as ::sark::service::RouteSpec>::Response<'static>,
                > + 'd>
                where
                    #state_ty: 'd,
                    #state_outlives_d
                {
                    let _ = self;
                    let _ = timer;
                    let raw_body = req.into_body();
                    let request = #from_parts_call;
                    ::sark::fiber::Fiber::new(
                        #hidden_fn_ref_turbofish(request, state #timer_call_arg)
                    )
                }
            }
        }
    } else {
        TokenStream::new()
    };
    Ok(quote! {
        #[allow(unreachable_code)]
        #fun
        #route_tokens
        #handle_impl
        #shim
        #fiber_impl
    })
}

fn attr(
    st: ItemStruct,
    handler_async: bool,
    user_opted_borrowed: bool,
    stream_response_ty: Option<&TokenStream>,
) -> Result<TokenStream> {
    let is_fixed_response = user_opted_borrowed;
    let mut st = st;
    let (
        _headers,
        _queries,
        _paths,
        state_ty,
        body_ty,
        raw_body,
        request_ty,
        static_response,
        response_body_kind,
        request_body_kind,
        max_body,
    ) = parse_struct_route_cfg(&mut st)?;
    let name = st.ident.clone();
    let request_ty = request_ty.ok_or_else(|| {
        syn::Error::new_spanned(
            &name,
            "#[sark_gen::handler] internal: missing synthesized #[request]",
        )
    })?;
    let request_ident = request_ty.type_ident()?;

    let request_headers_ident = format_ident!("{}Headers", request_ident);
    let request_raw_headers_ident = format_ident!("{}HeadersRaw", request_ident);
    let request_params_ident = format_ident!("{}Params", request_ident);
    let request_raw_params_ident = format_ident!("{}ParamsRaw", request_ident);
    let request_params_inner_ident = format_ident!("{}ParamsInner", request_ident);
    let request_headers_inner_ident = format_ident!("{}HeadersInner", request_ident);
    let request_header_slot_ident = format_ident!("{}HeaderSlot", request_ident);
    let header_slot_ty = quote!(#request_header_slot_ident);

    let response_ty_override = if matches!(response_body_kind, ResponseKind::Static) {
        None
    } else if matches!(response_body_kind, ResponseKind::Stream) {
        Some(
            stream_response_ty
                .cloned()
                .unwrap_or_else(|| quote!(sark_core::http::Stream)),
        )
    } else if is_fixed_response {
        Some(quote!(sark_core::http::FixedResponseInner<'__req>))
    } else {
        None
    };
    let (parsed_body_ty_tokens, parse_body_body_tokens): (
        Option<TokenStream>,
        Option<TokenStream>,
    ) = if let Some(body_ty) = &body_ty {
        let parse_body_impl = if raw_body {
            quote! {
                <#body_ty as sark::json::JsonScan>::scan_json(
                    ::core::iter::once(raw),
                )
            }
        } else {
            quote! {
                <#body_ty as sark::json::JsonDecode>::decode_json_borrowed(raw)
            }
        };
        (Some(quote!(#body_ty)), Some(parse_body_impl))
    } else {
        (None, None)
    };
    let route_spec_impl = route_spec::Cfg {
        name: &name,
        request_ident: &request_ident,
        params_ident: &request_params_ident,
        raw_params_ident: &request_raw_params_ident,
        headers_ident: &request_headers_ident,
        raw_headers_ident: &request_raw_headers_ident,
        params_has_lifetime: true,
        headers_has_lifetime: true,
        params_inner_ident: Some(&request_params_inner_ident),
        headers_inner_ident: Some(&request_headers_inner_ident),
        header_slot_ty: &header_slot_ty,
        static_response,
        response_body_kind,
        request_body_kind,
        response_ty_override: response_ty_override.as_ref(),
        parsed_body_ty: parsed_body_ty_tokens.as_ref(),
        parse_body_body: parse_body_body_tokens.as_ref(),
        max_body: max_body.as_ref(),
    }
    .build();
    let body_call = if body_ty.is_some() {
        quote!(self.handle(#request_ty::from_parts(params, headers, parsed_body, raw_body), state))
    } else {
        quote!(self.handle(#request_ty::from_parts(params, headers, raw_body), state))
    };
    let map_into = if matches!(response_body_kind, ResponseKind::Static) {
        quote!(sark::http::IntoServeResponseStatic::into_serve_response_static)
    } else if matches!(response_body_kind, ResponseKind::Stream) {
        quote!(::core::convert::identity)
    } else if is_fixed_response {
        quote!(sark::http::FixedResponseInner::from)
    } else {
        quote!(sark::http::IntoServeResponse::into_serve_response)
    };
    let body_try = quote! {
        {
            let raw_body = req.into_body();
            #map_into(#body_call)
        }
    };
    let borrowed_call_request_inner_ident = format_ident!("{}Inner", request_ident);
    let borrowed_call_hidden_fn_ref = format_ident!("__{}_fn_ref", name);
    let is_stream = matches!(response_body_kind, ResponseKind::Stream);
    let runtime_tokens = Runtime::build(
        &name,
        &state_ty,
        &request_params_ident,
        &request_headers_ident,
        Some(&body_try),
        Some((
            &borrowed_call_request_inner_ident,
            &borrowed_call_hidden_fn_ref,
        )),
        !handler_async,
        is_stream,
    );

    Ok(quote! {
        #st

        #route_spec_impl

        #runtime_tokens
    })
}

struct StateLifetimes;

impl StateLifetimes {
    fn any(ty: &syn::Type) -> bool {
        struct Detect(bool);
        impl syn::visit::Visit<'_> for Detect {
            fn visit_lifetime(&mut self, _: &syn::Lifetime) {
                self.0 = true;
            }
        }
        let mut d = Detect(false);
        syn::visit::Visit::visit_type(&mut d, ty);
        d.0
    }

    fn normalize(mut ty: syn::Type) -> syn::Type {
        struct Rewrite;
        impl syn::visit_mut::VisitMut for Rewrite {
            fn visit_lifetime_mut(&mut self, lt: &mut syn::Lifetime) {
                lt.ident = format_ident!("state");
            }
        }
        syn::visit_mut::VisitMut::visit_type_mut(&mut Rewrite, &mut ty);
        ty
    }
}