cf-mach 0.2.2

Network quality measurement CLI for latency, throughput, packet loss, and responsiveness
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

// Copyright (c) 2023-2024 Cloudflare, Inc.
// Licensed under the BSD-3-Clause license found in the LICENSE file or at https://opensource.org/licenses/BSD-3-Clause

use std::sync::Arc;

use crate::nq_core::{Network, Time, TokioTime};
use crate::nq_latency::{Latency, LatencyConfig, LatencyResult};
use crate::nq_tokio_network::TokioNetwork;
use anyhow::Context;
use tokio_util::sync::CancellationToken;
use tracing::info;

use crate::util::pretty_secs_to_ms;

pub async fn run(url: String, runs: usize) -> anyhow::Result<()> {
    info!("measuring rtt with {runs} runs against {url}");

    if runs == 0 {
        anyhow::bail!("latency runs must be >= 1");
    }

    let result = run_test(&LatencyConfig {
        url: url.parse()?,
        runs,
        scoped_headers: crate::access::cf_access_scoped_headers()?,
    })
    .await?;

    let latency_ms = result
        .median()
        .map(pretty_secs_to_ms)
        .context("no measurements found, median rtt is null")?;

    let jitter_ms = result.jitter().map(pretty_secs_to_ms).unwrap_or(0.0);

    let json = serde_json::json!({
        "jitter_ms": jitter_ms,
        "latency_ms": latency_ms,
    });

    println!("{:#}", json);

    Ok(())
}

pub async fn run_test(config: &LatencyConfig) -> anyhow::Result<LatencyResult> {
    let shutdown = CancellationToken::new();
    let time = Arc::new(TokioTime::new()) as Arc<dyn Time>;
    let network =
        Arc::new(TokioNetwork::new(Arc::clone(&time), shutdown.clone())) as Arc<dyn Network>;

    let rtt = Latency::new(config.clone());
    let results = rtt.run_test(network, time, shutdown).await?;

    Ok(results)
}