go/oasis-node/cmd/storage: Warn when the node should not be running

Author: martintomazic

docs/oasis-node/cli.md

@@ -336,7 +336,7 @@ oasis1qqncl383h8458mr9cytatygctzwsx02n4c5f8ed7
 
 ### compact-experimental
 
-Run
+Run (when the node is not running):
 
 ```sh
 oasis-node storage compact-experimental --config /path/to/config/file
@@ -367,7 +367,7 @@ maintenance periods.
 
 ### prune-experimental
 
-Run
+Run (when the node is not running):
 
 ```sh
 oasis-node storage prune-experimental --config /path/to/config/file

go/oasis-node/cmd/common/common.go

@@ -2,8 +2,10 @@
 package common
 
 import (
+	"errors"
 	"fmt"
 	"io"
+	"io/fs"
 	"os"
 	"path/filepath"
 	"strings"
@@ -71,6 +73,20 @@ func InternalSocketPath() string {
 	return filepath.Join(DataDir(), InternalSocketName)
 }
 
+// IsNodeRunning returns true when the node is running.
+func IsNodeRunning() (bool, error) {
+	path := InternalSocketPath()
+
+	if _, err := os.Stat(path); err != nil {
+		if errors.Is(err, fs.ErrNotExist) {
+			return false, nil
+		}
+		return false, fmt.Errorf("stat %s: %w", path, err)
+	}
+
+	return true, nil
+}
+
 // IsNodeCmd returns true iff the current command is the ekiden node.
 func IsNodeCmd() bool {
 	return isNodeCmd

go/oasis-node/cmd/storage/storage.go

@@ -321,6 +321,15 @@ func doDBCompactions(_ *cobra.Command, args []string) error {
 		cmdCommon.EarlyLogAndExit(err)
 	}
 
+	running, err := cmdCommon.IsNodeRunning()
+	if err != nil {
+		return fmt.Errorf("failed to ensure the node is not running: %w", err)
+	}
+
+	if running {
+		return fmt.Errorf("compaction can only be done when the node is not running")
+	}
+
 	dataDir := cmdCommon.DataDir()
 
 	logger.Info("Starting database compactions. This may take a while...")
@@ -439,6 +448,15 @@ func doPrune(_ *cobra.Command, args []string) error {
 		cmdCommon.EarlyLogAndExit(err)
 	}
 
+	running, err := cmdCommon.IsNodeRunning()
+	if err != nil {
+		return fmt.Errorf("failed to ensure the node is not running: %w", err)
+	}
+
+	if running {
+		return fmt.Errorf("pruning can only be done when the node is not running")
+	}
+
 	if config.GlobalConfig.Consensus.Prune.Strategy == cmtConfig.PruneStrategyNone {
 		logger.Info("skipping consensus pruning since disabled in the config")
 		return nil