fix: handle deleting dangling reference root node

[iboss-ptk]

We found a case in Osmosis node where there is a root key that is points to a node that doesn't exists and it hangs the pruning process because fails at get root key (returns ErrVersionDoesNotExist).

There is already a code to clean the dangling ref node up, but it just never get there because it early returns ErrVersionDoesNotExist before getting there.

Summary by CodeRabbit

• Bug Fixes

  • Improved handling when attempting to remove data for a non-existent version, reducing unexpected errors.

• Refactor

  • Streamlined the process for managing associated data during version removal to enhance overall stability and consistency.

[coderabbitai[bot]]

Walkthrough

The changes modify the deleteVersion method in the node database. The error handling for retrieving the root key from the cache now distinguishes ErrVersionDoesNotExist so that processing can continue. The orphan node pruning logic has been updated: if the retrieved rootKey is nil, the orphan pruning is skipped; otherwise, the method traverses orphans using a dedicated function. During traversal, if an orphan's nonce is 1 and its version is below the current version, the nonce is reset. Deletion from pruning is now handled separately based on orphan type.

Changes

File	Change Summary
nodedb.go	Updated deleteVersion: adjusted error checking for cache.getRootKey, added check for nil rootKey to conditionally skip orphan pruning, revised orphan traversal to reset nonce and handle deletions separately based on node type.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant deleteVersion
    participant Cache
    participant OrphanTraversal

    Caller->>deleteVersion: call deleteVersion(version)
    deleteVersion->>Cache: getRootKey(ndb, version)
    Cache-->>deleteVersion: return rootKey or error
    alt Error is ErrVersionDoesNotExist
        deleteVersion->>deleteVersion: Continue processing
    else Other error
        deleteVersion->>Caller: return error
    end
    alt rootKey is nil
        deleteVersion->>Caller: Skip orphan pruning
    else Not nil
        deleteVersion->>OrphanTraversal: traverseOrphansWithRootkeyCache
        OrphanTraversal->>deleteVersion: Process orphans (reset nonce, delete prunings)
    end
    deleteVersion->>Caller: complete deletion process

Possibly related PRs

• cosmos/iavl#1029: Updated the deleteVersion method to utilize a new rootkeyCache, directly aligning with the changes.
• cosmos/iavl#1026: Modified the deleteVersion method to incorporate an updated caching mechanism for root keys.
• cosmos/iavl#1007: Addresses handling of orphan nodes and reformatting of nodes, closely relating to the new orphan traversal logic.

Suggested labels

backport/v1.x

Suggested reviewers

• tac0turtle

Poem

Oh, I’m a rabbit with a code delight,
Hopping through changes from morning to night.
Errors now sorted with a keen little twist,
Orphans pruned cleanly—none will be missed.
With each committed hop, our code sings,
A meadow of logic where new growth springs!
🐇🌸 Happy coding, under bright pixel skies!

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

[aljo242]

@iboss-ptk we have some conflict - would be good to resolve so we can merge