fix(store/v2): Remove should not error on miss #20423

kocubinski · 2024-05-17T16:48:36Z

Description

Remove behavior is inconsistent with store/v1. This fixes it.

See:

cosmos-sdk/store/cachekv/store.go

Line 159 in d7cc6de

store.parent.Delete([]byte(obj.key))

cosmos-sdk/store/iavl/store.go

Lines 218 to 224 in d7cc6de

    
           func (st *Store) Delete(key []byte) { 
        
           	defer st.metrics.MeasureSince("store", "iavl", "delete") 
        
           	_, _, err := st.tree.Remove(key) 
        
           	if err != nil { 
        
           		panic(err) 
        
           	} 
        
           }

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

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

coderabbitai · 2024-05-17T16:48:42Z

Walkthrough

The Remove method in the IavlTree struct within the store/v2/commitment/iavl/tree.go file has been simplified. Previously, the method checked whether the removal operation was successful by verifying if the key existed. Now, this check has been removed, and the method always returns nil, ignoring whether the key was found or not.

Changes

File Path	Change Summary
`store/v2/commitment/iavl/tree.go`	Modified the `Remove` method in the `IavlTree` struct to always return `nil` without checking if the key was found.

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

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

github-actions · 2024-05-17T16:48:53Z

@kocubinski your pull request is missing a changelog!

coderabbitai

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

store/v2/commitment/iavl/tree.go (1)

32-32: Consider adding a comment explaining why errors are ignored.

This helps maintain clarity for future maintainers.

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d7cc6de and 6c7904b.

Files selected for processing (1)

store/v2/commitment/iavl/tree.go (1 hunks)

Additional Context Used

Path-based Instructions (1)

store/v2/commitment/iavl/tree.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (1)

store/v2/commitment/iavl/tree.go (1)
32-32: Ensure alignment with intended behavior by ignoring errors.

Verification successful

Verification of Remove Method Return Value Handling

The Remove method is used in various files across the codebase. We need to ensure that the change in error handling (always returning nil) does not introduce any issues. Here are the files where Remove is called:

x/staking/keeper/validator.go

x/staking/keeper/unbonding.go

x/slashing/keeper/signing_info.go

x/slashing/keeper/hooks.go

x/staking/keeper/historical_info.go

x/staking/keeper/delegation.go

x/staking/keeper/cons_pubkey.go

x/protocolpool/keeper/msg_server.go

x/protocolpool/keeper/keeper.go

x/gov/keeper/msg_server.go

x/gov/keeper/tally.go

x/gov/keeper/proposal.go

x/gov/keeper/deposit.go

x/gov/keeper/abci.go

x/feegrant/keeper/keeper.go

x/epochs/keeper/keeper_test.go

x/epochs/keeper/genesis_test.go

x/epochs/keeper/abci_test.go

x/circuit/keeper/msg_server.go

x/circuit/keeper/keeper_test.go

x/distribution/keeper/hooks.go

x/distribution/keeper/validator.go

x/distribution/keeper/delegation.go

x/bank/keeper/send.go

x/bank/keeper/keeper.go

x/accounts/defaults/multisig/update_config.go

x/accounts/defaults/multisig/account.go

x/auth/keeper/account.go

types/mempool/mempool_test.go

types/mempool/sender_nonce.go

types/mempool/sender_nonce_test.go

types/mempool/priority_nonce_test.go

types/mempool/priority_nonce.go

tests/systemtests/system.go

tests/e2e/genutil/export_test.go

tools/confix/migrations.go

tools/cosmovisor/args.go

store/v2/commitment/store.go

store/v2/commitment/iavl/tree.go

store/v2/snapshots/store.go

store/v2/commitment/iavl/tree_test.go

store/snapshots/store.go

store/iavl/tree_test.go

store/iavl/store.go

store/cache/cache.go

server/config/config_test.go

crypto/keyring/keyring.go

crypto/keyring/keyring_test.go

depinject/debug.go

depinject/container_test.go

collections/indexed_map.go

collections/vec.go

collections/map_test.go

collections/lookup_map_test.go

collections/keyset.go

collections/keyset_test.go

collections/item_test.go

collections/item.go

collections/indexed_map_test.go

collections/indexes/reverse_pair.go

collections/indexes/unique.go

collections/indexes/reverse_pair_test.go

collections/indexes/multi.go

baseapp/baseapp.go

baseapp/abci_utils.go

Next, we need to verify how the return value of Remove is handled in these files to ensure that the change does not introduce any issues.

Verification of Remove Method Return Value Handling

The Remove method is used extensively across various files in the codebase. The change in error handling (always returning nil) needs to be verified to ensure it does not introduce any issues. The search results show that the return value of Remove is consistently checked for errors in the following files:

x/staking/keeper/validator.go

x/staking/keeper/unbonding.go

x/staking/keeper/historical_info.go

x/staking/keeper/delegation.go

x/staking/keeper/cons_pubkey.go

x/slashing/keeper/signing_info.go

x/slashing/keeper/hooks.go

x/protocolpool/keeper/msg_server.go

x/protocolpool/keeper/keeper.go

x/gov/keeper/proposal.go

x/gov/keeper/tally.go

x/gov/keeper/msg_server.go

x/gov/keeper/deposit.go

x/gov/keeper/abci.go

x/feegrant/keeper/keeper.go

x/distribution/keeper/validator.go

x/distribution/keeper/hooks.go

x/distribution/keeper/delegation.go

x/bank/keeper/send.go

x/bank/keeper/keeper.go

x/accounts/defaults/multisig/update_config.go

x/accounts/defaults/multisig/account.go

x/auth/keeper/account.go

types/mempool/sender_nonce.go

types/mempool/sender_nonce_test.go

types/mempool/priority_nonce_test.go

types/mempool/priority_nonce.go

store/v2/commitment/store.go

store/v2/commitment/iavl/tree.go

store/v2/commitment/iavl/tree_test.go

store/iavl/store.go

store/cache/cache.go

crypto/keyring/keyring.go

crypto/keyring/keyring_test.go

collections/vec.go

collections/map_test.go

collections/lookup_map_test.go

collections/keyset.go

collections/keyset_test.go

collections/item.go

collections/item_test.go

collections/indexed_map_test.go

collections/indexed_map.go

collections/indexes/unique.go

collections/indexes/reverse_pair_test.go

collections/indexes/reverse_pair.go

collections/indexes/multi.go

baseapp/baseapp.go

baseapp/abci_utils.go

In these files, the return value of Remove is checked for errors, ensuring that the change in error handling does not introduce any issues. Therefore, the change in the Remove method to always return nil is handled correctly across the codebase.

: The change in the Remove method to always return nil is handled correctly across the codebase.
Scripts Executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify that the change in error handling in `Remove` method does not adversely affect other parts of the application.

# Test: Search for usage of `Remove` method. Expect: Proper handling of the always `nil` return value.
rg --type go $'\\.Remove\\('
Length of output: 9251

Script:
#!/bin/bash
# Description: Verify handling of the `Remove` method's return value in the identified files.

# Check for error handling of `Remove` method in the identified files.
for file in $(rg --files-with-matches '\.Remove\('); do
  echo "Checking file: $file"
  rg --context 5 '\.Remove\(' $file
done
Length of output: 47669

* main: (95 commits) fix(x/accounts): check for overflows in multisig weights and votes (#20384) docs(x/account/auth): Improve error handling and comments in fee.go (#20426) docs: fix some markdown syntax (#20432) revert: bank change module to account change (#20427) fix: nil pointer panic when store don't exists in historical version (#20425) fix(store/v2): Remove should not error on miss (#20423) chore: upstream more changes from v2 (#20387) docs(x/auth/ante): fixed typo in TxWithTimeoutHeight interface name (#20418) fix: avoid default sendenabled for module accounts (#20419) docs(x/auth): fixed typo in command example for multisign transaction (#20417) build(deps): Bump bufbuild/buf-setup-action from 1.31.0 to 1.32.0 (#20413) build(deps): Bump github.com/hashicorp/go-plugin from 1.6.0 to 1.6.1 in /store (#20414) feat(x/accounts): Add schema caching feature and corresponding test case (#20055) refactor(runtime/v2): remove dependency on sdk (#20389) refactor!: turn MsgsV2 into ReflectMessages to make it less confusing (#19839) docs: Enhanced the ParsePagination method documentation (#20385) refactor(runtime,core): split router service (#20401) chore: fix spelling errors (#20400) docs: Documented error handling in OfferSnapshot method (#20380) build(deps): Bump google.golang.org/grpc from 1.63.2 to 1.64.0 (#20390) ...

fix(store/v2): Remove should not error on miss

6c7904b

kocubinski requested a review from a team as a code owner May 17, 2024 16:48

github-actions bot added the C:Store label May 17, 2024

tac0turtle approved these changes May 17, 2024

View reviewed changes

coderabbitai bot reviewed May 17, 2024

View reviewed changes

julienrbrt approved these changes May 18, 2024

View reviewed changes

julienrbrt added this pull request to the merge queue May 18, 2024

Merged via the queue into main with commit 9fd3d13 May 18, 2024
76 checks passed

julienrbrt deleted the kocu/store-v2-rm-fix branch May 18, 2024 07:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(store/v2): Remove should not error on miss #20423

fix(store/v2): Remove should not error on miss #20423

kocubinski commented May 17, 2024 •

edited

Loading

coderabbitai bot commented May 17, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented May 17, 2024

coderabbitai bot left a comment

Verification of `Remove` Method Return Value Handling

Verification of `Remove` Method Return Value Handling

	func (st *Store) Delete(key []byte) {
	defer st.metrics.MeasureSince("store", "iavl", "delete")
	_, _, err := st.tree.Remove(key)
	if err != nil {
	panic(err)
	}
	}

fix(store/v2): Remove should not error on miss #20423

fix(store/v2): Remove should not error on miss #20423

Conversation

kocubinski commented May 17, 2024 • edited Loading

Description

Author Checklist

Reviewers Checklist

coderabbitai bot commented May 17, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented May 17, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

Verification of Remove Method Return Value Handling

Verification of Remove Method Return Value Handling

kocubinski commented May 17, 2024 •

edited

Loading

coderabbitai bot commented May 17, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

Verification of `Remove` Method Return Value Handling

Verification of `Remove` Method Return Value Handling