Problem: memiavl has resource leaks (#1075)

* Problem: memiavl has resource leaks Solution: - add defers and close functions * Update CHANGELOG.md Signed-off-by: yihuang <[email protected]> * code changes * Update CHANGELOG.md Co-authored-by: mmsqe <[email protected]> Signed-off-by: yihuang <[email protected]> * add more reruns to flaky test --------- Signed-off-by: yihuang <[email protected]> Co-authored-by: mmsqe <[email protected]>
crypto-org-chain · Jun 21, 2023 · ed5ce30 · ed5ce30
1 parent 368524d
commit ed5ce30
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -27,6 +27,7 @@
 - [#1042](https://github.com/crypto-org-chain/cronos/pull/1042) Avoid channel get changed when concurrent subscribe happens ([ethermint commit](https://github.com/crypto-org-chain/ethermint/commit/72bbe0a80dfd3c586868e2f0b4fbed72593c45bf)).
 - [#1058](https://github.com/crypto-org-chain/cronos/pull/1058) Fix decode log for multi topics in websocket subscribe ([ethermint commit](https://github.com/crypto-org-chain/ethermint/commit/2136ad029860c819942ad1836dd3f42585002233)).
 - [#1062](https://github.com/crypto-org-chain/cronos/pull/1062) Update cometbft `v0.34.29` with several minor bug fixes and low-severity security-fixes.
+- [#1075](https://github.com/crypto-org-chain/cronos/pull/1075) Add missing close in memiavl to avoid resource leaks.
 
 ### Features
 

diff --git a/integration_tests/test_mempool.py b/integration_tests/test_mempool.py
@@ -23,7 +23,7 @@ def cronos_mempool(tmp_path_factory):
     )
 
 
-@pytest.mark.flaky
+@pytest.mark.flaky(max_runs=5)
 def test_mempool(cronos_mempool):
     w3: Web3 = cronos_mempool.w3
     filter = w3.eth.filter("pending")

diff --git a/memiavl/export.go b/memiavl/export.go
@@ -16,7 +16,7 @@ import (
 // especially since callers may export several IAVL stores in parallel (e.g. the Cosmos SDK).
 const exportBufferSize = 32
 
-func (db *DB) Snapshot(height uint64, protoWriter protoio.Writer) error {
+func (db *DB) Snapshot(height uint64, protoWriter protoio.Writer) (returnErr error) {
 	if height > math.MaxUint32 {
 		return fmt.Errorf("height overflows uint32: %d", height)
 	}
@@ -31,6 +31,11 @@ func (db *DB) Snapshot(height uint64, protoWriter protoio.Writer) error {
 		if err != nil {
 			return errors.Wrapf(err, "invalid height: %d", height)
 		}
+		defer func() {
+			if err := db.Close(); returnErr == nil {
+				returnErr = err
+			}
+		}()
 
 		mtree = &db.MultiTree
 	} else {
@@ -45,6 +50,11 @@ func (db *DB) Snapshot(height uint64, protoWriter protoio.Writer) error {
 		if err != nil {
 			return errors.Wrapf(err, "snapshot don't exists: height: %d", version)
 		}
+		defer func() {
+			if err := mtree.Close(); returnErr == nil {
+				returnErr = err
+			}
+		}()
 	}
 
 	for _, tree := range mtree.trees {

diff --git a/memiavl/import.go b/memiavl/import.go
@@ -223,7 +223,7 @@ func (i *importer) Add(n *iavl.ExportNode) error {
 	return nil
 }
 
-func updateMetadataFile(dir string, height int64) error {
+func updateMetadataFile(dir string, height int64) (returnErr error) {
 	entries, err := os.ReadDir(dir)
 	if err != nil {
 		return err
@@ -238,6 +238,11 @@ func updateMetadataFile(dir string, height int64) error {
 		if err != nil {
 			return err
 		}
+		defer func() {
+			if err := snapshot.Close(); returnErr == nil {
+				returnErr = err
+			}
+		}()
 		storeInfos = append(storeInfos, storetypes.StoreInfo{
 			Name: name,
 			CommitId: storetypes.CommitID{

diff --git a/store/rootmulti/store.go b/store/rootmulti/store.go
@@ -427,6 +427,7 @@ func (rs *Store) Query(req abci.RequestQuery) abci.ResponseQuery {
 		if err != nil {
 			return sdkerrors.QueryResult(err, false)
 		}
+		defer db.Close()
 	}
 
 	path := req.Path