chore(go-lint): fix linter errors #2764

GAtom22 · 2024-08-14T20:31:35Z

Description

The golangci-lint version was bumped to v1.60.1. Now we have new linter errors.
This PR addresses those

Closes: #XXXX

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

tackled an existing issue or discussed with a team member
left instructions on how to review the changes
targeted the correct branch (see PR Targeting)

Reviewers Checklist

All items are required.
Please add a note if the item is not applicable
and please add your handle next to the items reviewed
if you only reviewed selected items.

I have...

added a relevant changelog entry to the Unreleased section in CHANGELOG.md
confirmed all author checklist items have been addressed
confirmed that this PR does not change production code
reviewed content
tested instructions (if applicable)
confirmed all CI checks have passed

Summary by CodeRabbit

New Features
- Enhanced clarity of error messages throughout the application, providing more context for debugging.
- Improved consistency in error reporting by standardizing the method of error message creation.
Bug Fixes
- Adjustments to error handling mechanisms that simplify the error creation process.

These changes improve user experience by making errors more understandable and facilitating easier debugging.

coderabbitai · 2024-08-14T20:31:39Z

Walkthrough

The recent changes primarily enhance error handling across several files, focusing on improving the clarity and consistency of error messages. By employing simpler error creation methods and refining the formatting, these updates bolster logging and debugging capabilities without affecting existing functionality or public entity declarations.

Changes

File Path	Change Summary
app/ante/cosmos/authz.go, precompiles/erc20/tx.go	Updated error message formatting for clarity in error handling; switched to simpler error wrapping.
app/tps_counter_test.go, precompiles/testutil/logs.go	Added directives to suppress linter warnings.
ibc/utils.go	Improved error handling in `GetDenomTrace` to provide better context in error messages.
precompiles/authorization/types.go, precompiles/ics20/types.go, precompiles/staking/tx.go	Simplified error creation by replacing `fmt.Errorf` with `errors.New`.
precompiles/common/precompile.go	Updated error handling in `RunSetup` to use `errors.New` for type assertion failures.
tests/e2e/upgrade/manager.go	Enhanced error message formatting for consistency.
testutil/abci.go	Modified error messages in `BroadcastTxBytes` and `checkTxBytes` to prepend "log: ".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant Logger

    User->>System: Send request
    System->>Logger: Log request details
    System->>System: Process request
    alt Error Handling
        System->>Logger: Log error with context
    end
    Logger->>User: Return response

🐰 In the meadow where bunnies dwell,
Clearer logs now ring the bell.
With simpler messages, bright and bold,
Debugging tales of joy unfold!
Let's dance in code, both swift and spry,
For these changes make our spirits fly! 🌼✨

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.
- @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

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

CodeRabbit Configuration 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.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9933943 and a239ac1.

Files selected for processing (11)

app/ante/cosmos/authz.go (1 hunks)
app/tps_counter_test.go (1 hunks)
ibc/utils.go (1 hunks)
precompiles/authorization/types.go (3 hunks)
precompiles/common/precompile.go (2 hunks)
precompiles/erc20/tx.go (1 hunks)
precompiles/ics20/types.go (3 hunks)
precompiles/staking/tx.go (3 hunks)
precompiles/testutil/logs.go (1 hunks)
tests/e2e/upgrade/manager.go (2 hunks)
testutil/abci.go (2 hunks)

Files skipped from review due to trivial changes (6)

app/ante/cosmos/authz.go
app/tps_counter_test.go
ibc/utils.go
precompiles/staking/tx.go
precompiles/testutil/logs.go
tests/e2e/upgrade/manager.go

Additional comments not posted (11)

precompiles/erc20/tx.go (1)

100-100: Improved error message clarity.

The error message in the transfer function has been enhanced by prepending "error: " to the original error message. This improves the clarity and context of the error output, aiding in debugging.

precompiles/authorization/types.go (3)

7-7: Simplified error handling with errors.New.

The addition of the errors import allows for the use of errors.New, simplifying the creation of static error messages and improving readability.

78-78: Simplified static error message creation.

The use of errors.New for static error messages in CheckApprovalArgs improves readability by removing unnecessary formatting.

195-195: Simplified static error message creation.

In validateMsgTypes, the use of errors.New for static error messages simplifies the code by removing unnecessary formatting.

testutil/abci.go (2)

190-190: Enhanced error message clarity in BroadcastTxBytes.

The error message now includes "log: " before the response log content, improving clarity and aiding in debugging.

237-237: Enhanced error message clarity in checkTxBytes.

The error message now includes "log: " before the response log content, improving clarity and aiding in debugging.

precompiles/common/precompile.go (1)

81-81: Simplified error creation is appropriate.

The use of errors.New instead of fmt.Errorf is suitable here since the error message is static and does not require formatting.

precompiles/ics20/types.go (4)

111-111: Improved error handling for sourcePort.

The change from fmt.Errorf to errors.New for the ErrInvalidSourcePort error is appropriate, as the error message does not require formatting.

116-116: Improved error handling for sourceChannel.

The change from fmt.Errorf to errors.New for the ErrInvalidSourceChannel error is appropriate, as the error message does not require formatting.

276-276: Improved error handling for sourcePort in checkAllowanceArgs.

The change from fmt.Errorf to errors.New for the ErrInvalidSourcePort error is appropriate, as the error message does not require formatting.

281-281: Improved error handling for sourceChannel in checkAllowanceArgs.

The change from fmt.Errorf to errors.New for the ErrInvalidSourceChannel error is appropriate, as the error message does not require formatting.

app/ante/cosmos/authz.go

precompiles/erc20/tx.go

Signed-off-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com>

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a239ac1 and 9b21252.

Files selected for processing (2)

app/ante/cosmos/authz.go (1 hunks)
precompiles/erc20/tx.go (1 hunks)

Files skipped from review as they are similar to previous changes (2)

app/ante/cosmos/authz.go
precompiles/erc20/tx.go

mergify · 2024-08-28T10:54:12Z

backport release/v20.0.x

✅ Backports have been created

#2789 chore(go-lint): fix linter errors (backport #2764) has been created for branch release/v20.0.x but encountered conflicts

* fix linter errors * Apply suggestions from code review Signed-off-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> --------- Signed-off-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> (cherry picked from commit 8ad527d) # Conflicts: # app/ante/cosmos/authz.go # app/tps_counter_test.go # ibc/utils.go # precompiles/authorization/types.go # precompiles/common/precompile.go # precompiles/erc20/tx.go # precompiles/ics20/types.go # precompiles/staking/tx.go # precompiles/testutil/logs.go # tests/e2e/upgrade/manager.go # testutil/abci.go

* chore(go-lint): fix linter errors (#2764) * fix linter errors * Apply suggestions from code review Signed-off-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> --------- Signed-off-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> (cherry picked from commit 8ad527d) # Conflicts: # app/ante/cosmos/authz.go # app/tps_counter_test.go # ibc/utils.go # precompiles/authorization/types.go # precompiles/common/precompile.go # precompiles/erc20/tx.go # precompiles/ics20/types.go # precompiles/staking/tx.go # precompiles/testutil/logs.go # tests/e2e/upgrade/manager.go # testutil/abci.go * fix conflicts * run make format * fix lint --------- Co-authored-by: Tom <54514587+GAtom22@users.noreply.github.com> Co-authored-by: Vlad <vladislav.varadinov@gmail.com> Co-authored-by: Vvaradinov <Vvaradinov@users.noreply.github.com>

fix linter errors

a239ac1

GAtom22 temporarily deployed to release August 14, 2024 20:31 — with GitHub Actions Inactive

github-actions bot added tests precompile labels Aug 14, 2024

GAtom22 marked this pull request as ready for review August 14, 2024 23:48

GAtom22 requested a review from a team as a code owner August 14, 2024 23:48

GAtom22 requested review from ramacarlucho and 0xstepit and removed request for a team August 14, 2024 23:48

coderabbitai bot reviewed Aug 15, 2024

View reviewed changes

fedekunze approved these changes Aug 15, 2024

View reviewed changes

app/ante/cosmos/authz.go Outdated Show resolved Hide resolved

precompiles/erc20/tx.go Outdated Show resolved Hide resolved

Apply suggestions from code review

9b21252

Signed-off-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com>

fedekunze had a problem deploying to release August 15, 2024 06:44 — with GitHub Actions Failure

coderabbitai bot reviewed Aug 15, 2024

View reviewed changes

GAtom22 enabled auto-merge (squash) August 15, 2024 12:25

ramacarlucho approved these changes Aug 15, 2024

View reviewed changes

GAtom22 merged commit 8ad527d into main Aug 15, 2024
49 of 52 checks passed

GAtom22 deleted the GAtom22/go-lint-fix branch August 15, 2024 12:53

evmos deleted a comment from mergify bot Aug 28, 2024

mergify bot mentioned this pull request Aug 28, 2024

chore(go-lint): fix linter errors (backport #2764) #2789

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(go-lint): fix linter errors #2764

chore(go-lint): fix linter errors #2764

Uh oh!

GAtom22 commented Aug 14, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 14, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

mergify bot commented Aug 28, 2024 •

edited

Loading

Uh oh!

Uh oh!

chore(go-lint): fix linter errors #2764

chore(go-lint): fix linter errors #2764

Uh oh!

Conversation

GAtom22 commented Aug 14, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mergify bot commented Aug 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Backports have been created

Uh oh!

Uh oh!

GAtom22 commented Aug 14, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 14, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

mergify bot commented Aug 28, 2024 •

edited

Loading