fix(store/commitment/iavl): honor tree.Remove error firstly

[odeke-em]

Previously the check was if !res and then it would return the error below but that has a consequence of ignoring/swallowing up the error returned by (*iavl.MutableTree).Remove. Even more is the fact that when !res, an error occurred and it could be anything else, thus checking against the error firstly ensures that we only return a synthesized error when we are certain the key wasn't in the tree.

Fixes #18650

Summary by CodeRabbit

• Bug Fixes
  • Improved error handling for tree removal operations, ensuring that accurate error messages are propagated to the user.
  • Snapshot failures are now correctly reported to the user, rather than creating an empty snapshot without notification.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve improving error handling in the IavlTree.Remove method. The method now prioritizes checking for errors before considering the result of the removal operation. This ensures that errors are not missed and are properly propagated to the caller, aligning with the objectives to handle specific error scenarios more effectively.

Changes

File Path	Change Summary
store/commitment/iavl/tree.go	Updated IavlTree.Remove to check and return errors before evaluating the result of the removal operation.
store/CHANGELOG.md	Documented the changes in error handling for iavl.MutableTree.Remove and the Snapshotter's error propagation.

Assessment against linked issues

Objective	Addressed	Explanation
Update IavlTree.Remove to check errors before result (res) (#18650)	✅
Handle errors related to leaf nodes, nil keys, and missing values (#18650)	❓	The summary does not provide enough detail to confirm if all specific error scenarios are addressed.
Align error handling with identified scenarios without being overshadowed by result-based checks (#18650)	✅
Notify the relevant contributor for awareness and potential input (#18650)	❌	This task is non-coding and thus not verifiable through the code changes.

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

[coderabbitai]

Review Status

Actionable comments generated: 5

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f6df368 and 4991053.

Files selected for processing (2)

• store/CHANGELOG.md (1 hunks)
• store/commitment/iavl/tree.go (1 hunks)

Additional comments: 1

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

• 29-39: The changes to the Remove method correctly prioritize error handling before checking the result, which aligns with the PR's objective to ensure that errors are not overlooked. This is a critical improvement for the reliability and correctness of the method.

[julienrbrt]

Can you move this under unreleased?

[odeke-em]

Done and thank you @julienrbrt!

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 112f6cb and 9409254.

Files selected for processing (2)

• store/CHANGELOG.md (2 hunks)
• store/commitment/iavl/tree.go (1 hunks)

Additional comments: 3

store/CHANGELOG.md (2)

• 61-61: The summary incorrectly suggests that the Snapshotter's failure propagation change is part of a different pull request. The changelog entry for PR fix: snapshotter's failure is not propogated #16588 correctly documents this change as part of the current codebase.

• 38-38: The changelog entry for PR fix(store/commitment/iavl): honor tree.Remove error firstly #18651 accurately describes the changes made to the iavl.MutableTree.Remove method, ensuring that errors are propagated first to the caller.

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

• 29-39: The changes to the Remove method correctly prioritize error handling before checking the result of the removal operation. This ensures that errors are not ignored and are properly communicated to the caller, aligning with the PR objectives to fix the error handling bug.