chore: add linter enforcing static WithSourceErrorf format strings - #3248
Open
ivanauth wants to merge 1 commit into
Open
chore: add linter enforcing static WithSourceErrorf format strings#3248ivanauth wants to merge 1 commit into
ivanauth wants to merge 1 commit into
Conversation
A dynamic string in the format position of dslNode.WithSourceErrorf is interpreted as a format string, so any '%' it contains produces a malformed error. The new staticformatcheck analyzer requires the format argument to be a compile-time constant. Signed-off-by: ivanauth <ivan@authzed.com>
github-actions
Bot
added
the
area/tooling
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #2124
A dynamic string in the format position of dslNode.WithSourceErrorf is read as a format string, so any
%it contains yields a malformed error. Adds a staticformatcheck analyzer (wired into the analyzers cmd/CI) requiring that argument to be a compile-time constant.Follow-up: sibling dslNode.Errorf has the same issue, but the analyzer matches by name only, so covering it needs type-scoped matching (would else collide with fmt.Errorf et al.).