Skip to content

fix: no GC for stateless nodes #5863

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.

Sign up for GitHub

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

Jump to bottom
Merged
hanabi1224 merged 1 commit into from
Jul 24, 2025
Merged

fix: no GC for stateless nodes #5863

hanabi1224 merged 1 commit into from
Jul 24, 2025

Conversation

@LesnyRumcajs
Copy link
Member

@LesnyRumcajs LesnyRumcajs commented Jul 24, 2025 •
edited by coderabbitai bot
Loading

Summary of changes

Changes introduced in this pull request:

  • GC shouldn't be run on stateless nodes, even on-demand.

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

  • Bug Fixes

    • Resolved an issue where unnecessary garbage collection processes were running on stateless nodes, improving efficiency.

  • Documentation

    • Updated the changelog to reflect the fix for unnecessary garbage collection on stateless nodes.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 24, 2025 •
edited
Loading

Walkthrough

The changes update the daemon startup logic to prevent garbage collection (GC) tasks from running when the node is in stateless mode. Both the GC event loop and the periodic GC scheduler loop are now conditionally spawned only if the node is not stateless, with the scheduler loop also requiring GC to be enabled.

Changes

File(s) Change Summary
CHANGELOG.md Added entry documenting fix for unnecessary GC runs on stateless nodes, referencing PR #5863.
src/daemon/mod.rs Updated logic to prevent spawning GC event and scheduler loops when node is stateless.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • hanabi1224
  • akaladarshi

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch double-gc-bug
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests 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.

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.

@LesnyRumcajs LesnyRumcajs changed the title fix: double GC spawn fix: no GC for stateless nodes Jul 24, 2025
@LesnyRumcajs LesnyRumcajs marked this pull request as ready for review July 24, 2025 09:54
@LesnyRumcajs LesnyRumcajs requested a review from a team as a code owner July 24, 2025 09:54
@LesnyRumcajs LesnyRumcajs requested review from akaladarshi and hanabi1224 and removed request for a team July 24, 2025 09:54
coderabbitai[bot]
coderabbitai bot reviewed Jul 24, 2025
View reviewed changes
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

🧹 Nitpick comments (1)
CHANGELOG.md (1)

38-39: Consider tightening wording for parallel-structure & readability

The plural “nodes” is already used elsewhere and reads more naturally. Suggest:

- [#5863](https://github.com/ChainSafe/forest/pull/5863) Fixed needless GC runs on a stateless node.
+ [#5863](https://github.com/ChainSafe/forest/pull/5863) Fixed needless GC runs on stateless nodes.

Purely a stylistic nit—feel free to ignore if you prefer the current phrasing.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bc1dfc7 and 5c937f2.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • src/daemon/mod.rs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
  • GitHub Check: Build forest binaries on Linux AMD64
  • GitHub Check: tests-release
  • GitHub Check: tests
  • GitHub Check: cargo-publish-dry-run
  • GitHub Check: Build Ubuntu
  • GitHub Check: All lint checks
🔇 Additional comments (2)
src/daemon/mod.rs (2)

512-518: LGTM! Proper prevention of on-demand GC for stateless nodes.

The conditional check correctly prevents the GC event loop from being spawned when the node is stateless. This addresses the PR objective of preventing on-demand GC operations on stateless nodes, which is appropriate since stateless nodes don't maintain persistent state that would benefit from garbage collection.

519-521: LGTM! Consistent logic for preventing periodic GC on stateless nodes.

The additional !opts.stateless condition properly extends the existing GC scheduler logic. The combined condition !opts.no_gc && !opts.stateless ensures that periodic GC is disabled when either explicitly disabled by the user or when running in stateless mode, which maintains consistency with the event loop logic above.

@hanabi1224 hanabi1224 added this pull request to the merge queue Jul 24, 2025
Merged via the queue into main with commit 6e2f2dc Jul 24, 2025
51 checks passed
@hanabi1224 hanabi1224 deleted the double-gc-bug branch July 24, 2025 13:55
@coderabbitai coderabbitai bot mentioned this pull request Oct 15, 2025
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@hanabi1224 hanabi1224 hanabi1224 approved these changes

@sudo-shashank sudo-shashank sudo-shashank approved these changes

@akaladarshi akaladarshi Awaiting requested review from akaladarshi akaladarshi is a code owner automatically assigned from ChainSafe/forest

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@LesnyRumcajs @hanabi1224 @sudo-shashank