feat(cosmovisor): load cosmovisor configuration from toml file #19995
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
WalkthroughWalkthroughThe recent updates to the Cosmovisor tool focus on enhancing configuration management. Key changes include the integration of a configuration file system, improved error handling, and the ability to export and import configurations. Commands have been updated to support new configuration pathways, and a new flag has been introduced across various commands to specify the config file path, streamlining the tool's usability and flexibility. Changes
Recent Review DetailsConfiguration used: .coderabbit.yml Files selected for processing (1)
Files skipped from review due to trivial changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| func mustNoError(err error) { | ||
| if err != nil { | ||
| panic(err) | ||
| } |
There was a problem hiding this comment.
Consider enhancing the mustNoError function by adding logging before panicking to provide more context about the error, which can be helpful for debugging.
func mustNoError(err error) {
if err != nil {
+ log.Error("An error occurred:", err)
panic(err)
}
}Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| func mustNoError(err error) { | |
| if err != nil { | |
| panic(err) | |
| } | |
| func mustNoError(err error) { | |
| if err != nil { | |
| log.Error("An error occurred:", err) | |
| panic(err) | |
| } | |
| } |
|
Hey @julienrbrt. Should I mark these changes under version |
|
Hi, you can just leave it under unreleased. A new version of cosmovisor is due soon but there is other issues to fix before tagging a new version. |
tools/cosmovisor/CHANGELOG.md
Outdated
| * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`. | ||
| * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run` | ||
| * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`. |
There was a problem hiding this comment.
Adjust the indentation of the unordered list items to align with the markdown standards (4 spaces instead of 2).
- * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`.
+ * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`.
- * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run`
+ * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run`
- * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`.
+ * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`. | |
| * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run` | |
| * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`. | |
| * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`. | |
| * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run` | |
| * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`. |
| @@ -36,6 +36,17 @@ Ref: https://keepachangelog.com/en/1.0.0/ | |||
|
|
|||
| ## [Unreleased] | |||
|
|
|||
| ## Features | |||
There was a problem hiding this comment.
Ensure there is a blank line before the "Features" heading to maintain consistency and readability.
+
## FeaturesCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ## Features | |
| ## Features |
| @@ -36,6 +36,17 @@ | |||
|
|
|||
| ## [Unreleased] | |||
|
|
|||
| ## Features | |||
|
|
|||
| * [#19764](https://github.com/cosmos/cosmos-sdk/issues/19764) Use config file for cosmovisor configuration. | |||
There was a problem hiding this comment.
Ensure there is a blank line after the "Features" list item to separate it from the next section for better readability.
* [#19764](https://github.com/cosmos/cosmos-sdk/issues/19764) Use config file for cosmovisor configuration.
+ Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * [#19764](https://github.com/cosmos/cosmos-sdk/issues/19764) Use config file for cosmovisor configuration. | |
| * [#19764](https://github.com/cosmos/cosmos-sdk/issues/19764) Use config file for cosmovisor configuration. | |
|
|
||
| * [#19764](https://github.com/cosmos/cosmos-sdk/issues/19764) Use config file for cosmovisor configuration. | ||
|
|
||
| ## Improvements |
There was a problem hiding this comment.
Ensure there is a blank line before the "Improvements" heading to maintain consistency and readability.
+
## ImprovementsCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ## Improvements | |
| ## Improvements |
|
|
||
| ## Improvements | ||
|
|
||
| * [#19995](https://github.com/cosmos/cosmos-sdk/pull/19995): |
There was a problem hiding this comment.
Ensure there is a blank line after the "Improvements" list item to separate it from the next section for better readability.
* [#19995](https://github.com/cosmos/cosmos-sdk/pull/19995):
+ Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * [#19995](https://github.com/cosmos/cosmos-sdk/pull/19995): | |
| * [#19995](https://github.com/cosmos/cosmos-sdk/pull/19995): | |
tools/cosmovisor/CHANGELOG.md
Outdated
| * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`. | ||
| * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run` | ||
| * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`. |
There was a problem hiding this comment.
Adjust the indentation of the unordered list items to align with markdown standards (4 spaces instead of 2).
- * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`.
+ * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`.
- * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run`
+ * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run`
- * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`.
+ * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`. | |
| * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run` | |
| * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`. | |
| * Add `--export-config` flag to provide `config.toml` path to initialise configuration in `cosmovisor init`. | |
| * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run` | |
| * Add `--config` flag to provide `config.toml` path to the configuration file in `cosmovisor add-upgrade`. |
tools/cosmovisor/args.go
Outdated
| TimeFormatLogs string | ||
| CustomPreupgrade string | ||
| DisableRecase bool | ||
| Home string `toml:"DAEMON_HOME" mapstructure:"DAEMON_HOME"` |
There was a problem hiding this comment.
Can we have the toml keys lower-case and kebab-case? This looks odd
tools/cosmovisor/args.go
Outdated
| // If ENV variables are set, they will override the values in the file. | ||
| func GetConfigFromFile(filePath string) (*Config, error) { | ||
| if filePath == "" { | ||
| return nil, ErrEmptyConfigENV |
There was a problem hiding this comment.
I don't think we should return an error, that will be a behavior change for existing users. Maybe we should use a temporary empty file? Quite hacky, but at least it will preserve the current behavior for users that won't use the config file.
There was a problem hiding this comment.
Make sense.
Updated. Now if the filePath is not provided instead of returning an error it will try to load config from env variables
|
|
||
| return addUpgrade | ||
| } | ||
|
|
||
| // AddUpgrade adds upgrade info to manifest | ||
| func AddUpgrade(cmd *cobra.Command, args []string) error { | ||
| cfg, err := cosmovisor.GetConfigFromEnv() | ||
| configPath, err := cmd.Flags().GetString(cosmovisor.FlagConfig) |
There was a problem hiding this comment.
shouldn't we read the config in the root command and pass it down to sub commands?
this way we can have a persistent flag on the root command and avoid adding a flag to each command.
There was a problem hiding this comment.
I have used two flags:
configfor taking config file as input used by (add-upgrade)export-configfor exporting configuration to toml file used by (init).
Using config flag in root command will create confusion for user as they will see both flags export-config and config for init command.
There was a problem hiding this comment.
Yes, I don't think we should allow to export during init. Imho init should always create the file (maybe ask for a confirmation if the file already exists).
Additionally for people upgrading having an export command that converts flags to a config flag would be handy.
Additionally this way you don't have clashing flag names as you just pointed out.
There was a problem hiding this comment.
Make sense.
So basically init command should only write to default path(leaving file already exist case aside).
additionally export command can read the config from the file(override if env is set) and print it.
| }, | ||
| } | ||
|
|
||
| initCmd.Flags().String(cosmovisor.FlagExportConfig, "", "path to export the configuration file to (default is <-home_path->/cosmovisor/config.toml") |
There was a problem hiding this comment.
I don't see where the default is set.
IMHO it shouldn't be current dir but within the node directory (DAEMON_HOME)
| filePath, err := cfg.Export() | ||
| if err != nil { | ||
| return fmt.Errorf("failed to export configuration: %w", err) | ||
| } | ||
|
|
||
| logger.Info(fmt.Sprintf("config file present at: %s", filePath)) | ||
|
|
There was a problem hiding this comment.
Validate the configuration export path before proceeding.
Before exporting the configuration, validate that the path is writable and not already occupied by crucial files. This prevents potential data loss by ensuring that the export operation does not overwrite important files unintentionally.
tools/cosmovisor/CHANGELOG.md
Outdated
| * `init command` writes the configuration to the config file only at the default path `DAEMON_HOME/cosmovisor/config.toml`. | ||
| * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run`. | ||
| * Add `--config` flag to provide `config.toml` path to the configuration file in root command used by `add-upgrade` and `config` subcommands. | ||
| * `config command` now displays the configuration from the config file if it is provided. If the config file is not provided, it will display the configuration from the environment variables. |
There was a problem hiding this comment.
Adjust the indentation of list items to align with Markdown standards.
- * `init command` writes the configuration to the config file only at the default path `DAEMON_HOME/cosmovisor/config.toml`.
+ * `init command` writes the configuration to the config file only at the default path `DAEMON_HOME/cosmovisor/config.toml`.
- * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run`.
+ * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run`.
- * Add `--config` flag to provide `config.toml` path to the configuration file in root command used by `add-upgrade` and `config` subcommands.
+ * Add `--config` flag to provide `config.toml` path to the configuration file in root command used by `add-upgrade` and `config` subcommands.
- * `config command` now displays the configuration from the config file if it is provided. If the config file is not provided, it will display the configuration from the environment variables.
+ * `config command` now displays the configuration from the config file if it is provided. If the config file is not provided, it will display the configuration from the environment variables.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * `init command` writes the configuration to the config file only at the default path `DAEMON_HOME/cosmovisor/config.toml`. | |
| * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run`. | |
| * Add `--config` flag to provide `config.toml` path to the configuration file in root command used by `add-upgrade` and `config` subcommands. | |
| * `config command` now displays the configuration from the config file if it is provided. If the config file is not provided, it will display the configuration from the environment variables. | |
| * `init command` writes the configuration to the config file only at the default path `DAEMON_HOME/cosmovisor/config.toml`. | |
| * Set `CONFIG` environment variable to provide `config.toml` path to load the configuration in `cosmovisor run`. | |
| * Add `--config` flag to provide `config.toml` path to the configuration file in root command used by `add-upgrade` and `config` subcommands. | |
| * `config command` now displays the configuration from the config file if it is provided. If the config file is not provided, it will display the configuration from the environment variables. |
|
Thanks for this, I'll review today! |
| runCmd, | ||
| configCmd, | ||
| NewVersionCmd(), | ||
| NewAddUpgradeCmd(), | ||
| ) | ||
|
|
||
| rootCmd.PersistentFlags().String(cosmovisor.FlagConfig, "", "path to cosmovisor config file") |
There was a problem hiding this comment.
Nit, StringP and use c as shortcut
| @@ -18,7 +27,7 @@ var runCmd = &cobra.Command{ | |||
|
|
|||
| // run runs the configured program with the given args and monitors it for upgrades. | |||
| func run(args []string, options ...RunOption) error { | |||
| cfg, err := cosmovisor.GetConfigFromEnv() | |||
| cfg, err := cosmovisor.GetConfigFromFile(os.Getenv(cfgENV)) | |||
There was a problem hiding this comment.
I don't get this, why cannot we use the --config flag from cosmovisor.
I don't like that you need another env variable just for the config name.
There was a problem hiding this comment.
As you can see here run command has disabled flag parsing.
So I didn't want to change the existing behaviour of the run command.
edit:
As of now cosmovisor run -h will not show any flags which might create confusion.
Let me know your thoughts on this I will update it.
There was a problem hiding this comment.
That is true. Then I think we should maybe rename the --config flag so we are sure it won't clash with an app flag, maybe --cosmovisor-config. Then I'd personally say we should parse that one for consistency here too.
It will a tiny be less nice to implement but the UX will be better.
Are you willing to do that? Otherwise happy to do that myself in a follow up.
There was a problem hiding this comment.
Okay.
So you mean we should replace the config flag with cosmovisor-config in root commands and enable flag parsing in run command.
There was a problem hiding this comment.
Yes, but you shouldn't enable flag parsing as you pass the app command there. You'll need to manually parse --cosmovisor-config there and remove it from the arguments you pass to the app.
There was a problem hiding this comment.
Actionable comments posted: 3
Out of diff range and nitpick comments (4)
tools/cosmovisor/args.go (4)
160-202: Review the error handling inGetConfigFromFile. Consider aggregating errors rather than returning immediately to provide more comprehensive feedback to the user.
160-202: The functionGetConfigFromFileshould handle the case where the configuration file is not found more gracefully. Perhaps it could fall back to environment variables if the file is not mandatory.
465-465: ThegetTimeFormatOptionfunction currently returns an error if an unrecognized format is provided. It might be more user-friendly to log a warning and fall back to a default format.
577-609: TheExportfunction should handle potential errors fromfile.Close()in the deferred function by logging them or handling them in another appropriate manner.
| Home string `toml:"daemon_home" mapstructure:"daemon_home"` | ||
| Name string `toml:"daemon_name" mapstructure:"daemon_name"` | ||
| AllowDownloadBinaries bool `toml:"daemon_allow_download_binaries" mapstructure:"daemon_allow_download_binaries" default:"false"` | ||
| DownloadMustHaveChecksum bool `toml:"daemon_download_must_have_checksum" mapstructure:"daemon_download_must_have_checksum" default:"false"` | ||
| RestartAfterUpgrade bool `toml:"daemon_restart_after_upgrade" mapstructure:"daemon_restart_after_upgrade" default:"true"` | ||
| RestartDelay time.Duration `toml:"daemon_restart_delay" mapstructure:"daemon_restart_delay"` | ||
| ShutdownGrace time.Duration `toml:"daemon_shutdown_grace" mapstructure:"daemon_shutdown_grace"` | ||
| PollInterval time.Duration `toml:"daemon_poll_interval" mapstructure:"daemon_poll_interval" default:"300ms"` | ||
| UnsafeSkipBackup bool `toml:"unsafe_skip_backup" mapstructure:"unsafe_skip_backup" default:"false"` | ||
| DataBackupPath string `toml:"daemon_data_backup_dir" mapstructure:"daemon_data_backup_dir"` | ||
| PreUpgradeMaxRetries int `toml:"daemon_preupgrade_max_retries" mapstructure:"daemon_preupgrade_max_retries" default:"0"` | ||
| DisableLogs bool `toml:"cosmovisor_disable_logs" mapstructure:"cosmovisor_disable_logs" default:"false"` | ||
| ColorLogs bool `toml:"cosmovisor_color_logs" mapstructure:"cosmovisor_color_logs" default:"true"` | ||
| TimeFormatLogs string `toml:"cosmovisor_timeformat_logs" mapstructure:"cosmovisor_timeformat_logs" default:"kitchen"` | ||
| CustomPreUpgrade string `toml:"cosmovisor_custom_preupgrade" mapstructure:"cosmovisor_custom_preupgrade" default:""` | ||
| DisableRecase bool `toml:"cosmovisor_disable_recase" mapstructure:"cosmovisor_disable_recase" default:"false"` |
There was a problem hiding this comment.
Ensure that the TOML tags are in kebab-case as per previous review comments.
| return getTimeFormatOption(val) | ||
| } | ||
|
|
||
| func getTimeFormatOption(val string) (string, error) { |
There was a problem hiding this comment.
The getTimeFormatOption function should handle an empty string case more gracefully by returning a default or previously set value instead of an empty string, which might not be a valid time format.
| // Export exports the configuration to a file at the given path. | ||
| func (cfg Config) Export() (string, error) { | ||
| // always use the default path | ||
| path := filepath.Clean(cfg.DefaultCfgPath()) | ||
|
|
||
| // check if config file already exists ask user if they want to overwrite it | ||
| if _, err := os.Stat(path); err == nil { | ||
| // ask user if they want to overwrite the file | ||
| if !askForConfirmation(fmt.Sprintf("file %s already exists, do you want to overwrite it?", path)) { | ||
| cfg.Logger(os.Stdout).Info("file already exists, not overriding") | ||
| return path, nil | ||
| } | ||
| } | ||
|
|
||
| // create the file | ||
| file, err := os.Create(filepath.Clean(path)) | ||
| if err != nil { | ||
| return "", fmt.Errorf("failed to create configuration file: %w", err) | ||
| } | ||
|
|
||
| // convert the time value to its format option | ||
| cfg.TimeFormatLogs = ValueToTimeFormatOption(cfg.TimeFormatLogs) | ||
|
|
||
| defer file.Close() | ||
|
|
||
| // write the configuration to the file | ||
| err = toml.NewEncoder(file).Encode(cfg) | ||
| if err != nil { | ||
| return "", fmt.Errorf("failed to encode configuration: %w", err) | ||
| } | ||
|
|
||
| return path, nil | ||
| } |
There was a problem hiding this comment.
In the Export function, the confirmation prompt logic could be improved. Consider moving the prompt into a separate function to clean up the Export function and make it more readable.
- if !askForConfirmation(fmt.Sprintf("file %s already exists, do you want to overwrite it?", path)) {
- cfg.Logger(os.Stdout).Info("file already exists, not overriding")
- return path, nil
- }
+ if fileExists(path) {
+ if !confirmOverwrite(path) {
+ cfg.Logger(os.Stdout).Info("file already exists, not overriding")
+ return path, nil
+ }
+ }Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| // Export exports the configuration to a file at the given path. | |
| func (cfg Config) Export() (string, error) { | |
| // always use the default path | |
| path := filepath.Clean(cfg.DefaultCfgPath()) | |
| // check if config file already exists ask user if they want to overwrite it | |
| if _, err := os.Stat(path); err == nil { | |
| // ask user if they want to overwrite the file | |
| if !askForConfirmation(fmt.Sprintf("file %s already exists, do you want to overwrite it?", path)) { | |
| cfg.Logger(os.Stdout).Info("file already exists, not overriding") | |
| return path, nil | |
| } | |
| } | |
| // create the file | |
| file, err := os.Create(filepath.Clean(path)) | |
| if err != nil { | |
| return "", fmt.Errorf("failed to create configuration file: %w", err) | |
| } | |
| // convert the time value to its format option | |
| cfg.TimeFormatLogs = ValueToTimeFormatOption(cfg.TimeFormatLogs) | |
| defer file.Close() | |
| // write the configuration to the file | |
| err = toml.NewEncoder(file).Encode(cfg) | |
| if err != nil { | |
| return "", fmt.Errorf("failed to encode configuration: %w", err) | |
| } | |
| return path, nil | |
| } | |
| // Export exports the configuration to a file at the given path. | |
| func (cfg Config) Export() (string, error) { | |
| // always use the default path | |
| path := filepath.Clean(cfg.DefaultCfgPath()) | |
| // check if config file already exists ask user if they want to overwrite it | |
| if _, err := os.Stat(path); err == nil { | |
| // ask user if they want to overwrite the file | |
| if fileExists(path) { | |
| if !confirmOverwrite(path) { | |
| cfg.Logger(os.Stdout).Info("file already exists, not overriding") | |
| return path, nil | |
| } | |
| } | |
| } | |
| // create the file | |
| file, err := os.Create(filepath.Clean(path)) | |
| if err != nil { | |
| return "", fmt.Errorf("failed to create configuration file: %w", err) | |
| } | |
| // convert the time value to its format option | |
| cfg.TimeFormatLogs = ValueToTimeFormatOption(cfg.TimeFormatLogs) | |
| defer file.Close() | |
| // write the configuration to the file | |
| err = toml.NewEncoder(file).Encode(cfg) | |
| if err != nil { | |
| return "", fmt.Errorf("failed to encode configuration: %w", err) | |
| } | |
| return path, nil | |
| } |
|
|
||
| ## Improvements | ||
|
|
||
| * [#19995](https://github.com/cosmos/cosmos-sdk/pull/19995): |
There was a problem hiding this comment.
Nice description here, could you as well update the README with almost a copy paste of that :D
Description
Closes: #19764
configflag andexport-configconfig.tomlconfig.tomlto load config structAuthor Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
Summary by CodeRabbit
New Features
initcommand to automatically write configuration to a default path.--cosmovisor-configto specify the config file path across various commands.Enhancements
Refactor
initCmd.runCmdto include detailed descriptions and handle new configuration parsing logic.Bug Fixes