Propagate additional safety information #2230
Merged
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
Generate changelog in
|
|
Released 4.117.0 |
This was referenced Apr 27, 2022
Merged
This was referenced Apr 27, 2022
bulldozer-bot bot
pushed a commit
to palantir/witchcraft-api
that referenced
this pull request
Apr 27, 2022
###### _excavator_ is a bot for automating changes across repositories. Changes produced by the roomba/latest-baseline-oss check. # Release Notes ## 4.117.0 | Type | Description | Link | | ---- | ----------- | ---- | | Improvement | Propagate additional safety information in the `SafeLoggingPropagation` check and automated fixes:<br>1. Method return statements are analyzed to determine safety of unmarked methods<br>2. Types are annotated based on the safety of their `toString` method, which is a reasonable heuristic for value types that may be logged. | palantir/gradle-baseline#2230 | To enable or disable this check, please contact the maintainers of Excavator.
This was referenced Apr 27, 2022
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.
==COMMIT_MSG==
Propagate additional safety information in the
SafeLoggingPropagationcheck and automated fixes:toStringmethod, which is a reasonable heuristic for value types that may be logged.==COMMIT_MSG==
These two checks work together nicely when types define a
toString: the inputs to the toString (assuming string concatenation, we haven't implemented anything special for StringBuilder accumulation) are combined into an annotation on the toString method, which is applied at the type level in the next run.Possible downsides?
This may result in a lot of annotations.
Our automation can restrict safety, but i never eases safety -- we can mark a method
@Unsafeor@DoNotLog, but never@Safe.