Server TOML config template can get out of sync with config.go

[gibson042]

Is there an existing issue for this?

• I have searched the existing issues

What happened?

server/config/toml.go includes contents that are similar to those of server/config/config.go, but any synchronization between the two locations is manual so there are undesirable differences (and some undesirable similarities, such as using the CamelCase Go names to comment on TOML settings like halt-height).

To remedy this, I would recommend programmatically deriving the TOML template from the Go config structs and their doc comments in a build step. Here's a proof of concept that parses Go source text and emits TOML template text: https://go.dev/play/p/W74nda-DQKZ

Cosmos SDK Version

main

How to reproduce?

No response

[julienrbrt]

Yes 100% agree, we are going to use struct annotations and github.com/pelletier/go-toml/v2 library for server/v2: https://github.com/cosmos/cosmos-sdk/blob/605b724/server/v2/api/grpc/config.go#L19-L34
I don't think it makes sense to refactor the server v0 config.

[julienrbrt]

Could you please point me where you see a missing field between the config.go and the toml.go? I cannot find any.
Removing the bug label as it is more a suggestion / refactor request than a bug.

[gibson042]

Could you please point me where you see a missing field between the config.go and the toml.go? I cannot find any. Removing the bug label as it is more a suggestion / refactor request than a bug.

I don't see any missing fields, but I do see bugs:

• Many TOML comments use Go field names. Example:

  cosmos-sdk/server/config/toml.go

  Lines 38 to 42 in fb29045

  	# HaltHeight contains a non-zero block height at which a node will gracefully
  	# halt and shutdown that can be used to assist upgrades and testing.
  	#
  	# Note: Commitment of state will be attempted on the corresponding block.
  	halt-height = {{ .BaseConfig.HaltHeight }}

  (HaltHeight vs. halt-height)
• Many TOML comments are missing from Go doc comments. Examples:

  • cosmos-sdk/server/config/toml.go

    Lines 34 to 36 in fb29045

    	# These are applied if and only if the pruning strategy is custom.
    	pruning-keep-recent = "{{ .BaseConfig.PruningKeepRecent }}"
    	pruning-interval = "{{ .BaseConfig.PruningInterval }}"

    vs.

    cosmos-sdk/server/config/config.go

    Lines 45 to 47 in fb29045

    	Pruning string `mapstructure:"pruning"`
    	PruningKeepRecent string `mapstructure:"pruning-keep-recent"`
    	PruningInterval string `mapstructure:"pruning-interval"`

  • cosmos-sdk/server/config/toml.go

    Lines 84 to 87 in fb29045

    	# AppDBBackend defines the database backend type to use for the application and snapshots DBs.
    	# An empty string indicates that a fallback will be used.
    	# The fallback is the db_backend value set in CometBFT's config.toml.
    	app-db-backend = "{{ .BaseConfig.AppDBBackend }}"

    vs.

    cosmos-sdk/server/config/config.go

    Lines 91 to 93 in fb29045

    	// AppDBBackend defines the type of Database to use for the application and snapshots databases.
    	// An empty string indicates that the CometBFT config's DBBackend value should be used.
    	AppDBBackend string `mapstructure:"app-db-backend"`

  • cosmos-sdk/server/config/toml.go

    Lines 221 to 235 in fb29045

    	# List of kv store keys to stream out via gRPC.
    	# The store key names MUST match the module's StoreKey name.
    	#
    	# Example:
    	# ["acc", "bank", "gov", "staking", "mint"[,...]]
    	# ["*"] to expose all keys.
    	keys = [{{ range .Streaming.ABCI.Keys }}{{ printf "%q, " . }}{{end}}]
    	# The plugin name used for streaming via gRPC.
    	# Streaming is only enabled if this is set.
    	# Supported plugins: abci
    	plugin = "{{ .Streaming.ABCI.Plugin }}"
    	# stop-node-on-err specifies whether to stop the node on message delivery error.
    	stop-node-on-err = {{ .Streaming.ABCI.StopNodeOnErr }}

    vs.

    cosmos-sdk/server/config/config.go

    Lines 178 to 182 in fb29045

    	ABCIListenerConfig struct {
    	Keys []string `mapstructure:"keys"`
    	Plugin string `mapstructure:"plugin"`
    	StopNodeOnErr bool `mapstructure:"stop-node-on-err"`
    	}

[julienrbrt]

Could you please point me where you see a missing field between the config.go and the toml.go? I cannot find any. Removing the bug label as it is more a suggestion / refactor request than a bug.

I don't see any missing fields, but I do see bugs:

• Many TOML comments use Go field names. Example:

  cosmos-sdk/server/config/toml.go

  Lines 38 to 42 in fb29045

  	# HaltHeight contains a non-zero block height at which a node will gracefully
  	# halt and shutdown that can be used to assist upgrades and testing.
  	#
  	# Note: Commitment of state will be attempted on the corresponding block.
  	halt-height = {{ .BaseConfig.HaltHeight }}

  (HaltHeight vs. halt-height)

• Many TOML comments are missing from Go doc comments. Examples:

  • cosmos-sdk/server/config/toml.go

    Lines 34 to 36 in fb29045

    	# These are applied if and only if the pruning strategy is custom.
    	pruning-keep-recent = "{{ .BaseConfig.PruningKeepRecent }}"
    	pruning-interval = "{{ .BaseConfig.PruningInterval }}"

    vs.

    cosmos-sdk/server/config/config.go

    Lines 45 to 47 in fb29045

    	Pruning string `mapstructure:"pruning"`
    	PruningKeepRecent string `mapstructure:"pruning-keep-recent"`
    	PruningInterval string `mapstructure:"pruning-interval"`

  • cosmos-sdk/server/config/toml.go

    Lines 84 to 87 in fb29045

    	# AppDBBackend defines the database backend type to use for the application and snapshots DBs.
    	# An empty string indicates that a fallback will be used.
    	# The fallback is the db_backend value set in CometBFT's config.toml.
    	app-db-backend = "{{ .BaseConfig.AppDBBackend }}"

    vs.

    cosmos-sdk/server/config/config.go

    Lines 91 to 93 in fb29045

    	// AppDBBackend defines the type of Database to use for the application and snapshots databases.
    	// An empty string indicates that the CometBFT config's DBBackend value should be used.
    	AppDBBackend string `mapstructure:"app-db-backend"`

  • cosmos-sdk/server/config/toml.go

    Lines 221 to 235 in fb29045

    	# List of kv store keys to stream out via gRPC.
    	# The store key names MUST match the module's StoreKey name.
    	#
    	# Example:
    	# ["acc", "bank", "gov", "staking", "mint"[,...]]
    	# ["*"] to expose all keys.
    	keys = [{{ range .Streaming.ABCI.Keys }}{{ printf "%q, " . }}{{end}}]
    	# The plugin name used for streaming via gRPC.
    	# Streaming is only enabled if this is set.
    	# Supported plugins: abci
    	plugin = "{{ .Streaming.ABCI.Plugin }}"
    	# stop-node-on-err specifies whether to stop the node on message delivery error.
    	stop-node-on-err = {{ .Streaming.ABCI.StopNodeOnErr }}

    vs.

    cosmos-sdk/server/config/config.go

    Lines 178 to 182 in fb29045

    	ABCIListenerConfig struct {
    	Keys []string `mapstructure:"keys"`
    	Plugin string `mapstructure:"plugin"`
    	StopNodeOnErr bool `mapstructure:"stop-node-on-err"`
    	}

Right, I see. We could fix those inconsistencies indeed regarding the comments.