apollo-router 2.14.0-rc.2

A configurable, high-performance routing runtime for Apollo Federation 🚀
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

use std::time::Duration;

use schemars::JsonSchema;
use serde::Deserialize;
use serde::Serialize;

use crate::configuration::RedisCache;
use crate::configuration::TlsClient;
use crate::configuration::default_metrics_interval;
use crate::configuration::default_required_to_start;

#[derive(Debug, Clone, Deserialize, Serialize, JsonSchema, PartialEq)]
#[serde(deny_unknown_fields)]
/// Redis cache configuration
pub(crate) struct Config {
    /// List of URLs to the Redis cluster
    pub(crate) urls: Vec<url::Url>,

    /// Redis username if not provided in the URLs. This field takes precedence over the username in the URL
    pub(crate) username: Option<String>,
    /// Redis password if not provided in the URLs. This field takes precedence over the password in the URL
    pub(crate) password: Option<String>,

    #[serde(
        deserialize_with = "humantime_serde::deserialize",
        default = "default_fetch_timeout"
    )]
    #[schemars(with = "Option<String>", default)]
    /// Timeout for Redis fetch commands (default: 150ms)
    pub(crate) fetch_timeout: Duration,

    #[serde(
        deserialize_with = "humantime_serde::deserialize",
        default = "default_insert_timeout"
    )]
    #[schemars(with = "Option<String>", default)]
    /// Timeout for Redis insert commands (default: 500ms)
    ///
    /// Inserts are processed asynchronously, so this will not affect response duration.
    pub(crate) insert_timeout: Duration,

    #[serde(
        deserialize_with = "humantime_serde::deserialize",
        default = "default_invalidate_timeout"
    )]
    #[schemars(with = "Option<String>", default)]
    /// Timeout for Redis invalidation commands (default: 1s)
    pub(crate) invalidate_timeout: Duration,

    #[serde(
        deserialize_with = "humantime_serde::deserialize",
        default = "default_maintenance_timeout"
    )]
    #[schemars(with = "Option<String>", default)]
    /// Timeout for Redis maintenance commands (default: 500ms)
    ///
    /// Maintenance tasks are processed asynchronously, so this will not affect response duration.
    pub(crate) maintenance_timeout: Duration,

    /// namespace used to prefix Redis keys
    pub(crate) namespace: Option<String>,

    #[serde(default)]
    /// TLS client configuration
    pub(crate) tls: Option<TlsClient>,

    #[serde(default = "default_required_to_start")]
    /// Prevents the router from starting if it cannot connect to Redis
    pub(crate) required_to_start: bool,

    #[serde(default = "default_pool_size")]
    /// The size of the Redis connection pool (default: 5)
    pub(crate) pool_size: u32,

    #[serde(
        deserialize_with = "humantime_serde::deserialize",
        default = "default_metrics_interval"
    )]
    #[schemars(with = "Option<String>", default)]
    /// Interval for collecting Redis metrics (default: 1s)
    pub(crate) metrics_interval: Duration,
}

fn default_fetch_timeout() -> Duration {
    Duration::from_millis(150)
}

fn default_insert_timeout() -> Duration {
    Duration::from_millis(500)
}

fn default_invalidate_timeout() -> Duration {
    Duration::from_secs(1)
}

fn default_maintenance_timeout() -> Duration {
    Duration::from_millis(500)
}

fn default_pool_size() -> u32 {
    5
}

impl From<&Config> for RedisCache {
    fn from(value: &Config) -> Self {
        let timeout = value
            .fetch_timeout
            .max(value.insert_timeout)
            .max(value.invalidate_timeout)
            .max(value.maintenance_timeout);
        Self {
            urls: value.urls.clone(),
            username: value.username.clone(),
            password: value.password.clone(),
            timeout,
            ttl: None,
            namespace: value.namespace.clone(),
            tls: value.tls.clone(),
            required_to_start: value.required_to_start,
            reset_ttl: false,
            pool_size: value.pool_size,
            metrics_interval: value.metrics_interval,
        }
    }
}

#[cfg(all(
    test,
    any(not(feature = "ci"), all(target_arch = "x86_64", target_os = "linux"))
))]
impl Config {
    pub(crate) fn test(clustered: bool, namespace: &str) -> Self {
        let url = if clustered {
            "redis-cluster://127.0.0.1:7000"
        } else {
            "redis://127.0.0.1:6379"
        };

        serde_json_bytes::from_value(serde_json_bytes::json!({
            "urls": [url],
            "namespace": namespace,
            "pool_size": 1,
            "required_to_start": true,
        }))
        .unwrap()
    }
}