infof: clearly indicate truncation #3216
Conversation
The internal buffer in infof() is limited to 2048 bytes of payload plus an additional byte for NULL termination. Servers with very long error messages can however cause truncation of the string, which currently isn't very clear, and leads to badly formatted output. This appends a "..." marker to the end of the string to clearly show that it has been truncated, and adds a mandatory newline. There are cases when infof() input doesn't require a newline, but when there is truncation of the input is probably not one of them so forcibly add it to avoid breaking the output. Also include a unittest covering infof() to try and catch any bugs introduced in this quite important function.
| * | (__| |_| | _ <| |___ | ||
| * \___|\___/|_| \_\_____| | ||
| * | ||
| * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. |
There was a problem hiding this comment.
Clearly I didn't read it carefully enough when I copy pasted, will fix the year before pushing in case this goes in.
lib/sendf.c
Outdated
| vsnprintf(print_buffer, sizeof(print_buffer), fmt, ap); | ||
| len = vsnprintf(print_buffer, sizeof(print_buffer), fmt, ap); | ||
| if(len >= sizeof(print_buffer)) | ||
| snprintf(print_buffer + (sizeof(print_buffer) - 5), 5, "...\n"); |
There was a problem hiding this comment.
I'm not a fan of magic numbers, but the alternatives didn't seem terribly appealing either. Any better suggestions?
There was a problem hiding this comment.
Not a fan either, but in this case the plain number seems like the better choice.
|
Something else: this assumes the string is newline terminated if too long, as it adds one then. Can we be sure of this? |
I was thinking that there are no legitimate usecases of a truncated string not having a trailing |
Yes. It's either that, or we make a separate function entry for non-trailing-newline use, as they're very rare in the code base. |
|
The appveyor failure is unrelated - I didn't bother to retrigger those builds. |
It was reported off-list that very large error messages garbled the output due to
infof()truncating and losing the trailing newline. This attempts to handle that gracefully, and also include a more clear indication that the output was indeed truncated.The internal buffer in
infof()is limited to 2048 bytes of payload plus an additional byte for NULL termination. Servers with very long error messages can however cause truncation of the string, which currently isn't very clear, and leads to badly formatted output.This appends a
...marker to the end of the string to clearly show that it has been truncated, and adds a mandatory newline. There are cases wheninfof()input doesn't require a newline, but when there is truncation of the input is probably not one of them so forcibly add it to avoid breaking the output.Also include a unittest covering
infof()to try and catch any bugs introduced in this quite important function.