Avoid panic on nil allocation

[joe-bowman]

1. Summary

Fixes #1277

Remove reference to err.Error() in log message when no error is present.

2.Type of change

• Bug fix (non-breaking change which fixes an issue)

3. Implementation details

Remove reference in log message to err when err is always nil.

Summary by CodeRabbit

• Refactor
  • Simplified error handling in the rewards distribution process after an epoch ends.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
quicksilver	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 14, 2024 3:27am

[coderabbitai]

Walkthrough

The modification focuses on refining the error handling mechanism within the AfterEpochEnd function of a Keeper module. It streamlines the process by eliminating the need for an explicit error message when dealing with a nil allocation scenario, thereby simplifying the logging approach.

Changes

File Path	Change Summary
.../participationrewards/keeper/hooks.go	Modified error handling for nil allocation in AfterEpochEnd function to simplify logging.

🐇
In the code where errors tread,
A simple change, complexity shed.
No verbose lines where silence reigns,
Just silent fails in code's domains.
Through fields of code, the rabbit hops,
With every leap, complexity drops. 🌟
🐇

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f3fb2d9 and aceb996.

Files selected for processing (1)

• x/participationrewards/keeper/hooks.go (1 hunks)

Additional comments: 1

x/participationrewards/keeper/hooks.go (1)

• 79-79: The modification to log "nil allocation" without referencing err.Error() when allocation is nil is a direct response to the issue described. This change effectively prevents a panic that could occur from attempting to dereference a nil err. However, it's important to ensure that this logging statement provides enough context for debugging purposes.

Consider enhancing the log message to include more context about why the allocation is nil, which could aid in troubleshooting without needing to dive into the code.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 63.26%. Comparing base (8cb42f6) to head (6c9c2df).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1278   +/-   ##
=======================================
  Coverage   63.26%   63.26%           
=======================================
  Files         170      170           
  Lines       11269    11269           
=======================================
  Hits         7129     7129           
  Misses       3415     3415           
  Partials      725      725           

Flag	Coverage Δ
unittests	63.26% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
x/participationrewards/keeper/hooks.go	75.26% <0.00%> (ø)