chore: address linter issues in 04-channel, 06-solomachines, 09-localhost #6130
Conversation
bznein
requested review from
colin-axner,
AdityaSripal,
damiannolan and
chatton
as code owners
WalkthroughThe series of updates across various modules primarily focuses on enhancing type safety and error handling in the codebase. By incorporating checks for successful type assertions and improving error messages, these changes aim to make the code more robust and maintainable. This shift towards explicit error handling and type safety is a testament to the commitment to code quality and reliability. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| var clientState *ClientState | ||
| clientState, ok := clientStateI.(*ClientState) | ||
| if !ok { | ||
| panic(fmt.Errorf("cannot convert %T into %T", clientStateI, clientState)) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods Warning
| height := header.GetHeight().(clienttypes.Height) | ||
| height, ok := header.GetHeight().(clienttypes.Height) | ||
| if !ok { | ||
| panic(fmt.Errorf("cannot convert %T to %T", header.GetHeight(), &clienttypes.Height{})) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods Warning
|
Interesting findings by CodeQL, thought I'm not sure what would be the best thing to do then :) |
these were applicable even before the change, seems it couldn't find them, though 🤔 |
My guess would be that CodeQL was enabled after this file was touched last time and it only runs on modified files? Absolutely not sure though :) |
|
hm, probably. Either way, this seems safe to ignore, the panics were already a possibility before. |
| var clientState *ClientState | ||
| clientState, ok := clientStateI.(*ClientState) | ||
| if !ok { | ||
| panic(fmt.Errorf("cannot convert %T to %T", clientStateI, clientState)) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods Warning
| var consensusState *ConsensusState | ||
| consensusState, ok := consensusStateI.(*ConsensusState) | ||
| if !ok { | ||
| panic(fmt.Errorf("cannot convert %T into %T", consensusStateI, consensusState)) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods Warning
| var clientState *ClientState | ||
| clientState, ok := clientStateI.(*ClientState) | ||
| if !ok { | ||
| panic(fmt.Errorf("cannot convert %T into %T", clientStateI, clientState)) |
Check warning
Code scanning / CodeQL
Panic in BeginBock or EndBlock consensus methods Warning
| var clientState *ClientState | ||
| clientState, ok := clientStateI.(*ClientState) | ||
| if !ok { | ||
| panic(fmt.Errorf("cannot convert %T to %T", clientStateI, clientState)) |
There was a problem hiding this comment.
I guess if we wanted to avoid the panic we could return nil, false, but that's stretching maybe a bit too much the semantics of the function signature...
There was a problem hiding this comment.
I agree that nil, false would probably hide the issue. The other way would be to change the signature to return an error, but it seems this would become a much broader PR
Description
There are also a couple changes to 07-tenderming but I realized after that there are much more in that module so I'm going to do them separately.
ref: #6086
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/).godoccomments.Files changedin the GitHub PR explorer.SonarCloud Reportin the comment section below once CI passes.Summary by CodeRabbit