Ensure all strings with spaces are quoted in logs #332
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
I think the code is obvious enough here.
The problem with the stubbing is that it allows the implementation to output extra _unexpected_ stuff, in addition to what the test expects, without causing a test failure. By removing it we ensure a test will fail if unexpected stuff is output.
I couldn't see explicit tests for this stuff anywhere (some of it is indirectly tested higher up in the file).
stevenharman
approved these changes
Jan 30, 2020
The current logic covers the case when the log data is already a `String` instance, but not when the data is some other object that, when interpolated into the log string, results in a string containing spaces. The example that led me here is where an exception is logged and the exception's message contains spaces. The exception gets interpolated into the string and has `to_s` called on it. [`Exception#to_s`](https://ruby-doc.org/core-2.6.5/Exception.html#method-i-to_s) returns the message, so the message (with its spaces) go into the log line, but it's bypassed the logic that adds quotes. I used `"#{v}"` instead of `v.to_s` because it seems there is a [subtle difference in their behaviour](https://github.com/ruby/spec/blob/master/language/string_spec.rb#L147-L158), to cover the rare case where `to_s` doesn't return a string. I think we want to keep the existing behaviour here.
bensymonds
force-pushed
the
quote-more-strings
branch
from
29b6c9b to
71ad622
Compare
|
@stevenharman Thanks for the review. FYI I amended the last commit to add a changelog entry. I'm going to go ahead and merge this. I actually have another PR I want to open, but after that I'll be bugging you for a release 😄 |
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.
The current logic covers the case when the log data is already a
Stringinstance, but not when the data is some other object that, when interpolated into the log string, results in a string containing spaces.The example that led me here is where an exception is logged and the exception's message contains spaces. The exception gets interpolated into the string and has
to_scalled on it.Exception#to_sreturns the message, so the message (with its spaces) go into the log line, but it's bypassed the logic that adds quotes.See the commits for more details. I slipped in a few cleanups and added some tests too.