fix: close the pruning process properly

[cool-develope]

Context

close: #966

Summary by CodeRabbit

• New Features

  • Introduced a new API to close the pruning process when the node database is closed, enhancing resource management and system stability.

• Bug Fixes

  • Improved cancellation handling during the pruning process to prevent memory leaks and ensure graceful termination of operations.

• Tests

  • Added a test to verify the closure functionality of the NodeDB instance, ensuring it can close without errors.

[coderabbitai]

Walkthrough

The recent updates enhance the nodeDB structure by implementing context management for asynchronous pruning operations. A new API call ensures the pruning process is gracefully terminated when the database is closed, improving resource management and system stability. Additionally, a new test verifies this closure functionality, contributing to the robustness of the database management system.

Changes

Files	Change Summary
CHANGELOG.md	Added entry for new API call: Close the pruning process when the nodeDB is closed (pull request #970).
nodedb.go	Integrated context management for pruning, added cancellation support, and updated the Close method to terminate ongoing operations.
nodedb_test.go	Added TestCloseNodeDB to verify that the NodeDB closure works without errors.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant NodeDB
    participant PruningRoutine

    Client->>NodeDB: Close()
    NodeDB->>PruningRoutine: Cancel()
    PruningRoutine-->>NodeDB: Finish Pruning
    NodeDB-->>Client: Closed

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Stop pruning Go routine on close (#966)	✅

🐇 Hopping through the code with glee,
Resources managed, oh so free!
When the database says, "It's time to rest,"
Pruning will pause, giving it its best.
Clean and tidy, no leaks to find,
A joyful database, oh how refined! 🌟

---

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 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 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 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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

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.

[cool-develope]

@Mergifyio backport release/v1.2.x

[mergify]

backport release/v1.2.x

✅ Backports have been created

• #971 fix: close the pruning process properly (backport #970) has been created for branch release/v1.2.x

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d561baf and e62d9fd.

Files selected for processing (3)

• CHANGELOG.md (1 hunks)
• nodedb.go (6 hunks)
• nodedb_test.go (1 hunks)

Additional comments not posted (7)

CHANGELOG.md (1)

10-10: Changelog entry is accurate and complete.

The new entry for pull request #970 correctly describes the addition of the API call to close the pruning process when the nodeDB is closed.

nodedb_test.go (1)

440-447: Test function TestCloseNodeDB is well-structured and effective.

The test correctly verifies the closure functionality of the NodeDB instance. Consider adding more assertions to check the state of the NodeDB after closure.

nodedb.go (5)

5-5: Context package import is necessary.

The import of the context package is required for managing asynchronous operations in the nodeDB.

---

76-81: Additions to nodeDB struct are necessary.

The new fields ctx, cancel, and done are required for managing the context and signaling the completion of the pruning process.

---

Line range hint 104-124: Changes to newNodeDB function are necessary and correct.

The function now correctly initializes the context and cancel function, and starts the pruning process if asynchronous pruning is enabled.

---

588-612: Changes to startPruning method ensure graceful termination.

The method now listens for the context's Done signal, allowing the pruning process to exit cleanly when the context is canceled.

---

1112-1116: Changes to Close method ensure proper cleanup.

The method now calls the cancel function and waits for the pruning process to finish, ensuring that all resources are properly cleaned up when the nodeDB instance is closed.