0a14d72646
In #9656, we already tried to fix the pipelining of messages to the portal. Unfortunately, a bug was introduced in a last-minute refactoring where we would _only_ send messages while we were joining a room. Due a 2nd bug where we weren't actually processing the room join replies correctly, this didn't matter so the PR was effectively a no-op and didn't change any behaviour. Further investigation of the code surfaced additional problems. For one, we were not re-queuing the message into the correct buffer. Two, we were only flushing after sending a message. To fix both of these, we move the flushing out of the message sending branch completely and duplicate some of the code for sending messages in order to correctly handle join requests before other messages. Finally, join requests have an _empty_ payload and are therefore processed in a different branch. By moving the checking for the replies of join requests, we can correctly update the state and continue sending messages once the join is successful. Resolves: #9647
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
Benchmarking on Linux
The recommended way for benchmarking any of the Rust components is Linux' perf utility.
For example, to attach to a running application, do:
- Ensure the binary you are profiling is compiled with the
releaseprofile. sudo perf record -g --freq 10000 --pid $(pgrep <your-binary>).- Run the speed test or whatever load-inducing task you want to measure.
sudo perf script > profile.perf- Open profiler.firefox.com and load
profile.perf
Instead of attaching to a process with --pid, you can also specify the path to executable directly.
That is useful if you want to capture perf data for a test or a micro-benchmark.