fix(errors): improve error string output with codespace and code

[Pronoss]

• Improved the Error() method in errors.go to include the codespace and code in the error string for better debugging and tracing:

func (e Error) Error() string {
    return fmt.Sprintf("[%s:%d] %s", e.codespace, e.code, e.desc)
}

• Updated errors_test.go to replace hardcoded code values with usage of ErrTxDecode.ABCICode() for better test robustness.

Author Checklist

• included the correct type prefix in the PR title (fix)
• targeted the correct branch (main or release)
• provided a link to the relevant issue or specification
• reviewed "Files changed"
• added/updated tests if necessary
• added a changelog entry to CHANGELOG.md
• updated documentation or inline comments if necessary
• confirmed all CI checks have passed

Reviewers Checklist

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items addressed
• reviewed logic, API changes, documentation, tests, and coverage

Summary by CodeRabbit

• New Features
  • Enhanced error messages now provide additional context by including error identifiers and related codes alongside descriptive details.
• Bug Fixes
  • Updated test cases to reflect the new error message format, ensuring accuracy in error handling assertions.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates the error formatting in the errors package. The Error() method now returns a formatted string including the codespace, code, and desc fields in the format "[codespace:code] desc". Additionally, the corresponding test case in errors/errors_test.go has been modified to dynamically retrieve the error code using ErrTxDecode.ABCICode() instead of using the static value 2.

Changes

File(s)	Summary
errors/errors.go	Updated the Error() method to include codespace, code, and desc in the formatted output.
errors/errors_test.go	Changed the test parameter for ABCIError from a static value (2) to a dynamic value from ErrTxDecode.ABCICode().

Sequence Diagram(s)

(No sequence diagrams provided as the changes do not significantly modify control flow.)

Suggested labels

C:x/tx

Suggested reviewers

• kocubinski
• testinginprod
• aaronc
• julienrbrt

---

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea421e0 and 88ea89c.

📒 Files selected for processing (1)

• errors/errors_test.go (1 hunks)

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

• errors/errors_test.go

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Summary

---

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 generate docstrings to generate docstrings for this 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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc54534 and ea421e0.

📒 Files selected for processing (2)

• errors/errors.go (1 hunks)
• errors/errors_test.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

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

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

• errors/errors.go
• errors/errors_test.go

`**/*_test.go`: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

**/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

• errors/errors_test.go

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Summary

🔇 Additional comments (1)

errors/errors.go (1)

91-91: LGTM! Enhanced error format provides better context

Adding the codespace and code in the formatted error string will make debugging easier by providing more context about where errors originate. This is a good improvement.

However, this change affects error string output in all places where Error() is called, including in ABCIError(). Make sure all test cases that expect specific error message formats are updated (as noted in the review of errors_test.go).

[aljo242]

Could you open this against release/v0.53.x?

[Pronoss]

@aljo242
I have updated the pull request to target the release/v0.53.x branch as suggested. Here's the link to the new pull request with the changes: #24099.

Please let me know if anything else needs to be updated!