mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
da296038b9
I noticed we sometimes have a flaky integration test with an ICE timeout in its logs. For example: https://github.com/firezone/firezone/actions/runs/10278933741/job/28443578376 Analyzing this one more closely turned out to be caused by a race condition between client and gateway, when they exchange their ICE candidates. We send ICE candidates in batches but because they are serialized to strings early, their ordering actually depends on the so-called "foundation" of the ICE candidates. that one is simply a hash of several components. As a result, the ordering of these candidates can vary between test runs. We should try ICE candidates in order of their reverse-priority (i.e. best first). By introducing a helper-collection, we can enforce this ordering before sending ICE candidates across.
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