perf: remove duplicated rootkey fetch inpruning (9% pruning speedup on osmosis)

[ValarDragon]

Currently delete version duplicatedly fetches rootkeys. This rootkey fetch does not go through the normal caching logic (as the rootkey fetch call does a direct call to the underlying database. Its not routed through the standard GetNode cache wrappers)

I did a 2 hour long block sync on osmosis, which got through 66000 blocks.
We should cache this root setting logic. Right now root key fetching is ~37% of the block pruning time during my latest sync. And block pruning is 40% of the overall sync time.

This PR does a quick cache to reduce from 4 calls to 3 calls. (TraverseOrphans has 2 calls as well) Ideally we can setup a second cache later on to ensure none of these DB calls get repeated, but for now wanted to keep it simple/uncontroversial with this PR, getting an 9% speedup to pruning's sync time component. (and ~4% to overall block sync)

Summary by CodeRabbit

• New Features

  • Introduced a caching mechanism for root keys to enhance retrieval efficiency.
  • Added methods for managing root key caching, including fetching and updating keys.

• Bug Fixes

  • Optimized version deletion process by reducing database access through caching.

[coderabbitai]

Walkthrough

The changes introduce a new rootkeyCache type in the nodedb.go file to optimize root key retrieval and management. The new caching mechanism reduces database access by storing and reusing root keys for specific versions. The deleteVersion method is modified to accept a cache parameter, and the DeleteVersionsTo method now instantiates and uses this cache during version deletion operations, improving the efficiency of root key handling within the node database structure.

Changes

File	Change Summary
nodedb.go	- Added rootkeyCache struct for caching root keys - Implemented getRootKey method to retrieve cached root keys - Implemented setRootKey method to update cached root keys - Modified deleteVersion to accept cache parameter - Updated DeleteVersionsTo to use root key caching

Poem

🐰 Caching Keys with Rabbit Glee

In nodedb's realm, a cache so bright,
Root keys dancing with delight,
Fewer queries, more speed we see,
Efficiency hops merrily free!

Nibble, cache, and hop hooray! 🔑✨

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c20afc1 and 8790141.

📒 Files selected for processing (1)

• nodedb.go (3 hunks)

🔇 Additional comments (5)

nodedb.go (5)

419-422: Consider concurrency implications for a single-version cache.

The rootkeyCache maintains exactly one (version, rootKey) pair. If multiple goroutines call getRootKey() for different versions concurrently, the cache would get updated to the latest requested version, potentially invalidating or overwriting prior results. If this is intentional, that's fine, but if separate consumers read different versions concurrently, this approach might return inconsistent data.

---

424-434: Verify error handling and ensure no silent fallback logic is needed.

The getRootKey method calls ndb.GetRoot(version) and immediately returns any error. Confirm whether additional fallback or logging is wanted if ndb.GetRoot(version) returns ErrVersionDoesNotExist—especially if there's a scenario where the version might not exist but isn't an error.

---

436-439: Good use of one-step setter.

The straightforward setRootKey method helps keep the data in sync. If concurrency is a concern, consider adding a lock or clarifying that this logic runs single-threaded.

---

443-443: Parameterizing deleteVersion with a cache is beneficial.

Passing in *rootkeyCache to deleteVersion integrates the caching logic seamlessly without overcomplicating existing data flows. This design is less invasive and maintains modular clarity.

---

709-711: Confirm performance gains with caching.

Here, rootkeyCache is instantiated and consistently reused across multiple calls to deleteVersion. This approach appears to reduce root key retrieval by half. Recommend running performance metrics on large datasets to verify the anticipated speedup.

---

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.

[ValarDragon]

Aiming to update this to have a better cache that should de-duplicate 3 out of the 4 relevant root key calls here

[tac0turtle]

@Mergifyio backport release/v1.2.x

[mergify]

backport release/v1.2.x

✅ Backports have been created

• #1027 perf: remove duplicated rootkey fetch inpruning (9% pruning speedup on osmosis) (backport #1026) has been created for branch release/v1.2.x

[tac0turtle]

@Mergifyio backport release/v1.3.x

[mergify]

backport release/v1.3.x

✅ Backports have been created

• #1028 perf: remove duplicated rootkey fetch inpruning (9% pruning speedup on osmosis) (backport #1026) has been created for branch release/v1.3.x