Keep calm and don't panic: enable and apply forcetypeassert lint rules #522
+79
−19
Conversation
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
Signed-off-by: Furkan <furkan.turkal@trendyol.com>
dlorenc
reviewed
Jun 23, 2022
| @@ -309,7 +323,7 @@ func (h hashivaultClient) verify(sig, digest []byte, alg crypto.Hash, opts ...si | |||
|
|
|||
| isValid, ok := valid.(bool) | |||
| if !ok { | |||
| return fmt.Errorf("data type assertion for field `valid` failed: %T %#v", valid.(bool), valid.(bool)) | |||
| return fmt.Errorf("received non-bool value from 'valid' key") | |||
There was a problem hiding this comment.
should we use something like %T to still get the type or %s to attempt to stringify it?
There was a problem hiding this comment.
Reproduced the same case on playground, and it threw panic for the valid.(bool) casting: https://go.dev/play/p/-rCmjQsK0e8
But works well if we just use
fmt.Printf("%T %#v", valid, valid)I can change all type assert errors to get their types %T and stringify %#v but I'm not sure if they are safe to print the entire content to stdout in vault client. 🤔
dlorenc
approved these changes
Jun 28, 2022
mtrmac
pushed a commit
to mtrmac/sigstore
that referenced
this pull request
Mar 10, 2023
* sigstore#522 set Created date to time of execution Signed-off-by: Tobias Trabelsi <lerentis@uploadfilter24.eu> * sigstore#522 added check to only sign if previous date was zero and added date change to files as well Signed-off-by: Tobias Trabelsi <tobias.trabelsi@dbschenker.com> * added unit tests and removed log entry Signed-off-by: Tobias Trabelsi <tobias.trabelsi@dbschenker.com> * sigstore#522 review feedback Signed-off-by: Tobias Trabelsi <tobias.trabelsi@dbschenker.com> * sigstore#522 Apply suggestions from code review Co-authored-by: Jason Hall <jason@chainguard.dev> Signed-off-by: Tobias Trabelsi <tobias.trabelsi@dbschenker.com> * sigstore#522 additional nil check Signed-off-by: Tobias Trabelsi <tobias.trabelsi@dbschenker.com> Co-authored-by: Tobias Trabelsi <tobias.trabelsi@dbschenker.com> Co-authored-by: Jason Hall <jason@chainguard.dev>
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.
Signed-off-by: Furkan furkan.turkal@trendyol.com
Summary
I was playing with Vault KMS and hit two different panic cases. And both of are actually casting error:
I'm not so sure which cases caused this problem. So I thought It would be nice to have a forcetypeassert analyzer in the golangci-lint.
I also had to remove the following line because forcetypeassert still complains about:
type assertion must be checkedI could have passed a
//nolinter:but I thought in both cases the following above throws panic, right? @blz-eaTicket Link
Fixes
Release Note