Avoid panic in Itertools::format_with #108
Conversation
|
Oops didn't mean to reformat Cargo.toml. This PR is not intended to be merged anyway. |
|
I had to read it a couple of times but now it makes sense to me. I would be fine adding Would you mind implementing the fix too? |
|
Yes, I'm happy to. I have been running with that change already in an internal build and it's been fine. I just don't know how to implement a test for this problem that won't interfere with the other tests. Would you prefer I modify this PR to add the fix (and remove the test) or submit a new PR? |
|
Awesome, feel free to modify this pr |
When tracing is configured with multiple output layers, the argument to `tracing::debug!` may be evaluated multiple times. Since `Itertools::format_with` panics if `fmt` is called on it more than once, use `to_string` to materialize the value into something safe to format multiple times.
jrray
force-pushed
the
format-with-panic
branch
from
465798c to
3c50199
Compare
jrray
changed the title
PR has been updated. Let me know if it needs anything else. |
Run this new test by itself with
cargo test test_tracing.When tracing is configured with multiple output channels, it is possible for the
tracing::debug!macro to callfmtmultiple times on its arguments.format_withis documented to panic if formatted more than once. https://docs.rs/itertools/latest/itertools/trait.Itertools.html#method.format_withThe panic can be avoided by adding
.to_string()to the end of the use offormat_witharound line 569 of solver/mod.rs, but this may not be the best fix.This test sets a global default which conflicts with tracing_test, so this new test doesn't play nice with the other tests when running the whole test suite.
Edit:
Test removed and the
to_stringfix has been put in place instead.