mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
847e7801f6
When the property-based state machine test was first created, I envisioned that we could also easily test advancing time. Unfortunately, the tricky part of advancing time is to correctly encode the _expected_ behaviour as it requires knowledge of all timeouts etc. Thus, the `Tick` transition has been left lingering and doesn't actually test much. It is obviously still sampled by the test runner and thus "wastes" test cases that don't end up exercising anything meaningful because the time advancements are < 1000ms. There are plans to more roughly test time-related things by implementing delays between applying `Transmit`s. Until then, we can remove the `Tick` transition.
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