chore: close iterator in IterateEpochInfo

[expertdicer]

Purpose / Abstract

Based on L-01 | Unclosed Iterator in IterateEpochInfo

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a minor maintenance update to the Nibiru EVM's epoch management code. The change focuses on adding a deferred iterator closure in the IterateEpochInfo method, which is a standard practice for proper resource management. This update ensures that the iterator is closed after its use, preventing potential resource leaks without altering the core functionality of the method.

Changes

File	Change Summary
CHANGELOG.md	Added new entry documenting iterator closure in IterateEpochInfo function
x/epochs/keeper/epoch.go	Added defer iterate.Close() to IterateEpochInfo method to ensure proper iterator resource management

Poem

🐰 A Rabbit's Ode to Iterator Care 🔍

In lines of code, a tiny tweak,
Closing iterators, no more leak!
Resources freed with gentle might,
A programmer's delight so bright
Clean code hops, no memory fright!

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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>, 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. (Beta)
• @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.

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

🧹 Nitpick comments (1)

x/epochs/keeper/epoch.go (1)

69-69: Consider handling the Close() error.

While the current implementation is correct, it might be worth considering handling any potential errors from the Close() operation.

Here's a suggestion to handle the Close() error:

-	defer iterate.Close()
+	defer func() {
+		if err := iterate.Close(); err != nil {
+			// Log the error or wrap it into a multi-error if the function
+			// signature is updated to return error
+			k.Logger(ctx).Error("failed to close epoch iterator", "error", err)
+		}
+	}()

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0ef4099 and fb281fd.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• x/epochs/keeper/epoch.go (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• CHANGELOG.md

🔇 Additional comments (1)

x/epochs/keeper/epoch.go (1)

69-69: LGTM! Good catch on adding the iterator cleanup.

The addition of defer iterate.Close() is a good practice for proper resource management, ensuring the iterator is closed after use.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.89%. Comparing base (13c71a7) to head (fb281fd).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2172      +/-   ##
==========================================
+ Coverage   64.86%   64.89%   +0.02%     
==========================================
  Files         277      277              
  Lines       22283    22302      +19     
==========================================
+ Hits        14454    14472      +18     
  Misses       6839     6839              
- Partials      990      991       +1     

Files with missing lines	Coverage Δ
x/epochs/keeper/epoch.go	82.97% <100.00%> (+0.37%)	⬆️

... and 4 files with indirect coverage changes