Skip to content

fix: Add Extra Check for Reformatted Root Node in GetNode (backport #1007)#1009

Merged
tac0turtle merged 2 commits intorelease/v1.2.xfrom
mergify/bp/release/v1.2.x/pr-1007
Nov 26, 2024
Merged

fix: Add Extra Check for Reformatted Root Node in GetNode (backport #1007)#1009
tac0turtle merged 2 commits intorelease/v1.2.xfrom
mergify/bp/release/v1.2.x/pr-1007

Conversation

@mergify
Copy link
Contributor

@mergify mergify bot commented Nov 26, 2024

Problem Description

When the root node is reformatted due to pruning, its nodeKey changes from (version, 1) to (version, 0). As a result:

1.	This version becomes invisible during a root search.
2.	If a node in the next version references the reformatted node, it becomes inaccessible.

Proposed Solution

Add an extra check in the GetNode function to handle reformatted root nodes. This ensures that:

•	Reformatted nodes with nodeKey (version, 0) remain accessible.
•	References to these nodes from subsequent versions are correctly resolved.

Summary by CodeRabbit

  • New Features

    • Introduced a new test to validate the behavior of the MutableTree after version deletions.
    • Added new APIs: DeleteVersionsFrom(int64) and GetLatestVersion.
  • Bug Fixes

    • Enhanced the GetNode method to improve retrieval logic for nodes, ensuring better handling of cases with nil buffers and legacy nodes.
  • Documentation

    • Updated the changelog to reflect recent improvements and fixes, including a new section for bug fixes and detailed descriptions of changes.

This is an automatic backport of pull request #1007 done by [Mergify](https://mergify.com).

(cherry picked from commit cf74234)

# Conflicts:
#	mutable_tree_test.go
@mergify
Copy link
Contributor Author

mergify bot commented Nov 26, 2024

Cherry-pick of cf74234 has failed:

On branch mergify/bp/release/v1.2.x/pr-1007
Your branch is up to date with 'origin/release/v1.2.x'.

You are currently cherry-picking commit cf74234.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   CHANGELOG.md
	modified:   nodedb.go

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   mutable_tree_test.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@coderabbitai
Copy link

coderabbitai bot commented Nov 26, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

@tac0turtle tac0turtle merged commit 99821d4 into release/v1.2.x Nov 26, 2024
@tac0turtle tac0turtle deleted the mergify/bp/release/v1.2.x/pr-1007 branch November 26, 2024 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

3 participants