go/oasis-node/cmd/storage: Factor out db providers

Observe that migrate command now opens runtime light history with
hasLocalStorage=true. This is intentional, to be consistent with
the other callsite. When doing migration or offline pruning the
node clearly needs to have local storage. In practice this is not
relevant as it only affects behaviour of light history when
the storage committee worker is running. Furthermore, once we
move pruning and (re)-indexing of the runtime light history
this half of the history.History api can be removed, including
this variable.

Author: martintomazic

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

@@ -0,0 +1,85 @@
+package storage
+
+import (
+	"fmt"
+	"path/filepath"
+
+	cmtCfg "github.com/cometbft/cometbft/config"
+	"github.com/cometbft/cometbft/state"
+	"github.com/cometbft/cometbft/store"
+
+	"github.com/oasisprotocol/oasis-core/go/common"
+	"github.com/oasisprotocol/oasis-core/go/config"
+	"github.com/oasisprotocol/oasis-core/go/consensus/cometbft/abci"
+	cmtCommon "github.com/oasisprotocol/oasis-core/go/consensus/cometbft/common"
+	cmtDB "github.com/oasisprotocol/oasis-core/go/consensus/cometbft/db"
+	runtimeConfig "github.com/oasisprotocol/oasis-core/go/runtime/config"
+	"github.com/oasisprotocol/oasis-core/go/runtime/history"
+	"github.com/oasisprotocol/oasis-core/go/storage/api"
+)
+
+func openConsensusNodeDB(dataDir string) (api.NodeDB, func(), error) {
+	ldb, ndb, _, err := abci.InitStateStorage(
+		&abci.ApplicationConfig{
+			DataDir:             filepath.Join(dataDir, cmtCommon.StateDir),
+			StorageBackend:      config.GlobalConfig.Storage.Backend,
+			MemoryOnlyStorage:   false,
+			ReadOnlyStorage:     false,
+			DisableCheckpointer: true,
+		},
+	)
+	if err != nil {
+		return nil, nil, fmt.Errorf("failed to initialize ABCI storage backend: %w", err)
+	}
+
+	// Close and Cleanup both only close NodeDB. Still closing both explicitly,
+	// to prevent resource leaks if things change in the future.
+	close := func() {
+		ndb.Close()
+		ldb.Cleanup()
+	}
+
+	return ndb, close, nil
+}
+
+func openConsensusBlockstore(dataDir string) (*store.BlockStore, error) {
+	cmtConfig := cmtCfg.DefaultConfig()
+	cmtConfig.SetRoot(filepath.Join(dataDir, cmtCommon.StateDir))
+
+	dbProvider, err := cmtDB.Provider()
+	if err != nil {
+		return nil, fmt.Errorf("failed to obtain db provider: %w", err)
+	}
+
+	blockstoreDB, err := cmtDB.OpenBlockstoreDB(dbProvider, cmtConfig)
+	if err != nil {
+		return nil, fmt.Errorf("failed to open blockstore: %w", err)
+	}
+	blockstore := store.NewBlockStore(blockstoreDB)
+
+	return blockstore, nil
+}
+
+func openConsensusStatestore(dataDir string) (state.Store, error) {
+	cmtConfig := cmtCfg.DefaultConfig()
+	cmtConfig.SetRoot(filepath.Join(dataDir, cmtCommon.StateDir))
+
+	dbProvider, err := cmtDB.Provider()
+	if err != nil {
+		return nil, fmt.Errorf("failed to obtain db provider: %w", err)
+	}
+	stateDB, err := cmtDB.OpenStateDB(dbProvider, cmtConfig)
+	if err != nil {
+		return nil, fmt.Errorf("failed to open state db: %w", err)
+	}
+	return cmtDB.OpenStateStore(stateDB), nil
+}
+
+func openRuntimeLightHistory(dataDir string, rt common.Namespace) (history.History, error) {
+	rtDir := runtimeConfig.GetRuntimeStateDir(dataDir, rt)
+	history, err := history.New(rt, rtDir, history.NewNonePrunerFactory(), true)
+	if err != nil {
+		return nil, fmt.Errorf("failed to open new light history: %w", err)
+	}
+	return history, nil
+}

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

@@ -12,27 +12,21 @@ import (
 	"strings"
 	"time"
 
-	cmtconfig "github.com/cometbft/cometbft/config"
-	cmtBlockstore "github.com/cometbft/cometbft/store"
 	badgerDB "github.com/dgraph-io/badger/v4"
 	"github.com/spf13/cobra"
 
 	"github.com/oasisprotocol/oasis-core/go/common"
 	"github.com/oasisprotocol/oasis-core/go/common/crypto/hash"
 	"github.com/oasisprotocol/oasis-core/go/common/logging"
 	"github.com/oasisprotocol/oasis-core/go/config"
-	"github.com/oasisprotocol/oasis-core/go/consensus/cometbft/abci"
-	cmtCommon "github.com/oasisprotocol/oasis-core/go/consensus/cometbft/common"
 	cmtConfig "github.com/oasisprotocol/oasis-core/go/consensus/cometbft/config"
-	cmtDB "github.com/oasisprotocol/oasis-core/go/consensus/cometbft/db"
 	cmtDBProvider "github.com/oasisprotocol/oasis-core/go/consensus/cometbft/db/badger"
 	cmdCommon "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common"
 	roothash "github.com/oasisprotocol/oasis-core/go/roothash/api"
 	"github.com/oasisprotocol/oasis-core/go/runtime/bundle"
 	runtimeConfig "github.com/oasisprotocol/oasis-core/go/runtime/config"
 	"github.com/oasisprotocol/oasis-core/go/runtime/history"
 	"github.com/oasisprotocol/oasis-core/go/runtime/registry"
-	"github.com/oasisprotocol/oasis-core/go/storage/api"
 	db "github.com/oasisprotocol/oasis-core/go/storage/mkvs/db/api"
 	"github.com/oasisprotocol/oasis-core/go/storage/mkvs/db/badger"
 	"github.com/oasisprotocol/oasis-core/go/storage/mkvs/node"
@@ -195,9 +189,7 @@ func doMigrate(_ *cobra.Command, args []string) error {
 		}
 		err := func() error {
 			runtimeDir := runtimeConfig.GetRuntimeStateDir(dataDir, rt)
-
-			prunerFactory := history.NewNonePrunerFactory()
-			history, err := history.New(rt, runtimeDir, prunerFactory, false)
+			history, err := openRuntimeLightHistory(dataDir, rt)
 			if err != nil {
 				return fmt.Errorf("error creating history provider: %w", err)
 			}
@@ -417,30 +409,6 @@ func compactConsensusNodeDB(dataDir string) error {
 	return ndb.Compact()
 }
 
-func openConsensusNodeDB(dataDir string) (api.NodeDB, func(), error) {
-	ldb, ndb, _, err := abci.InitStateStorage(
-		&abci.ApplicationConfig{
-			DataDir:             filepath.Join(dataDir, cmtCommon.StateDir),
-			StorageBackend:      config.GlobalConfig.Storage.Backend,
-			MemoryOnlyStorage:   false,
-			ReadOnlyStorage:     false,
-			DisableCheckpointer: true,
-		},
-	)
-	if err != nil {
-		return nil, nil, fmt.Errorf("failed to initialize ABCI storage backend: %w", err)
-	}
-
-	// Close and Cleanup both only close NodeDB. Still closing both explicitly,
-	// to prevent resource leaks if things change in the future.
-	close := func() {
-		ndb.Close()
-		ldb.Cleanup()
-	}
-
-	return ndb, close, nil
-}
-
 func doPrune(_ *cobra.Command, args []string) error {
 	if err := cmdCommon.Init(); err != nil {
 		cmdCommon.EarlyLogAndExit(err)
@@ -554,11 +522,9 @@ func pruneConsensusNodeDB(ndb db.NodeDB, retainHeight uint64) error {
 // In case of no configured runtimes it returns max int64.
 func minReindexedHeight(dataDir string, runtimes []common.Namespace) (int64, error) {
 	fetchLastReindexedHeight := func(runtimeID common.Namespace) (int64, error) {
-		rtDir := runtimeConfig.GetRuntimeStateDir(dataDir, runtimeID)
-
-		history, err := history.New(runtimeID, rtDir, history.NewNonePrunerFactory(), true)
+		history, err := openRuntimeLightHistory(dataDir, runtimeID)
 		if err != nil {
-			return 0, fmt.Errorf("failed to open new light history: %w", err)
+			return 0, fmt.Errorf("failed to open runtime light history: %w", err)
 		}
 		defer history.Close()
 
@@ -586,19 +552,10 @@ func minReindexedHeight(dataDir string, runtimes []common.Namespace) (int64, err
 }
 
 func pruneCometDBs(dataDir string, retainHeight int64) error {
-	cmtConfig := cmtconfig.DefaultConfig()
-	cmtConfig.SetRoot(filepath.Join(dataDir, cmtCommon.StateDir))
-
-	dbProvider, err := cmtDB.Provider()
-	if err != nil {
-		return fmt.Errorf("failed to obtain db provider: %w", err)
-	}
-
-	blockstoreDB, err := cmtDB.OpenBlockstoreDB(dbProvider, cmtConfig)
+	blockstore, err := openConsensusBlockstore(dataDir)
 	if err != nil {
-		return fmt.Errorf("failed to open blockstore: %w", err)
+		return fmt.Errorf("failed to open consensus blockstore: %w", err)
 	}
-	blockstore := cmtBlockstore.NewBlockStore(blockstoreDB)
 	defer blockstore.Close()
 
 	// Mimic the upstream pruning logic from CometBFT
@@ -623,11 +580,10 @@ func pruneCometDBs(dataDir string, retainHeight int64) error {
 	}
 	logger.Info("blockstore pruning finished", "pruned", n)
 
-	stateDB, err := cmtDB.OpenStateDB(dbProvider, cmtConfig)
+	state, err := openConsensusStatestore(dataDir)
 	if err != nil {
-		return fmt.Errorf("failed to open state db: %w", err)
+		return fmt.Errorf("failed to open consensus state store: %w", err)
 	}
-	state := cmtDB.OpenStateStore(stateDB)
 	defer state.Close()
 
 	logger.Info("pruning consensus states", "base", base, "retain_height", retainHeight)