feat: add Close method for resource cleanup in graceful shutdown (backport cosmos#16193) (cosmos#16205)

Co-authored-by: yihuang <[email protected]>
Co-authored-by: Julien Robert <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -46,6 +46,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (gov) [#15979](https://github.com/cosmos/cosmos-sdk/pull/15979) Improve gov error message when failing to convert v1 proposal to v1beta1.
 * (server) [#16061](https://github.com/cosmos/cosmos-sdk/pull/16061) add comet bootstrap command
 * (store) [#16067](https://github.com/cosmos/cosmos-sdk/pull/16067) Add local snapshots management commands.
+* (baseapp) [#16193](https://github.com/cosmos/cosmos-sdk/pull/16193) Add `Close` method to `BaseApp` for custom app to cleanup resource in graceful shutdown.
 
 ### Bug Fixes
 

baseapp/baseapp.go

@@ -1096,107 +1096,7 @@ func makeABCIData(msgResponses []*codectypes.Any) ([]byte, error) {
 	return proto.Marshal(&sdk.TxMsgData{MsgResponses: msgResponses})
 }
 
-func createEvents(cdc codec.Codec, events sdk.Events, msg sdk.Msg, reflectMsg protoreflect.Message) (sdk.Events, error) {
-	eventMsgName := sdk.MsgTypeURL(msg)
-	msgEvent := sdk.NewEvent(sdk.EventTypeMessage, sdk.NewAttribute(sdk.AttributeKeyAction, eventMsgName))
-
-	// we set the signer attribute as the sender
-	signers, err := cdc.GetReflectMsgSigners(reflectMsg)
-	if err != nil {
-		return nil, err
-	}
-	if len(signers) > 0 && signers[0] != nil {
-		addrStr, err := cdc.InterfaceRegistry().SigningContext().AddressCodec().BytesToString(signers[0])
-		if err != nil {
-			return nil, err
-		}
-		msgEvent = msgEvent.AppendAttributes(sdk.NewAttribute(sdk.AttributeKeySender, addrStr))
-	}
-
-	// verify that events have no module attribute set
-	if _, found := events.GetAttributes(sdk.AttributeKeyModule); !found {
-		if moduleName := sdk.GetModuleNameFromTypeURL(eventMsgName); moduleName != "" {
-			msgEvent = msgEvent.AppendAttributes(sdk.NewAttribute(sdk.AttributeKeyModule, moduleName))
-		}
-	}
-
-	return sdk.Events{msgEvent}.AppendEvents(events), nil
-}
-
-// PrepareProposalVerifyTx performs transaction verification when a proposer is
-// creating a block proposal during PrepareProposal. Any state committed to the
-// PrepareProposal state internally will be discarded. <nil, err> will be
-// returned if the transaction cannot be encoded. <bz, nil> will be returned if
-// the transaction is valid, otherwise <bz, err> will be returned.
-func (app *BaseApp) PrepareProposalVerifyTx(tx sdk.Tx) ([]byte, error) {
-	bz, err := app.txEncoder(tx)
-	if err != nil {
-		return nil, err
-	}
-
-	_, _, _, err = app.runTx(execModePrepareProposal, bz)
-	if err != nil {
-		return nil, err
-	}
-
-	return bz, nil
-}
-
-// ProcessProposalVerifyTx performs transaction verification when receiving a
-// block proposal during ProcessProposal. Any state committed to the
-// ProcessProposal state internally will be discarded. <nil, err> will be
-// returned if the transaction cannot be decoded. <Tx, nil> will be returned if
-// the transaction is valid, otherwise <Tx, err> will be returned.
-func (app *BaseApp) ProcessProposalVerifyTx(txBz []byte) (sdk.Tx, error) {
-	tx, err := app.txDecoder(txBz)
-	if err != nil {
-		return nil, err
-	}
-
-	_, _, _, err = app.runTx(execModeProcessProposal, txBz)
-	if err != nil {
-		return nil, err
-	}
-
-	return tx, nil
-}
-
-func (app *BaseApp) TxDecode(txBytes []byte) (sdk.Tx, error) {
-	return app.txDecoder(txBytes)
-}
-
-func (app *BaseApp) TxEncode(tx sdk.Tx) ([]byte, error) {
-	return app.txEncoder(tx)
-}
-
 // Close is called in start cmd to gracefully cleanup resources.
 func (app *BaseApp) Close() error {
-	var errs []error
-
-	// Close app.db (opened by cosmos-sdk/server/start.go call to openDB)
-	if app.db != nil {
-		app.logger.Info("Closing application.db")
-		if err := app.db.Close(); err != nil {
-			errs = append(errs, err)
-		}
-	}
-
-	// Close app.snapshotManager
-	// - opened when app chains use cosmos-sdk/server/util.go/DefaultBaseappOptions (boilerplate)
-	// - which calls cosmos-sdk/server/util.go/GetSnapshotStore
-	// - which is passed to baseapp/options.go/SetSnapshot
-	// - to set app.snapshotManager = snapshots.NewManager
-	if app.snapshotManager != nil {
-		app.logger.Info("Closing snapshots/metadata.db")
-		if err := app.snapshotManager.Close(); err != nil {
-			errs = append(errs, err)
-		}
-	}
-
-	return errors.Join(errs...)
-}
-
-// GetBaseApp returns the pointer to itself.
-func (app *BaseApp) GetBaseApp() *BaseApp {
-	return app
+	return nil
 }

server/start.go

@@ -262,9 +262,11 @@ func startStandAlone[T types.Application](svrCtx *Context, svrCfg serverconfig.C
 		if err != nil {
 			return err
 		}
-		// re-assign for making the client available below
-		// do not use := to avoid shadowing clientCtx
-		clientCtx = clientCtx.WithClient(rpcclient)
+
+		if err = app.Close(); err != nil {
+			tmos.Exit(err.Error())
+		}
+	}()
 
 		// use the provided clientCtx to register the services
 		app.RegisterTxService(clientCtx)
@@ -536,6 +538,7 @@ func startApp[T types.Application](svrCtx *Context, appCreator types.AppCreator[
 	defer func() {
 		if tmNode != nil && tmNode.IsRunning() {
 			_ = tmNode.Stop()
+			_ = app.Close()
 		}
 
 		if apiSrv != nil {

server/types/app.go

@@ -57,6 +57,9 @@ type (
 
 		// Return the snapshot manager
 		SnapshotManager() *snapshots.Manager
+
+		// Close is called in start cmd to gracefully cleanup resources.
+		Close() error
 	}
 
 	// ApplicationQueryService defines an extension of the Application interface