fix(console): prevent panics if subscriber reports out-of-order times #295
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tokio-console is now at v0.1.2.
Changes duration_since and unchecked subtractions to assume Duration::ZERO (via Default) if the alternative would be a crash. If the subscriber reports nonsensical data this can result in negative Durations in console's calculations, leading to panics. This has already happened inadvertently. All changed code relates directly to received protobuf data whose validity isn't guaranteed. Relates to tokio-rs#266 (crash) and tokio-rs#289 (fix for root cause)
thombles
force-pushed
the
tk/reducing-panics
branch
from
ff48887
to
15e1618
Compare
hawkw
approved these changes
Mar 4, 2022
Comment on lines
+299
to
+303
| self.stats.total.unwrap_or_else(|| { | ||
| since | ||
| .duration_since(self.stats.created_at) | ||
| .unwrap_or_default() | ||
| }) |
There was a problem hiding this comment.
nit, take it or leave it: consider
Suggested change
| self.stats.total.unwrap_or_else(|| { | |
| since | |
| .duration_since(self.stats.created_at) | |
| .unwrap_or_default() | |
| }) | |
| self.stats | |
| .total | |
| .or_else(|| since.duration_since(self.stats.created_at).ok()) | |
| .unwrap_or_default() |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes duration_since and unchecked subtractions to assume
Duration::ZERO (via Default) if the alternative would be a crash.
If the subscriber reports nonsensical data this can result in negative
Durations in console's calculations, leading to panics. This has already
happened inadvertently. All changed code relates directly to received
protobuf data whose validity isn't guaranteed.
Relates to #266 (crash) and #289 (fix for root cause)
There are a handful of other unwraps/expects I'm not so sure about. These ones looked like pretty clear-cut cases where panicking is possible, undesirable, and clamping to zero is a reasonable response.