Skip to content
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.

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

feat: lazy pruning #898

Closed
wants to merge 23 commits into from
Closed

feat: lazy pruning #898

wants to merge 23 commits into from

Conversation

cool-develope
Copy link
Collaborator

@cool-develope cool-develope commented Mar 5, 2024

Implement the deferred pruning

Closes: #885

Fix

When the root refers to the legacy root, it will reformat the legacy node as a new node key format. This node is removed while pruning but it is still being referred by the forward version.
Another issue with the reference node, it can refer to the internal node, not only the root. For example, if there are no adds, just removes, then the leaf or inner node can be the root.

  • Store the nodeKey instead of only the version as a reference node value
  • When reformat the legacy root, use (version, 0) as a nodeKey to distinguish with the root. It will also be applied for the case of when pruning the version, reformat the given root nodeKey to (version, 0).
  • Fix the legacy node pruning

@cool-develope cool-develope requested a review from a team as a code owner March 5, 2024 15:39
@cool-develope cool-develope marked this pull request as draft March 5, 2024 15:39
Copy link

coderabbitai bot commented Mar 5, 2024

Walkthrough

The recent changes focus on enhancing synchronization and performance within a tree data structure, particularly through the introduction of lazy pruning, renaming methods for clarity on synchronous operations, and adjusting control flow in test scenarios. Major updates include the implementation of lazy pruning to improve commit flow efficiency, synchronization enhancements by renaming deletion methods, and modifications in node handling to support these improvements. These changes aim to address performance bottlenecks and improve the overall robustness of the system.

Changes

Files Change Summary
export_test.go, iterator_test.go, ... Renamed DeleteVersionsTo to DeleteVersionsToSync; updated test logic for synchronization.
import.go Adjusted batch.Set method call within a conditional statement.
migrate_test.go Removed dbType parameter, updated method calls, and introduced new logic for pruning.
mutable_tree.go, mutable_tree_test.go Added methods for commit state management and synchronous version deletion; updated comments.
nodedb.go Enhanced committing state management, pruning operations, and orphan handling with new fields/methods.
batch.go Modified Set and Delete methods to internally call Write for flushing batches.
node.go Added isLegacy field and logic to handle legacy nodes differently.
benchmarks/bench_test.go Replaced DeleteVersionsTo with DeleteVersionsToSync in commitTree function.

Assessment against linked issues

Objective Addressed Explanation
Implement lazy pruning in IAVL v1 (#885)
Run the internal pruning loop process
Store the version in the Prune function
Setup channel between SaveVersion and internal pruning process The changes indicate the setup of a channel for communication, aligning with the issue's proposal.

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.

export_test.go Show resolved Hide resolved
export_test.go Show resolved Hide resolved
nodedb.go Outdated Show resolved Hide resolved
migrate_test.go Show resolved Hide resolved
@cool-develope cool-develope marked this pull request as ready for review March 7, 2024 13:34
batch.go Show resolved Hide resolved
batch.go Show resolved Hide resolved
Comment on lines +629 to +653
// startPruning starts the pruning process.
func (ndb *nodeDB) startPruning() {
for {
ndb.mtx.Lock()
toVersion := ndb.pruneVersion
ndb.mtx.Unlock()

if toVersion == 0 {
time.Sleep(100 * time.Millisecond)
continue
}

if err := ndb.DeleteVersionsToSync(toVersion); err != nil {
ndb.logger.Error("Error while pruning", "err", err)
time.Sleep(1 * time.Second)
continue
}

ndb.mtx.Lock()
if ndb.pruneVersion <= toVersion {
ndb.pruneVersion = 0
}
ndb.mtx.Unlock()
}
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The startPruning method initiates the pruning process in a separate goroutine, continuously checking for versions to prune and calling DeleteVersionsToSync accordingly. This implementation effectively decouples pruning from the commit process, allowing it to run asynchronously. However, it's crucial to monitor the performance and resource usage of this goroutine, especially in scenarios with frequent version updates or large datasets. Consider adding mechanisms to control the frequency of pruning checks or to pause/resume the pruning process based on system load or other criteria.

Consider adding mechanisms to control the pruning process more dynamically, such as adjusting the sleep duration based on system load or providing a way to pause/resume pruning based on external triggers.

nodedb.go Show resolved Hide resolved
@cool-develope
Copy link
Collaborator Author

The lazy pruning feature is not working properly since multi trees share the same db backend in store

close in favor of #909

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lazy Pruning
3 participants