chore: improve HeaderByNumber error message #3356
Conversation
📝 WalkthroughWalkthroughThe pull request introduces a minor modification to the error handling in the Changes
Suggested Reviewers
Note: No sequence diagram is generated as the changes are minimal and do not involve significant control flow modifications. Finishing Touches
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
zetaclient/chains/evm/rpc/rpc.go (1)
Line range hint
65-81: Consider standardizing error messages across all RPC calls.While the HeaderByNumber error message improvement is great, we could maintain consistency by applying similar contextual information to other RPC calls. This would provide a uniform debugging experience.
Consider applying this pattern:
bn, err := client.BlockNumber(ctx) if err != nil { - return time.Time{}, errors.Wrap(err, "RPC failed on BlockNumber, RPC down?") + return time.Time{}, errors.Wrap(err, "RPC failed on BlockNumber(), RPC down?") } _, err = client.SuggestGasPrice(ctx) if err != nil { - return time.Time{}, errors.Wrap(err, "RPC failed on SuggestGasPrice, RPC down?") + return time.Time{}, errors.Wrap(err, "RPC failed on SuggestGasPrice(), RPC down?") }
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
zetaclient/chains/evm/rpc/rpc.go(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
zetaclient/chains/evm/rpc/rpc.go (1)
Pattern **/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: start-e2e-test / e2e
🔇 Additional comments (1)
zetaclient/chains/evm/rpc/rpc.go (1)
79-79: Excellent improvement to error observability!The enhanced error message now includes the block number, which will significantly improve debugging capabilities when HeaderByNumber fails. The implementation maintains consistency with the codebase's error handling patterns while providing more context.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #3356 +/- ##
========================================
Coverage 62.43% 62.43%
========================================
Files 449 449
Lines 31706 31706
========================================
Hits 19795 19795
Misses 11024 11024
Partials 887 887
|
Include block number in error message for easier debugging. Current log makes it hard to tell why this is failing:
Summary by CodeRabbit