nautilus_finfeed/
config.rs1use nautilus_core::string::secret::SecretString;
19use serde::{Deserialize, Serialize};
20
21use crate::{http::client::FinFeedHttpConfig, instruments::FinFeedInstrumentSelection};
22
23#[derive(Debug, Clone, Serialize, Deserialize, bon::Builder)]
49#[serde(default, deny_unknown_fields)]
50#[cfg_attr(
51 feature = "python",
52 pyo3::pyclass(module = "nautilus_trader.adapters.finfeed", from_py_object)
53)]
54#[cfg_attr(
55 feature = "python",
56 pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.adapters.finfeed")
57)]
58pub struct FinFeedDataClientConfig {
59 pub api_key: Option<SecretString>,
61 #[builder(default = FinFeedHttpConfig::default())]
63 pub http: FinFeedHttpConfig,
64 #[builder(default = Vec::new())]
66 pub instruments: Vec<FinFeedInstrumentSelection>,
67 #[builder(default = FinFeedDataClientConfig::default().poll_interval_ms)]
69 pub poll_interval_ms: u64,
70 #[builder(default = FinFeedDataClientConfig::default().poll_limit)]
73 pub poll_limit: u32,
74 #[builder(default = FinFeedDataClientConfig::default().connect_timeout_secs)]
76 pub connect_timeout_secs: u64,
77}
78
79impl Default for FinFeedDataClientConfig {
80 fn default() -> Self {
81 Self {
82 api_key: None,
83 http: FinFeedHttpConfig::default(),
84 instruments: Vec::new(),
85 poll_interval_ms: 10_000,
86 poll_limit: 100,
87 connect_timeout_secs: 120,
88 }
89 }
90}
91
92#[cfg(test)]
93mod tests {
94 use rstest::rstest;
95
96 use super::*;
97
98 #[rstest]
99 fn builder_and_serde_defaults_match() {
100 let config = FinFeedDataClientConfig::default();
101 let expected = serde_json::to_value(&config).unwrap();
102 let empty = serde_json::Value::Object(serde_json::Map::new());
103 let decoded: FinFeedDataClientConfig = serde_json::from_value(empty).unwrap();
104
105 assert_eq!(config.http.timeout_secs, 300);
106 assert_eq!(config.http.retry.operation_timeout_ms, Some(330_000));
107 assert_eq!(config.http.retry.max_elapsed_ms, Some(600_000));
108 assert_eq!(
109 serde_json::to_value(FinFeedDataClientConfig::builder().build()).unwrap(),
110 expected
111 );
112 assert_eq!(serde_json::to_value(decoded).unwrap(), expected);
113 }
114
115 #[rstest]
116 fn partial_retry_override_preserves_finfeed_defaults() {
117 let value = serde_json::json!({"http": {"retry": {"max_retries": 5}}});
118 let config: FinFeedDataClientConfig = serde_json::from_value(value).unwrap();
119
120 assert_eq!(
121 serde_json::to_value(config.http.retry).unwrap(),
122 serde_json::json!({
123 "max_retries": 5,
124 "initial_delay_ms": 1000,
125 "max_delay_ms": 10000,
126 "backoff_factor": 2.0,
127 "jitter_ms": 0,
128 "operation_timeout_ms": 330000,
129 "immediate_first": false,
130 "max_elapsed_ms": 600000,
131 })
132 );
133 }
134
135 #[rstest]
136 fn retry_overrides_preserve_explicit_values_and_nulls() {
137 let retry = serde_json::json!({
138 "max_retries": 2,
139 "initial_delay_ms": 29,
140 "max_delay_ms": 53,
141 "backoff_factor": 1.5,
142 "jitter_ms": 7,
143 "operation_timeout_ms": 31000,
144 "immediate_first": true,
145 "max_elapsed_ms": 71000,
146 });
147 let value = serde_json::json!({"http": {"retry": retry}});
148 let config: FinFeedDataClientConfig = serde_json::from_value(value).unwrap();
149 assert_eq!(serde_json::to_value(config.http.retry).unwrap(), retry);
150
151 let value = serde_json::json!({"http": {"retry": {"max_elapsed_ms": null}}});
152 let config: FinFeedDataClientConfig = serde_json::from_value(value).unwrap();
153 assert_eq!(config.http.retry.max_elapsed_ms, None);
154 assert_eq!(config.http.retry.jitter_ms, 0);
155 }
156
157 #[rstest]
158 #[case(serde_json::json!({"unknown": 1}))]
159 #[case(serde_json::json!({"http": {"unknown": 2}}))]
160 #[case(serde_json::json!({"http": {"retry": {"unknown": 3}}}))]
161 #[case(serde_json::json!({"instruments": [{"exchange_id": "POLYMARKET", "market_ids": ["a_YES"], "unknown": 4}]}))]
162 fn rejects_unknown_fields(#[case] value: serde_json::Value) {
163 let error = serde_json::from_value::<FinFeedDataClientConfig>(value).unwrap_err();
164 assert!(error.to_string().contains("unknown field `unknown`"));
165 }
166}