use proc_macro::TokenStream;
use quote::{format_ident, quote};
use syn::visit::Visit;
use syn::{ExprAwait, ExprCall, ItemFn, Lit, parse_macro_input};
use std::collections::BTreeSet;
use crate::utils::{has_attr_flag, parse_attr_value, parse_duration_tokens, to_pascal_case};
const TOKIO_SLEEP_THRESHOLD_SECS: u64 = 100;
struct TokioSleepDetector {
violation_span: Option<proc_macro2::Span>,
}
impl TokioSleepDetector {
fn new() -> Self {
Self {
violation_span: None,
}
}
fn extract_duration_secs(
args: &syn::punctuated::Punctuated<syn::Expr, syn::token::Comma>,
) -> Option<u64> {
if args.len() != 1 {
return None;
}
if let syn::Expr::Call(call) = &args[0]
&& let syn::Expr::Path(path) = &*call.func
{
let path_str: String = path
.path
.segments
.iter()
.map(|s| s.ident.to_string())
.collect::<Vec<_>>()
.join("::");
if path_str.ends_with("from_secs") {
if let Some(syn::Expr::Lit(lit)) = call.args.first()
&& let Lit::Int(int_lit) = &lit.lit
{
return int_lit.base10_parse::<u64>().ok();
}
} else if path_str.ends_with("from_millis") {
if let Some(syn::Expr::Lit(lit)) = call.args.first()
&& let Lit::Int(int_lit) = &lit.lit
{
return int_lit.base10_parse::<u64>().ok().map(|ms| ms / 1000);
}
} else if path_str.ends_with("from_days")
&& let Some(syn::Expr::Lit(lit)) = call.args.first()
&& let Lit::Int(int_lit) = &lit.lit
{
return int_lit.base10_parse::<u64>().ok().map(|d| d * 86400);
}
}
None
}
fn check_sleep_call(
&mut self,
path_str: &str,
args: &syn::punctuated::Punctuated<syn::Expr, syn::token::Comma>,
span: proc_macro2::Span,
) {
if self.violation_span.is_some() {
return;
}
let is_tokio_sleep =
(path_str.contains("tokio") && path_str.contains("sleep")) || path_str == "sleep";
if !is_tokio_sleep {
return;
}
match Self::extract_duration_secs(args) {
Some(secs) if secs <= TOKIO_SLEEP_THRESHOLD_SECS => {}
_ => self.violation_span = Some(span),
}
}
}
impl<'ast> Visit<'ast> for TokioSleepDetector {
fn visit_expr_call(&mut self, node: &'ast ExprCall) {
if let syn::Expr::Path(path) = &*node.func {
let path_str: String = path
.path
.segments
.iter()
.map(|s| s.ident.to_string())
.collect::<Vec<_>>()
.join("::");
let span = path
.path
.segments
.last()
.map(|s| s.ident.span())
.unwrap_or_else(proc_macro2::Span::call_site);
self.check_sleep_call(&path_str, &node.args, span);
}
syn::visit::visit_expr_call(self, node);
}
fn visit_expr_await(&mut self, node: &'ast ExprAwait) {
if let syn::Expr::Call(call) = &*node.base
&& let syn::Expr::Path(path) = &*call.func
{
let path_str: String = path
.path
.segments
.iter()
.map(|s| s.ident.to_string())
.collect::<Vec<_>>()
.join("::");
let span = path
.path
.segments
.last()
.map(|s| s.ident.span())
.unwrap_or_else(proc_macro2::Span::call_site);
self.check_sleep_call(&path_str, &call.args, span);
}
syn::visit::visit_expr_await(self, node);
}
}
#[derive(Debug, Default)]
struct WorkflowAttrs {
name: Option<String>,
version: Option<String>,
timeout: Option<String>,
is_public: bool,
is_active: bool,
is_deprecated: bool,
required_role: Option<String>,
}
fn parse_workflow_attrs(attr: TokenStream) -> WorkflowAttrs {
let mut result = WorkflowAttrs::default();
let attr_str = attr.to_string();
if let Some(name) = parse_attr_value(&attr_str, "name") {
result.name = Some(name);
}
if let Some(version) = parse_attr_value(&attr_str, "version") {
result.version = Some(version);
}
if let Some(timeout) = parse_attr_value(&attr_str, "timeout") {
result.timeout = Some(timeout);
}
if has_attr_flag(&attr_str, "public") {
result.is_public = true;
}
if has_attr_flag(&attr_str, "active") {
result.is_active = true;
}
if has_attr_flag(&attr_str, "deprecated") {
result.is_deprecated = 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('"');
result.required_role = Some(role.to_string());
}
}
if !result.is_active && !result.is_deprecated {
result.is_active = true;
}
result
}
struct ContractExtractor {
step_keys: BTreeSet<String>,
wait_keys: BTreeSet<String>,
}
impl ContractExtractor {
fn new() -> Self {
Self {
step_keys: BTreeSet::new(),
wait_keys: BTreeSet::new(),
}
}
fn extract_string_lit(expr: &syn::Expr) -> Option<String> {
if let syn::Expr::Lit(lit) = expr
&& let Lit::Str(s) = &lit.lit
{
return Some(s.value());
}
None
}
}
impl<'ast> Visit<'ast> for ContractExtractor {
fn visit_expr_method_call(&mut self, node: &'ast syn::ExprMethodCall) {
let method_name = node.method.to_string();
match method_name.as_str() {
"step" => {
if let Some(first_arg) = node.args.first()
&& let Some(key) = Self::extract_string_lit(first_arg)
{
self.step_keys.insert(key);
}
}
"wait_for_event" => {
if let Some(first_arg) = node.args.first()
&& let Some(key) = Self::extract_string_lit(first_arg)
{
self.wait_keys.insert(key);
}
}
_ => {}
}
syn::visit::visit_expr_method_call(self, node);
}
}
fn derive_signature(
name: &str,
version: &str,
step_keys: &BTreeSet<String>,
wait_keys: &BTreeSet<String>,
timeout_secs: u64,
input_type: &str,
output_type: &str,
) -> String {
let mut hash: u64 = 0xcbf29ce484222325;
let fnv_prime: u64 = 0x100000001b3;
let mut feed = |bytes: &[u8]| {
for &b in bytes {
hash ^= u64::from(b);
hash = hash.wrapping_mul(fnv_prime);
}
hash ^= 0xff;
hash = hash.wrapping_mul(fnv_prime);
};
feed(name.as_bytes());
feed(version.as_bytes());
for key in step_keys {
feed(b"step:");
feed(key.as_bytes());
}
for key in wait_keys {
feed(b"wait:");
feed(key.as_bytes());
}
feed(timeout_secs.to_le_bytes().as_slice());
feed(input_type.as_bytes());
feed(output_type.as_bytes());
format!("{hash:016x}")
}
pub fn workflow_impl(attr: TokenStream, item: TokenStream) -> TokenStream {
let input = parse_macro_input!(item as ItemFn);
let attrs = parse_workflow_attrs(attr);
if attrs.is_active && attrs.is_deprecated {
return syn::Error::new(
proc_macro2::Span::call_site(),
"A workflow version cannot be both `active` and `deprecated`",
)
.to_compile_error()
.into();
}
let fn_name = &input.sig.ident;
let fn_name_str = fn_name.to_string();
let workflow_name = attrs.name.as_deref().unwrap_or(&fn_name_str);
let struct_name = format_ident!("{}Workflow", to_pascal_case(&fn_name.to_string()));
let vis = &input.vis;
let block = &input.block;
let mut sleep_detector = TokioSleepDetector::new();
sleep_detector.visit_block(block);
if let Some(span) = sleep_detector.violation_span {
return syn::Error::new(
span,
"Use `ctx.sleep()` instead of `tokio::sleep()` for long sleeps in workflows. \
Workflows require durable sleep that survives process restarts. \
Short sleeps (<100s) for polling are allowed with tokio::sleep.",
)
.to_compile_error()
.into();
}
let mut contract_extractor = ContractExtractor::new();
contract_extractor.visit_block(block);
let mut input_type = quote! { () };
let mut input_ident = format_ident!("_input");
let mut input_type_str = String::from("()");
for (i, input_arg) in input.sig.inputs.iter().enumerate() {
if i == 0 {
continue; }
if let syn::FnArg::Typed(pat_type) = input_arg {
if let syn::Pat::Ident(ident) = pat_type.pat.as_ref() {
input_ident = ident.ident.clone();
}
let ty = &pat_type.ty;
input_type_str = quote!(#ty).to_string();
input_type = quote! { #ty };
}
}
let mut output_type_str = String::from("()");
let output_type = match &input.sig.output {
syn::ReturnType::Default => quote! { () },
syn::ReturnType::Type(_, ty) => {
if let syn::Type::Path(path) = ty.as_ref() {
if let Some(segment) = path.path.segments.last() {
if segment.ident == "Result" {
if let syn::PathArguments::AngleBracketed(args) = &segment.arguments {
if let Some(syn::GenericArgument::Type(inner)) = args.args.first() {
output_type_str = quote!(#inner).to_string();
quote! { #inner }
} else {
quote! { () }
}
} else {
quote! { () }
}
} else {
output_type_str = quote!(#ty).to_string();
quote! { #ty }
}
} else {
output_type_str = quote!(#ty).to_string();
quote! { #ty }
}
} else {
output_type_str = quote!(#ty).to_string();
quote! { #ty }
}
}
};
let version_str = attrs.version.as_deref().unwrap_or("v1");
let is_public = attrs.is_public;
let is_active = attrs.is_active;
let is_deprecated = attrs.is_deprecated;
let required_role = if let Some(ref role) = attrs.required_role {
quote! { Some(#role) }
} else {
quote! { None }
};
let timeout = if let Some(ref t) = attrs.timeout {
parse_duration_tokens(t, 86400)
} else {
quote! { std::time::Duration::from_secs(86400) } };
let timeout_secs: u64 = if let Some(ref t) = attrs.timeout {
crate::utils::parse_duration_secs(t).unwrap_or(86400)
} else {
86400
};
let http_timeout = if let Some(ref t) = attrs.timeout {
let timeout = parse_duration_tokens(t, 0);
quote! { Some(#timeout) }
} else {
quote! { None }
};
let signature = derive_signature(
workflow_name,
version_str,
&contract_extractor.step_keys,
&contract_extractor.wait_keys,
timeout_secs,
&input_type_str,
&output_type_str,
);
let fn_attrs = &input.attrs;
let expanded = quote! {
#(#fn_attrs)*
#vis struct #struct_name;
impl forge::forge_core::workflow::ForgeWorkflow for #struct_name {
type Input = #input_type;
type Output = #output_type;
fn info() -> forge::forge_core::workflow::WorkflowInfo {
forge::forge_core::workflow::WorkflowInfo {
name: #workflow_name,
version: #version_str,
signature: #signature,
is_active: #is_active,
is_deprecated: #is_deprecated,
timeout: #timeout,
http_timeout: #http_timeout,
is_public: #is_public,
required_role: #required_role,
}
}
fn execute(
ctx: &forge::forge_core::workflow::WorkflowContext,
#input_ident: Self::Input,
) -> std::pin::Pin<Box<dyn std::future::Future<Output = forge::forge_core::Result<Self::Output>> + Send + '_>> {
Box::pin(async move #block)
}
}
forge::inventory::submit!(forge::AutoWorkflow(|registry| {
registry.register::<#struct_name>();
}));
};
TokenStream::from(expanded)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_derive_signature_deterministic() {
let mut steps = BTreeSet::new();
steps.insert("create_user".to_string());
steps.insert("send_email".to_string());
let waits = BTreeSet::new();
let sig1 = derive_signature("onboarding", "v1", &steps, &waits, 86400, "Input", "Output");
let sig2 = derive_signature("onboarding", "v1", &steps, &waits, 86400, "Input", "Output");
assert_eq!(sig1, sig2);
}
#[test]
fn test_derive_signature_changes_with_steps() {
let mut steps1 = BTreeSet::new();
steps1.insert("create_user".to_string());
let mut steps2 = BTreeSet::new();
steps2.insert("create_user".to_string());
steps2.insert("send_email".to_string());
let waits = BTreeSet::new();
let sig1 = derive_signature("wf", "v1", &steps1, &waits, 86400, "()", "()");
let sig2 = derive_signature("wf", "v1", &steps2, &waits, 86400, "()", "()");
assert_ne!(sig1, sig2);
}
#[test]
fn test_derive_signature_changes_with_version() {
let steps = BTreeSet::new();
let waits = BTreeSet::new();
let sig1 = derive_signature("wf", "v1", &steps, &waits, 86400, "()", "()");
let sig2 = derive_signature("wf", "v2", &steps, &waits, 86400, "()", "()");
assert_ne!(sig1, sig2);
}
#[test]
fn test_derive_signature_changes_with_waits() {
let steps = BTreeSet::new();
let mut waits1 = BTreeSet::new();
waits1.insert("payment_confirmed".to_string());
let waits2 = BTreeSet::new();
let sig1 = derive_signature("wf", "v1", &steps, &waits1, 86400, "()", "()");
let sig2 = derive_signature("wf", "v1", &steps, &waits2, 86400, "()", "()");
assert_ne!(sig1, sig2);
}
}