allframe-macros 0.1.28

Procedural macros for AllFrame 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
//! Resilience-related macros for AllFrame.
//!
//! Provides attribute macros for retry, circuit breaker, and rate limiting.

use proc_macro2::TokenStream;
use quote::quote;
use syn::{parse2, ItemFn, LitInt, LitStr};

/// Configuration parsed from `#[retry(...)]` attributes.
#[derive(Default)]
struct RetryConfig {
    max_retries: Option<u32>,
    initial_interval_ms: Option<u64>,
    max_interval_ms: Option<u64>,
    multiplier: Option<f64>,
}

/// Implementation of the `#[retry]` attribute macro.
///
/// **⚠️ DEPRECATED since 0.1.13**: This macro uses the old architecture that
/// violates Clean Architecture principles by coupling resilience logic to
/// function definitions.
///
/// ## Migration Guide
///
/// Replace `#[retry]` with the Clean Architecture resilience system:
///
/// **Before (deprecated):**
/// ```ignore
/// #[retry(max_retries = 3, initial_interval_ms = 500)]
/// async fn fetch_data() -> Result<Data, Error> { /* ... */ }
/// ```
///
/// **After (new architecture):**
/// ```ignore
/// use allframe_core::application::resilience::{ResilienceOrchestrator, DefaultResilienceOrchestrator};
/// use allframe_core::domain::resilience::{ResiliencePolicy, BackoffStrategy};
///
/// let orchestrator = DefaultResilienceOrchestrator::new();
/// let policy = ResiliencePolicy::Retry {
///     max_attempts: 3,
///     backoff: BackoffStrategy::Exponential {
///         initial_delay: Duration::from_millis(500),
///         multiplier: 2.0,
///         max_delay: Some(Duration::from_secs(30)),
///         jitter: true,
///     },
/// };
/// let result = orchestrator.execute_with_policy(policy, || fetch_data()).await;
/// ```
pub fn retry_impl(attr: TokenStream, item: TokenStream) -> syn::Result<TokenStream> {
    let config = parse_retry_attr(attr)?;
    let func: ItemFn = parse2(item)?;

    let visibility = &func.vis;
    let sig = &func.sig;
    let block = &func.block;
    let attrs = &func.attrs;

    // Build retry policy configuration
    let max_retries = config.max_retries.unwrap_or(3);
    let initial_interval_ms = config.initial_interval_ms.unwrap_or(500);
    let max_interval_ms = config.max_interval_ms.unwrap_or(30000);
    let multiplier = config.multiplier.unwrap_or(2.0);

    // Generate deprecation warning
    let deprecation_warning = quote! {
        #[deprecated(
            since = "0.1.13",
            note = "The #[retry] macro uses legacy architecture. Consider migrating to the new Clean Architecture resilience system. See: https://docs.allframe.rs/guides/MIGRATION_GUIDE.html"
        )]
    };

    Ok(quote! {
        #deprecation_warning
        #(#attrs)*
        #visibility #sig {
            // Import the new architectural components
            #[cfg(feature = "resilience")]
            {
                use allframe_core::application::resilience::{ResilienceOrchestrator, DefaultResilienceOrchestrator};
                use allframe_core::domain::resilience::{ResiliencePolicy, BackoffStrategy};

                // Create orchestrator (lazy initialization for performance)
                static ORCHESTRATOR: std::sync::OnceLock<std::sync::Arc<dyn ResilienceOrchestrator + Send + Sync>> = std::sync::OnceLock::new();
                let orchestrator = ORCHESTRATOR.get_or_init(|| {
                    std::sync::Arc::new(DefaultResilienceOrchestrator::new())
                });

                // Build the retry policy using new architecture
                let policy = ResiliencePolicy::Retry {
                    max_attempts: #max_retries,
                    backoff: BackoffStrategy::Exponential {
                        initial_delay: std::time::Duration::from_millis(#initial_interval_ms),
                        multiplier: #multiplier,
                        max_delay: Some(std::time::Duration::from_millis(#max_interval_ms)),
                        jitter: true,
                    },
                };

                // Execute with new architecture
                // The orchestration returns the same Result type as the original function
                // This maintains backward compatibility
                match orchestrator.execute_with_policy(policy, || async {
                    #block
                }).await {
                    Ok(result) => result,
                    Err(_) => {
                        // For backward compatibility, panic on orchestration errors
                        // The old macro would typically let the operation's own errors bubble up
                        panic!("Resilience orchestration failed");
                    }
                }
            }

            // Fallback for when resilience features are not enabled
            #[cfg(not(feature = "resilience"))]
            {
                compile_error!("The #[retry] macro requires the 'resilience' feature. Enable it in Cargo.toml or migrate to the new Clean Architecture approach.");
            }
        }
    })
}

fn parse_retry_attr(attr: TokenStream) -> syn::Result<RetryConfig> {
    let mut config = RetryConfig::default();

    if attr.is_empty() {
        return Ok(config);
    }

    let parser = syn::meta::parser(|meta| {
        if meta.path.is_ident("max_retries") {
            let value: LitInt = meta.value()?.parse()?;
            config.max_retries = Some(value.base10_parse()?);
        } else if meta.path.is_ident("initial_interval_ms") {
            let value: LitInt = meta.value()?.parse()?;
            config.initial_interval_ms = Some(value.base10_parse()?);
        } else if meta.path.is_ident("max_interval_ms") {
            let value: LitInt = meta.value()?.parse()?;
            config.max_interval_ms = Some(value.base10_parse()?);
        } else if meta.path.is_ident("multiplier") {
            let value: syn::LitFloat = meta.value()?.parse()?;
            config.multiplier = Some(value.base10_parse()?);
        }
        Ok(())
    });

    parse2::<syn::parse::Nothing>(attr.clone())
        .ok()
        .map(|_| ())
        .or_else(|| syn::parse::Parser::parse2(parser, attr).ok());

    Ok(config)
}

/// Configuration parsed from `#[circuit_breaker(...)]` attributes.
#[derive(Default)]
struct CircuitBreakerConfig {
    name: Option<String>,
    failure_threshold: Option<u32>,
    success_threshold: Option<u32>,
    timeout_ms: Option<u64>,
}

/// Implementation of the `#[circuit_breaker]` attribute macro.
///
/// **⚠️ DEPRECATED since 0.1.13**: Use the Clean Architecture resilience system instead.
///
/// **Migration**: Replace `#[circuit_breaker(threshold = 5)]` with
/// `ResiliencePolicy::CircuitBreaker { failure_threshold: 5, .. }` passed to
/// `ResilienceOrchestrator::execute_with_policy()`. See `#[retry]` docs for
/// a full migration example.
pub fn circuit_breaker_impl(attr: TokenStream, item: TokenStream) -> syn::Result<TokenStream> {
    let config = parse_circuit_breaker_attr(attr)?;
    let func: ItemFn = parse2(item)?;

    let visibility = &func.vis;
    let sig = &func.sig;
    let block = &func.block;
    let attrs = &func.attrs;

    let failure_threshold = config.failure_threshold.unwrap_or(5);
    let success_threshold = config.success_threshold.unwrap_or(3);
    let timeout_ms = config.timeout_ms.unwrap_or(30000);

    // Generate deprecation warning for circuit breaker macro
    let deprecation_warning = quote! {
        #[deprecated(
            since = "0.1.13",
            note = "The #[circuit_breaker] macro uses legacy architecture. Consider migrating to the new Clean Architecture resilience system. See: https://docs.allframe.rs/guides/MIGRATION_GUIDE.html"
        )]
    };

    Ok(quote! {
        #deprecation_warning
        #(#attrs)*
        #visibility #sig {
            // Import the new architectural components
            #[cfg(feature = "resilience")]
            {
                use allframe_core::application::resilience::{ResilienceOrchestrator, DefaultResilienceOrchestrator};
                use allframe_core::domain::resilience::ResiliencePolicy;
                use std::time::Duration;

                // Create orchestrator (lazy initialization for performance)
                static ORCHESTRATOR: std::sync::OnceLock<std::sync::Arc<dyn ResilienceOrchestrator + Send + Sync>> = std::sync::OnceLock::new();
                let orchestrator = ORCHESTRATOR.get_or_init(|| {
                    std::sync::Arc::new(DefaultResilienceOrchestrator::new())
                });

                // Build the circuit breaker policy using new architecture
                let policy = ResiliencePolicy::CircuitBreaker {
                    failure_threshold: #failure_threshold,
                    recovery_timeout: Duration::from_millis(#timeout_ms),
                    success_threshold: #success_threshold,
                };

                // Execute with new architecture
                match orchestrator.execute_with_policy(policy, || async {
                    #block
                }).await {
                    Ok(result) => result,
                    Err(_) => {
                        // For backward compatibility, panic on circuit breaker errors
                        panic!("Circuit breaker error in legacy macro");
                    }
                }
            }

            // Fallback for when resilience features are not enabled
            #[cfg(not(feature = "resilience"))]
            {
                compile_error!("The #[circuit_breaker] macro requires the 'resilience' feature. Enable it in Cargo.toml or migrate to the new Clean Architecture approach.");
            }
        }
    })
}

fn parse_circuit_breaker_attr(attr: TokenStream) -> syn::Result<CircuitBreakerConfig> {
    let mut config = CircuitBreakerConfig::default();

    if attr.is_empty() {
        return Ok(config);
    }

    let parser = syn::meta::parser(|meta| {
        if meta.path.is_ident("name") {
            let value: LitStr = meta.value()?.parse()?;
            config.name = Some(value.value());
        } else if meta.path.is_ident("failure_threshold") {
            let value: LitInt = meta.value()?.parse()?;
            config.failure_threshold = Some(value.base10_parse()?);
        } else if meta.path.is_ident("success_threshold") {
            let value: LitInt = meta.value()?.parse()?;
            config.success_threshold = Some(value.base10_parse()?);
        } else if meta.path.is_ident("timeout_ms") {
            let value: LitInt = meta.value()?.parse()?;
            config.timeout_ms = Some(value.base10_parse()?);
        }
        Ok(())
    });

    parse2::<syn::parse::Nothing>(attr.clone())
        .ok()
        .map(|_| ())
        .or_else(|| syn::parse::Parser::parse2(parser, attr).ok());

    Ok(config)
}

/// Configuration parsed from `#[rate_limited(...)]` attributes.
#[derive(Default)]
struct RateLimitConfig {
    rps: Option<u32>,
    burst: Option<u32>,
}

/// Implementation of the `#[rate_limited]` attribute macro.
///
/// **⚠️ DEPRECATED since 0.1.13**: Use the Clean Architecture resilience system instead.
///
/// **Migration**: Replace `#[rate_limited(max_per_second = 100)]` with
/// `ResiliencePolicy::RateLimited { max_requests: 100, window: Duration::from_secs(1) }`
/// passed to `ResilienceOrchestrator::execute_with_policy()`. See `#[retry]` docs
/// for a full migration example.
pub fn rate_limited_impl(attr: TokenStream, item: TokenStream) -> syn::Result<TokenStream> {
    let config = parse_rate_limit_attr(attr)?;
    let func: ItemFn = parse2(item)?;

    let visibility = &func.vis;
    let sig = &func.sig;
    let block = &func.block;
    let attrs = &func.attrs;

    let rps = config.rps.unwrap_or(100);
    let burst = config.burst.unwrap_or(10);

    // Generate deprecation warning for rate limiting macro
    let deprecation_warning = quote! {
        #[deprecated(
            since = "0.1.13",
            note = "The #[rate_limited] macro uses legacy architecture. Consider migrating to the new Clean Architecture resilience system. See: https://docs.allframe.rs/guides/MIGRATION_GUIDE.html"
        )]
    };

    Ok(quote! {
        #deprecation_warning
        #(#attrs)*
        #visibility #sig {
            // Import the new architectural components
            #[cfg(feature = "resilience")]
            {
                use allframe_core::application::resilience::{ResilienceOrchestrator, DefaultResilienceOrchestrator};
                use allframe_core::domain::resilience::ResiliencePolicy;

                // Create orchestrator (lazy initialization for performance)
                static ORCHESTRATOR: std::sync::OnceLock<std::sync::Arc<dyn ResilienceOrchestrator + Send + Sync>> = std::sync::OnceLock::new();
                let orchestrator = ORCHESTRATOR.get_or_init(|| {
                    std::sync::Arc::new(DefaultResilienceOrchestrator::new())
                });

                // Build the rate limiting policy using new architecture
                let policy = ResiliencePolicy::RateLimit {
                    requests_per_second: #rps,
                    burst_capacity: #burst,
                };

                // Execute with new architecture
                match orchestrator.execute_with_policy(policy, || async {
                    #block
                }).await {
                    Ok(result) => result,
                    Err(_) => {
                        // For backward compatibility, panic on rate limiting errors
                        panic!("Rate limiting error in legacy macro");
                    }
                }
            }

            // Fallback for when resilience features are not enabled
            #[cfg(not(feature = "resilience"))]
            {
                compile_error!("The #[rate_limited] macro requires the 'resilience' feature. Enable it in Cargo.toml or migrate to the new Clean Architecture approach.");
            }
        }
    })
}

fn parse_rate_limit_attr(attr: TokenStream) -> syn::Result<RateLimitConfig> {
    let mut config = RateLimitConfig::default();

    if attr.is_empty() {
        return Ok(config);
    }

    let parser = syn::meta::parser(|meta| {
        if meta.path.is_ident("rps") {
            let value: LitInt = meta.value()?.parse()?;
            config.rps = Some(value.base10_parse()?);
        } else if meta.path.is_ident("burst") {
            let value: LitInt = meta.value()?.parse()?;
            config.burst = Some(value.base10_parse()?);
        }
        Ok(())
    });

    parse2::<syn::parse::Nothing>(attr.clone())
        .ok()
        .map(|_| ())
        .or_else(|| syn::parse::Parser::parse2(parser, attr).ok());

    Ok(config)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_retry_impl_basic() {
        let attr = TokenStream::new();
        let item = quote! {
            async fn fetch_data() -> Result<String, std::io::Error> {
                Ok("data".to_string())
            }
        };

        let result = retry_impl(attr, item);
        assert!(result.is_ok());
        let output = result.unwrap().to_string();
        assert!(output.contains("ResilienceOrchestrator"));
        assert!(output.contains("ResiliencePolicy"));
    }

    #[test]
    fn test_circuit_breaker_impl_basic() {
        let attr = TokenStream::new();
        let item = quote! {
            async fn call_api() -> Result<String, std::io::Error> {
                Ok("response".to_string())
            }
        };

        let result = circuit_breaker_impl(attr, item);
        assert!(result.is_ok());
        let output = result.unwrap().to_string();
        assert!(output.contains("CircuitBreaker"));
    }

    #[test]
    fn test_rate_limited_impl_basic() {
        let attr = TokenStream::new();
        let item = quote! {
            fn handle_request() -> Result<(), std::io::Error> {
                Ok(())
            }
        };

        let result = rate_limited_impl(attr, item);
        assert!(result.is_ok());
        let output = result.unwrap().to_string();
        assert!(output.contains("ResilienceOrchestrator"));
        assert!(output.contains("RateLimit"));
    }
}