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(all): replace all fmt.Errorf without paramters with errors.New #21590

Merged
merged 1 commit into from
Sep 9, 2024

Conversation

yukionfire
Copy link
Contributor

@yukionfire yukionfire commented Sep 9, 2024

Description

This PR cleans up all fmt.Errorf without parameters with errors.New among whole codebase

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling in various components by simplifying error message creation, enhancing clarity and consistency across the application.
    • Streamlined error responses for empty request scenarios and type mismatches.
  • Chores

    • Updated import statements to reflect the new error handling approach, removing unnecessary dependencies.

Copy link
Contributor

coderabbitai bot commented Sep 9, 2024

Walkthrough

Walkthrough

The changes involve modifications to error handling in several files, specifically transitioning from fmt.Errorf to errors.New for creating error messages. This adjustment affects methods within the objectIndexer struct, the rpcClient function, and the Params method of the querier struct. The overall functionality of the methods remains unchanged, but the approach to error message creation has been simplified and standardized across the affected files.

Changes

File Path Change Summary
indexer/postgres/params.go Modified error handling in bindKeyParams and bindValueParams to use errors.New instead of fmt.Errorf.
server/v2/cometbft/commands.go Changed error handling in rpcClient to utilize errors.New for empty rpcURI error messages.
x/bank/v2/keeper/query_server.go Updated error handling in Params method to replace fmt.Errorf with errors.New for nil request errors.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System

    User->>System: Send Request
    alt Request is valid
        System-->>User: Processed Response
    else Request is invalid
        System-->>User: Return Error (using errors.New)
    end
Loading

Tip

New features

Walkthrough comment now includes:

  • Possibly related PRs: A list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 95383f5 and e01855b.

Files selected for processing (3)
  • indexer/postgres/params.go (3 hunks)
  • server/v2/cometbft/commands.go (1 hunks)
  • x/bank/v2/keeper/query_server.go (2 hunks)
Files skipped from review due to trivial changes (2)
  • indexer/postgres/params.go
  • server/v2/cometbft/commands.go
Additional context used
Path-based instructions (1)
x/bank/v2/keeper/query_server.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (1)
x/bank/v2/keeper/query_server.go (1)

24-24: Approved change from fmt.Errorf to errors.New.

The change to use errors.New for a static error message is a good practice when no formatting is required, making the code simpler and more readable. This aligns well with the PR's objective and the Uber Golang style guide.

@julienrbrt
Copy link
Member

Are you aware of a linter to add in golangci-lint for that?

If so, that would make sense to add it.

@yukionfire
Copy link
Contributor Author

Are you aware of a linter to add in golangci-lint for that?

If so, that would make sense to add it.

Okay, I will try it later

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants