Skip to main content

rorpc_parse/codegen/
router.rs

1//! Code generation for the `router!(...)` proc macro.
2//!
3//! Parses 0–2 arguments (state expression and/or module path pattern) in any
4//! order, then emits an Axum `Router` that merges all matching registered
5//! handlers from the `inventory`.
6
7use proc_macro2::TokenStream;
8use quote::quote;
9use syn::{
10    parse::{Parse, ParseStream},
11    Expr, ExprArray, LitStr, Token,
12};
13
14// ---------------------------------------------------------------------------
15// RouterArgs — parsed from router!(state?, pattern?)
16// ---------------------------------------------------------------------------
17
18/// Parsed arguments for the `router!(...)` macro.
19///
20/// Both arguments are optional and may appear in any order.
21pub struct RouterArgs {
22    pub state: Option<Expr>,
23    pub pattern: Option<Pattern>,
24}
25
26impl std::fmt::Debug for RouterArgs {
27    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
28        f.debug_struct("RouterArgs")
29            .field("has_state", &self.state.is_some())
30            .field("pattern", &self.pattern)
31            .finish()
32    }
33}
34
35/// Module path filter pattern.
36#[derive(Clone, Debug)]
37pub enum Pattern {
38    /// `"handlers::planet"` — single pattern
39    Single(String),
40    /// `["handlers::planet", "handlers::user"]` — multiple patterns
41    Multiple(Vec<String>),
42}
43
44impl Parse for RouterArgs {
45    fn parse(input: ParseStream) -> syn::Result<Self> {
46        let mut state: Option<Expr> = None;
47        let mut pattern: Option<Pattern> = None;
48
49        if !input.is_empty() {
50            match parse_one_arg(input)? {
51                Arg::Pattern(p) => pattern = Some(p),
52                Arg::State(s) => state = Some(s),
53            }
54
55            if input.peek(Token![,]) {
56                input.parse::<Token![,]>()?;
57                if !input.is_empty() {
58                    match parse_one_arg(input)? {
59                        Arg::Pattern(p) => {
60                            if pattern.is_some() {
61                                return Err(syn::Error::new(
62                                    input.span(),
63                                    "router!(): pattern specified twice",
64                                ));
65                            }
66                            pattern = Some(p);
67                        }
68                        Arg::State(s) => {
69                            if state.is_some() {
70                                return Err(syn::Error::new(
71                                    input.span(),
72                                    "router!(): state specified twice",
73                                ));
74                            }
75                            state = Some(s);
76                        }
77                    }
78                }
79            }
80        }
81
82        Ok(RouterArgs { state, pattern })
83    }
84}
85
86enum Arg {
87    Pattern(Pattern),
88    State(Expr),
89}
90
91fn parse_one_arg(input: ParseStream) -> syn::Result<Arg> {
92    if let Ok(lit) = input.parse::<LitStr>() {
93        return Ok(Arg::Pattern(Pattern::Single(lit.value())));
94    }
95    if let Ok(array) = input.parse::<ExprArray>() {
96        let patterns: syn::Result<Vec<String>> = array
97            .elems
98            .iter()
99            .map(|elem| match elem {
100                Expr::Lit(expr_lit) => {
101                    if let syn::Lit::Str(s) = &expr_lit.lit {
102                        Ok(s.value())
103                    } else {
104                        Err(syn::Error::new_spanned(
105                            elem,
106                            "router!(): array elements must be string literals",
107                        ))
108                    }
109                }
110                _ => Err(syn::Error::new_spanned(
111                    elem,
112                    "router!(): array elements must be string literals",
113                )),
114            })
115            .collect();
116        return Ok(Arg::Pattern(Pattern::Multiple(patterns?)));
117    }
118    Ok(Arg::State(input.parse::<Expr>()?))
119}
120
121// ---------------------------------------------------------------------------
122// expand_router
123// ---------------------------------------------------------------------------
124
125/// Generate the `router!(...)` expansion.
126pub fn expand_router(args: RouterArgs) -> TokenStream {
127    let state_expr = match &args.state {
128        Some(expr) => quote! { ::std::sync::Arc::new(#expr) },
129        None => quote! { ::std::sync::Arc::new(()) },
130    };
131
132    let filter = build_filter(&args.pattern);
133
134    quote! {
135        {
136            let state: ::std::sync::Arc<dyn ::std::any::Any + Send + Sync> = #state_expr;
137            let mut app: ::axum::Router = ::axum::Router::new();
138            for reg in ::rorpc::inventory::iter::<::rorpc::HandlerRegistration> {
139                let matches = #filter;
140                if matches {
141                    let route = (reg.factory)(::std::sync::Arc::clone(&state));
142                    app = app.merge(route);
143                }
144            }
145            app
146        }
147    }
148}
149
150// ---------------------------------------------------------------------------
151// Filter predicate generation
152// ---------------------------------------------------------------------------
153
154fn build_filter(pattern: &Option<Pattern>) -> TokenStream {
155    let Some(p) = pattern else {
156        return quote! { true };
157    };
158
159    let expanded: Vec<String> = match p {
160        Pattern::Single(s) => expand_pattern(s),
161        Pattern::Multiple(vec) => vec.iter().flat_map(|s| expand_pattern(s)).collect(),
162    };
163
164    if expanded.is_empty() {
165        return quote! { true };
166    }
167
168    let conditions: Vec<TokenStream> = expanded
169        .iter()
170        .map(|pat| {
171            let with_sep = format!("{}::", pat);
172            quote! {
173                (metadata.module_path == #pat || metadata.module_path.starts_with(#with_sep))
174            }
175        })
176        .collect();
177
178    quote! {
179        {
180            let mut matches = false;
181            for metadata in ::rorpc::inventory::iter::<::rorpc::HandlerMetadata> {
182                if metadata.path == reg.path && metadata.method == reg.method {
183                    matches = #(#conditions)||*;
184                    break;
185                }
186            }
187            matches
188        }
189    }
190}
191
192/// Expand a pattern string, handling brace groups and wildcards.
193///
194/// - `"handlers::{planet,user}"` → `["handlers::planet", "handlers::user"]`
195/// - `"handlers::*"` → `["handlers::"]` (prefix match)
196fn expand_pattern(pattern: &str) -> Vec<String> {
197    if let (Some(start), Some(end)) = (pattern.find('{'), pattern.find('}')) {
198        let prefix = &pattern[..start];
199        let group = &pattern[start + 1..end];
200        let suffix = &pattern[end + 1..];
201        return group
202            .split(',')
203            .map(|seg| normalise(format!("{}{}{}", prefix, seg.trim(), suffix)))
204            .collect();
205    }
206    vec![normalise(pattern.to_string())]
207}
208
209/// Normalise a single pattern: strip trailing `*` after `::`.
210fn normalise(pattern: String) -> String {
211    if pattern.ends_with("::*") {
212        pattern[..pattern.len() - 1].to_string()
213    } else {
214        pattern
215    }
216}
217
218// ---------------------------------------------------------------------------
219// Tests
220// ---------------------------------------------------------------------------
221
222#[cfg(test)]
223mod tests {
224    use super::*;
225
226    #[test]
227    fn expand_simple() {
228        assert_eq!(expand_pattern("handlers::planet"), vec!["handlers::planet"]);
229    }
230
231    #[test]
232    fn expand_wildcard() {
233        assert_eq!(expand_pattern("handlers::*"), vec!["handlers::"]);
234    }
235
236    #[test]
237    fn expand_brace_group() {
238        let mut result = expand_pattern("handlers::{planet,user}");
239        result.sort();
240        assert_eq!(result, vec!["handlers::planet", "handlers::user"]);
241    }
242
243    #[test]
244    fn expand_brace_with_whitespace() {
245        let mut result = expand_pattern("handlers::{ planet , user }");
246        result.sort();
247        assert_eq!(result, vec!["handlers::planet", "handlers::user"]);
248    }
249
250    #[test]
251    fn parse_no_args() {
252        let args: RouterArgs = syn::parse_str("").unwrap();
253        assert!(args.state.is_none());
254        assert!(args.pattern.is_none());
255    }
256
257    #[test]
258    fn parse_pattern_only() {
259        let args: RouterArgs = syn::parse_str("\"handlers::planet\"").unwrap();
260        assert!(args.state.is_none());
261        assert!(matches!(args.pattern, Some(Pattern::Single(_))));
262    }
263
264    #[test]
265    fn parse_array_pattern() {
266        let args: RouterArgs =
267            syn::parse_str("[\"handlers::planet\", \"handlers::user\"]").unwrap();
268        assert!(matches!(args.pattern, Some(Pattern::Multiple(_))));
269    }
270
271    #[test]
272    fn parse_duplicate_pattern_errors() {
273        let result: syn::Result<RouterArgs> =
274            syn::parse_str("\"handlers::planet\", \"handlers::user\"");
275        assert!(result.is_err());
276        assert!(result
277            .unwrap_err()
278            .to_string()
279            .contains("pattern specified twice"));
280    }
281}