chore: Address linting issues in apps/ #6117
Conversation
bznein
requested review from
colin-axner,
AdityaSripal,
damiannolan,
srdtrk,
chatton and
charleenfei
as code owners
WalkthroughThis 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
Possibly related issues
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}
There was a problem hiding this comment.
Actionable comments posted: 5
Review Status
Configuration used: CodeRabbit UI
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 forporttypes.ICS4Wrapperenhances 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 forconsensuspackage looks correct.
121-121: Updated import path fortransferpackage looks correct.
514-517: Adding a check for the success of the type assertion withokis a good practice to prevent potential runtime panics.
539-542: Adding a check for the success of the type assertion withokis a good practice to prevent potential runtime panics.
530-545: > 📝 NOTEThis 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: > 📝 NOTEThis 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" | |||
There was a problem hiding this comment.
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.
| "github.com/cosmos/ibc-go/v8/modules/apps/transfer" | |
| "github.com/cosmos/ibc-go/modules/apps/transfer" |
| app.ICAAuthModule = icaControllerStack.(ibcmock.IBCModule) | ||
| app.ICAAuthModule, ok = icaControllerStack.(ibcmock.IBCModule) | ||
| if !ok { | ||
| panic("Can't convert icaControllerStack to IBCModule") |
| icaICS4Wrapper := icaControllerStack.(porttypes.ICS4Wrapper) | ||
| icaICS4Wrapper, ok := icaControllerStack.(porttypes.ICS4Wrapper) | ||
| if !ok { | ||
| panic("Can't convert icaControllerStack to ICS4Wrapper") |
Co-authored-by: Carlos Rodriguez <[email protected]>
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
panicas 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.
docs/).godoccomments.Files changedin the GitHub PR explorer.SonarCloud Reportin the comment section below once CI passes.Summary by CodeRabbit