fix(cosmovisor): premature upgrade on restart (#22528)

akhilkumarpilli · web-flow · commit fbd725dce77e · 2024-11-18T08:46:41.000Z
diff --git a/tools/cosmovisor/CHANGELOG.md b/tools/cosmovisor/CHANGELOG.md
@@ -36,19 +36,22 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## [Unreleased]
 
+## v1.7.0 - 2024-11-18
+
 ### Features
 
 * [#21790](https://github.com/cosmos/cosmos-sdk/pull/21790) Add `add-batch-upgrade` command.
 * [#21972](https://github.com/cosmos/cosmos-sdk/pull/21972) Add `prepare-upgrade` command
+* [#21932](https://github.com/cosmos/cosmos-sdk/pull/21932) Add `cosmovisor show-upgrade-info` command to display the upgrade-info.json into stdout.
 
 ### Improvements
 
 * [#21891](https://github.com/cosmos/cosmos-sdk/pull/21891) create `current` symlink as relative
 * [#21462](https://github.com/cosmos/cosmos-sdk/pull/21462) Pass `stdin` to binary.
+  
+### Bug Fixes
 
-### Features
-
-* [#21932](https://github.com/cosmos/cosmos-sdk/pull/21932) Add `cosmovisor show-upgrade-info` command to display the upgrade-info.json into stdout.
+* [#22528](https://github.com/cosmos/cosmos-sdk/pull/22528) Fix premature upgrades on restarting cosmovisor.
 
 ## v1.6.0 - 2024-08-12
 
diff --git a/tools/cosmovisor/scanner.go b/tools/cosmovisor/scanner.go
@@ -15,6 +15,8 @@ import (
 	upgradetypes "cosmossdk.io/x/upgrade/types"
 )
 
+var errUntestAble = errors.New("untestable")
+
 type fileWatcher struct {
 	daemonHome string
 	filename   string // full path to a watched file
@@ -149,8 +151,8 @@ func (fw *fileWatcher) CheckUpdate(currentUpgrade upgradetypes.Plan) bool {
 	}
 
 	// file exist but too early in height
-	currentHeight, _ := fw.checkHeight()
-	if currentHeight != 0 && currentHeight < info.Height {
+	currentHeight, err := fw.checkHeight()
+	if (err != nil || currentHeight < info.Height) && !errors.Is(err, errUntestAble) { // ignore this check for tests
 		return false
 	}
 
@@ -182,7 +184,7 @@ func (fw *fileWatcher) CheckUpdate(currentUpgrade upgradetypes.Plan) bool {
 // checkHeight checks if the current block height
 func (fw *fileWatcher) checkHeight() (int64, error) {
 	if testing.Testing() { // we cannot test the command in the test environment
-		return 0, nil
+		return 0, errUntestAble
 	}
 
 	result, err := exec.Command(fw.currentBin, "status", "--home", fw.daemonHome).CombinedOutput() //nolint:gosec // we want to execute the status command

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ import (`
`15`	`15`	`upgradetypes "cosmossdk.io/x/upgrade/types"`
`16`	`16`	`)`
`17`	`17`
	`18`	`+var errUntestAble = errors.New("untestable")`
	`19`	`+`
`18`	`20`	`type fileWatcher struct {`
`19`	`21`	`daemonHome string`
`20`	`22`	`filename string // full path to a watched file`
`@@ -149,8 +151,8 @@ func (fw *fileWatcher) CheckUpdate(currentUpgrade upgradetypes.Plan) bool {`
`149`	`151`	`}`
`150`	`152`
`151`	`153`	`// file exist but too early in height`
`152`		`- currentHeight, _ := fw.checkHeight()`
`153`		`- if currentHeight != 0 && currentHeight < info.Height {`
	`154`	`+ currentHeight, err := fw.checkHeight()`
	`155`	`+ if (err != nil \|\| currentHeight < info.Height) && !errors.Is(err, errUntestAble) { // ignore this check for tests`
`154`	`156`	`return false`
`155`	`157`	`}`
`156`	`158`
`@@ -182,7 +184,7 @@ func (fw *fileWatcher) CheckUpdate(currentUpgrade upgradetypes.Plan) bool {`
`182`	`184`	`// checkHeight checks if the current block height`
`183`	`185`	`func (fw *fileWatcher) checkHeight() (int64, error) {`
`184`	`186`	`if testing.Testing() { // we cannot test the command in the test environment`
`185`		`- return 0, nil`
	`187`	`+ return 0, errUntestAble`
`186`	`188`	`}`
`187`	`189`
`188`	`190`	`result, err := exec.Command(fw.currentBin, "status", "--home", fw.daemonHome).CombinedOutput() //nolint:gosec // we want to execute the status command`