fix: Fixes memiterator #21775

alpe · 2024-09-17T10:27:08Z

Description

This PR contains 2 fixes to the MemIterator.

Copy on write, see: [Bug]: server v2 - memIterator/ InitGenesis #21754 for more context (Thanks @fdymylja )
Excluding end for keyInRange when in desc order

The first fix has side negative effects as described in #21754 that may have to be addressed before.
Not sure about the keyInRange fix. I was applying the rules defined in the constructor where end is ecluded.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

included the correct type prefix in the PR title, you can find examples of the prefixes below:
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

New Features
- Enhanced the iterator functionality to operate on a copy of the tree, improving accuracy and preventing unintended side effects.
- Introduced refined key range validation for better identification of valid keys.
Bug Fixes
- Improved robustness of the iterator through enhanced range checking logic.
Tests
- Renamed existing test for clarity and added a new test for comprehensive coverage of key range functionality.

github-actions · 2024-09-17T10:27:27Z

@alpe your pull request is missing a changelog!

coderabbitai · 2024-09-17T10:29:11Z

Walkthrough

The changes introduced in this pull request modify the memIterator structure in the changeset.go file by initializing the iterator with a copy of the tree and enhancing the keyInRange method for improved key validation. In the test file, an existing test function has been renamed for clarity, and a new test function has been added to assess the keyInRange method's functionality across various scenarios.

Changes

Files	Change Summary
`server/v2/stf/branch/changeset.go`	Modified `memIterator` initialization to use a copy of the tree; refined `keyInRange` logic.
`server/v2/stf/branch/changeset_test.go`	Renamed `Test_memIterator` to `TestMemIteratorWithWriteToRebalance`; added `TestKeyInRange`.

Possibly related PRs

fix(stf/branch/memiter): Fix Iter validity #21556: The changes in this PR also involve modifications to the memIterator structure in changeset.go, specifically focusing on iterator validity and state management, which is directly related to the changes made in the main PR regarding the memIterator functionality.

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2b30bd8 and 54f5f1b.

Files selected for processing (1)

server/v2/stf/branch/changeset.go (3 hunks)

Files skipped from review as they are similar to previous changes (1)

server/v2/stf/branch/changeset.go

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:

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.

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 · 2024-09-17T12:08:21Z

server/v2/stf/branch/changeset.go

@@ -111,7 +111,7 @@ type memIterator struct {
 // The `valid` field of the iterator indicates whether the iterator is positioned at a valid key.
 // The `start` and `end` fields of the iterator store the start and end keys respectively.
 func newMemIterator(start, end []byte, tree *btree.BTreeG[item], ascending bool) *memIterator {
-	iter := tree.Iter()
+	iter := tree.Copy().Iter()


can we add to the godoc that we create a copy here

testinginprod

llgtm

Fixes memiterator

2b30bd8

alpe requested review from testinginprod, kocubinski and a team as code owners September 17, 2024 10:27

github-actions bot added C:server/v2 Issues related to server/v2 C:server/v2 stf labels Sep 17, 2024

julienrbrt assigned kocubinski and testinginprod Sep 17, 2024

tac0turtle approved these changes Sep 17, 2024

View reviewed changes

testinginprod approved these changes Sep 18, 2024

View reviewed changes

add comment

54f5f1b

tac0turtle enabled auto-merge September 20, 2024 09:41

tac0turtle added this pull request to the merge queue Sep 20, 2024

Merged via the queue into main with commit aa90bb4 Sep 20, 2024
73 checks passed

tac0turtle deleted the alex/memiter_fix branch September 20, 2024 10:01

coderabbitai bot mentioned this pull request Oct 7, 2024

test(server/v2/stf): Add test for mergeiterator #22141

Merged

12 tasks

coderabbitai bot mentioned this pull request Oct 29, 2024

feat(stf/branch): simplify merged iterator #22131

Merged

12 tasks

coderabbitai bot mentioned this pull request Nov 20, 2024

feat(core/coretesting): make memDB satisfy db.Db interface #22570

Merged

12 tasks

This was referenced Nov 29, 2024

fix(store/v2): iavl/v2 reverse iterator #22699

Merged

test: add test case for memiterator.go #22725

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Fixes memiterator #21775

fix: Fixes memiterator #21775

alpe commented Sep 17, 2024 •

edited by coderabbitai bot

Loading

github-actions bot commented Sep 17, 2024

coderabbitai bot commented Sep 17, 2024 •

edited

Loading

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

tac0turtle Sep 17, 2024

testinginprod left a comment

fix: Fixes memiterator #21775

fix: Fixes memiterator #21775

Conversation

alpe commented Sep 17, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

github-actions bot commented Sep 17, 2024

coderabbitai bot commented Sep 17, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

tac0turtle Sep 17, 2024

Choose a reason for hiding this comment

testinginprod left a comment

Choose a reason for hiding this comment

alpe commented Sep 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 17, 2024 •

edited

Loading