Reformat log statements so that they aren't susceptible to formatting errors and worse when {} are in the message #1084
+642
−872
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1084 +/- ##
============================================
+ Coverage 80.66% 80.75% +0.08%
+ Complexity 2893 2838 -55
============================================
Files 383 383
Lines 14361 14349 -12
Branches 989 988 -1
============================================
+ Hits 11584 11587 +3
+ Misses 2184 2167 -17
- Partials 593 595 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
… errors and worse when {} could end up directly in the 'message' string.
I tried to codify on a couple of standards as well.
1) setMessage(Supplier...) should not be used. Placeholders and arguments should always be used instead.
2) All arguments being added should use a supplier if the argument requires any evaluation of a function. To confirm, the regex `.addArgument\([^\(\)]+\([^\)]*` shouldn't found present.
On stylistic levels
3) The sequence of fluent/builder operations should be setCause, setMessage, addArguments...
4) If more than one argument is added, each argument should be on a separate line, followed by a log() also on its own line.
Signed-off-by: Greg Schohn <greg.schohn@gmail.com>
gregschohn
force-pushed
the
LogFormatFixes
branch
from
8ebd9f8
to
99d5290
Compare
… in an earlier commit Signed-off-by: Greg Schohn <greg.schohn@gmail.com>
gregschohn
requested review from
AndreKurait,
chelma,
lewijacn,
mikaylathompson,
peternied and
sumobrian
as code owners
gregschohn
changed the title
gregschohn
changed the title
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.
Description
[Describe what this change achieves]
Issues Resolved
[List any issues this PR will resolve]
Is this a backport? If so, please add backport PR # and/or commits #
Testing
[Please provide details of testing done: unit testing, integration testing and manual testing]
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.