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.

Sign up for GitHub

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

Jump to bottom

chore: address last linter findings and upgrade golanci-lint to latest version (1.57.2) #6169

Merged
merged 19 commits into from
Apr 16, 2024
Merged

chore: address last linter findings and upgrade golanci-lint to latest version (1.57.2) #6169

merged 19 commits into from
Apr 16, 2024

Conversation

bznein
Copy link
Contributor

@bznein bznein commented Apr 16, 2024 •
edited by coderabbitai bot
Loading

Description

Upgrades the version used by the lint github actions to 1.57.2 and addresses the last few findings.

closes: #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

  • Chores
    • Updated the linter tool to a newer version to enhance code quality checks.
  • Tests
    • Improved type safety in test cases by ensuring successful type assertions before usage.
  • Documentation
    • Updated workflow files to use the latest version of a code quality tool for consistency and efficiency.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 16, 2024 •
edited
Loading

Walkthrough

Walkthrough

The recent changes involve updating the golangci-lint tool to a newer version and enhancing type safety in various test files. This includes adding checks for successful type assertions to prevent potential runtime errors and ensure the code adheres to stricter linting standards.

Changes

File Path Change Summary
.github/workflows/golangci.yml Updated golangci-lint to v1.57.2, set timeout 10m
.github/workflows/callbacks.yml, .github/workflows/e2emodule.yml, .github/workflows/golangci-feature.yml, .github/workflows/wasm-client.yml Updated workflow files to use golangci/golangci-lint-action v1.57.2, minor modifications in Go Test step
modules/core/migrations/v7/genesis_test.go Modified handling of cdc variable with type assertion checks
modules/light-clients/07-tendermint/light_client_module_test.go Added type assertion checks in test functions

Assessment against linked issues

Objective Addressed Explanation
Bump golangci-lint to latest version (#6086) ✅
Address new linting errors related to type assertions (#6086) ✅

The updates successfully address the objectives from the linked issue #6086 by updating the linting tool and correcting type assertion practices as per the new linting rules.

Recent Review Details

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 4f461e3 and a67bc8c.
Files selected for processing (1)
  • modules/light-clients/08-wasm/types/types_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • modules/light-clients/08-wasm/types/types_test.go

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.

@bznein bznein marked this pull request as ready for review April 16, 2024 08:05
@bznein bznein requested a review from DimitrisJim April 16, 2024 08:44
@bznein bznein marked this pull request as draft April 16, 2024 08:59
@DimitrisJim
Copy link
Contributor

ah, 08-wasm lints. Feel free to push changes here if it would be easier for ya

github-advanced-security[bot]
github-advanced-security bot found potential problems Apr 16, 2024
View reviewed changes
modules/light-clients/08-wasm/types/store.go
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
@bznein bznein marked this pull request as ready for review April 16, 2024 10:26
@bznein bznein requested a review from srdtrk as a code owner April 16, 2024 10:26
DimitrisJim
DimitrisJim approved these changes Apr 16, 2024
View reviewed changes
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! thanks for the work on all these! ❤️

crodriguezvega
crodriguezvega approved these changes Apr 16, 2024
View reviewed changes
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.

Finally, the finish line! :) 🍾

damiannolan
damiannolan approved these changes Apr 16, 2024
View reviewed changes
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 for the cleanup! LGTM!

@DimitrisJim DimitrisJim merged commit 328aff2 into cosmos:main Apr 16, 2024
79 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DimitrisJim DimitrisJim DimitrisJim approved these changes

@crodriguezvega crodriguezvega crodriguezvega approved these changes

@damiannolan damiannolan damiannolan approved these changes

@colin-axner colin-axner Awaiting requested review from colin-axner

@AdityaSripal AdityaSripal Awaiting requested review from AdityaSripal AdityaSripal is a code owner

@chatton chatton Awaiting requested review from chatton

@charleenfei charleenfei Awaiting requested review from charleenfei

@srdtrk srdtrk Awaiting requested review from srdtrk srdtrk is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Bump golangci-lint to latest version
5 participants
@bznein @DimitrisJim @damiannolan @crodriguezvega @seay404