Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: address linter findings in 07-tendermint #6136

Merged
merged 19 commits into from
Apr 15, 2024
Merged

Conversation

bznein
Copy link
Contributor

@bznein bznein commented Apr 10, 2024

Description

Addresses all linting issues that would be found in 07-tendermint by upgrading golanci-lint version (see linked issue)

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.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

  • Refactor
    • Enhanced error handling and type safety across various modules by introducing checks for successful type assertions before proceeding with operations.

Copy link
Contributor

coderabbitai bot commented Apr 10, 2024

Walkthrough

The recent updates across various light client modules in the IBC framework focus on enhancing type safety and error handling. These improvements include added checks for type assertion success and refined error management strategies, ensuring more robust and fault-tolerant client operations.

Changes

Files Change Summary
modules/light-clients/06-solomachine/solomachine_test.go, modules/light-clients/06-solomachine/store.go Improved type safety and error handling in Solomachine module by adding type assertion checks and refining error management in GetSequenceFromStore function and getClientState function.

Possibly related issues

  • IBC Tendermint minor fixes #33: The changes in this PR, which enhance error handling and type assertions, indirectly support the objective of deduplicating and optimizing code in VerifyXYZ functions by making them more robust and less prone to errors.

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 9

modules/light-clients/07-tendermint/store.go Outdated Show resolved Hide resolved
modules/light-clients/07-tendermint/store.go Outdated Show resolved Hide resolved
modules/light-clients/06-solomachine/store.go Outdated Show resolved Hide resolved
modules/light-clients/09-localhost/store.go Outdated Show resolved Hide resolved
modules/light-clients/07-tendermint/update.go Outdated Show resolved Hide resolved
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

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
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

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
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

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
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

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
Copy link
Contributor

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, wondering if it might be best to wait for Charly's PR #6074 for moving these tests over to reduce conflicts there

Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty admirable your persistence to fix all these linter errors, man. :)

We will have some merge conflicts, or linter screaming again depending on whether this PR mergers first or the ones for moving the 07-tendermint tests for client state to the light client module (this and this). Something just to keep in mind...

@bznein
Copy link
Contributor Author

bznein commented Apr 11, 2024

Pretty admirable your persistence to fix all these linter errors, man. :)

We will have some merge conflicts, or linter screaming again depending on whether this PR mergers first or the ones for moving the 07-tendermint tests for client state to the light client module (this and this). Something just to keep in mind...

Thanks! I'll keep this PR open and solve merge conflicts when those two gets merged :)

Copy link
Contributor

@charleenfei charleenfei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for keeping up with this pr @bznein!

Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

It will be nice when we eventually remove the exported.Height interface in favour of using the concrete type directly in all cases. This will remove all of these type conversions which are now in a lot of places.
The exported interface only exists due to historical reasons for avoiding import cycles within different sub pkgs in the codebase, and there is no good reason why there should exist multiple implementations of the Height type.
We have plans to remove to it soon ™️

@DimitrisJim DimitrisJim merged commit 89fdb1e into cosmos:main Apr 15, 2024
75 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants