mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
7c8bbd550b
Currently, `tunnel_test` executes all actions within the same `Instant`, i.e. time is never advanced by itself. The difficulty with advancing time compared to other actions like sending packets is that all time-related actions "overlap". In other words, all timers within connlib advance at the same time. This makes it difficult to model the expected behaviour after a certain amount of time has passed as we'd effectively need to model all timers and their relation to particular actions (like resending of connection intents or STUN requests). Instead of only advancing time by itself, we can model some aspect of it by introducing latency on network messages. This allows us to define a range of an "acceptable" network latency within everything is expected to work. Whilst this doesn't cover all failure cases, it gives us a solid foundation of parameters within which we should not expect any operational problems.
Rust development guide
Firezone uses Rust for all data plane components. This directory contains the Linux and Windows clients, and low-level networking implementations related to STUN/TURN.
We target the last stable release of Rust using rust-toolchain.toml.
If you are using rustup, that is automatically handled for you.
Otherwise, ensure you have the latest stable version of Rust installed.
Reading Client logs
The Client logs are written as JSONL for machine-readability.
To make them more human-friendly, pipe them through jq like this:
cd path/to/logs # e.g. `$HOME/.cache/dev.firezone.client/data/logs` on Linux
cat *.log | jq -r '"\(.time) \(.severity) \(.message)"'
Resulting in, e.g.
2024-04-01T18:25:47.237661392Z INFO started log
2024-04-01T18:25:47.238193266Z INFO GIT_VERSION = 1.0.0-pre.11-35-gcc0d43531
2024-04-01T18:25:48.295243016Z INFO No token / actor_name on disk, starting in signed-out state
2024-04-01T18:25:48.295360641Z INFO null