statsig_rust/networking/
network_client.rs

1use chrono::Utc;
2
3use super::network_error::NetworkError;
4use super::providers::get_network_provider;
5use super::{HttpMethod, NetworkProvider, RequestArgs, Response};
6use crate::networking::proxy_config::ProxyConfig;
7use crate::observability::ops_stats::{OpsStatsForInstance, OPS_STATS};
8use crate::observability::ErrorBoundaryEvent;
9use crate::sdk_diagnostics::marker::{ActionType, Marker, StepType};
10use crate::{log_d, log_i, log_w, StatsigOptions};
11use std::collections::HashMap;
12use std::sync::atomic::{AtomicBool, Ordering};
13use std::sync::{Arc, Weak};
14use std::time::Duration;
15
16const NON_RETRY_CODES: [u16; 6] = [
17    400, // Bad Request
18    403, // Forbidden
19    413, // Payload Too Large
20    405, // Method Not Allowed
21    429, // Too Many Requests
22    501, // Not Implemented
23];
24const SHUTDOWN_ERROR: &str = "Request was aborted because the client is shutting down";
25
26const TAG: &str = stringify!(NetworkClient);
27
28pub struct NetworkClient {
29    headers: HashMap<String, String>,
30    is_shutdown: Arc<AtomicBool>,
31    ops_stats: Arc<OpsStatsForInstance>,
32    net_provider: Weak<dyn NetworkProvider>,
33    disable_network: bool,
34    proxy_config: Option<ProxyConfig>,
35    silent_on_network_failure: bool,
36    disable_file_streaming: bool,
37}
38
39impl NetworkClient {
40    #[must_use]
41    pub fn new(
42        sdk_key: &str,
43        headers: Option<HashMap<String, String>>,
44        options: Option<&StatsigOptions>,
45    ) -> Self {
46        let net_provider = get_network_provider();
47        let (disable_network, proxy_config) = options
48            .map(|opts| {
49                (
50                    opts.disable_network.unwrap_or(false),
51                    opts.proxy_config.clone(),
52                )
53            })
54            .unwrap_or((false, None));
55
56        NetworkClient {
57            headers: headers.unwrap_or_default(),
58            is_shutdown: Arc::new(AtomicBool::new(false)),
59            net_provider,
60            ops_stats: OPS_STATS.get_for_instance(sdk_key),
61            disable_network,
62            proxy_config,
63            silent_on_network_failure: false,
64            disable_file_streaming: options
65                .map(|opts| opts.disable_disk_access.unwrap_or(false))
66                .unwrap_or(false),
67        }
68    }
69
70    pub fn shutdown(&self) {
71        self.is_shutdown.store(true, Ordering::SeqCst);
72    }
73
74    pub async fn get(&self, request_args: RequestArgs) -> Result<Response, NetworkError> {
75        self.make_request(HttpMethod::GET, request_args).await
76    }
77
78    pub async fn post(
79        &self,
80        mut request_args: RequestArgs,
81        body: Option<Vec<u8>>,
82    ) -> Result<Response, NetworkError> {
83        request_args.body = body;
84        self.make_request(HttpMethod::POST, request_args).await
85    }
86
87    async fn make_request(
88        &self,
89        method: HttpMethod,
90        mut request_args: RequestArgs,
91    ) -> Result<Response, NetworkError> {
92        let is_shutdown = if let Some(is_shutdown) = &request_args.is_shutdown {
93            is_shutdown.clone()
94        } else {
95            self.is_shutdown.clone()
96        };
97
98        if self.disable_network {
99            log_d!(TAG, "Network is disabled, not making requests");
100            return Err(NetworkError::DisableNetworkOn(request_args.url));
101        }
102
103        request_args.populate_headers(self.headers.clone());
104
105        if request_args.disable_file_streaming.is_none() {
106            request_args.disable_file_streaming = Some(self.disable_file_streaming);
107        }
108
109        let mut merged_headers = request_args.headers.unwrap_or_default();
110        if !self.headers.is_empty() {
111            merged_headers.extend(self.headers.clone());
112        }
113        merged_headers.insert(
114            "STATSIG-CLIENT-TIME".into(),
115            Utc::now().timestamp_millis().to_string(),
116        );
117        request_args.headers = Some(merged_headers);
118
119        // passing down proxy config through request args
120        if let Some(proxy_config) = &self.proxy_config {
121            request_args.proxy_config = Some(proxy_config.clone());
122        }
123
124        let mut attempt = 0;
125
126        loop {
127            if let Some(key) = request_args.diagnostics_key {
128                self.ops_stats.add_marker(
129                    Marker::new(key, ActionType::Start, Some(StepType::NetworkRequest))
130                        .with_attempt(attempt)
131                        .with_url(request_args.url.clone()),
132                    None,
133                );
134            }
135            if is_shutdown.load(Ordering::SeqCst) {
136                log_i!(TAG, "{}", SHUTDOWN_ERROR);
137                return Err(NetworkError::ShutdownError(request_args.url));
138            }
139
140            let mut response = match self.net_provider.upgrade() {
141                Some(net_provider) => net_provider.send(&method, &request_args).await,
142                None => {
143                    return Err(NetworkError::RequestFailed(
144                        request_args.url,
145                        None,
146                        "Failed to get a NetworkProvider instance".to_string(),
147                    ));
148                }
149            };
150
151            log_d!(
152                TAG,
153                "Response ({}): {:?}",
154                &request_args.url,
155                response.status_code
156            );
157
158            let status = response.status_code;
159            let sdk_region_str = response
160                .headers
161                .as_ref()
162                .and_then(|h| h.get("x-statsig-region"));
163            let success = (200..300).contains(&status.unwrap_or(0));
164
165            let error_message = response
166                .error
167                .clone()
168                .unwrap_or_else(|| get_error_message_for_status(status, response.data.as_mut()));
169
170            if let Some(key) = request_args.diagnostics_key {
171                let mut end_marker =
172                    Marker::new(key, ActionType::End, Some(StepType::NetworkRequest))
173                        .with_attempt(attempt)
174                        .with_url(request_args.url.clone())
175                        .with_is_success(success)
176                        .with_sdk_region(sdk_region_str.map(|s| s.to_owned()));
177
178                if let Some(status_code) = status {
179                    end_marker = end_marker.with_status_code(status_code);
180                }
181
182                let error_map = if !error_message.is_empty() {
183                    let mut map = HashMap::new();
184                    map.insert("name".to_string(), "NetworkError".to_string());
185                    map.insert("message".to_string(), error_message.clone());
186                    let status_string = match status {
187                        Some(code) => code.to_string(),
188                        None => "None".to_string(),
189                    };
190                    map.insert("code".to_string(), status_string);
191                    Some(map)
192                } else {
193                    None
194                };
195
196                if let Some(error_map) = error_map {
197                    end_marker = end_marker.with_error(error_map);
198                }
199
200                self.ops_stats.add_marker(end_marker, None);
201            }
202
203            if success {
204                return Ok(response);
205            }
206
207            if NON_RETRY_CODES.contains(&status.unwrap_or(0)) {
208                let error = NetworkError::RequestNotRetryable(
209                    request_args.url.clone(),
210                    status,
211                    error_message,
212                );
213                self.log_warning(&error, &request_args);
214                return Err(error);
215            }
216
217            if attempt >= request_args.retries {
218                let error = NetworkError::RetriesExhausted(
219                    request_args.url.clone(),
220                    status,
221                    attempt + 1,
222                    error_message,
223                );
224                self.log_warning(&error, &request_args);
225                return Err(error);
226            }
227
228            attempt += 1;
229            let backoff_ms = 2_u64.pow(attempt) * 100;
230
231            log_i!(
232                TAG, "Network request failed with status code {} (attempt {}/{}), will retry after {}ms...\n{}",
233                status.map_or("unknown".to_string(), |s| s.to_string()),
234                attempt,
235                request_args.retries + 1,
236                backoff_ms,
237                error_message
238            );
239
240            tokio::time::sleep(Duration::from_millis(backoff_ms)).await;
241        }
242    }
243
244    pub fn mute_network_error_log(mut self) -> Self {
245        self.silent_on_network_failure = true;
246        self
247    }
248
249    fn log_warning(&self, error: &NetworkError, args: &RequestArgs) {
250        let exception = error.name();
251
252        log_w!(TAG, "{}", error);
253        if !self.silent_on_network_failure {
254            let dedupe_key = format!("{:?}", args.diagnostics_key);
255            self.ops_stats.log_error(ErrorBoundaryEvent {
256                tag: TAG.to_string(),
257                exception: exception.to_string(),
258                bypass_dedupe: false,
259                info: serde_json::to_string(error).unwrap_or_default(),
260                dedupe_key: Some(dedupe_key),
261                extra: None,
262            });
263        }
264    }
265}
266
267fn get_error_message_for_status(
268    status: Option<u16>,
269    data: Option<&mut super::ResponseData>,
270) -> String {
271    if (200..300).contains(&status.unwrap_or(0)) {
272        return String::new();
273    }
274
275    let mut message = String::new();
276    if let Some(data) = data {
277        let lossy_str = data.read_to_string().unwrap_or_default();
278        if lossy_str.is_ascii() {
279            message = lossy_str.to_string();
280        }
281    }
282
283    let status_value = match status {
284        Some(code) => code,
285        None => return format!("HTTP Error None: {message}"),
286    };
287
288    let generic_message = match status_value {
289        400 => "Bad Request",
290        401 => "Unauthorized",
291        403 => "Forbidden",
292        404 => "Not Found",
293        405 => "Method Not Allowed",
294        406 => "Not Acceptable",
295        408 => "Request Timeout",
296        500 => "Internal Server Error",
297        502 => "Bad Gateway",
298        503 => "Service Unavailable",
299        504 => "Gateway Timeout",
300        0 => "Unknown Error",
301        _ => return format!("HTTP Error {status_value}: {message}"),
302    };
303
304    if message.is_empty() {
305        return generic_message.to_string();
306    }
307
308    format!("{generic_message}: {message}")
309}
statsig_rust/networking/network_client.rs

statsig_rust/networking/
network_client.rs
