feat(server): Allow calling back into the application struct in PostSetup. #19455
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -108,26 +108,28 @@ const ( | |||||
| ) | ||||||
|
|
||||||
| // StartCmdOptions defines options that can be customized in `StartCmdWithOptions`, | ||||||
| type StartCmdOptions[T types.Application] struct { | ||||||
| // DBOpener can be used to customize db opening, for example customize db options or support different db backends, | ||||||
| // default to the builtin db opener. | ||||||
| DBOpener func(rootDir string, backendType dbm.BackendType) (dbm.DB, error) | ||||||
| // PostSetup can be used to setup extra services under the same cancellable context, | ||||||
| // it's not called in stand-alone mode, only for in-process mode. | ||||||
| PostSetup func(app T, svrCtx *Context, clientCtx client.Context, ctx context.Context, g *errgroup.Group) error | ||||||
| // PostSetupStandalone can be used to setup extra services under the same cancellable context, | ||||||
| PostSetupStandalone func(app T, svrCtx *Context, clientCtx client.Context, ctx context.Context, g *errgroup.Group) error | ||||||
| // AddFlags add custom flags to start cmd | ||||||
| AddFlags func(cmd *cobra.Command) | ||||||
| } | ||||||
|
|
||||||
| // StartCmd runs the service passed in, either stand-alone or in-process with | ||||||
| // CometBFT. | ||||||
| func StartCmd[T types.Application](appCreator types.AppCreator[T]) *cobra.Command { | ||||||
| return StartCmdWithOptions(appCreator, StartCmdOptions[T]{}) | ||||||
| } | ||||||
|
|
||||||
| // StartCmdWithOptions runs the service passed in, either stand-alone or in-process with | ||||||
| // CometBFT. | ||||||
| func StartCmdWithOptions[T types.Application](appCreator types.AppCreator[T], opts StartCmdOptions[T]) *cobra.Command { | ||||||
| if opts.DBOpener == nil { | ||||||
| opts.DBOpener = OpenDB | ||||||
| } | ||||||
|
|
@@ -199,13 +201,13 @@ is performed. Note, when enabled, gRPC will also be automatically enabled. | |||||
| return cmd | ||||||
| } | ||||||
|
|
||||||
| func start[T types.Application](svrCtx *Context, clientCtx client.Context, appCreator types.AppCreator[T], withCmt bool, opts StartCmdOptions[T]) error { | ||||||
| svrCfg, err := getAndValidateConfig(svrCtx) | ||||||
| if err != nil { | ||||||
| return err | ||||||
| } | ||||||
|
|
||||||
| app, appCleanupFn, err := startApp[T](svrCtx, appCreator, opts) | ||||||
| if err != nil { | ||||||
| return err | ||||||
| } | ||||||
|
|
@@ -219,12 +221,12 @@ func start(svrCtx *Context, clientCtx client.Context, appCreator types.AppCreato | |||||
| emitServerInfoMetrics() | ||||||
|
|
||||||
| if !withCmt { | ||||||
| return startStandAlone[T](svrCtx, svrCfg, clientCtx, app, metrics, opts) | ||||||
| } | ||||||
| return startInProcess[T](svrCtx, svrCfg, clientCtx, app, metrics, opts) | ||||||
| } | ||||||
|
|
||||||
| func startStandAlone[T types.Application](svrCtx *Context, svrCfg serverconfig.Config, clientCtx client.Context, app T, metrics *telemetry.Metrics, opts StartCmdOptions[T]) error { | ||||||
| addr := svrCtx.Viper.GetString(flagAddress) | ||||||
| transport := svrCtx.Viper.GetString(flagTransport) | ||||||
|
|
||||||
|
|
@@ -271,6 +273,12 @@ func startStandAlone(svrCtx *Context, svrCfg serverconfig.Config, clientCtx clie | |||||
| return err | ||||||
| } | ||||||
|
|
||||||
| if opts.PostSetup != nil { | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. @itsdevbear, it should still be committed as you've forced pushed your last commit, which removed this. |
||||||
| if err := opts.PostSetupStandalone(app, svrCtx, clientCtx, ctx, g); err != nil { | ||||||
| return err | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| g.Go(func() error { | ||||||
| if err := svr.Start(); err != nil { | ||||||
| svrCtx.Logger.Error("failed to start out-of-process ABCI server", "err", err) | ||||||
|
|
@@ -287,8 +295,8 @@ func startStandAlone(svrCtx *Context, svrCfg serverconfig.Config, clientCtx clie | |||||
| return g.Wait() | ||||||
| } | ||||||
|
|
||||||
| func startInProcess[T types.Application](svrCtx *Context, svrCfg serverconfig.Config, clientCtx client.Context, app T, | ||||||
| metrics *telemetry.Metrics, opts StartCmdOptions[T], | ||||||
| ) error { | ||||||
| cmtCfg := svrCtx.Config | ||||||
| home := cmtCfg.RootDir | ||||||
|
|
@@ -334,7 +342,7 @@ func startInProcess(svrCtx *Context, svrCfg serverconfig.Config, clientCtx clien | |||||
| } | ||||||
|
|
||||||
| if opts.PostSetup != nil { | ||||||
| if err := opts.PostSetup(app, svrCtx, clientCtx, ctx, g); err != nil { | ||||||
| return err | ||||||
| } | ||||||
| } | ||||||
|
|
@@ -585,7 +593,7 @@ func getCtx(svrCtx *Context, block bool) (*errgroup.Group, context.Context) { | |||||
| return g, ctx | ||||||
| } | ||||||
|
|
||||||
| func startApp[T types.Application](svrCtx *Context, appCreator types.AppCreator[T], opts StartCmdOptions[T]) (app T, cleanupFn func(), err error) { | ||||||
| traceWriter, traceCleanupFn, err := SetupTraceWriter(svrCtx.Logger, svrCtx.Viper.GetString(flagTraceStore)) | ||||||
| if err != nil { | ||||||
| return app, traceCleanupFn, err | ||||||
|
|
@@ -598,10 +606,12 @@ func startApp(svrCtx *Context, appCreator types.AppCreator, opts StartCmdOptions | |||||
| } | ||||||
|
|
||||||
| if isTestnet, ok := svrCtx.Viper.Get(KeyIsTestnet).(bool); ok && isTestnet { | ||||||
| var appPtr *T | ||||||
| appPtr, err = testnetify[T](svrCtx, home, appCreator, db, traceWriter) | ||||||
| if err != nil { | ||||||
| return app, traceCleanupFn, err | ||||||
| } | ||||||
| app = *appPtr | ||||||
| } else { | ||||||
| app = appCreator(svrCtx.Logger, db, traceWriter, svrCtx.Viper) | ||||||
| } | ||||||
|
|
@@ -618,8 +628,8 @@ func startApp(svrCtx *Context, appCreator types.AppCreator, opts StartCmdOptions | |||||
| // InPlaceTestnetCreator utilizes the provided chainID and operatorAddress as well as the local private validator key to | ||||||
| // control the network represented in the data folder. This is useful to create testnets nearly identical to your | ||||||
| // mainnet environment. | ||||||
| func InPlaceTestnetCreator[T types.Application](testnetAppCreator types.AppCreator[T]) *cobra.Command { | ||||||
| opts := StartCmdOptions[T]{} | ||||||
| if opts.DBOpener == nil { | ||||||
| opts.DBOpener = OpenDB | ||||||
| } | ||||||
|
|
@@ -711,7 +721,7 @@ you want to test the upgrade handler itself. | |||||
|
|
||||||
| // testnetify modifies both state and blockStore, allowing the provided operator address and local validator key to control the network | ||||||
| // that the state in the data folder represents. The chainID of the local genesis file is modified to match the provided chainID. | ||||||
| func testnetify[T types.Application](ctx *Context, home string, testnetAppCreator types.AppCreator[T], db dbm.DB, traceWriter io.WriteCloser) (*T, error) { | ||||||
| config := ctx.Config | ||||||
|
|
||||||
| newChainID, ok := ctx.Viper.Get(KeyNewChainID).(string) | ||||||
|
Comment on lines
721
to
727
There was a problem hiding this comment.
The + // Explanation of the logic and its impact on the application's state |
||||||
|
|
@@ -925,11 +935,11 @@ func testnetify(ctx *Context, home string, testnetAppCreator types.AppCreator, d | |||||
| return nil, err | ||||||
| } | ||||||
|
|
||||||
| return &testnetApp, err | ||||||
| } | ||||||
|
|
||||||
| // addStartNodeFlags should be added to any CLI commands that start the network. | ||||||
| func addStartNodeFlags[T types.Application](cmd *cobra.Command, opts StartCmdOptions[T]) { | ||||||
| cmd.Flags().Bool(flagWithComet, true, "Run abci app embedded in-process with CometBFT") | ||||||
| cmd.Flags().String(flagAddress, "tcp://127.0.0.1:26658", "Listen address") | ||||||
| cmd.Flags().String(flagTransport, "socket", "Transport protocol: socket, grpc") | ||||||
|
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
startfunction's adaptation to use generics is well-implemented. However, consider adding error handling for thestartStandAloneandstartInProcesscalls to ensure any errors during the startup process are appropriately managed.