feat(tools/cosmovisor): Introduce a new optional config variable for setting custom path to application data directory

math/dec_test.go

@@ -629,10 +629,10 @@ func BenchmarkMarshalTo(b *testing.B) {
 	}{
 		{
 			math.LegacyNewDec(1e8), []byte{
-				0x31, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
-				0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
-				0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
-			},
+			0x31, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+			0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+			0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30, 0x30,
+		},
 		},
 		{math.LegacyNewDec(0), []byte{0x30}},
 	}
@@ -1067,4 +1067,4 @@ func Test_DocumentLegacyAsymmetry(t *testing.T) {
 	// !!! this is the key point, they are not equal, it looks like a bug
 	require.NotEqual(t, emptyDecJSON, emptyDecRoundTripJSON)
 	require.NotEqual(t, emptyDec, emptyDecRoundTrip)
-}
+}

tools/cosmovisor/CHANGELOG.md

@@ -36,6 +36,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## [Unreleased]
 
+### Improvements
+
+* [#21971](https://github.com/cosmos/cosmos-sdk/pull/21971) Support Custom path to application data directory
+
 ## v1.7.0 - 2024-11-18
 
 ### Features

tools/cosmovisor/README.md

@@ -92,6 +92,7 @@ All arguments passed to `cosmovisor run` will be passed to the application binar
 
 * `DAEMON_HOME` is the location where the `cosmovisor/` directory is kept that contains the genesis binary, the upgrade binaries, and any additional auxiliary files associated with each binary (e.g. `$HOME/.gaiad`, `$HOME/.regend`, `$HOME/.simd`, etc.).
 * `DAEMON_NAME` is the name of the binary itself (e.g. `gaiad`, `regend`, `simd`, etc.).
+* `DAEMON_DATA_DIR` option to set an absolute path to the `data` directory. this path is used to detect upgrade info file and backups. If not set, `$DAEMON_HOME/data` is used.
 * `DAEMON_ALLOW_DOWNLOAD_BINARIES` (*optional*), if set to `true`, will enable auto-downloading of new binaries (for security reasons, this is intended for full nodes rather than validators). By default, `cosmovisor` will not auto-download new binaries.
 * `DAEMON_DOWNLOAD_MUST_HAVE_CHECKSUM` (*optional*, default = `false`), if `true` cosmovisor will require that a checksum is provided in the upgrade plan for the binary to be downloaded. If `false`, cosmovisor will not require a checksum to be provided, but still check the checksum if one is provided.
 * `DAEMON_RESTART_AFTER_UPGRADE` (*optional*, default = `true`), if `true`, restarts the subprocess with the same command-line arguments and flags (but with the new binary) after a successful upgrade. Otherwise (`false`), `cosmovisor` stops running after an upgrade and requires the system administrator to manually restart it. Note restart is only after the upgrade and does not auto-restart the subprocess after an error occurs.
@@ -127,14 +128,24 @@ All arguments passed to `cosmovisor run` will be passed to the application binar
 
 The `cosmovisor/` directory includes a subdirectory for each version of the application (i.e. `genesis` or `upgrades/<name>`). Within each subdirectory is the application binary (i.e. `bin/$DAEMON_NAME`) and any additional auxiliary files associated with each binary. `current` is a symbolic link to the currently active directory (i.e. `genesis` or `upgrades/<name>`). The `name` variable in `upgrades/<name>` is the lowercased URI-encoded name of the upgrade as specified in the upgrade module plan. Note that the upgrade name path are normalized to be lowercased: for instance, `MyUpgrade` is normalized to `myupgrade`, and its path is `upgrades/myupgrade`.
 
-Please note that `$DAEMON_HOME/cosmovisor` only stores the *application binaries*. The `cosmovisor` binary itself can be stored in any typical location (e.g. `/usr/local/bin`). The application will continue to store its data in the default data directory (e.g. `$HOME/.simapp`) or the data directory specified with the `--home` flag. `$DAEMON_HOME` is dependent of the data directory and must be set to the same directory as the data directory, you will end up with a configuration like the following:
+Please note that `$DAEMON_HOME/cosmovisor` only stores the *application binaries*. The `cosmovisor` binary itself can be stored in any typical location (e.g. `/usr/local/bin`). The application will continue to store its data in the default data directory (e.g. `$HOME/.simapp`) or the data directory specified with the `--home` flag. `$DAEMON_HOME` is independent of the data directory and can be set to any location and the actual data directory path can be set through `DAEMON_DATA_DIR` config. If you set `$DAEMON_HOME` to the same directory as the data directory, you will end up with a configuration like the following:
 
 ```text
 .simapp
 ├── config
 ├── data
 └── cosmovisor
 ```
+Otherwise, if you decide to set `$DAEMON_HOME` to an arbitrary location, such as `$HOME/.simapp_manager`, and use the `--home` flag of the application as `$HOME/.simapp`, you must explicitly set the `DAEMON_DATA_DIR` to the application's data directory path, `$HOME/.simapp/data`. Your directory structure will look like this:
+
+```text
+$HOME
+ ├── .simapp
+ │   ├── config
+ │   └── data
+ └── .simapp_manager
+     └── cosmovisor
+```
 
 ## Usage
 

tools/cosmovisor/args.go

@@ -31,6 +31,7 @@ const (
 	EnvShutdownGrace            = "DAEMON_SHUTDOWN_GRACE"
 	EnvSkipBackup               = "UNSAFE_SKIP_BACKUP"
 	EnvDataBackupPath           = "DAEMON_DATA_BACKUP_DIR"
+	EnvDataPath                 = "DAEMON_DATA_DIR"
 	EnvInterval                 = "DAEMON_POLL_INTERVAL"
 	EnvPreupgradeMaxRetries     = "DAEMON_PREUPGRADE_MAX_RETRIES"
 	EnvGRPCAddress              = "DAEMON_GRPC_ADDRESS"
@@ -46,6 +47,7 @@ const (
 	genesisDir  = "genesis"
 	upgradesDir = "upgrades"
 	currentLink = "current"
+	dataDir     = "data"
 
 	cfgFileName  = "config"
 	cfgExtension = "toml"
@@ -63,6 +65,7 @@ type Config struct {
 	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"`
+	DataPath                 string        `toml:"daemon_data_dir" mapstructure:"daemon_data_dir"`
 	PreUpgradeMaxRetries     int           `toml:"daemon_preupgrade_max_retries" mapstructure:"daemon_preupgrade_max_retries" default:"0"`
 	GRPCAddress              string        `toml:"daemon_grpc_address" mapstructure:"daemon_grpc_address"`
 	DisableLogs              bool          `toml:"cosmovisor_disable_logs" mapstructure:"cosmovisor_disable_logs" default:"false"`
@@ -108,7 +111,11 @@ func (cfg *Config) BaseUpgradeDir() string {
 
 // UpgradeInfoFilePath is the expected upgrade-info filename created by `x/upgrade/keeper`.
 func (cfg *Config) UpgradeInfoFilePath() string {
-	return filepath.Join(cfg.Home, "data", upgradetypes.UpgradeInfoFilename)
+	return filepath.Join(cfg.DataPath, upgradetypes.UpgradeInfoFilename)
+}
+
+func (cfg *Config) DefaultDataDirPath() string {
+	return filepath.Join(cfg.Home, dataDir)
 }
 
 // UpgradeInfoBatchFilePath is the same as UpgradeInfoFilePath but with a batch suffix.
@@ -219,13 +226,18 @@ func GetConfigFromEnv(skipValidate bool) (*Config, error) {
 		Home:             os.Getenv(EnvHome),
 		Name:             os.Getenv(EnvName),
 		DataBackupPath:   os.Getenv(EnvDataBackupPath),
+		DataPath:         os.Getenv(EnvDataPath),
 		CustomPreUpgrade: os.Getenv(EnvCustomPreupgrade),
 	}
 
 	if cfg.DataBackupPath == "" {
 		cfg.DataBackupPath = cfg.Home
 	}
 
+	if cfg.DataPath == "" {
+		cfg.DataPath = cfg.DefaultDataDirPath()
+	}
+
 	var err error
 	if cfg.AllowDownloadBinaries, err = BooleanOption(EnvDownloadBin, false); err != nil {
 		errs = append(errs, err)
@@ -358,6 +370,20 @@ func (cfg *Config) validate() []error {
 			errs = append(errs, fmt.Errorf("%s is not a directory", cfg.Root()))
 		}
 	}
+	// validate DataPath
+	switch {
+	case cfg.DataPath == "":
+		errs = append(errs, fmt.Errorf("%s is not set", EnvDataPath))
+	case !filepath.IsAbs(cfg.DataPath):
+		errs = append(errs, fmt.Errorf("%s must be an absolute path", EnvDataPath))
+	default:
+		switch info, err := os.Stat(cfg.DataPath); {
+		case err != nil:
+			errs = append(errs, fmt.Errorf("%q must be a valid directory: %w", cfg.DataPath, err))
+		case !info.IsDir():
+			errs = append(errs, fmt.Errorf("%q must be a valid directory", cfg.DataPath))
+		}
+	}
 
 	// check the DataBackupPath
 	if cfg.UnsafeSkipBackup {
@@ -555,6 +581,7 @@ func (cfg Config) DetailString() string {
 		{EnvInterval, cfg.PollInterval.String()},
 		{EnvSkipBackup, fmt.Sprintf("%t", cfg.UnsafeSkipBackup)},
 		{EnvDataBackupPath, cfg.DataBackupPath},
+		{EnvDataPath, cfg.DataPath},
 		{EnvPreupgradeMaxRetries, fmt.Sprintf("%d", cfg.PreUpgradeMaxRetries)},
 		{EnvDisableLogs, fmt.Sprintf("%t", cfg.DisableLogs)},
 		{EnvColorLogs, fmt.Sprintf("%t", cfg.ColorLogs)},
@@ -569,6 +596,7 @@ func (cfg Config) DetailString() string {
 		{"Genesis Bin", cfg.GenesisBin()},
 		{"Monitored File", cfg.UpgradeInfoFilePath()},
 		{"Data Backup Dir", cfg.DataBackupPath},
+		{"Data Dir", cfg.DataPath},
 	}
 
 	var sb strings.Builder