From ef67b7b60ae57ba699905597774b99c888add9cd Mon Sep 17 00:00:00 2001 From: leonardo fleitas alvarez Date: Sat, 22 Oct 2022 15:51:53 +0200 Subject: [PATCH 1/6] Add LogDeferred to x/bank --- internal/util.go | 12 +++++++++++- x/bank/keeper/keeper.go | 6 ++++-- x/bank/keeper/send.go | 3 ++- x/bank/keeper/view.go | 3 ++- x/bank/migrations/v2/store.go | 8 +++++--- x/bank/migrations/v3/store.go | 14 ++++++++------ 6 files changed, 32 insertions(+), 14 deletions(-) diff --git a/internal/util.go b/internal/util.go index fc67461bd489..0a361179dc57 100644 --- a/internal/util.go +++ b/internal/util.go @@ -1,6 +1,10 @@ package util -import "fmt" +import ( + "fmt" + + log "github.com/tendermint/tendermint/libs/log" +) func CombineErrors(ret error, also error, desc string) error { if also != nil { @@ -12,3 +16,9 @@ func CombineErrors(ret error, also error, desc string) error { } return ret } + +func LogDeferred(logger log.Logger, f func() error) { + if err := f(); err != nil { + logger.Error(err.Error()) + } +} diff --git a/x/bank/keeper/keeper.go b/x/bank/keeper/keeper.go index f8ce411b4cbe..61182757656b 100644 --- a/x/bank/keeper/keeper.go +++ b/x/bank/keeper/keeper.go @@ -5,6 +5,7 @@ import ( "cosmossdk.io/math" "github.com/cosmos/cosmos-sdk/codec" + util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/internal/conv" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" @@ -288,7 +289,8 @@ func (k BaseKeeper) IterateAllDenomMetaData(ctx sdk.Context, cb func(types.Metad denomMetaDataStore := prefix.NewStore(store, types.DenomMetadataPrefix) iterator := denomMetaDataStore.Iterator(nil, nil) - defer iterator.Close() + + defer util.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) for ; iterator.Valid(); iterator.Next() { var metadata types.Metadata @@ -527,7 +529,7 @@ func (k BaseViewKeeper) IterateTotalSupply(ctx sdk.Context, cb func(sdk.Coin) bo supplyStore := prefix.NewStore(store, types.SupplyKey) iterator := supplyStore.Iterator(nil, nil) - defer iterator.Close() + defer util.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) for ; iterator.Valid(); iterator.Next() { var amount math.Int diff --git a/x/bank/keeper/send.go b/x/bank/keeper/send.go index e7f7727c98c9..2fdc971de368 100644 --- a/x/bank/keeper/send.go +++ b/x/bank/keeper/send.go @@ -4,6 +4,7 @@ import ( "fmt" "github.com/cosmos/cosmos-sdk/codec" + util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" "github.com/cosmos/cosmos-sdk/telemetry" @@ -442,7 +443,7 @@ func (k BaseSendKeeper) IterateSendEnabledEntries(ctx sdk.Context, cb func(denom seStore := k.getSendEnabledPrefixStore(ctx) iterator := seStore.Iterator(nil, nil) - defer iterator.Close() + defer util.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) for ; iterator.Valid(); iterator.Next() { denom := string(iterator.Key()) diff --git a/x/bank/keeper/view.go b/x/bank/keeper/view.go index 32e146ecdd15..188ebd4c558c 100644 --- a/x/bank/keeper/view.go +++ b/x/bank/keeper/view.go @@ -7,6 +7,7 @@ import ( "github.com/tendermint/tendermint/libs/log" "github.com/cosmos/cosmos-sdk/codec" + util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" sdk "github.com/cosmos/cosmos-sdk/types" @@ -120,7 +121,7 @@ func (k BaseViewKeeper) IterateAccountBalances(ctx sdk.Context, addr sdk.AccAddr accountStore := k.getAccountStore(ctx, addr) iterator := accountStore.Iterator(nil, nil) - defer iterator.Close() + defer util.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) for ; iterator.Valid(); iterator.Next() { var amount math.Int diff --git a/x/bank/migrations/v2/store.go b/x/bank/migrations/v2/store.go index 84a882d3d40b..1eab68fe5e64 100644 --- a/x/bank/migrations/v2/store.go +++ b/x/bank/migrations/v2/store.go @@ -3,12 +3,14 @@ package v2 import ( "cosmossdk.io/math" "github.com/cosmos/cosmos-sdk/codec" + util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" sdk "github.com/cosmos/cosmos-sdk/types" v042auth "github.com/cosmos/cosmos-sdk/x/auth/migrations/v042" v1 "github.com/cosmos/cosmos-sdk/x/bank/migrations/v1" "github.com/cosmos/cosmos-sdk/x/bank/types" + "github.com/tendermint/tendermint/libs/log" ) // migrateSupply migrates the supply to be stored by denom key instead in a @@ -50,7 +52,7 @@ func migrateSupply(store sdk.KVStore, cdc codec.BinaryCodec) error { // migrateBalanceKeys migrate the balances keys to cater for variable-length // addresses. -func migrateBalanceKeys(store sdk.KVStore) { +func migrateBalanceKeys(store sdk.KVStore, logger log.Logger) { // old key is of format: // prefix ("balances") || addrBytes (20 bytes) || denomBytes // new key is of format @@ -58,7 +60,7 @@ func migrateBalanceKeys(store sdk.KVStore) { oldStore := prefix.NewStore(store, v1.BalancesPrefix) oldStoreIter := oldStore.Iterator(nil, nil) - defer oldStoreIter.Close() + defer util.LogDeferred(logger, func() error { return oldStoreIter.Close() }) for ; oldStoreIter.Valid(); oldStoreIter.Next() { addr := v1.AddressFromBalancesStore(oldStoreIter.Key()) @@ -80,7 +82,7 @@ func migrateBalanceKeys(store sdk.KVStore) { // - Prune balances & supply with zero coins (ref: https://github.com/cosmos/cosmos-sdk/pull/9229) func MigrateStore(ctx sdk.Context, storeKey storetypes.StoreKey, cdc codec.BinaryCodec) error { store := ctx.KVStore(storeKey) - migrateBalanceKeys(store) + migrateBalanceKeys(store, ctx.Logger()) if err := pruneZeroBalances(store, cdc); err != nil { return err diff --git a/x/bank/migrations/v3/store.go b/x/bank/migrations/v3/store.go index 1ac18373f5c8..8074908a8749 100644 --- a/x/bank/migrations/v3/store.go +++ b/x/bank/migrations/v3/store.go @@ -2,12 +2,14 @@ package v3 import ( "github.com/cosmos/cosmos-sdk/codec" + util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" sdk "github.com/cosmos/cosmos-sdk/types" "github.com/cosmos/cosmos-sdk/types/address" v2 "github.com/cosmos/cosmos-sdk/x/bank/migrations/v2" "github.com/cosmos/cosmos-sdk/x/bank/types" + "github.com/tendermint/tendermint/libs/log" ) // MigrateStore performs in-place store migrations from v0.43 to v0.45. The @@ -18,19 +20,19 @@ import ( // - Remove duplicate denom from denom metadata store key. func MigrateStore(ctx sdk.Context, storeKey storetypes.StoreKey, cdc codec.BinaryCodec) error { store := ctx.KVStore(storeKey) - err := addDenomReverseIndex(store, cdc) + err := addDenomReverseIndex(store, cdc, ctx.Logger()) if err != nil { return err } - return migrateDenomMetadata(store) + return migrateDenomMetadata(store, ctx.Logger()) } -func addDenomReverseIndex(store sdk.KVStore, cdc codec.BinaryCodec) error { +func addDenomReverseIndex(store sdk.KVStore, cdc codec.BinaryCodec, logger log.Logger) error { oldBalancesStore := prefix.NewStore(store, v2.BalancesPrefix) oldBalancesIter := oldBalancesStore.Iterator(nil, nil) - defer oldBalancesIter.Close() + defer util.LogDeferred(logger, func() error { return oldBalancesIter.Close() }) denomPrefixStores := make(map[string]prefix.Store) // memoize prefix stores @@ -72,11 +74,11 @@ func addDenomReverseIndex(store sdk.KVStore, cdc codec.BinaryCodec) error { return nil } -func migrateDenomMetadata(store sdk.KVStore) error { +func migrateDenomMetadata(store sdk.KVStore, logger log.Logger) error { oldDenomMetaDataStore := prefix.NewStore(store, v2.DenomMetadataPrefix) oldDenomMetaDataIter := oldDenomMetaDataStore.Iterator(nil, nil) - defer oldDenomMetaDataIter.Close() + defer util.LogDeferred(logger, func() error { return oldDenomMetaDataIter.Close() }) for ; oldDenomMetaDataIter.Valid(); oldDenomMetaDataIter.Next() { oldKey := oldDenomMetaDataIter.Key() From 10f3a96a87b9de9f9f9dec7240614844c6dd63e8 Mon Sep 17 00:00:00 2001 From: leonardo fleitas alvarez Date: Sun, 23 Oct 2022 01:37:15 +0200 Subject: [PATCH 2/6] Add entry in changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8e0289c0d09d..1fdc7966d4f2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -56,6 +56,7 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Improvements +* [#13619](https://github.com/cosmos/cosmos-sdk/pull/13619) Add new function called LogDeferred to report errors in defers. Use the function in x/bank files. * (tools) [#13603](https://github.com/cosmos/cosmos-sdk/pull/13603) Rename cosmovisor package name to `cosmossdk.io/tools/cosmovisor`. The new tool directory contains Cosmos SDK tools. * (deps) [#13397](https://github.com/cosmos/cosmos-sdk/pull/13397) Bump Go version minimum requirement to `1.19`. * [#13070](https://github.com/cosmos/cosmos-sdk/pull/13070) Migrate from `gogo/protobuf` to `cosmos/gogoproto`. From b81403538119878d289f3913a049e6de3a5ffd09 Mon Sep 17 00:00:00 2001 From: leonardo fleitas alvarez Date: Sun, 23 Oct 2022 01:38:41 +0200 Subject: [PATCH 3/6] Remove unnecessary space --- x/bank/keeper/keeper.go | 1 - 1 file changed, 1 deletion(-) diff --git a/x/bank/keeper/keeper.go b/x/bank/keeper/keeper.go index 61182757656b..556aff1c20b7 100644 --- a/x/bank/keeper/keeper.go +++ b/x/bank/keeper/keeper.go @@ -289,7 +289,6 @@ func (k BaseKeeper) IterateAllDenomMetaData(ctx sdk.Context, cb func(types.Metad denomMetaDataStore := prefix.NewStore(store, types.DenomMetadataPrefix) iterator := denomMetaDataStore.Iterator(nil, nil) - defer util.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) for ; iterator.Valid(); iterator.Next() { From 0f83bdbf7054f22a863c6595d566e52557ebfeb1 Mon Sep 17 00:00:00 2001 From: leonardo fleitas alvarez Date: Sun, 23 Oct 2022 01:41:09 +0200 Subject: [PATCH 4/6] Add comment in LogDeferred function --- internal/util.go | 1 + 1 file changed, 1 insertion(+) diff --git a/internal/util.go b/internal/util.go index 0a361179dc57..d4b95a2a7ff9 100644 --- a/internal/util.go +++ b/internal/util.go @@ -17,6 +17,7 @@ func CombineErrors(ret error, also error, desc string) error { return ret } +// Report errors in defers func LogDeferred(logger log.Logger, f func() error) { if err := f(); err != nil { logger.Error(err.Error()) From d2178d93ca3c55364659f9a0fb75304a6c0fb434 Mon Sep 17 00:00:00 2001 From: leonardo fleitas alvarez Date: Sun, 23 Oct 2022 01:53:00 +0200 Subject: [PATCH 5/6] Add a better description for LogDeferred function --- internal/util.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/util.go b/internal/util.go index d4b95a2a7ff9..cf024c06161d 100644 --- a/internal/util.go +++ b/internal/util.go @@ -17,7 +17,7 @@ func CombineErrors(ret error, also error, desc string) error { return ret } -// Report errors in defers +// LogDeferred logs an error in a deferred function call if the returned error is non-nil. func LogDeferred(logger log.Logger, f func() error) { if err := f(); err != nil { logger.Error(err.Error()) From 8e795b5d55b0bb23ec53c6d7e98e07d15736a08e Mon Sep 17 00:00:00 2001 From: leonardo fleitas alvarez Date: Sun, 23 Oct 2022 21:44:16 +0200 Subject: [PATCH 6/6] Move LogDeferred to types/utils --- internal/util.go | 9 --------- types/utils.go | 8 ++++++++ x/bank/keeper/keeper.go | 5 ++--- x/bank/keeper/send.go | 3 +-- x/bank/keeper/view.go | 3 +-- x/bank/migrations/v2/store.go | 3 +-- x/bank/migrations/v3/store.go | 5 ++--- 7 files changed, 15 insertions(+), 21 deletions(-) diff --git a/internal/util.go b/internal/util.go index cf024c06161d..bcbcf821638d 100644 --- a/internal/util.go +++ b/internal/util.go @@ -2,8 +2,6 @@ package util import ( "fmt" - - log "github.com/tendermint/tendermint/libs/log" ) func CombineErrors(ret error, also error, desc string) error { @@ -16,10 +14,3 @@ func CombineErrors(ret error, also error, desc string) error { } return ret } - -// LogDeferred logs an error in a deferred function call if the returned error is non-nil. -func LogDeferred(logger log.Logger, f func() error) { - if err := f(); err != nil { - logger.Error(err.Error()) - } -} diff --git a/types/utils.go b/types/utils.go index b3a1efebba60..88c19f8d0069 100644 --- a/types/utils.go +++ b/types/utils.go @@ -7,6 +7,7 @@ import ( "time" "github.com/cosmos/cosmos-sdk/types/kv" + log "github.com/tendermint/tendermint/libs/log" ) // SortedJSON takes any JSON and returns it sorted by keys. Also, all white-spaces @@ -133,3 +134,10 @@ func ParseLengthPrefixedBytes(key []byte, startIndex int, sliceLength int) ([]by return byteSlice, endIndex } + +// LogDeferred logs an error in a deferred function call if the returned error is non-nil. +func LogDeferred(logger log.Logger, f func() error) { + if err := f(); err != nil { + logger.Error(err.Error()) + } +} diff --git a/x/bank/keeper/keeper.go b/x/bank/keeper/keeper.go index 556aff1c20b7..4fbb622ad9e6 100644 --- a/x/bank/keeper/keeper.go +++ b/x/bank/keeper/keeper.go @@ -5,7 +5,6 @@ import ( "cosmossdk.io/math" "github.com/cosmos/cosmos-sdk/codec" - util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/internal/conv" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" @@ -289,7 +288,7 @@ func (k BaseKeeper) IterateAllDenomMetaData(ctx sdk.Context, cb func(types.Metad denomMetaDataStore := prefix.NewStore(store, types.DenomMetadataPrefix) iterator := denomMetaDataStore.Iterator(nil, nil) - defer util.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) + defer sdk.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) for ; iterator.Valid(); iterator.Next() { var metadata types.Metadata @@ -528,7 +527,7 @@ func (k BaseViewKeeper) IterateTotalSupply(ctx sdk.Context, cb func(sdk.Coin) bo supplyStore := prefix.NewStore(store, types.SupplyKey) iterator := supplyStore.Iterator(nil, nil) - defer util.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) + defer sdk.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) for ; iterator.Valid(); iterator.Next() { var amount math.Int diff --git a/x/bank/keeper/send.go b/x/bank/keeper/send.go index ced576cdfbf3..afaf44b4d15a 100644 --- a/x/bank/keeper/send.go +++ b/x/bank/keeper/send.go @@ -4,7 +4,6 @@ import ( "fmt" "github.com/cosmos/cosmos-sdk/codec" - util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" "github.com/cosmos/cosmos-sdk/telemetry" @@ -446,7 +445,7 @@ func (k BaseSendKeeper) IterateSendEnabledEntries(ctx sdk.Context, cb func(denom seStore := k.getSendEnabledPrefixStore(ctx) iterator := seStore.Iterator(nil, nil) - defer util.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) + defer sdk.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) for ; iterator.Valid(); iterator.Next() { denom := string(iterator.Key()) diff --git a/x/bank/keeper/view.go b/x/bank/keeper/view.go index f0eeb08f1634..c761163beab2 100644 --- a/x/bank/keeper/view.go +++ b/x/bank/keeper/view.go @@ -7,7 +7,6 @@ import ( "github.com/tendermint/tendermint/libs/log" "github.com/cosmos/cosmos-sdk/codec" - util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" sdk "github.com/cosmos/cosmos-sdk/types" @@ -117,7 +116,7 @@ func (k BaseViewKeeper) IterateAccountBalances(ctx sdk.Context, addr sdk.AccAddr accountStore := k.getAccountStore(ctx, addr) iterator := accountStore.Iterator(nil, nil) - defer util.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) + defer sdk.LogDeferred(ctx.Logger(), func() error { return iterator.Close() }) for ; iterator.Valid(); iterator.Next() { denom := string(iterator.Key()) diff --git a/x/bank/migrations/v2/store.go b/x/bank/migrations/v2/store.go index 1eab68fe5e64..7b9331bdfbdf 100644 --- a/x/bank/migrations/v2/store.go +++ b/x/bank/migrations/v2/store.go @@ -3,7 +3,6 @@ package v2 import ( "cosmossdk.io/math" "github.com/cosmos/cosmos-sdk/codec" - util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" sdk "github.com/cosmos/cosmos-sdk/types" @@ -60,7 +59,7 @@ func migrateBalanceKeys(store sdk.KVStore, logger log.Logger) { oldStore := prefix.NewStore(store, v1.BalancesPrefix) oldStoreIter := oldStore.Iterator(nil, nil) - defer util.LogDeferred(logger, func() error { return oldStoreIter.Close() }) + defer sdk.LogDeferred(logger, func() error { return oldStoreIter.Close() }) for ; oldStoreIter.Valid(); oldStoreIter.Next() { addr := v1.AddressFromBalancesStore(oldStoreIter.Key()) diff --git a/x/bank/migrations/v3/store.go b/x/bank/migrations/v3/store.go index 8074908a8749..5525f0015bff 100644 --- a/x/bank/migrations/v3/store.go +++ b/x/bank/migrations/v3/store.go @@ -2,7 +2,6 @@ package v3 import ( "github.com/cosmos/cosmos-sdk/codec" - util "github.com/cosmos/cosmos-sdk/internal" "github.com/cosmos/cosmos-sdk/store/prefix" storetypes "github.com/cosmos/cosmos-sdk/store/types" sdk "github.com/cosmos/cosmos-sdk/types" @@ -32,7 +31,7 @@ func addDenomReverseIndex(store sdk.KVStore, cdc codec.BinaryCodec, logger log.L oldBalancesStore := prefix.NewStore(store, v2.BalancesPrefix) oldBalancesIter := oldBalancesStore.Iterator(nil, nil) - defer util.LogDeferred(logger, func() error { return oldBalancesIter.Close() }) + defer sdk.LogDeferred(logger, func() error { return oldBalancesIter.Close() }) denomPrefixStores := make(map[string]prefix.Store) // memoize prefix stores @@ -78,7 +77,7 @@ func migrateDenomMetadata(store sdk.KVStore, logger log.Logger) error { oldDenomMetaDataStore := prefix.NewStore(store, v2.DenomMetadataPrefix) oldDenomMetaDataIter := oldDenomMetaDataStore.Iterator(nil, nil) - defer util.LogDeferred(logger, func() error { return oldDenomMetaDataIter.Close() }) + defer sdk.LogDeferred(logger, func() error { return oldDenomMetaDataIter.Close() }) for ; oldDenomMetaDataIter.Valid(); oldDenomMetaDataIter.Next() { oldKey := oldDenomMetaDataIter.Key()