netspeed-cli 0.10.1

Command-line interface for testing internet bandwidth using speedtest.net
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
#![allow(
    clippy::cast_precision_loss,
    clippy::cast_possible_truncation,
    clippy::cast_sign_loss
)]

use crate::endpoints::ServerEndpoints;
use crate::error::Error;
use crate::test_config::TestConfig;
use crate::types::Server;
use quick_xml::de::from_str;
use reqwest::Client;
use serde::Deserialize;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};

/// Root element for the Speedtest.net servers XML response
/// XML structure: <settings><servers><server .../></servers></settings>
#[derive(Debug, Clone, Deserialize)]
#[serde(rename = "settings")]
struct ServerConfig {
    #[serde(rename = "servers")]
    servers_wrapper: ServersWrapper,
}

/// Wrapper for the list of servers (maps to <servers> element)
#[derive(Debug, Clone, Deserialize)]
struct ServersWrapper {
    #[serde(rename = "server", default)]
    servers: Vec<Server>,
}

const SPEEDTEST_SERVERS_URL: &str = "https://www.speedtest.net/speedtest-servers-static.php";
const SPEEDTEST_CONFIG_URL: &str = "https://www.speedtest.net/api/ios-config.php";

/// Calculate distance between two geographic points using Haversine formula.
///
/// # Examples
///
/// ```
/// # use netspeed_cli::servers::calculate_distance;
/// let dist = calculate_distance(40.7128, -74.0060, 34.0522, -118.2437);
/// assert!((dist - 3944.0).abs() < 200.0); // ~3944 km, NYC to LA
/// ```
#[must_use]
pub fn calculate_distance(lat1: f64, lon1: f64, lat2: f64, lon2: f64) -> f64 {
    const EARTH_RADIUS_KM: f64 = 6371.0;

    let lat1_rad = lat1.to_radians();
    let lat2_rad = lat2.to_radians();
    let delta_lat = (lat2 - lat1).to_radians();
    let delta_lon = (lon2 - lon1).to_radians();

    let a = (delta_lat / 2.0).sin().powi(2)
        + lat1_rad.cos() * lat2_rad.cos() * (delta_lon / 2.0).sin().powi(2);
    let c = 2.0 * a.sqrt().atan2((1.0 - a).sqrt());

    EARTH_RADIUS_KM * c
}

/// Client location data from the speedtest.net config API.
///
/// This struct mirrors the client element from the speedtest.net iOS config API.
/// It contains geographic coordinates and optional location metadata.
#[derive(Debug, Clone, Deserialize, Default)]
struct ClientConfig {
    #[serde(rename = "client", default)]
    client: ClientInfo,
}

/// Client information from the speedtest.net config API.
#[derive(Debug, Clone, Deserialize, Default)]
struct ClientInfo {
    #[serde(rename = "@lat", default)]
    lat: Option<f64>,
    #[serde(rename = "@lon", default)]
    lon: Option<f64>,
    #[serde(rename = "@city", default)]
    city: Option<String>,
    #[serde(rename = "@country", default)]
    country: Option<String>,
}

/// Fetch client location from speedtest.net config API.
///
/// Returns a [`crate::types::ClientLocation`] with coordinates and optional
/// city/country information from the speedtest.net iOS config endpoint.
///
/// # Errors
///
/// Returns [`Error::Context`] if the response cannot be parsed or coordinates
/// are missing.
pub async fn fetch_client_location(client: &Client) -> Result<crate::types::ClientLocation, Error> {
    let response = client
        .get(SPEEDTEST_CONFIG_URL)
        .send()
        .await?
        .text()
        .await?;

    let config: ClientConfig = from_str(&response)?;

    match (config.client.lat, config.client.lon) {
        (Some(lat), Some(lon)) => Ok(crate::types::ClientLocation {
            lat,
            lon,
            city: config.client.city,
            country: config.client.country,
        }),
        _ => Err(Error::Context {
            msg: "Could not parse client location from config".to_string(),
            source: None,
        }),
    }
}

/// Fetch the list of available speedtest servers, sorted by distance.
///
/// Also returns the client location if available, so callers don't need
/// to make a separate API call.
///
/// # Errors
///
/// Returns [`Error::NetworkError`] if fetching the server list fails.
/// Returns [`Error::DeserializeXml`] if the XML response cannot be parsed.
pub async fn fetch(
    client: &Client,
) -> Result<(Vec<Server>, Option<crate::types::ClientLocation>), Error> {
    let client_location = match fetch_client_location(client).await {
        Ok(loc) => Some(loc),
        Err(ref e) => {
            eprintln!(
                "Warning: could not determine client location ({e}), using default (equator)"
            );
            None
        }
    };

    // Use 0,0 as default if location fetch failed
    let (client_lat, client_lon) = client_location
        .as_ref()
        .map_or((0.0, 0.0), |loc| (loc.lat, loc.lon));

    let response = client
        .get(SPEEDTEST_SERVERS_URL)
        .send()
        .await?
        .text()
        .await?;

    let server_config: ServerConfig = from_str(&response)?;

    let mut servers = server_config.servers_wrapper.servers;
    for server in &mut servers {
        server.distance = calculate_distance(client_lat, client_lon, server.lat, server.lon);
    }

    // Sort by distance so closest servers are first
    servers.sort_by(|a, b| {
        a.distance
            .partial_cmp(&b.distance)
            .unwrap_or(std::cmp::Ordering::Equal)
    });

    Ok((servers, client_location))
}

/// Select the best server from a list, preferring the closest by distance.
///
/// # Errors
///
/// Returns [`Error::ServerNotFound`] if the server list is empty.
pub fn select_best_server(servers: &[Server]) -> Result<Server, Error> {
    if servers.is_empty() {
        return Err(Error::ServerNotFound("No servers available".to_string()));
    }

    // Select server with lowest distance (closest)
    let best = servers
        .iter()
        .min_by(|a, b| {
            a.distance
                .partial_cmp(&b.distance)
                .unwrap_or(std::cmp::Ordering::Equal)
        })
        .cloned()
        .ok_or_else(|| Error::ServerNotFound("No servers available".to_string()))?;

    Ok(best)
}

/// Run a ping test against the given server, returning (average latency, jitter, `packet_loss`%, `individual_samples`).
///
/// # Errors
///
/// Returns [`Error::NetworkError`] if all ping attempts fail.
pub async fn ping_test(
    client: &Client,
    server: &Server,
) -> Result<(f64, f64, f64, Vec<f64>), Error> {
    let config = TestConfig::default();
    let ping_attempts = config.ping_attempts;
    let mut latencies = Vec::new();

    // Perform multiple ping measurements
    for _ in 0..ping_attempts {
        let start = std::time::Instant::now();

        let response = client
            .get(ServerEndpoints::from_server_url(&server.url).latency())
            .send()
            .await;

        let elapsed = start.elapsed().as_secs_f64() * 1000.0; // Convert to ms
        if let Ok(resp) = response {
            if resp.status().is_success() {
                latencies.push(elapsed);
            }
        }
    }

    // Calculate average latency
    if latencies.is_empty() {
        return Err(Error::Context {
            msg: "All ping attempts failed".to_string(),
            source: None,
        });
    }

    // Safe: len() is at most PING_ATTEMPTS (8), well under 2^53.
    let avg = latencies.iter().sum::<f64>() / latencies.len() as f64;

    // Calculate jitter (average of absolute differences between consecutive latencies)
    let jitter = if latencies.len() > 1 {
        let mut jitter_sum = 0.0;
        for i in 1..latencies.len() {
            jitter_sum += (latencies[i] - latencies[i - 1]).abs();
        }
        // Safe: len() is at most PING_ATTEMPTS (8).
        jitter_sum / (latencies.len() - 1) as f64
    } else {
        0.0
    };

    // Calculate packet loss percentage
    // Safe: both operands are at most PING_ATTEMPTS (8), tiny values.
    let packet_loss = ((ping_attempts - latencies.len()) as f64 / ping_attempts as f64) * 100.0;

    Ok((avg, jitter, packet_loss, latencies))
}

pub async fn measure_latency_under_load(
    client: Client,
    server_url: String,
    samples: Arc<std::sync::Mutex<Vec<f64>>>,
    stop: Arc<AtomicBool>,
) {
    let config = TestConfig::default();
    let poll_interval = config.latency_poll_interval_ms;

    while !stop.load(Ordering::Acquire) {
        let start = std::time::Instant::now();
        let response = client
            .get(ServerEndpoints::from_server_url(&server_url).latency())
            .send()
            .await;

        if let Ok(resp) = response {
            if resp.status().is_success() {
                let elapsed = start.elapsed().as_secs_f64() * 1000.0;
                if let Ok(mut lock) = samples.lock() {
                    lock.push(elapsed);
                }
            }
        }

        tokio::time::sleep(std::time::Duration::from_millis(poll_interval)).await;
    }
}

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

    #[test]
    fn test_select_best_server() {
        let servers = vec![
            Server {
                id: "1".to_string(),
                url: "http://server1.com".to_string(),
                name: "Far Server".to_string(),
                sponsor: "ISP 1".to_string(),
                country: "US".to_string(),
                lat: 40.0,
                lon: -74.0,
                distance: 5000.0,
            },
            Server {
                id: "2".to_string(),
                url: "http://server2.com".to_string(),
                name: "Close Server".to_string(),
                sponsor: "ISP 2".to_string(),
                country: "US".to_string(),
                lat: 41.0,
                lon: -73.0,
                distance: 100.0,
            },
        ];

        let best = select_best_server(&servers).unwrap();
        assert_eq!(best.id, "2");
        assert!((best.distance - 100.0).abs() < f64::EPSILON);
    }

    #[test]
    fn test_select_best_server_empty() {
        let servers: Vec<Server> = vec![];
        let result = select_best_server(&servers);
        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), Error::ServerNotFound(_)));
    }

    #[test]
    fn test_select_best_server_single() {
        let servers = vec![Server {
            id: "1".to_string(),
            url: "http://server1.com".to_string(),
            name: "Only Server".to_string(),
            sponsor: "ISP".to_string(),
            country: "US".to_string(),
            lat: 40.0,
            lon: -74.0,
            distance: 500.0,
        }];

        let best = select_best_server(&servers).unwrap();
        assert_eq!(best.id, "1");
    }

    #[test]
    fn test_server_distance_comparison() {
        let servers = vec![
            Server {
                id: "1".to_string(),
                url: "http://server1.com".to_string(),
                name: "Server 1".to_string(),
                sponsor: "ISP".to_string(),
                country: "US".to_string(),
                lat: 40.0,
                lon: -74.0,
                distance: 300.0,
            },
            Server {
                id: "2".to_string(),
                url: "http://server2.com".to_string(),
                name: "Server 2".to_string(),
                sponsor: "ISP".to_string(),
                country: "US".to_string(),
                lat: 41.0,
                lon: -73.0,
                distance: 200.0,
            },
            Server {
                id: "3".to_string(),
                url: "http://server3.com".to_string(),
                name: "Server 3".to_string(),
                sponsor: "ISP".to_string(),
                country: "US".to_string(),
                lat: 42.0,
                lon: -72.0,
                distance: 100.0,
            },
        ];

        let best = select_best_server(&servers).unwrap();
        assert_eq!(best.id, "3");
    }

    #[test]
    fn test_server_with_equal_distances() {
        let servers = vec![
            Server {
                id: "1".to_string(),
                url: "http://server1.com".to_string(),
                name: "Server 1".to_string(),
                sponsor: "ISP".to_string(),
                country: "US".to_string(),
                lat: 40.0,
                lon: -74.0,
                distance: 100.0,
            },
            Server {
                id: "2".to_string(),
                url: "http://server2.com".to_string(),
                name: "Server 2".to_string(),
                sponsor: "ISP".to_string(),
                country: "US".to_string(),
                lat: 41.0,
                lon: -73.0,
                distance: 100.0,
            },
        ];

        let best = select_best_server(&servers).unwrap();
        // Should return one of the servers with equal distance
        assert!(best.id == "1" || best.id == "2");
    }

    #[test]
    fn test_ping_test_average_calculation() {
        let latencies = [10.0, 20.0, 15.0, 25.0];
        let avg = latencies.iter().sum::<f64>() / latencies.len() as f64;
        assert!((avg - 17.5).abs() < f64::EPSILON);
    }

    #[test]
    fn test_ping_test_empty_handling() {
        let latencies: Vec<f64> = vec![];
        assert!(latencies.is_empty());
    }

    #[test]
    fn test_calculate_distance_same_location() {
        let dist = calculate_distance(40.7128, -74.0060, 40.7128, -74.0060);
        assert!(dist < 0.01);
    }

    #[test]
    fn test_calculate_distance_nyc_la() {
        let dist = calculate_distance(40.7128, -74.0060, 34.0522, -118.2437);
        assert!((dist - 3944.0).abs() < 200.0);
    }

    #[test]
    fn test_calculate_distance_nyc_london() {
        let dist = calculate_distance(40.7128, -74.0060, 51.5074, -0.1278);
        assert!((dist - 5570.0).abs() < 300.0);
    }

    #[test]
    fn test_client_config_deserialization() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<settings>
    <client lat="40.7128" lon="-74.0060" ip="192.168.1.1" />
</settings>"#;
        let config: ClientConfig = from_str(xml).unwrap();
        assert_eq!(config.client.lat, Some(40.7128));
        assert_eq!(config.client.lon, Some(-74.0060));
    }

    #[test]
    fn test_client_config_missing_coords() {
        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
<settings>
    <client ip="192.168.1.1" />
</settings>"#;
        let config: ClientConfig = from_str(xml).unwrap();
        assert!(config.client.lat.is_none());
        assert!(config.client.lon.is_none());
    }

    #[test]
    fn test_calculate_distance_sydney_tokyo() {
        let dist = calculate_distance(-33.8688, 151.2093, 35.6762, 139.6503);
        assert!((dist - 7823.0).abs() < 300.0);
    }

    #[test]
    fn test_calculate_distance_opposite_sides() {
        // NYC to Sydney (roughly opposite sides of Earth)
        let dist = calculate_distance(40.7128, -74.0060, -33.8688, 151.2093);
        assert!(dist > 15_000.0); // Should be a very long distance
    }

    #[test]
    fn test_calculate_distance_equator() {
        // Points on the equator
        let dist = calculate_distance(0.0, 0.0, 0.0, 10.0);
        assert!((dist - 1111.0).abs() < 100.0); // ~1111 km per 10 degrees at equator
    }

    #[test]
    fn test_server_config_deserialization() {
        let xml = r#"<?xml version="1.0"?>
<settings>
    <servers>
        <server url="http://server1.com/speedtest/upload.php" name="Server 1" sponsor="ISP 1" country="US" id="1" lat="40.0" lon="-74.0" />
        <server url="http://server2.com/speedtest/upload.php" name="Server 2" sponsor="ISP 2" country="CA" id="2" lat="43.0" lon="-79.0" />
    </servers>
</settings>"#;
        let config: ServerConfig = from_str(xml).unwrap();
        assert_eq!(config.servers_wrapper.servers.len(), 2);
        assert_eq!(config.servers_wrapper.servers[0].id, "1");
        assert_eq!(config.servers_wrapper.servers[1].country, "CA");
    }

    #[test]
    fn test_server_distance_comparison_with_negative_coords() {
        // Test with servers in different hemispheres
        let servers = vec![
            Server {
                id: "1".to_string(),
                url: "http://server1.com".to_string(),
                name: "Southern".to_string(),
                sponsor: "ISP".to_string(),
                country: "AU".to_string(),
                lat: -33.8688,
                lon: 151.2093,
                distance: 15_000.0,
            },
            Server {
                id: "2".to_string(),
                url: "http://server2.com".to_string(),
                name: "Northern".to_string(),
                sponsor: "ISP".to_string(),
                country: "US".to_string(),
                lat: 40.7128,
                lon: -74.0060,
                distance: 100.0,
            },
        ];

        let best = select_best_server(&servers).unwrap();
        assert_eq!(best.id, "2"); // Northern is closer
    }

    #[test]
    fn test_servers_wrapper_empty_deserialization() {
        let xml = r#"<?xml version="1.0"?>
<settings>
    <servers>
    </servers>
</settings>"#;
        let config: ServerConfig = from_str(xml).unwrap();
        assert!(config.servers_wrapper.servers.is_empty());
    }
}