fraiseql-core 2.12.0

Core execution engine for FraiseQL v2 - Compiled GraphQL over SQL
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

//! Rate limiting configuration.

use serde::{Deserialize, Serialize};

/// Rate limiting configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct RateLimitConfig {
    /// Enable rate limiting.
    pub enabled: bool,

    /// Maximum requests per window.
    pub requests_per_window: u32,

    /// Window duration in seconds.
    pub window_secs: u64,

    /// Key extractor (ip, user, `api_key`).
    pub key_by: RateLimitKey,

    /// Paths to exclude from rate limiting.
    pub exclude_paths: Vec<String>,

    /// Custom limits per path pattern.
    pub path_limits: Vec<PathRateLimit>,
}

impl Default for RateLimitConfig {
    fn default() -> Self {
        Self {
            enabled:             false,
            requests_per_window: 100,
            window_secs:         60,
            key_by:              RateLimitKey::Ip,
            exclude_paths:       vec!["/health".to_string()],
            path_limits:         vec![],
        }
    }
}

/// Rate limit key extractor.
#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum RateLimitKey {
    /// Rate limit by IP address.
    #[default]
    Ip,
    /// Rate limit by authenticated user.
    User,
    /// Rate limit by API key.
    ApiKey,
}

/// Per-path rate limit override.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PathRateLimit {
    /// Path pattern (glob).
    pub path:                String,
    /// Maximum requests per window for this path.
    pub requests_per_window: u32,
}