forge-macros 0.9.0

Procedural macros for the Forge framework
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
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::{FnArg, ItemFn, Pat, ReturnType, Type, parse_macro_input};

use crate::utils::{
    has_attr_flag, parse_attr_value, parse_duration_secs, parse_size_bytes, to_pascal_case,
};

/// Expand the #[forge::mutation] attribute.
///
/// This transforms an async function into a mutation handler that:
/// - Takes a MutationContext as the first parameter
/// - Returns a Result<T>
/// - Runs within a database transaction
/// - Generates a struct implementing ForgeMutation trait
pub fn expand_mutation(attr: TokenStream, item: TokenStream) -> TokenStream {
    let input = parse_macro_input!(item as ItemFn);
    let attrs = parse_mutation_attrs(attr);

    expand_mutation_impl(input, attrs)
        .unwrap_or_else(|e| e.to_compile_error())
        .into()
}

#[derive(Default)]
struct MutationAttrs {
    required_role: Option<String>,
    is_public: bool,
    is_unscoped: bool,
    timeout: Option<u64>,
    rate_limit_requests: Option<u32>,
    rate_limit_per_secs: Option<u64>,
    rate_limit_key: Option<String>,
    log_level: Option<String>,
    transactional: bool,
    max_upload_size_bytes: Option<usize>,
}

fn parse_mutation_attrs(attr: TokenStream) -> MutationAttrs {
    let mut attrs = MutationAttrs::default();

    let attr_str = attr.to_string();

    if has_attr_flag(&attr_str, "transactional") {
        attrs.transactional = true;
    }

    if has_attr_flag(&attr_str, "public") {
        attrs.is_public = true;
    }

    if has_attr_flag(&attr_str, "unscoped") {
        attrs.is_unscoped = true;
    }

    if let Some(role_start) = attr_str.find("require_role")
        && let Some(paren_start) = attr_str[role_start..].find('(')
    {
        let remaining = &attr_str[role_start + paren_start + 1..];
        if let Some(paren_end) = remaining.find(')') {
            let role = remaining[..paren_end].trim().trim_matches('"');
            attrs.required_role = Some(role.to_string());
        }
    }

    if let Some(timeout) = parse_attr_value(&attr_str, "timeout")
        && let Ok(secs) = timeout.parse::<u64>()
    {
        attrs.timeout = Some(secs);
    }

    if let Some(rl_start) = attr_str.find("rate_limit")
        && let Some(paren_start) = attr_str[rl_start..].find('(')
    {
        let remaining = &attr_str[rl_start + paren_start + 1..];
        if let Some(paren_end) = remaining.find(')') {
            let rl_content = &remaining[..paren_end];

            if let Some(req_start) = rl_content.find("requests")
                && let Some(eq_pos) = rl_content[req_start..].find('=')
            {
                let after_eq = &rl_content[req_start + eq_pos + 1..];
                if let Ok(n) = after_eq
                    .split(',')
                    .next()
                    .unwrap_or("")
                    .trim()
                    .parse::<u32>()
                {
                    attrs.rate_limit_requests = Some(n);
                }
            }

            if let Some(per_start) = rl_content.find("per")
                && let Some(quote_start) = rl_content[per_start..].find('"')
            {
                let after_quote = &rl_content[per_start + quote_start + 1..];
                if let Some(quote_end) = after_quote.find('"') {
                    let per_str = &after_quote[..quote_end];
                    attrs.rate_limit_per_secs = parse_duration_secs(per_str);
                }
            }

            if let Some(key_start) = rl_content.find("key")
                && let Some(quote_start) = rl_content[key_start..].find('"')
            {
                let after_quote = &rl_content[key_start + quote_start + 1..];
                if let Some(quote_end) = after_quote.find('"') {
                    let key = &after_quote[..quote_end];
                    attrs.rate_limit_key = Some(key.to_string());
                }
            }
        }
    }

    if let Some(log_start) = attr_str.find("log") {
        // Make sure it's not part of another word
        let before = if log_start > 0 {
            attr_str.chars().nth(log_start - 1)
        } else {
            None
        };
        if (before.is_none() || !before.unwrap().is_alphanumeric())
            && let Some(quote_start) = attr_str[log_start..].find('"')
        {
            let after_quote = &attr_str[log_start + quote_start + 1..];
            if let Some(quote_end) = after_quote.find('"') {
                let level = &after_quote[..quote_end];
                attrs.log_level = Some(level.to_string());
            }
        }
    }

    if let Some(size_str) = parse_attr_value(&attr_str, "max_size") {
        attrs.max_upload_size_bytes = parse_size_bytes(&size_str);
    }

    attrs
}

fn expand_mutation_impl(input: ItemFn, attrs: MutationAttrs) -> syn::Result<TokenStream2> {
    let fn_name = &input.sig.ident;
    let fn_name_str = fn_name.to_string();
    let struct_name = syn::Ident::new(
        &format!("{}Mutation", to_pascal_case(&fn_name_str)),
        fn_name.span(),
    );

    let vis = &input.vis;
    let asyncness = &input.sig.asyncness;
    let fn_block = &input.block;
    let fn_attrs = &input.attrs;

    // Check for dispatch_job or start_workflow calls without transactional attribute
    let block_str = quote! { #fn_block }.to_string();
    let has_dispatch = block_str.contains("dispatch_job") || block_str.contains("start_workflow");
    if has_dispatch && !attrs.transactional {
        return Err(syn::Error::new_spanned(
            &input.sig.ident,
            "Mutations that call `dispatch_job()` or `start_workflow()` must use \
             #[forge::mutation(transactional)] to ensure atomicity. Without it, \
             jobs may be dispatched but database changes rolled back on error.",
        ));
    }

    // Validate async
    if asyncness.is_none() {
        return Err(syn::Error::new_spanned(
            &input.sig,
            "Mutation functions must be async",
        ));
    }

    // Extract parameters (skip first which should be &MutationContext)
    let params: Vec<_> = input.sig.inputs.iter().collect();
    if params.is_empty() {
        return Err(syn::Error::new_spanned(
            &input.sig,
            "Mutation functions must have at least a MutationContext parameter",
        ));
    }

    // Get context param - extract name and ensure it uses reference
    let (ctx_name, ctx_type) = match &params[0] {
        FnArg::Typed(pat_type) => {
            let name = if let Pat::Ident(pat_ident) = &*pat_type.pat {
                pat_ident.ident.clone()
            } else {
                return Err(syn::Error::new_spanned(
                    pat_type,
                    "Expected context parameter to be an identifier",
                ));
            };
            (name, &*pat_type.ty)
        }
        _ => {
            return Err(syn::Error::new_spanned(
                params[0],
                "Expected typed context parameter",
            ));
        }
    };

    // Determine the context type string (e.g., MutationContext)
    let type_str = quote! { #ctx_type }.to_string();
    let is_ref = type_str.starts_with('&');

    // Get remaining params for args struct
    let arg_params: Vec<_> = params.iter().skip(1).cloned().collect();

    // Build args struct fields
    let args_fields: Vec<TokenStream2> = arg_params
        .iter()
        .filter_map(|p| {
            if let FnArg::Typed(pat_type) = p
                && let Pat::Ident(pat_ident) = &*pat_type.pat
            {
                let name = &pat_ident.ident;
                let ty = &pat_type.ty;
                return Some(quote! { pub #name: #ty });
            }
            None
        })
        .collect();

    // Build destructuring for function call
    let arg_names: Vec<TokenStream2> = arg_params
        .iter()
        .filter_map(|p| {
            if let FnArg::Typed(pat_type) = p
                && let Pat::Ident(pat_ident) = &*pat_type.pat
            {
                let name = &pat_ident.ident;
                return Some(quote! { #name });
            }
            None
        })
        .collect();

    // Get return type
    let output_type = match &input.sig.output {
        ReturnType::Default => quote! { () },
        ReturnType::Type(_, ty) => {
            if let Type::Path(type_path) = &**ty {
                if let Some(segment) = type_path.path.segments.last() {
                    if segment.ident == "Result" {
                        if let syn::PathArguments::AngleBracketed(args) = &segment.arguments {
                            if let Some(syn::GenericArgument::Type(t)) = args.args.first() {
                                quote! { #t }
                            } else {
                                quote! { #ty }
                            }
                        } else {
                            quote! { #ty }
                        }
                    } else {
                        quote! { #ty }
                    }
                } else {
                    quote! { #ty }
                }
            } else {
                quote! { #ty }
            }
        }
    };

    // Generate timeout option
    let timeout = match attrs.timeout {
        Some(t) => quote! { Some(#t) },
        None => quote! { None },
    };
    let http_timeout = timeout.clone();

    let required_role = match &attrs.required_role {
        Some(role) => quote! { Some(#role) },
        None => quote! { None },
    };

    let rate_limit_requests = match attrs.rate_limit_requests {
        Some(n) => quote! { Some(#n) },
        None => quote! { None },
    };

    let rate_limit_per_secs = match attrs.rate_limit_per_secs {
        Some(n) => quote! { Some(#n) },
        None => quote! { None },
    };

    let rate_limit_key = match &attrs.rate_limit_key {
        Some(k) => quote! { Some(#k) },
        None => quote! { None },
    };

    let log_level = match &attrs.log_level {
        Some(l) => quote! { Some(#l) },
        None => quote! { None },
    };

    let max_upload_size_bytes = match attrs.max_upload_size_bytes {
        Some(n) => quote! { Some(#n) },
        None => quote! { None },
    };

    let transactional = attrs.transactional;
    let is_public = attrs.is_public;

    // Check if we have a single custom args type (user-defined struct)
    // In this case, use it directly instead of wrapping it
    let single_custom_args_type: Option<&Type> = if arg_params.len() == 1 {
        if let FnArg::Typed(pat_type) = &arg_params[0] {
            // Check if it's a custom type (not a primitive)
            if let Type::Path(type_path) = &*pat_type.ty {
                if let Some(segment) = type_path.path.segments.last() {
                    // Use the user's type directly if it looks like a custom Args/Input struct
                    let type_name = segment.ident.to_string();
                    if type_name.ends_with("Args")
                        || type_name.contains("Args")
                        || type_name.ends_with("Input")
                        || type_name.contains("Input")
                    {
                        Some(&*pat_type.ty)
                    } else {
                        None
                    }
                } else {
                    None
                }
            } else {
                None
            }
        } else {
            None
        }
    } else {
        None
    };

    // Generate the args struct (use unit type if no args, user type if single custom args)
    let (args_struct, args_type, execute_call) = if args_fields.is_empty() {
        (
            quote! {
                #vis struct #struct_name;
            },
            quote! { () },
            quote! { #fn_name(ctx).await },
        )
    } else if let Some(user_args_type) = single_custom_args_type {
        // Use the user's args type directly
        (
            quote! {
                #vis struct #struct_name;
            },
            quote! { #user_args_type },
            quote! { #fn_name(ctx, args).await },
        )
    } else {
        // Generate a wrapper struct for multiple args
        let args_struct_name = syn::Ident::new(&format!("{}Args", struct_name), fn_name.span());
        (
            quote! {
                #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
                #vis struct #args_struct_name {
                    #(#args_fields),*
                }

                #vis struct #struct_name;
            },
            quote! { #args_struct_name },
            quote! { #fn_name(ctx, #(args.#arg_names),*).await },
        )
    };

    // Generate the inner function - always take context by reference
    let inner_fn = if is_ref {
        // User already uses reference, keep the type as-is
        if arg_names.is_empty() {
            quote! {
                #(#fn_attrs)*
                #vis async fn #fn_name(#ctx_name: #ctx_type) -> forge::forge_core::Result<#output_type> #fn_block
            }
        } else {
            quote! {
                #(#fn_attrs)*
                #vis async fn #fn_name(#ctx_name: #ctx_type, #(#arg_params),*) -> forge::forge_core::Result<#output_type> #fn_block
            }
        }
    } else {
        // User uses value, convert to reference in the generated function
        if arg_names.is_empty() {
            quote! {
                #(#fn_attrs)*
                #vis async fn #fn_name(#ctx_name: &#ctx_type) -> forge::forge_core::Result<#output_type> #fn_block
            }
        } else {
            quote! {
                #(#fn_attrs)*
                #vis async fn #fn_name(#ctx_name: &#ctx_type, #(#arg_params),*) -> forge::forge_core::Result<#output_type> #fn_block
            }
        }
    };

    Ok(quote! {
        #args_struct

        #inner_fn

        impl forge::forge_core::ForgeMutation for #struct_name {
            type Args = #args_type;
            type Output = #output_type;

            fn info() -> forge::forge_core::FunctionInfo {
                forge::forge_core::FunctionInfo {
                    name: #fn_name_str,
                    description: None,
                    kind: forge::forge_core::FunctionKind::Mutation,
                    required_role: #required_role,
                    is_public: #is_public,
                    cache_ttl: None,
                    timeout: #timeout,
                    http_timeout: #http_timeout,
                    rate_limit_requests: #rate_limit_requests,
                    rate_limit_per_secs: #rate_limit_per_secs,
                    rate_limit_key: #rate_limit_key,
                    log_level: #log_level,
                    table_dependencies: &[],
                    selected_columns: &[],
                    transactional: #transactional,
                    consistent: false,
                    max_upload_size_bytes: #max_upload_size_bytes,
                }
            }

            fn execute(
                ctx: &forge::forge_core::MutationContext,
                args: Self::Args,
            ) -> std::pin::Pin<Box<dyn std::future::Future<Output = forge::forge_core::Result<Self::Output>> + Send + '_>> {
                Box::pin(async move {
                    #execute_call
                })
            }
        }

        forge::inventory::submit!(forge::AutoMutation(|registry| {
            registry.register_mutation::<#struct_name>();
        }));
    })
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::indexing_slicing, clippy::panic)]
mod tests {
    use super::*;

    // Note: proc_macro::TokenStream cannot be created outside the compiler bridge,
    // so we test parse_mutation_attrs indirectly through the has_attr_flag/parse_attr_value
    // utilities and test expand_mutation_impl directly with syn::ItemFn + MutationAttrs.

    // --- MutationAttrs default ---

    #[test]
    fn default_attrs_are_all_none_or_false() {
        let attrs = MutationAttrs::default();
        assert!(!attrs.transactional);
        assert!(!attrs.is_public);
        assert!(!attrs.is_unscoped);
        assert!(attrs.required_role.is_none());
        assert!(attrs.timeout.is_none());
        assert!(attrs.rate_limit_requests.is_none());
        assert!(attrs.rate_limit_per_secs.is_none());
        assert!(attrs.rate_limit_key.is_none());
        assert!(attrs.log_level.is_none());
        assert!(attrs.max_upload_size_bytes.is_none());
    }

    // --- Validation: transactional requirement ---

    #[test]
    fn rejects_dispatch_job_without_transactional() {
        let input: ItemFn = syn::parse_str(
            r#"
            pub async fn create_user(ctx: &MutationContext, name: String) -> Result<User> {
                ctx.dispatch_job("send_email", json!({})).await?;
                Ok(User { name })
            }
            "#,
        )
        .unwrap();

        let attrs = MutationAttrs::default();
        let result = expand_mutation_impl(input, attrs);
        assert!(result.is_err());
        let err_msg = result.unwrap_err().to_string();
        assert!(
            err_msg.contains("transactional"),
            "Error should mention transactional: {err_msg}"
        );
    }

    #[test]
    fn rejects_start_workflow_without_transactional() {
        let input: ItemFn = syn::parse_str(
            r#"
            pub async fn begin_onboarding(ctx: &MutationContext) -> Result<()> {
                ctx.start_workflow("onboarding", json!({})).await?;
                Ok(())
            }
            "#,
        )
        .unwrap();

        let attrs = MutationAttrs::default();
        let result = expand_mutation_impl(input, attrs);
        assert!(result.is_err());
        let err_msg = result.unwrap_err().to_string();
        assert!(err_msg.contains("transactional"));
    }

    #[test]
    fn accepts_dispatch_job_with_transactional() {
        let input: ItemFn = syn::parse_str(
            r#"
            pub async fn create_user(ctx: &MutationContext, name: String) -> Result<User> {
                ctx.dispatch_job("send_email", json!({})).await?;
                Ok(User { name })
            }
            "#,
        )
        .unwrap();

        let attrs = MutationAttrs {
            transactional: true,
            ..Default::default()
        };
        let result = expand_mutation_impl(input, attrs);
        assert!(
            result.is_ok(),
            "Should accept dispatch_job with transactional"
        );
    }

    #[test]
    fn accepts_mutation_without_dispatch() {
        let input: ItemFn = syn::parse_str(
            r#"
            pub async fn update_name(ctx: &MutationContext, name: String) -> Result<()> {
                Ok(())
            }
            "#,
        )
        .unwrap();

        let attrs = MutationAttrs::default();
        let result = expand_mutation_impl(input, attrs);
        assert!(
            result.is_ok(),
            "Simple mutation without dispatch should work"
        );
    }

    // --- Validation: async requirement ---

    #[test]
    fn rejects_non_async_mutation() {
        let input: ItemFn = syn::parse_str(
            r#"
            pub fn create_user(ctx: &MutationContext) -> Result<()> {
                Ok(())
            }
            "#,
        )
        .unwrap();

        let attrs = MutationAttrs::default();
        let result = expand_mutation_impl(input, attrs);
        assert!(result.is_err());
        let err_msg = result.unwrap_err().to_string();
        assert!(
            err_msg.contains("async"),
            "Error should mention async: {err_msg}"
        );
    }

    // --- Validation: context parameter ---

    #[test]
    fn rejects_mutation_without_parameters() {
        let input: ItemFn = syn::parse_str(
            r#"
            pub async fn create_user() -> Result<()> {
                Ok(())
            }
            "#,
        )
        .unwrap();

        let attrs = MutationAttrs::default();
        let result = expand_mutation_impl(input, attrs);
        assert!(result.is_err());
        let err_msg = result.unwrap_err().to_string();
        assert!(
            err_msg.contains("MutationContext"),
            "Error should mention context param: {err_msg}"
        );
    }

    // --- Generated output structure ---

    #[test]
    fn generates_struct_for_no_arg_mutation() {
        let input: ItemFn = syn::parse_str(
            r#"
            pub async fn reset_all(ctx: &MutationContext) -> Result<()> {
                Ok(())
            }
            "#,
        )
        .unwrap();

        let attrs = MutationAttrs::default();
        let output = expand_mutation_impl(input, attrs).expect("should expand");
        let output_str = output.to_string();
        assert!(
            output_str.contains("ResetAllMutation"),
            "Should generate PascalCase struct name"
        );
        assert!(
            output_str.contains("ForgeMutation"),
            "Should implement ForgeMutation trait"
        );
        assert!(
            output_str.contains("inventory"),
            "Should register via inventory"
        );
    }

    #[test]
    fn generates_info_with_attributes() {
        let input: ItemFn = syn::parse_str(
            r#"
            pub async fn create_item(ctx: &MutationContext) -> Result<()> {
                Ok(())
            }
            "#,
        )
        .unwrap();

        let attrs = MutationAttrs {
            is_public: true,
            transactional: true,
            required_role: Some("admin".into()),
            ..Default::default()
        };
        let output = expand_mutation_impl(input, attrs).expect("should expand");
        let output_str = output.to_string();
        assert!(output_str.contains("is_public : true"));
        assert!(output_str.contains("transactional : true"));
        assert!(
            output_str.contains(r#"Some ("admin")"#) || output_str.contains(r#"Some("admin")"#)
        );
    }
}