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

odeke-em · web-flow · commit 1e216af3d6b7 · 2023-12-08T13:59:12.000Z
diff --git a/store/CHANGELOG.md b/store/CHANGELOG.md
@@ -33,6 +33,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 * [#17158](https://github.com/cosmos/cosmos-sdk/pull/17158) Start the goroutine after need to create a snapshot.
 
+### Bug fixes
+
+* [#18651](https://github.com/cosmos/cosmos-sdk/pull/18651) Propagate iavl.MutableTree.Remove errors firstly to the caller instead of returning a synthesized error firstly.
+
 
 ## [v1.0.0-alpha.1](https://github.com/cosmos/cosmos-sdk/releases/tag/store%2Fv1.0.0-alpha.1) - 2023-07-11
 
@@ -54,7 +58,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Bug Fixes
 
-* [#16588](https://github.com/cosmos/cosmos-sdk/pull/16588) Propogate the Snapshotter's failure to the caller, (it will create a empty snapshot silently before).
+* [#16588](https://github.com/cosmos/cosmos-sdk/pull/16588) Propagate the Snapshotter's failure to the caller, (it will create a empty snapshot silently before).
 
 ## [v0.1.0-alpha.1](https://github.com/cosmos/cosmos-sdk/releases/tag/store%2Fv0.1.0-alpha.1) - 2023-03-17
 
diff --git a/store/commitment/iavl/tree.go b/store/commitment/iavl/tree.go
@@ -29,10 +29,13 @@ func NewIavlTree(db dbm.DB, logger log.Logger, cfg *Config) *IavlTree {
 // Remove removes the given key from the tree.
 func (t *IavlTree) Remove(key []byte) error {
 	_, res, err := t.tree.Remove(key)
+	if err != nil {
+		return err
+	}
 	if !res {
 		return fmt.Errorf("key %x not found", key)
 	}
-	return err
+	return nil
 }
 
 // Set sets the given key-value pair in the tree.

Original file line number	Diff line number	Diff line change
`@@ -29,10 +29,13 @@ func NewIavlTree(db dbm.DB, logger log.Logger, cfg Config) IavlTree {`
`29`	`29`	`// Remove removes the given key from the tree.`
`30`	`30`	`func (t *IavlTree) Remove(key []byte) error {`
`31`	`31`	`_, res, err := t.tree.Remove(key)`
	`32`	`+ if err != nil {`
	`33`	`+ return err`
	`34`	`+ }`
`32`	`35`	`if !res {`
`33`	`36`	`return fmt.Errorf("key %x not found", key)`
`34`	`37`	`}`
`35`		`- return err`
	`38`	`+ return nil`
`36`	`39`	`}`
`37`	`40`
`38`	`41`	`// Set sets the given key-value pair in the tree.`