sark-gen 0.13.0

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
use proc_macro2::TokenStream;
use quote::{format_ident, quote};
use syn::visit_mut::VisitMut;
use syn::{Error, FnArg, ItemFn, Result};

use crate::{codegen::route_spec, lifetimes::TypeLifetimes, model::HeadSkip, util::TypeExt};

pub(super) struct Handler {
    fun: ItemFn,
    generated_request: TokenStream,
}

struct HandlerConfig {
    static_response: bool,
    max_body: Option<syn::Expr>,
    head_skip: HeadSkip,
}

/// Lifts early returns from the user handler into the generated parse-error
/// result without changing returns owned by nested control-flow scopes.
struct LiftHandlerReturns;

impl VisitMut for LiftHandlerReturns {
    fn visit_expr_return_mut(&mut self, expression: &mut syn::ExprReturn) {
        let value = expression
            .expr
            .take()
            .unwrap_or_else(|| Box::new(syn::parse_quote!(())));
        expression.expr = Some(Box::new(syn::parse_quote!(
            ::core::result::Result::Ok(#value)
        )));
    }

    fn visit_expr_async_mut(&mut self, _: &mut syn::ExprAsync) {}

    fn visit_expr_closure_mut(&mut self, _: &mut syn::ExprClosure) {}

    fn visit_item_mut(&mut self, _: &mut syn::Item) {}
}

impl Handler {
    pub(super) fn new(mut fun: ItemFn) -> Result<Self> {
        use syn::Safety;
        fun.modifiers.require_empty()?;
        if let Safety::Unsafe(unsafe_token) = &fun.sig.safety {
            return Err(Error::new_spanned(
                unsafe_token,
                "#[sark_gen::handler] does not support unsafe functions",
            ));
        }

        let generated_request = if fun.sig.inputs.len() == 1 {
            use crate::request::Mode;
            let request_ident =
                format_ident!("__Sark{}Request", upper_camel(&fun.sig.ident.to_string()));
            let request = Mode::empty().expand(syn::parse_quote! {
                struct #request_ident {}
            })?;
            fun.sig
                .inputs
                .insert(0, syn::parse_quote!(_request: #request_ident));
            request
        } else {
            TokenStream::new()
        };

        Ok(Self {
            fun,
            generated_request,
        })
    }

    pub(super) fn expand(mut self) -> Result<TokenStream> {
        use syn::{ReturnType, Type};
        let HandlerConfig {
            static_response,
            max_body,
            head_skip,
        } = self.take_config()?;
        let generated_request = self.generated_request;
        let mut fun = self.fun;

        let name = fun.sig.ident.clone();
        let vis = fun.vis.clone();
        let hidden_fn = format_ident!("__{}_fn", name);
        let output_ty = match &fun.sig.output {
            ReturnType::Type(_, ty) => (**ty).clone(),
            ReturnType::Default => syn::parse_quote!(()),
        };
        fun.sig.ident = hidden_fn.clone();

        let is_async = fun.sig.asyncness.is_some();
        let wants_timer = fun.sig.inputs.len() == 3;

        if is_async && TypeLifetimes::new(&output_ty).has_non_static() {
            return Err(Error::new_spanned(
                &output_ty,
                "async handler responses must own request-derived data",
            ));
        }
        if fun.sig.inputs.len() != 2 && !(is_async && wants_timer) {
            return Err(Error::new_spanned(
                &fun.sig.inputs,
                "#[sark_gen::handler] requires `(state)`, `(request, state)`, or async `(request, state, timer)`",
            ));
        }
        if wants_timer && !is_async {
            return Err(Error::new_spanned(
                &fun.sig.inputs,
                "#[sark_gen::handler] 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(Error::new_spanned(
                    other,
                    "#[sark_gen::handler] request argument must be typed",
                ));
            }
        };
        let request_pattern = match fun.sig.inputs.first() {
            Some(FnArg::Typed(pat)) => pat.pat.clone(),
            other => {
                return Err(Error::new_spanned(
                    other,
                    "#[sark_gen::handler] 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(Error::new_spanned(
                    other,
                    "#[sark_gen::handler] state argument must be typed",
                ));
            }
        };
        let state_arg_inner = match &state_arg_ty {
            Type::Reference(reference) => (*reference.elem).clone(),
            other => {
                return Err(Error::new_spanned(
                    other,
                    "#[sark_gen::handler] state argument must be a reference (`&T`)",
                ));
            }
        };

        let request_ty = request_arg_ty;
        let state_ty = state_arg_inner;

        let request_ident = request_ty.type_ident()?;
        let request_inner_ident = format_ident!("{}View", request_ident);
        let request_raw_headers_ident = format_ident!("{}HeadersRaw", request_ident);
        let request_raw_params_ident = format_ident!("{}ParamsRaw", request_ident);
        let request_params_inner_ident = format_ident!("{}Params", request_ident);
        let request_headers_inner_ident = format_ident!("{}Headers", request_ident);
        let request_header_slot_ident = format_ident!("{}HeaderSlot", request_ident);
        let header_slot_ty = quote!(#request_header_slot_ident);

        let state_lifetimes = TypeLifetimes::new(&state_ty);
        let state_has_lifetime = state_lifetimes.any();
        let state_ty_state = state_lifetimes.normalized_to("state");
        let state_ty_d = state_lifetimes.normalized_to("d");
        let state_lt_use = state_has_lifetime.then(|| quote!(<'state>));
        let state_outlives = state_has_lifetime.then(|| quote!('state: 'a,));
        let hidden_state_ty = if is_async {
            &state_ty_d
        } else {
            &state_ty_state
        };

        if !fun.sig.generics.params.iter().any(
            |param| matches!(param, syn::GenericParam::Lifetime(lt) if lt.lifetime.ident == "req"),
        ) {
            fun.sig.generics.params.insert(0, syn::parse_quote!('req));
        }
        if is_async
        && !fun.sig.generics.params.iter().any(
            |param| matches!(param, syn::GenericParam::Lifetime(lt) if lt.lifetime.ident == "d"),
        )
    {
        fun.sig.generics.params.insert(0, syn::parse_quote!('d));
    }
        if state_has_lifetime && !is_async {
            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 = if is_async {
                syn::parse_quote!(&'req #hidden_state_ty)
            } else {
                syn::parse_quote!(&#hidden_state_ty)
            };
        }
        if wants_timer && let Some(FnArg::Typed(pat)) = fun.sig.inputs.iter_mut().nth(2) {
            *pat.ty = syn::parse_quote!(&'req ::sark::Timer<'d>);
        }
        if is_async {
            let mut original_body = fun.block;
            LiftHandlerReturns.visit_block_mut(&mut original_body);
            let storage = format_ident!("__sark_storage");
            let raw_params = format_ident!("__sark_raw_params");
            let raw_headers = format_ident!("__sark_raw_headers");
            let target = format_ident!("__sark_target");
            let head = format_ident!("__sark_head");
            let body = format_ident!("__sark_body");
            let request = format_ident!("__sark_request");
            let params = format_ident!("__sark_params");
            let headers = format_ident!("__sark_headers");
            let parsed_body = format_ident!("__sark_parsed_body");

            if let Some(first) = fun.sig.inputs.first_mut() {
                *first = syn::parse_quote!(#storage: ::sark::request::RequestStorage);
            }
            fun.sig.inputs.insert(
                1,
                syn::parse_quote!(
                    #raw_params: <#name as ::sark::service::RouteSpec>::RawParams
                ),
            );
            fun.sig.inputs.insert(
                2,
                syn::parse_quote!(
                    #raw_headers: <#name as ::sark::service::RouteSpec>::RawHeaders
                ),
            );
            fun.sig
                .inputs
                .insert(3, syn::parse_quote!(#target: ::core::ops::Range<usize>));
            fun.sig.output = syn::parse_quote!(
                -> ::core::result::Result<#output_ty, &'static [u8]>
            );
            fun.block = Box::new(syn::parse_quote!({
                let (#head, #body) = #storage.as_parts();
                let #request = ::sark::request::Ref::from_slice(#target, #head, #body);
                let #params = <<#name as ::sark::service::RouteSpec>::Request
                    as ::sark::service::RouteRequestImpl>::build_params(
                    &#request,
                    #raw_params,
                )
                .ok_or(::sark::CANNED_400)?;
                let #headers = <<#name as ::sark::service::RouteSpec>::Request
                    as ::sark::service::RouteRequestImpl>::build_headers(
                    &#request,
                    #raw_headers,
                )
                .map_err(|_| ::sark::CANNED_400)?;
                let #parsed_body = <#name as ::sark::service::RouteSpec>::parse_body(#body)
                    .map_err(|_| ::sark::CANNED_400)?;
                let #request_pattern = #request_inner_ident::from_parts(
                    #params,
                    #headers,
                    #parsed_body,
                    &#request,
                );
                ::core::result::Result::Ok(#original_body)
            }));
            let where_clause = fun.sig.generics.make_where_clause();
            where_clause
                .predicates
                .push(syn::parse_quote!(#hidden_state_ty: 'req));
            where_clause.predicates.push(syn::parse_quote!('d: 'req));
            fun.attrs.push(syn::parse_quote!(#[::sark::fiber_fn('d)]));
        } else if let Some(FnArg::Typed(pat)) = fun.sig.inputs.first_mut() {
            *pat.ty = syn::parse_quote!(#request_inner_ident<'req>);
        }

        let parsed_body_ty = quote! {
            <#request_ident as sark::service::RouteRequestImpl>::ParsedBody<'__req>
        };
        let parse_body = quote! {
            <#request_ident as sark::service::RouteRequestImpl>::parse_body(raw)
        };

        let output_lifetimes = TypeLifetimes::new(&output_ty);
        let output_ty_req = output_lifetimes.normalized_to("__req");
        let output_ty_static = output_lifetimes.normalized_to("static");
        let kind_ty = if is_async {
            quote!(sark::service::manifold::NativeFiber)
        } else {
            quote! {
                <#output_ty_static as sark::service::manifold::NativeResponse<'static>>::Kind
            }
        };
        let native_response_ty = (!is_async).then_some(&output_ty_req);
        let native_response_ty_static = (!is_async).then_some(&output_ty_static);

        let route_spec_impl = route_spec::Config {
            name: &name,
            request_ident: &request_ident,
            raw_params_ident: &request_raw_params_ident,
            raw_headers_ident: &request_raw_headers_ident,
            params_inner_ident: &request_params_inner_ident,
            headers_inner_ident: &request_headers_inner_ident,
            header_slot_ty: &header_slot_ty,
            static_response,
            is_async,
            kind_ty: &kind_ty,
            native_response_ty,
            native_response_ty_static,
            async_response_ty: is_async.then_some(&output_ty),
            parsed_body_ty: Some(&parsed_body_ty),
            parse_body_body: Some(&parse_body),
            max_body: max_body.as_ref(),
            head_skip,
        }
        .build();

        let native_impl = if is_async {
            TokenStream::new()
        } else {
            quote! {
                impl #state_lt_use ::sark::service::manifold::Route<#state_ty_state> for #name {
                    fn invoke<'req, 'a>(
                        params: <Self as ::sark::service::RouteSpec>::Params<'req>,
                        req: &::sark::request::Ref<'req>,
                        headers: <Self as ::sark::service::RouteSpec>::Headers<'req>,
                        parsed_body: <Self as ::sark::service::RouteSpec>::ParsedBody<'req>,
                        state: &'a #state_ty_state,
                    ) -> <Self as ::sark::service::RouteSpec>::Response<'req>
                    where
                        'req: 'a,
                        #state_outlives
                    {
                        let request = #request_inner_ident::<'req>::from_parts(
                            params,
                            headers,
                            parsed_body,
                            req,
                        );
                        let response = #hidden_fn(request, state);
                        ::sark::service::manifold::NativeResponse::into_route_response(response)
                    }
                }
            }
        };

        let timer_call = wants_timer.then(|| quote!(, timer));
        let task_impl = if is_async {
            quote! {
                impl<'d> ::sark::service::manifold::TaskRoute<'d, #state_ty_d> for #name {
                    fn invoke_task<'req>(
                        storage: ::sark::request::RequestStorage,
                        raw_params: <Self as ::sark::service::RouteSpec>::RawParams,
                        raw_headers: <Self as ::sark::service::RouteSpec>::RawHeaders,
                        target: ::core::ops::Range<usize>,
                        state: &'req #state_ty_d,
                        timer: &'req ::sark::Timer<'d>,
                    ) -> impl ::sark::fiber::Fiber<
                        'd,
                        Output = ::core::result::Result<#output_ty, &'static [u8]>,
                    > + 'req
                    where
                        #state_ty_d: 'req,
                        'd: 'req,
                    {
                        #hidden_fn(storage, raw_params, raw_headers, target, state #timer_call)
                    }
                }
            }
        } else {
            TokenStream::new()
        };

        Ok(quote! {
        #generated_request

        #[allow(unreachable_code)]
        #fun

        #[allow(non_camel_case_types)]
        #vis struct #name;

        #route_spec_impl
        #native_impl
        #task_impl
        })
    }

    fn take_config(&mut self) -> Result<HandlerConfig> {
        let mut static_response = false;
        let mut max_body: Option<syn::Expr> = None;
        let mut head_skip = HeadSkip::default();
        let mut kept = Vec::with_capacity(self.fun.attrs.len());
        for attr in self.fun.attrs.drain(..) {
            if attr.path().is_ident("static_response") {
                static_response = true;
            } else if attr.path().is_ident("max_body") {
                if max_body.is_some() {
                    return Err(Error::new_spanned(attr, "duplicate #[max_body(...)]"));
                }
                max_body = Some(attr.parse_args::<syn::Expr>()?);
            } else if attr.path().is_ident("skip") {
                attr.parse_nested_meta(|meta| {
                    if meta.path.is_ident("date") {
                        head_skip.date = true;
                    } else if meta.path.is_ident("server") {
                        head_skip.server = true;
                    } else {
                        return Err(
                            meta.error("unknown #[skip(...)] target; expected `date` | `server`")
                        );
                    }
                    Ok(())
                })?;
            } else {
                kept.push(attr);
            }
        }
        self.fun.attrs = kept;
        Ok(HandlerConfig {
            static_response,
            max_body,
            head_skip,
        })
    }
}

fn upper_camel(value: &str) -> String {
    let mut output = String::with_capacity(value.len());
    for part in value.split('_').filter(|part| !part.is_empty()) {
        let mut chars = part.chars();
        if let Some(first) = chars.next() {
            output.extend(first.to_uppercase());
            output.extend(chars);
        }
    }
    output
}