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 linting issues in apps/ #6117

Merged
merged 9 commits into from
Apr 9, 2024
Merged

chore: Address linting issues in apps/ #6117

merged 9 commits into from
Apr 9, 2024

Conversation

bznein
Copy link
Contributor

@bznein bznein commented Apr 8, 2024

Description

Addresses linting issues (mostly unchecked type assertions and redundant imports) in apps.

In a specific case (inside modules/apps/callbacks/testing/simapp/app.go) I had to add panic as we don't return errors from there and we are not within a testing environment. But I'm open to more complex refactoring if we want to more gracefully handle these cases.

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 type assertion checks and error handling in various test suites to improve reliability.
    • Simplified import statements across several modules for better code readability.
  • Bug Fixes
    • Adjusted logic for service skipping based on annotations, ensuring correct behavior in specific scenarios.

Copy link
Contributor

coderabbitai bot commented Apr 8, 2024

Walkthrough

This collection of changes primarily focuses on refining the import paths, enhancing type assertion checks, and improving error handling across various modules within the interchain accounts and fee middleware. The adjustments aim to streamline codebase maintainability, ensure type safety, and optimize the testing framework by addressing specific technical nuances.

Changes

Files Change Summary
.../controller/ibc_middleware_test.go
.../29-fee/ibc_middleware_test.go
.../callbacks/ibc_middleware_test.go
Added type assertion checks and error handling in test functions.
.../controller/migrations/v6/migrations_test.go
.../callbacks/types/callbacks_test.go
.../transfer/types/transfer_authorization_test.go
Modified import paths to remove explicit versions or correct them.
.../host/keeper/keeper.go Enhanced logic for handling "cosmos.msg.v1.service" annotated services with boolean conversion.
.../types/keys_test.go
.../types/router.go
.../callbacks/testing/simapp/app.go
Simplified or updated import statements and added error handling for type assertions.

Possibly related issues

  • Testing improvements for working with multiple go mods #4527: The enhancements in testing flexibility, particularly the added error handling and refined import paths, align with the issue's objectives to improve the testing setup and modularity. This PR's focus on optimizing the testing framework could contribute to achieving more modular and efficient testing as outlined in the issue.

🐇✨
In the realm of code, where logic intertwines,
A rabbit hopped through, refining the lines.
With a twitch of its nose, errors caught in a glance,
Paths now uncluttered, the imports enhanced.
In tests, assertions checked, with care so profound,
Ensuring that safety and clarity abound.
🌟📜
So here's to the changes, both big and small,
A hop towards progress, celebrated by all.

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: 5

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 65f0ec7 and 1e108eb.
Files selected for processing (11)
  • modules/apps/27-interchain-accounts/controller/ibc_middleware_test.go (1 hunks)
  • modules/apps/27-interchain-accounts/controller/migrations/v6/migrations_test.go (1 hunks)
  • modules/apps/27-interchain-accounts/host/keeper/keeper.go (1 hunks)
  • modules/apps/27-interchain-accounts/types/keys_test.go (1 hunks)
  • modules/apps/27-interchain-accounts/types/router.go (1 hunks)
  • modules/apps/29-fee/ibc_middleware_test.go (1 hunks)
  • modules/apps/callbacks/callbacks_test.go (1 hunks)
  • modules/apps/callbacks/ibc_middleware_test.go (3 hunks)
  • modules/apps/callbacks/testing/simapp/app.go (4 hunks)
  • modules/apps/callbacks/types/callbacks_test.go (1 hunks)
  • modules/apps/transfer/types/transfer_authorization_test.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • modules/apps/27-interchain-accounts/types/keys_test.go
Additional comments not posted (10)
modules/apps/27-interchain-accounts/controller/migrations/v6/migrations_test.go (1)

11-11: The import path adjustment to remove the explicit version reference is a good practice for maintainability, ensuring that future version updates are handled more gracefully.

modules/apps/27-interchain-accounts/host/keeper/keeper.go (1)

291-298: The added logic for handling the "cosmos.msg.v1.service" option by converting the extension value to a boolean and checking its value is correctly implemented. This ensures that services annotated with this option are appropriately skipped, enhancing the module's flexibility and adherence to specifications.

modules/apps/27-interchain-accounts/controller/ibc_middleware_test.go (1)

1158-1160: Adding a type assertion check for porttypes.ICS4Wrapper enhances the safety of the code by ensuring the object is of the expected type before proceeding. This is a good practice to prevent runtime panics due to failed type assertions.

modules/apps/callbacks/testing/simapp/app.go (5)

70-70: Updated import path for consensus package looks correct.


121-121: Updated import path for transfer package looks correct.


514-517: Adding a check for the success of the type assertion with ok is a good practice to prevent potential runtime panics.


539-542: Adding a check for the success of the type assertion with ok is a good practice to prevent potential runtime panics.


530-545: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-542]

Ensure comprehensive testing of the changes to verify that the updated import paths and added type assertion checks do not introduce any regressions or unexpected behavior.

modules/apps/29-fee/ibc_middleware_test.go (2)

1547-1555: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1554-1559]

Ensure consistent error handling across tests.

Consider using a consistent approach for error handling in test cases. For instance, using suite.Require().NoError(err) consistently can improve readability and maintainability.


Line range hint 1561-1565: Validate the use of custom error messages for better clarity.

Using custom error messages, as done here, enhances the clarity of test failures. This practice could be applied consistently across all tests for improved debugging and readability.

@@ -8,7 +8,7 @@ import (
"github.com/cometbft/cometbft/crypto/secp256k1"

"github.com/cosmos/ibc-go/modules/apps/callbacks/types"
transfer "github.com/cosmos/ibc-go/v8/modules/apps/transfer"
"github.com/cosmos/ibc-go/v8/modules/apps/transfer"
Copy link
Contributor

Choose a reason for hiding this comment

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

Update import path to use the correct version.

-	"github.com/cosmos/ibc-go/v8/modules/apps/transfer"
+	"github.com/cosmos/ibc-go/modules/apps/transfer"

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
"github.com/cosmos/ibc-go/v8/modules/apps/transfer"
"github.com/cosmos/ibc-go/modules/apps/transfer"

modules/apps/callbacks/ibc_middleware_test.go Show resolved Hide resolved
modules/apps/callbacks/ibc_middleware_test.go Show resolved Hide resolved
modules/apps/callbacks/ibc_middleware_test.go Show resolved Hide resolved
modules/apps/29-fee/ibc_middleware_test.go Show resolved Hide resolved
modules/apps/callbacks/testing/simapp/app.go Outdated Show resolved Hide resolved
app.ICAAuthModule = icaControllerStack.(ibcmock.IBCModule)
app.ICAAuthModule, ok = icaControllerStack.(ibcmock.IBCModule)
if !ok {
panic("Can't convert icaControllerStack to IBCModule")
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto

icaICS4Wrapper := icaControllerStack.(porttypes.ICS4Wrapper)
icaICS4Wrapper, ok := icaControllerStack.(porttypes.ICS4Wrapper)
if !ok {
panic("Can't convert icaControllerStack to ICS4Wrapper")
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto

@bznein bznein requested a review from DimitrisJim April 9, 2024 08:31
Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

LGTM

@chatton chatton merged commit 9543cc6 into cosmos:main Apr 9, 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.

4 participants