refactor consensus follower to use protocol db

Author: zhangchiqing

cmd/node_builder.go

@@ -158,8 +158,7 @@ type BaseConfig struct {
 	pebbleDir                   string
 	pebbleCheckpointsDir        string
 	DBOps                       string
-	badgerDB                    *badger.DB
-	pebbleDB                    *pebble.DB
+	protocolDB                  storage.DB
 	secretsdir                  string
 	secretsDBEnabled            bool
 	InsecureSecretsDB           bool
@@ -265,7 +264,7 @@ type StateExcerptAtBoot struct {
 }
 
 func DefaultBaseConfig() *BaseConfig {
-	datadir := "/data/protocol"
+	datadir := "/data/protocol-pebble"
 	pebbleDir := "/data/protocol-pebble"
 
 	// NOTE: if the codec used in the network component is ever changed any code relying on
@@ -285,8 +284,7 @@ func DefaultBaseConfig() *BaseConfig {
 		datadir:          datadir,
 		pebbleDir:        pebbleDir,
 		DBOps:            string(dbops.PebbleBatch), // "pebble-batch" (default) or "badger-batch" (deprecated)
-		badgerDB:         nil,
-		pebbleDB:         nil,
+		protocolDB:       nil,
 		secretsdir:       NotSet,
 		secretsDBEnabled: true,
 		level:            "info",

cmd/scaffold.go

@@ -1973,55 +1973,29 @@ func WithBindAddress(bindAddress string) Option {
 	}
 }
 
-// WithDataDir set the data directory for the badger database
-// It will be ignored if WithBadgerDB is used
-func WithDataDir(dataDir string) Option {
+// WithProtocolDir set the protocol data directory for the database
+// It will be ignored if WithProtocolDB is used
+func WithProtocolDir(dataDir string) Option {
 	return func(config *BaseConfig) {
-		if config.badgerDB != nil {
-			log.Warn().Msgf("ignoring data directory %s as badger database is already set", dataDir)
+		if config.protocolDB != nil {
+			log.Warn().Msgf("ignoring data directory %s as storage database is already set", dataDir)
 			return
 		}
 
 		config.datadir = dataDir
 	}
 }
 
-// WithBadgerDB sets the badger database instance
+// WithProtocolDB sets the storage database instance
 // If used, then WithDataDir method will be ignored
-func WithBadgerDB(db *badger.DB) Option {
+func WithProtocolDB(db storage.DB) Option {
 	return func(config *BaseConfig) {
 		if config.datadir != "" && config.datadir != NotSet {
 			log.Warn().Msgf("ignoring data directory is already set for badger %v", config.datadir)
 			config.datadir = ""
 		}
 
-		config.badgerDB = db
-	}
-}
-
-// WithPebbleDir set the data directory for the pebble database
-// It will be ignored if WithPebbleDB is used
-func WithPebbleDir(dataDir string) Option {
-	return func(config *BaseConfig) {
-		if config.pebbleDB != nil {
-			log.Warn().Msgf("ignoring data directory %s as pebble database is already set", dataDir)
-			return
-		}
-
-		config.pebbleDir = dataDir
-	}
-}
-
-// WithPebbleDB sets the pebble database instance
-// If used, then WithPebbleDir method will be ignored
-func WithPebbleDB(db *pebble.DB) Option {
-	return func(config *BaseConfig) {
-		if config.pebbleDir != "" && config.pebbleDir != NotSet {
-			log.Warn().Msgf("ignoring data directory is already set for pebble %v", config.pebbleDir)
-			config.pebbleDir = ""
-		}
-
-		config.pebbleDB = db
+		config.protocolDB = db
 	}
 }
 

follower/consensus_follower.go

@@ -5,8 +5,6 @@ import (
 	"fmt"
 	"sync"
 
-	"github.com/cockroachdb/pebble/v2"
-	"github.com/dgraph-io/badger/v2"
 	"github.com/jordanschalm/lockctx"
 	"github.com/onflow/crypto"
 	"github.com/rs/zerolog"
@@ -20,6 +18,7 @@ import (
 	"github.com/onflow/flow-go/module/component"
 	"github.com/onflow/flow-go/module/irrecoverable"
 	"github.com/onflow/flow-go/module/util"
+	"github.com/onflow/flow-go/storage"
 )
 
 // ConsensusFollower is a standalone module run by third parties which provides
@@ -38,8 +37,7 @@ type Config struct {
 	networkPrivKey   crypto.PrivateKey   // the network private key of this node
 	bootstrapNodes   []BootstrapNodeInfo // the bootstrap nodes to use
 	bindAddr         string              // address to bind on
-	badgerDB         *badger.DB          // badger instance
-	pebbleDB         *pebble.DB          // pebble instance
+	protocolDB       storage.DB          // badger instance
 	bootstrapDir     string              // path to the bootstrap directory
 	logLevel         string              // log level
 	exposeMetrics    bool                // whether to expose metrics
@@ -53,15 +51,9 @@ type Config struct {
 type Option func(c *Config)
 
 // currently used by rosetta
-func WithDB(db *badger.DB) Option {
+func WithProtocolDB(db storage.DB) Option {
 	return func(cf *Config) {
-		cf.badgerDB = db
-	}
-}
-
-func WithPebbleDB(db *pebble.DB) Option {
-	return func(cf *Config) {
-		cf.pebbleDB = db
+		cf.protocolDB = db
 	}
 }
 
@@ -145,11 +137,8 @@ func getBaseOptions(config *Config) []cmd.Option {
 	if config.bindAddr != "" {
 		options = append(options, cmd.WithBindAddress(config.bindAddr))
 	}
-	if config.badgerDB != nil {
-		options = append(options, cmd.WithBadgerDB(config.badgerDB))
-	}
-	if config.pebbleDB != nil {
-		options = append(options, cmd.WithPebbleDB(config.pebbleDB))
+	if config.protocolDB != nil {
+		options = append(options, cmd.WithProtocolDB(config.protocolDB))
 	}
 	if config.logLevel != "" {
 		options = append(options, cmd.WithLogLevel(config.logLevel))
@@ -196,8 +185,7 @@ func NewConsensusFollower(
 		networkPrivKey: networkPrivKey,
 		bootstrapNodes: bootstapIdentities,
 		bindAddr:       bindAddr,
-		badgerDB:       nil,
-		pebbleDB:       nil,
+		protocolDB:     nil,
 		logLevel:       "info",
 		exposeMetrics:  false,
 		lockManager:    nil, // default to nil, can be set optionally with WithLockManager in tests