refactor(all): make cluster id flag common (#567)

kakao · Oct 4, 2023 · 42f563b · 42f563b
2 parents ac89e40 + 3953081
commit 42f563b
Show file tree

Hide file tree

Showing 18 changed files with 52 additions and 38 deletions.
diff --git a/cmd/benchmark/test_command.go b/cmd/benchmark/test_command.go
@@ -7,16 +7,13 @@ import (
 	"github.com/urfave/cli/v2"
 
 	"github.com/kakao/varlog/internal/benchmark"
+	"github.com/kakao/varlog/internal/flags"
 	"github.com/kakao/varlog/pkg/types"
 )
 
 var (
-	flagClusterID = &cli.StringFlag{
-		Name:  "cluster",
-		Usage: "Cluster ID",
-		Value: benchmark.DefaultClusterID.String(),
-	}
-	flagTarget = &cli.StringSliceFlag{
+	flagClusterID = flags.ClusterID
+	flagTarget    = &cli.StringSliceFlag{
 		Name:     "target",
 		Required: true,
 		Usage:    "The target of the benchmark load formatted by \"topic1:logstream1,topic2:logstream2,...<topic_id:logstream_id>\"",

diff --git a/cmd/mrtool/mrtool.go b/cmd/mrtool/mrtool.go
@@ -10,6 +10,7 @@ import (
 	"github.com/pkg/errors"
 	"github.com/urfave/cli/v2"
 
+	"github.com/kakao/varlog/internal/flags"
 	"github.com/kakao/varlog/pkg/mrc"
 	"github.com/kakao/varlog/pkg/types"
 )
@@ -22,7 +23,7 @@ const (
 	flagAddress   = "address"
 	flagTimeout   = "timeout"
 
-	defaultClusterID = types.ClusterID(1)
+	defaultClusterID = flags.DefaultClusterID
 	defaultTimeout   = time.Second
 )
 

diff --git a/cmd/varlogadm/cli.go b/cmd/varlogadm/cli.go
@@ -34,7 +34,7 @@ func newStartCommand() *cli.Command {
 		Usage:   "start [flags]",
 		Action:  start,
 		Flags: []cli.Flag{
-			flagClusterID.StringFlag(false, types.ClusterID(1).String()),
+			flagClusterID,
 			flagListen.StringFlag(false, admin.DefaultListenAddress),
 			flagReplicationFactor,
 			flagLogStreamGCTimeout.DurationFlag(false, admin.DefaultLogStreamGCTimeout),

diff --git a/cmd/varlogadm/flags.go b/cmd/varlogadm/flags.go
@@ -10,7 +10,7 @@ import (
 )
 
 var (
-	flagClusterID          = flags.ClusterID()
+	flagClusterID          = flags.ClusterID
 	flagMetadataRepository = flags.MetadataRepositoryAddress()
 	flagListen             = flags.FlagDesc{
 		Name:    "listen",

diff --git a/cmd/varlogcli/varlogcli.go b/cmd/varlogcli/varlogcli.go
@@ -79,7 +79,7 @@ func commandAction(c *cli.Context) error {
 		logStreamID types.LogStreamID
 	)
 	mrAddrs = c.StringSlice(flags.MetadataRepositoryAddress().Name)
-	clusterID, err = types.ParseClusterID(c.String(flags.ClusterID().Name))
+	clusterID, err = types.ParseClusterID(c.String(flags.ClusterID.Name))
 	if err != nil {
 		return err
 	}
@@ -116,8 +116,8 @@ func commandAction(c *cli.Context) error {
 
 func commonFlags() []cli.Flag {
 	return []cli.Flag{
+		flags.ClusterID,
 		flags.MetadataRepositoryAddress().StringSliceFlag(true, nil),
-		flags.ClusterID().StringFlag(false, types.ClusterID(1).String()),
 		flags.TopicID().StringFlag(true, ""),
 		flags.LogStreamID().StringFlag(false, ""),
 	}

diff --git a/cmd/varlogmr/flags.go b/cmd/varlogmr/flags.go
@@ -8,12 +8,7 @@ import (
 )
 
 var (
-	flagClusterID = flags.FlagDesc{
-		Name:    "cluster-id",
-		Aliases: []string{"cid"},
-		Usage:   "cluster id",
-		Envs:    []string{"CLUSTER_ID"},
-	}
+	flagClusterID = flags.ClusterID
 
 	flagRPCAddr = flags.FlagDesc{
 		Name:    "rpc-address",

diff --git a/cmd/varlogmr/metadata_repository.go b/cmd/varlogmr/metadata_repository.go
@@ -121,7 +121,7 @@ func initCLI() *cli.App {
 			Usage:   "start [flags]",
 			Action:  start,
 			Flags: []cli.Flag{
-				flagClusterID.StringFlag(false, metarepos.DefaultClusterID.String()),
+				flagClusterID,
 				flagRPCAddr.StringFlag(false, metarepos.DefaultRPCBindAddress),
 				flagRaftAddr.StringFlag(false, metarepos.DefaultRaftAddress),
 				flagDebugAddr.StringFlag(false, metarepos.DefaultDebugAddress),

diff --git a/cmd/varlogsn/cli.go b/cmd/varlogsn/cli.go
@@ -32,7 +32,7 @@ func newStartCommand() *cli.Command {
 		Aliases: []string{"s"},
 		Action:  start,
 		Flags: []cli.Flag{
-			flagClusterID.StringFlag(false, types.ClusterID(1).String()),
+			flagClusterID,
 			flagStorageNodeID.StringFlag(false, types.StorageNodeID(1).String()),
 			flagListen.StringFlag(false, "127.0.0.1:9091"),
 			flagAdvertise.StringFlag(false, ""),

diff --git a/cmd/varlogsn/flags.go b/cmd/varlogsn/flags.go
@@ -16,7 +16,7 @@ const (
 )
 
 var (
-	flagClusterID     = flags.ClusterID()
+	flagClusterID     = flags.ClusterID
 	flagStorageNodeID = flags.StorageNodeID()
 	flagListen        = flags.FlagDesc{
 		Name:    "listen",

diff --git a/internal/admin/config.go b/internal/admin/config.go
@@ -16,7 +16,7 @@ import (
 )
 
 const (
-	DefaultClusterID          = types.ClusterID(1)
+	defaultClusterID          = flags.DefaultClusterID
 	DefaultListenAddress      = "127.0.0.1:9090"
 	DefaultReplicationFactor  = flags.DefaultReplicationFactor
 	DefaultLogStreamGCTimeout = 24 * time.Hour
@@ -39,7 +39,7 @@ type config struct {
 
 func newConfig(opts []Option) (config, error) {
 	cfg := config{
-		cid:                DefaultClusterID,
+		cid:                defaultClusterID,
 		listenAddress:      DefaultListenAddress,
 		replicationFactor:  DefaultReplicationFactor,
 		logStreamGCTimeout: DefaultLogStreamGCTimeout,

diff --git a/internal/benchmark/config.go b/internal/benchmark/config.go
@@ -4,11 +4,12 @@ import (
 	"errors"
 	"time"
 
+	"github.com/kakao/varlog/internal/flags"
 	"github.com/kakao/varlog/pkg/types"
 )
 
 const (
-	DefaultClusterID      = types.ClusterID(1)
+	defaultClusterID      = flags.DefaultClusterID
 	DefaultMessageSize    = 0
 	DefaultBatchSize      = 1
 	DefaultConcurrency    = 0
@@ -28,7 +29,7 @@ type config struct {
 
 func newConfig(opts []Option) (config, error) {
 	cfg := config{
-		cid:            DefaultClusterID,
+		cid:            defaultClusterID,
 		duration:       DefaultDuration,
 		reportInterval: DefaultReportInterval,
 	}

diff --git a/internal/flags/cluster.go b/internal/flags/cluster.go
@@ -4,15 +4,33 @@ import (
 	"fmt"
 
 	"github.com/urfave/cli/v2"
+
+	"github.com/kakao/varlog/pkg/types"
 )
 
 const (
 	CategoryCluster = "Cluster:"
 
+	DefaultClusterID = types.MinClusterID
+
 	DefaultReplicationFactor = 1
 )
 
 var (
+	ClusterID = &cli.IntFlag{
+		Name:     "cluster-id",
+		Aliases:  []string{"cluster", "cid"},
+		Category: CategoryCluster,
+		EnvVars:  []string{"CLUSTER_ID"},
+		Value:    int(DefaultClusterID),
+		Action: func(_ *cli.Context, value int) error {
+			if value < int(types.MinClusterID) || value > int(types.MaxClusterID) {
+				return fmt.Errorf("invalid value \"%d\" for flag --cluster-id", value)
+			}
+			return nil
+		},
+	}
+
 	ReplicationFactor = &cli.IntFlag{
 		Name:     "replication-factor",
 		Category: CategoryCluster,

diff --git a/internal/flags/flags.go b/internal/flags/flags.go
@@ -103,13 +103,6 @@ func MetadataRepositoryAddress() *FlagDesc {
 	}
 }
 
-func ClusterID() *FlagDesc {
-	return &FlagDesc{
-		Name:    "cluster-id",
-		Aliases: []string{"cluster", "cid"},
-	}
-}
-
 func StorageNodeID() *FlagDesc {
 	return &FlagDesc{
 		Name:    "storage-node-id",

diff --git a/internal/metarepos/config.go b/internal/metarepos/config.go
@@ -16,7 +16,7 @@ import (
 )
 
 const (
-	DefaultClusterID                        = types.ClusterID(1)
+	defaultClusterID                        = flags.DefaultClusterID
 	DefaultRPCBindAddress                   = "0.0.0.0:9092"
 	DefaultDebugAddress                     = "0.0.0.0:9099"
 	DefaultRaftPort                         = 10000
@@ -99,7 +99,7 @@ func newConfig(opts []Option) (config, error) {
 			raftTick:          DefaultRaftTick,
 			raftDir:           DefaultRaftDir,
 		},
-		clusterID:                      DefaultClusterID,
+		clusterID:                      defaultClusterID,
 		rpcAddr:                        DefaultRPCBindAddress,
 		raftAddr:                       DefaultRaftAddress,
 		debugAddr:                      DefaultDebugAddress,

diff --git a/pkg/mrc/mrconnector/config.go b/pkg/mrc/mrconnector/config.go
@@ -6,13 +6,13 @@ import (
 	"github.com/pkg/errors"
 	"go.uber.org/zap"
 
+	"github.com/kakao/varlog/internal/flags"
 	"github.com/kakao/varlog/pkg/types"
 	"github.com/kakao/varlog/pkg/verrors"
-	"github.com/kakao/varlog/pkg/vflag"
 )
 
 const (
-	defaultClusterID         = vflag.DefaultClusterID
+	defaultClusterID         = flags.DefaultClusterID
 	defaultConnTimeout       = 1 * time.Second
 	defaultRPCTimeout        = 1 * time.Second
 	defaultInitCount         = 10

diff --git a/pkg/types/types.go b/pkg/types/types.go
@@ -14,6 +14,11 @@ type ClusterID int32
 
 var _ fmt.Stringer = (*ClusterID)(nil)
 
+const (
+	MinClusterID = ClusterID(1)
+	MaxClusterID = ClusterID(math.MaxInt32)
+)
+
 func ParseClusterID(s string) (ClusterID, error) {
 	id, err := strconv.ParseInt(s, 10, 32)
 	return ClusterID(id), err
@@ -23,6 +28,10 @@ func (cid ClusterID) String() string {
 	return strconv.FormatInt(int64(cid), 10)
 }
 
+func (cid ClusterID) Invalid() bool {
+	return cid < MinClusterID
+}
+
 type StorageNodeID int32
 
 const MinStorageNodeID = StorageNodeID(1)

diff --git a/pkg/vflag/defaults.go b/pkg/vflag/defaults.go
@@ -3,7 +3,6 @@ package vflag
 import "github.com/kakao/varlog/pkg/types"
 
 const (
-	DefaultClusterID          = types.ClusterID(1)
 	DefaultStorageNodeID      = types.StorageNodeID(1)
 	DefaultTelemetryCollector = "nop"
 )
diff --git a/tests/ee/cluster/config.go b/tests/ee/cluster/config.go
@@ -6,11 +6,12 @@ import (
 	"go.uber.org/zap"
 	"go.uber.org/zap/zaptest"
 
+	"github.com/kakao/varlog/internal/flags"
 	"github.com/kakao/varlog/pkg/types"
 )
 
 const (
-	DefaultClusterID         = types.ClusterID(1)
+	defaultClusterID         = flags.DefaultClusterID
 	DefaultReplicationFactor = 3
 	DefaultNumMetaRepos      = 3
 )
@@ -25,7 +26,7 @@ type Config struct {
 
 func NewConfig(t *testing.T, opts ...Option) (Config, error) {
 	cfg := Config{
-		cid:               DefaultClusterID,
+		cid:               defaultClusterID,
 		replicationFactor: DefaultReplicationFactor,
 		numMetaRepos:      DefaultNumMetaRepos,
 		logger:            zaptest.NewLogger(t),