use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;
use syn::visit::Visit;
use syn::{FnArg, ItemFn, Pat, ReturnType, Type, parse_macro_input};
use crate::sql_extractor::{
SqlStringExtractor, extract_columns_from_sql, extract_tables_from_sql,
sql_references_identity_scope,
};
use crate::utils::{has_attr_flag, parse_attr_value, parse_duration_secs, to_pascal_case};
pub fn expand_query(attr: TokenStream, item: TokenStream) -> TokenStream {
let input = parse_macro_input!(item as ItemFn);
let attrs = parse_query_attrs(attr);
expand_query_impl(input, attrs)
.unwrap_or_else(|e| e.to_compile_error())
.into()
}
#[derive(Default)]
struct QueryAttrs {
cache_ttl: Option<u64>,
required_role: Option<String>,
is_public: bool,
is_unscoped: bool,
consistent: bool,
timeout: Option<u64>,
rate_limit_requests: Option<u32>,
rate_limit_per_secs: Option<u64>,
rate_limit_key: Option<String>,
log_level: Option<String>,
tables: Option<Vec<String>>,
}
fn parse_query_attrs(attr: TokenStream) -> QueryAttrs {
let mut attrs = QueryAttrs::default();
let attr_str = attr.to_string();
if has_attr_flag(&attr_str, "public") {
attrs.is_public = true;
}
if has_attr_flag(&attr_str, "consistent") {
attrs.consistent = 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(cache_start) = attr_str.find("cache")
&& let Some(quote_start) = attr_str[cache_start..].find('"')
{
let remaining = &attr_str[cache_start + quote_start + 1..];
if let Some(quote_end) = remaining.find('"') {
let ttl_str = &remaining[..quote_end];
attrs.cache_ttl = parse_duration_secs(ttl_str);
}
}
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") {
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(tables_start) = attr_str.find("tables")
&& let Some(bracket_start) = attr_str[tables_start..].find('[')
{
let remaining = &attr_str[tables_start + bracket_start + 1..];
if let Some(bracket_end) = remaining.find(']') {
let tables_str = &remaining[..bracket_end];
let tables: Vec<String> = tables_str
.split(',')
.map(|s| s.trim().trim_matches('"').trim_matches('\'').to_string())
.filter(|s| !s.is_empty())
.collect();
if !tables.is_empty() {
attrs.tables = Some(tables);
}
}
}
attrs
}
fn expand_query_impl(input: ItemFn, attrs: QueryAttrs) -> syn::Result<TokenStream2> {
let fn_name = &input.sig.ident;
let fn_name_str = fn_name.to_string();
let struct_name = syn::Ident::new(
&format!("{}Query", 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;
if asyncness.is_none() {
return Err(syn::Error::new_spanned(
&input.sig,
"Query functions must be async",
));
}
let params: Vec<_> = input.sig.inputs.iter().collect();
if params.is_empty() {
return Err(syn::Error::new_spanned(
&input.sig,
"Query functions must have at least a QueryContext parameter",
));
}
let (ctx_name, ctx_type) = match ¶ms[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",
));
}
};
let type_str = quote! { #ctx_type }.to_string();
let is_ref = type_str.starts_with('&');
let table_dependencies: Vec<String> = if let Some(explicit_tables) = attrs.tables {
explicit_tables
} else {
let mut extractor = SqlStringExtractor::new();
extractor.visit_block(fn_block);
let tables = extract_tables_from_sql(&extractor.sql_strings);
let mut sorted: Vec<String> = tables.into_iter().collect();
sorted.sort();
sorted
};
let selected_columns: Vec<String> = {
let mut extractor = SqlStringExtractor::new();
extractor.visit_block(fn_block);
let cols = extract_columns_from_sql(&extractor.sql_strings);
let mut sorted: Vec<String> = cols.into_iter().collect();
sorted.sort();
sorted
};
if !attrs.is_public && !attrs.is_unscoped && !table_dependencies.is_empty() {
let mut scope_extractor = SqlStringExtractor::new();
scope_extractor.visit_block(fn_block);
if !sql_references_identity_scope(&scope_extractor.sql_strings) {
let tables_str = table_dependencies.join(", ");
return Err(syn::Error::new_spanned(
&input.sig.ident,
format!(
"Private query `{fn_name_str}` references table(s) [{tables_str}] but SQL \
does not filter by user_id or owner_id. Add a WHERE clause scoped to the \
authenticated user, or use #[query(unscoped)] if this is intentional."
),
));
}
}
let arg_params: Vec<_> = params.iter().skip(1).cloned().collect();
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();
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();
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 }
}
}
};
let cache_ttl = match attrs.cache_ttl {
Some(ttl) => quote! { Some(#ttl) },
None => quote! { None },
};
let timeout = match attrs.timeout {
Some(t) => quote! { Some(#t) },
None => quote! { None },
};
let http_timeout = timeout.clone();
let is_public = attrs.is_public;
let consistent = attrs.consistent;
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 table_deps_tokens = if table_dependencies.is_empty() {
quote! { &[] }
} else {
let table_strs: Vec<_> = table_dependencies.iter().map(|t| quote! { #t }).collect();
quote! { &[#(#table_strs),*] }
};
let selected_cols_tokens = if selected_columns.is_empty() {
quote! { &[] }
} else {
let col_strs: Vec<_> = selected_columns.iter().map(|c| quote! { #c }).collect();
quote! { &[#(#col_strs),*] }
};
let single_custom_args_type: Option<&Type> = if arg_params.len() == 1 {
if let FnArg::Typed(pat_type) = &arg_params[0] {
if let Type::Path(type_path) = &*pat_type.ty {
if let Some(segment) = type_path.path.segments.last() {
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
};
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 {
(
quote! {
#vis struct #struct_name;
},
quote! { #user_args_type },
quote! { #fn_name(ctx, args).await },
)
} else {
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 },
)
};
let inner_fn = if is_ref {
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 {
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::ForgeQuery 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::Query,
required_role: #required_role,
is_public: #is_public,
cache_ttl: #cache_ttl,
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: #table_deps_tokens,
selected_columns: #selected_cols_tokens,
transactional: false,
consistent: #consistent,
max_upload_size_bytes: None,
}
}
fn execute(
ctx: &forge::forge_core::QueryContext,
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::AutoQuery(|registry| {
registry.register_query::<#struct_name>();
}));
})
}